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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.925.2.20! raeburn     4: # $Id: loncommon.pm,v 1.925.2.19 2010/11/30 06:28:17 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
                    486:     my $wintitle = &mt('Course Browser');
                    487:     if ($crstype ne '') {
                    488:         $wintitle = &mt($crstype);
                    489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
                    903:     return &select_form($selected,$name,%langchoices);
                    904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.648     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
                   1093: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1094: 
                   1095: =cut
                   1096: 
                   1097: sub help_open_topic {
1.48      bowersj2 1098:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1099:     $text = "" if (not defined $text);
1.44      bowersj2 1100:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1101:     $width = 350 if (not defined $width);
                   1102:     $height = 400 if (not defined $height);
                   1103:     my $filename = $topic;
                   1104:     $filename =~ s/ /_/g;
                   1105: 
1.48      bowersj2 1106:     my $template = "";
                   1107:     my $link;
1.572     banghart 1108:     
1.159     www      1109:     $topic=~s/\W/\_/g;
1.44      bowersj2 1110: 
1.572     banghart 1111:     if (!$stayOnPage) {
1.72      bowersj2 1112: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1113:     } else {
1.48      bowersj2 1114: 	$link = "/adm/help/${filename}.hlp";
                   1115:     }
                   1116: 
                   1117:     # Add the text
1.755     neumanie 1118:     if ($text ne "") {	
1.763     bisitz   1119: 	$template.='<span class="LC_help_open_topic">'
                   1120:                   .'<a target="_top" href="'.$link.'">'
                   1121:                   .$text.'</a>';
1.48      bowersj2 1122:     }
                   1123: 
1.763     bisitz   1124:     # (Always) Add the graphic
1.179     matthew  1125:     my $title = &mt('Online Help');
1.667     raeburn  1126:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1127:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1128:               .'<img src="'.$helpicon.'" border="0"'
                   1129:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1130:               .' title="'.$title.'"' 
1.763     bisitz   1131:               .' /></a>';
                   1132:     if ($text ne "") {	
                   1133:         $template.='</span>';
                   1134:     }
1.44      bowersj2 1135:     return $template;
                   1136: 
1.106     bowersj2 1137: }
                   1138: 
                   1139: # This is a quicky function for Latex cheatsheet editing, since it 
                   1140: # appears in at least four places
                   1141: sub helpLatexCheatsheet {
1.732     raeburn  1142:     my ($topic,$text,$not_author) = @_;
                   1143:     my $out;
1.106     bowersj2 1144:     my $addOther = '';
1.732     raeburn  1145:     if ($topic) {
1.763     bisitz   1146: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1147: 							       undef, undef, 600).
                   1148: 								   '</span> ';
                   1149:     }
                   1150:     $out = '<span>' # Start cheatsheet
                   1151: 	  .$addOther
                   1152:           .'<span>'
                   1153: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1154: 					       undef,undef,600)
                   1155: 	  .'</span> <span>'
                   1156: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1157: 					       undef,undef,600)
                   1158: 	  .'</span>';
1.732     raeburn  1159:     unless ($not_author) {
1.763     bisitz   1160:         $out .= ' <span>'
                   1161: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1162: 	                                            undef,undef,600)
                   1163: 	       .'</span>';
1.732     raeburn  1164:     }
1.763     bisitz   1165:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1166:     return $out;
1.172     www      1167: }
                   1168: 
1.430     albertel 1169: sub general_help {
                   1170:     my $helptopic='Student_Intro';
                   1171:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1172: 	$helptopic='Authoring_Intro';
1.907     raeburn  1173:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1174: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1175:     } elsif ($env{'request.role'}=~/^dc/) {
                   1176:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1177:     }
                   1178:     return $helptopic;
                   1179: }
                   1180: 
                   1181: sub update_help_link {
                   1182:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1183:     my $origurl = $ENV{'REQUEST_URI'};
                   1184:     $origurl=~s|^/~|/priv/|;
                   1185:     my $timestamp = time;
                   1186:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1187:         $$datum = &escape($$datum);
                   1188:     }
                   1189: 
                   1190:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1191:     my $output .= <<"ENDOUTPUT";
                   1192: <script type="text/javascript">
1.824     bisitz   1193: // <![CDATA[
1.430     albertel 1194: banner_link = '$banner_link';
1.824     bisitz   1195: // ]]>
1.430     albertel 1196: </script>
                   1197: ENDOUTPUT
                   1198:     return $output;
                   1199: }
                   1200: 
                   1201: # now just updates the help link and generates a blue icon
1.193     raeburn  1202: sub help_open_menu {
1.430     albertel 1203:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1204: 	= @_;    
1.430     albertel 1205:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1206:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1207:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1208:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1209:         $stayOnPage=1;
1.430     albertel 1210:     }
                   1211:     my $output;
                   1212:     if ($component_help) {
                   1213: 	if (!$text) {
                   1214: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1215: 				       $width,$height);
                   1216: 	} else {
                   1217: 	    my $help_text;
                   1218: 	    $help_text=&unescape($topic);
                   1219: 	    $output='<table><tr><td>'.
                   1220: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1221: 				 $width,$height).'</td></tr></table>';
                   1222: 	}
                   1223:     }
                   1224:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1225:     return $output.$banner_link;
                   1226: }
                   1227: 
                   1228: sub top_nav_help {
                   1229:     my ($text) = @_;
1.436     albertel 1230:     $text = &mt($text);
1.572     banghart 1231:     my $stay_on_page = 
1.798     tempelho 1232: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1233:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1234: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1235:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1236: 
1.201     raeburn  1237:     my $title = &mt('Get help');
1.436     albertel 1238: 
                   1239:     return <<"END";
                   1240: $banner_link
                   1241:  <a href="$link" title="$title">$text</a>
                   1242: END
                   1243: }
                   1244: 
                   1245: sub help_menu_js {
                   1246:     my ($text) = @_;
                   1247: 
                   1248:     my $stayOnPage = 
1.798     tempelho 1249: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1250: 
                   1251:     my $width = 620;
                   1252:     my $height = 600;
1.430     albertel 1253:     my $helptopic=&general_help();
                   1254:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1255:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1256:     my $start_page =
                   1257:         &Apache::loncommon::start_page('Help Menu', undef,
                   1258: 				       {'frameset'    => 1,
                   1259: 					'js_ready'    => 1,
                   1260: 					'add_entries' => {
                   1261: 					    'border' => '0',
1.579     raeburn  1262: 					    'rows'   => "110,*",},});
1.331     albertel 1263:     my $end_page =
                   1264:         &Apache::loncommon::end_page({'frameset' => 1,
                   1265: 				      'js_ready' => 1,});
                   1266: 
1.436     albertel 1267:     my $template .= <<"ENDTEMPLATE";
                   1268: <script type="text/javascript">
1.877     bisitz   1269: // <![CDATA[
1.253     albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1271: var banner_link = '';
1.243     raeburn  1272: function helpMenu(target) {
                   1273:     var caller = this;
                   1274:     if (target == 'open') {
                   1275:         var newWindow = null;
                   1276:         try {
1.262     albertel 1277:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1278:         }
                   1279:         catch(error) {
                   1280:             writeHelp(caller);
                   1281:             return;
                   1282:         }
                   1283:         if (newWindow) {
                   1284:             caller = newWindow;
                   1285:         }
1.193     raeburn  1286:     }
1.243     raeburn  1287:     writeHelp(caller);
                   1288:     return;
                   1289: }
                   1290: function writeHelp(caller) {
1.430     albertel 1291:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1292:     caller.document.close()
                   1293:     caller.focus()
1.193     raeburn  1294: }
1.877     bisitz   1295: // END LON-CAPA Internal -->
1.253     albertel 1296: // ]]>
1.436     albertel 1297: </script>
1.193     raeburn  1298: ENDTEMPLATE
                   1299:     return $template;
                   1300: }
                   1301: 
1.172     www      1302: sub help_open_bug {
                   1303:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1304:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1305:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1306:     $text = "" if (not defined $text);
                   1307:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1308:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1309: 	$stayOnPage=1;
                   1310:     }
1.184     albertel 1311:     $width = 600 if (not defined $width);
                   1312:     $height = 600 if (not defined $height);
1.172     www      1313: 
                   1314:     $topic=~s/\W+/\+/g;
                   1315:     my $link='';
                   1316:     my $template='';
1.379     albertel 1317:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1318: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1319:     if (!$stayOnPage)
                   1320:     {
                   1321: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1322:     }
                   1323:     else
                   1324:     {
                   1325: 	$link = $url;
                   1326:     }
                   1327:     # Add the text
                   1328:     if ($text ne "")
                   1329:     {
                   1330: 	$template .= 
                   1331:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1332:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1333:     }
                   1334: 
                   1335:     # Add the graphic
1.179     matthew  1336:     my $title = &mt('Report a Bug');
1.215     albertel 1337:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1338:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1339:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1340: ENDTEMPLATE
                   1341:     if ($text ne '') { $template.='</td></tr></table>' };
                   1342:     return $template;
                   1343: 
                   1344: }
                   1345: 
                   1346: sub help_open_faq {
                   1347:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1348:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1349:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1350:     $text = "" if (not defined $text);
                   1351:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1352:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1353: 	$stayOnPage=1;
                   1354:     }
                   1355:     $width = 350 if (not defined $width);
                   1356:     $height = 400 if (not defined $height);
                   1357: 
                   1358:     $topic=~s/\W+/\+/g;
                   1359:     my $link='';
                   1360:     my $template='';
                   1361:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1362:     if (!$stayOnPage)
                   1363:     {
                   1364: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1365:     }
                   1366:     else
                   1367:     {
                   1368: 	$link = $url;
                   1369:     }
                   1370: 
                   1371:     # Add the text
                   1372:     if ($text ne "")
                   1373:     {
                   1374: 	$template .= 
1.173     www      1375:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1376:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1377:     }
                   1378: 
                   1379:     # Add the graphic
1.179     matthew  1380:     my $title = &mt('View the FAQ');
1.215     albertel 1381:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1382:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1383:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1384: ENDTEMPLATE
                   1385:     if ($text ne '') { $template.='</td></tr></table>' };
                   1386:     return $template;
                   1387: 
1.44      bowersj2 1388: }
1.37      matthew  1389: 
1.180     matthew  1390: ###############################################################
                   1391: ###############################################################
                   1392: 
1.45      matthew  1393: =pod
                   1394: 
1.648     raeburn  1395: =item * &change_content_javascript():
1.256     matthew  1396: 
                   1397: This and the next function allow you to create small sections of an
                   1398: otherwise static HTML page that you can update on the fly with
                   1399: Javascript, even in Netscape 4.
                   1400: 
                   1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1402: must be written to the HTML page once. It will prove the Javascript
                   1403: function "change(name, content)". Calling the change function with the
                   1404: name of the section 
                   1405: you want to update, matching the name passed to C<changable_area>, and
                   1406: the new content you want to put in there, will put the content into
                   1407: that area.
                   1408: 
                   1409: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1410: to contain room for the original contents. You need to "make space"
                   1411: for whatever changes you wish to make, and be B<sure> to check your
                   1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1413: it's adequate for updating a one-line status display, but little more.
                   1414: This script will set the space to 100% width, so you only need to
                   1415: worry about height in Netscape 4.
                   1416: 
                   1417: Modern browsers are much less limiting, and if you can commit to the
                   1418: user not using Netscape 4, this feature may be used freely with
                   1419: pretty much any HTML.
                   1420: 
                   1421: =cut
                   1422: 
                   1423: sub change_content_javascript {
                   1424:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1425:     if ($env{'browser.type'} eq 'netscape' &&
                   1426: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1427: 	return (<<NETSCAPE4);
                   1428: 	function change(name, content) {
                   1429: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1430: 	    doc.open();
                   1431: 	    doc.write(content);
                   1432: 	    doc.close();
                   1433: 	}
                   1434: NETSCAPE4
                   1435:     } else {
                   1436: 	# Otherwise, we need to use semi-standards-compliant code
                   1437: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1438: 	# is really scary, and every useful browser supports it
                   1439: 	return (<<DOMBASED);
                   1440: 	function change(name, content) {
                   1441: 	    element = document.getElementById(name);
                   1442: 	    element.innerHTML = content;
                   1443: 	}
                   1444: DOMBASED
                   1445:     }
                   1446: }
                   1447: 
                   1448: =pod
                   1449: 
1.648     raeburn  1450: =item * &changable_area($name,$origContent):
1.256     matthew  1451: 
                   1452: This provides a "changable area" that can be modified on the fly via
                   1453: the Javascript code provided in C<change_content_javascript>. $name is
                   1454: the name you will use to reference the area later; do not repeat the
                   1455: same name on a given HTML page more then once. $origContent is what
                   1456: the area will originally contain, which can be left blank.
                   1457: 
                   1458: =cut
                   1459: 
                   1460: sub changable_area {
                   1461:     my ($name, $origContent) = @_;
                   1462: 
1.258     albertel 1463:     if ($env{'browser.type'} eq 'netscape' &&
                   1464: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1465: 	# If this is netscape 4, we need to use the Layer tag
                   1466: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1467:     } else {
                   1468: 	return "<span id='$name'>$origContent</span>";
                   1469:     }
                   1470: }
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &viewport_geometry_js 
1.590     raeburn  1475: 
                   1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1477: 
                   1478: =cut
                   1479: 
                   1480: 
                   1481: sub viewport_geometry_js { 
                   1482:     return <<"GEOMETRY";
                   1483: var Geometry = {};
                   1484: function init_geometry() {
                   1485:     if (Geometry.init) { return };
                   1486:     Geometry.init=1;
                   1487:     if (window.innerHeight) {
                   1488:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1489:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1490:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1491:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1492:     }
                   1493:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1494:         Geometry.getViewportHeight =
                   1495:             function() { return document.documentElement.clientHeight; };
                   1496:         Geometry.getViewportWidth =
                   1497:             function() { return document.documentElement.clientWidth; };
                   1498: 
                   1499:         Geometry.getHorizontalScroll =
                   1500:             function() { return document.documentElement.scrollLeft; };
                   1501:         Geometry.getVerticalScroll =
                   1502:             function() { return document.documentElement.scrollTop; };
                   1503:     }
                   1504:     else if (document.body.clientHeight) {
                   1505:         Geometry.getViewportHeight =
                   1506:             function() { return document.body.clientHeight; };
                   1507:         Geometry.getViewportWidth =
                   1508:             function() { return document.body.clientWidth; };
                   1509:         Geometry.getHorizontalScroll =
                   1510:             function() { return document.body.scrollLeft; };
                   1511:         Geometry.getVerticalScroll =
                   1512:             function() { return document.body.scrollTop; };
                   1513:     }
                   1514: }
                   1515: 
                   1516: GEOMETRY
                   1517: }
                   1518: 
                   1519: =pod
                   1520: 
1.648     raeburn  1521: =item * &viewport_size_js()
1.590     raeburn  1522: 
                   1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1524: 
                   1525: =cut
                   1526: 
                   1527: sub viewport_size_js {
                   1528:     my $geometry = &viewport_geometry_js();
                   1529:     return <<"DIMS";
                   1530: 
                   1531: $geometry
                   1532: 
                   1533: function getViewportDims(width,height) {
                   1534:     init_geometry();
                   1535:     width.value = Geometry.getViewportWidth();
                   1536:     height.value = Geometry.getViewportHeight();
                   1537:     return;
                   1538: }
                   1539: 
                   1540: DIMS
                   1541: }
                   1542: 
                   1543: =pod
                   1544: 
1.648     raeburn  1545: =item * &resize_textarea_js()
1.565     albertel 1546: 
                   1547: emits the needed javascript to resize a textarea to be as big as possible
                   1548: 
                   1549: creates a function resize_textrea that takes two IDs first should be
                   1550: the id of the element to resize, second should be the id of a div that
                   1551: surrounds everything that comes after the textarea, this routine needs
                   1552: to be attached to the <body> for the onload and onresize events.
                   1553: 
1.648     raeburn  1554: =back
1.565     albertel 1555: 
                   1556: =cut
                   1557: 
                   1558: sub resize_textarea_js {
1.590     raeburn  1559:     my $geometry = &viewport_geometry_js();
1.565     albertel 1560:     return <<"RESIZE";
                   1561:     <script type="text/javascript">
1.824     bisitz   1562: // <![CDATA[
1.590     raeburn  1563: $geometry
1.565     albertel 1564: 
1.588     albertel 1565: function getX(element) {
                   1566:     var x = 0;
                   1567:     while (element) {
                   1568: 	x += element.offsetLeft;
                   1569: 	element = element.offsetParent;
                   1570:     }
                   1571:     return x;
                   1572: }
                   1573: function getY(element) {
                   1574:     var y = 0;
                   1575:     while (element) {
                   1576: 	y += element.offsetTop;
                   1577: 	element = element.offsetParent;
                   1578:     }
                   1579:     return y;
                   1580: }
                   1581: 
                   1582: 
1.565     albertel 1583: function resize_textarea(textarea_id,bottom_id) {
                   1584:     init_geometry();
                   1585:     var textarea        = document.getElementById(textarea_id);
                   1586:     //alert(textarea);
                   1587: 
1.588     albertel 1588:     var textarea_top    = getY(textarea);
1.565     albertel 1589:     var textarea_height = textarea.offsetHeight;
                   1590:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1591:     var bottom_top      = getY(bottom);
1.565     albertel 1592:     var bottom_height   = bottom.offsetHeight;
                   1593:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1594:     var fudge           = 23;
1.565     albertel 1595:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1596:     if (new_height < 300) {
                   1597: 	new_height = 300;
                   1598:     }
                   1599:     textarea.style.height=new_height+'px';
                   1600: }
1.824     bisitz   1601: // ]]>
1.565     albertel 1602: </script>
                   1603: RESIZE
                   1604: 
                   1605: }
                   1606: 
                   1607: =pod
                   1608: 
1.256     matthew  1609: =head1 Excel and CSV file utility routines
                   1610: 
                   1611: =over 4
                   1612: 
                   1613: =cut
                   1614: 
                   1615: ###############################################################
                   1616: ###############################################################
                   1617: 
                   1618: =pod
                   1619: 
1.648     raeburn  1620: =item * &csv_translate($text) 
1.37      matthew  1621: 
1.185     www      1622: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1623: format.
                   1624: 
                   1625: =cut
                   1626: 
1.180     matthew  1627: ###############################################################
                   1628: ###############################################################
1.37      matthew  1629: sub csv_translate {
                   1630:     my $text = shift;
                   1631:     $text =~ s/\"/\"\"/g;
1.209     albertel 1632:     $text =~ s/\n/ /g;
1.37      matthew  1633:     return $text;
                   1634: }
1.180     matthew  1635: 
                   1636: ###############################################################
                   1637: ###############################################################
                   1638: 
                   1639: =pod
                   1640: 
1.648     raeburn  1641: =item * &define_excel_formats()
1.180     matthew  1642: 
                   1643: Define some commonly used Excel cell formats.
                   1644: 
                   1645: Currently supported formats:
                   1646: 
                   1647: =over 4
                   1648: 
                   1649: =item header
                   1650: 
                   1651: =item bold
                   1652: 
                   1653: =item h1
                   1654: 
                   1655: =item h2
                   1656: 
                   1657: =item h3
                   1658: 
1.256     matthew  1659: =item h4
                   1660: 
                   1661: =item i
                   1662: 
1.180     matthew  1663: =item date
                   1664: 
                   1665: =back
                   1666: 
                   1667: Inputs: $workbook
                   1668: 
                   1669: Returns: $format, a hash reference.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: sub define_excel_formats {
                   1676:     my ($workbook) = @_;
                   1677:     my $format;
                   1678:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1679:                                                 bottom    => 1,
                   1680:                                                 align     => 'center');
                   1681:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1682:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1683:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1684:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1685:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1686:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1687:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1688:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1689:     return $format;
                   1690: }
                   1691: 
                   1692: ###############################################################
                   1693: ###############################################################
1.113     bowersj2 1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &create_workbook()
1.255     matthew  1698: 
                   1699: Create an Excel worksheet.  If it fails, output message on the
                   1700: request object and return undefs.
                   1701: 
                   1702: Inputs: Apache request object
                   1703: 
                   1704: Returns (undef) on failure, 
                   1705:     Excel worksheet object, scalar with filename, and formats 
                   1706:     from &Apache::loncommon::define_excel_formats on success
                   1707: 
                   1708: =cut
                   1709: 
                   1710: ###############################################################
                   1711: ###############################################################
                   1712: sub create_workbook {
                   1713:     my ($r) = @_;
                   1714:         #
                   1715:     # Create the excel spreadsheet
                   1716:     my $filename = '/prtspool/'.
1.258     albertel 1717:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1718:         time.'_'.rand(1000000000).'.xls';
                   1719:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1720:     if (! defined($workbook)) {
                   1721:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1722:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1723:                             "This error has been logged.  ".
                   1724:                             "Please alert your LON-CAPA administrator").
                   1725:                   '</p>');
                   1726:         return (undef);
                   1727:     }
                   1728:     #
                   1729:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1730:     #
                   1731:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1732:     return ($workbook,$filename,$format);
                   1733: }
                   1734: 
                   1735: ###############################################################
                   1736: ###############################################################
                   1737: 
                   1738: =pod
                   1739: 
1.648     raeburn  1740: =item * &create_text_file()
1.113     bowersj2 1741: 
1.542     raeburn  1742: Create a file to write to and eventually make available to the user.
1.256     matthew  1743: If file creation fails, outputs an error message on the request object and 
                   1744: return undefs.
1.113     bowersj2 1745: 
1.256     matthew  1746: Inputs: Apache request object, and file suffix
1.113     bowersj2 1747: 
1.256     matthew  1748: Returns (undef) on failure, 
                   1749:     Filehandle and filename on success.
1.113     bowersj2 1750: 
                   1751: =cut
                   1752: 
1.256     matthew  1753: ###############################################################
                   1754: ###############################################################
                   1755: sub create_text_file {
                   1756:     my ($r,$suffix) = @_;
                   1757:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1758:     my $fh;
                   1759:     my $filename = '/prtspool/'.
1.258     albertel 1760:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1761:         time.'_'.rand(1000000000).'.'.$suffix;
                   1762:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1763:     if (! defined($fh)) {
                   1764:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1765:         $r->print(&mt('Problems occurred in creating the output file. '
                   1766:                      .'This error has been logged. '
                   1767:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1796: 	return &select_form($name,$value,%domains);
                   1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.648     raeburn  1858: =item * &select_form($defdom,$name,%hash)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
                   1861: allow a user to select options from a hash option_name => displayed text.  
                   1862: See lonrights.pm for an example invocation and use.
                   1863: 
                   1864: =cut
                   1865: 
                   1866: #-------------------------------------------
                   1867: sub select_form {
                   1868:     my ($def,$name,%hash) = @_;
                   1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1870:     my @keys;
                   1871:     if (exists($hash{'select_form_order'})) {
                   1872: 	@keys=@{$hash{'select_form_order'}};
                   1873:     } else {
                   1874: 	@keys=sort(keys(%hash));
                   1875:     }
1.356     albertel 1876:     foreach my $key (@keys) {
                   1877:         $selectform.=
                   1878: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1879:             ($key eq $def ? 'selected="selected" ' : '').
1.922     bisitz   1880:                 ">".$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 '') {
1.925.2.13  raeburn  1981:                 my $domdesc;
                   1982:                 if ($name eq 'srchdomain') {
                   1983:                     if ($dom eq 'gci') {
                   1984:                         $domdesc = 'Faculty';
                   1985:                     } else {
                   1986:                         $domdesc = 'Students';
                   1987:                     }
                   1988:                 } else {
                   1989:                     $domdesc = &Apache::lonnet::domain($dom,'description');
                   1990:                 }
1.563     raeburn  1991:                 if ($domdesc ne '') {
                   1992:                     $selectdomain .= ' ('.$domdesc.')';
                   1993:                 }
                   1994:             } 
                   1995:         }
                   1996:         $selectdomain .= "</option>\n";
1.34      matthew  1997:     }
                   1998:     $selectdomain.="</select>";
                   1999:     return $selectdomain;
                   2000: }
                   2001: 
1.35      matthew  2002: #-------------------------------------------
                   2003: 
1.45      matthew  2004: =pod
                   2005: 
1.648     raeburn  2006: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2007: 
1.586     raeburn  2008: input: 4 arguments (two required, two optional) - 
                   2009:     $domain - domain of new user
                   2010:     $name - name of form element
                   2011:     $default - Value of 'default' causes a default item to be first 
                   2012:                             option, and selected by default. 
                   2013:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2014:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2015: output: returns 2 items: 
1.586     raeburn  2016: (a) form element which contains either:
                   2017:    (i) <select name="$name">
                   2018:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2019:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2020:        </select>
                   2021:        form item if there are multiple library servers in $domain, or
                   2022:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2023:        if there is only one library server in $domain.
                   2024: 
                   2025: (b) number of library servers found.
                   2026: 
                   2027: See loncreateuser.pm for example of use.
1.35      matthew  2028: 
                   2029: =cut
                   2030: 
                   2031: #-------------------------------------------
1.586     raeburn  2032: sub home_server_form_item {
                   2033:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2034:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2035:     my $result;
                   2036:     my $numlib = keys(%servers);
                   2037:     if ($numlib > 1) {
                   2038:         $result .= '<select name="'.$name.'" />'."\n";
                   2039:         if ($default) {
1.804     bisitz   2040:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2041:                        '</option>'."\n";
                   2042:         }
                   2043:         foreach my $hostid (sort(keys(%servers))) {
                   2044:             $result.= '<option value="'.$hostid.'">'.
                   2045: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2046:         }
                   2047:         $result .= '</select>'."\n";
                   2048:     } elsif ($numlib == 1) {
                   2049:         my $hostid;
                   2050:         foreach my $item (keys(%servers)) {
                   2051:             $hostid = $item;
                   2052:         }
                   2053:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2054:                    $hostid.'" />';
                   2055:                    if (!$hide) {
                   2056:                        $result .= $hostid.' '.$servers{$hostid};
                   2057:                    }
                   2058:                    $result .= "\n";
                   2059:     } elsif ($default) {
                   2060:         $result .= '<input type="hidden" name="'.$name.
                   2061:                    '" value="default" />';
                   2062:                    if (!$hide) {
                   2063:                        $result .= &mt('default');
                   2064:                    }
                   2065:                    $result .= "\n";
1.33      matthew  2066:     }
1.586     raeburn  2067:     return ($result,$numlib);
1.33      matthew  2068: }
1.112     bowersj2 2069: 
                   2070: =pod
                   2071: 
1.534     albertel 2072: =back 
                   2073: 
1.112     bowersj2 2074: =cut
1.87      matthew  2075: 
                   2076: ###############################################################
1.112     bowersj2 2077: ##                  Decoding User Agent                      ##
1.87      matthew  2078: ###############################################################
                   2079: 
                   2080: =pod
                   2081: 
1.112     bowersj2 2082: =head1 Decoding the User Agent
                   2083: 
                   2084: =over 4
                   2085: 
                   2086: =item * &decode_user_agent()
1.87      matthew  2087: 
                   2088: Inputs: $r
                   2089: 
                   2090: Outputs:
                   2091: 
                   2092: =over 4
                   2093: 
1.112     bowersj2 2094: =item * $httpbrowser
1.87      matthew  2095: 
1.112     bowersj2 2096: =item * $clientbrowser
1.87      matthew  2097: 
1.112     bowersj2 2098: =item * $clientversion
1.87      matthew  2099: 
1.112     bowersj2 2100: =item * $clientmathml
1.87      matthew  2101: 
1.112     bowersj2 2102: =item * $clientunicode
1.87      matthew  2103: 
1.112     bowersj2 2104: =item * $clientos
1.87      matthew  2105: 
                   2106: =back
                   2107: 
1.157     matthew  2108: =back 
                   2109: 
1.87      matthew  2110: =cut
                   2111: 
                   2112: ###############################################################
                   2113: ###############################################################
                   2114: sub decode_user_agent {
1.247     albertel 2115:     my ($r)=@_;
1.87      matthew  2116:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2117:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2118:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2119:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2120:     my $clientbrowser='unknown';
                   2121:     my $clientversion='0';
                   2122:     my $clientmathml='';
                   2123:     my $clientunicode='0';
                   2124:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2125:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2126: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2127: 	    $clientbrowser=$bname;
                   2128:             $httpbrowser=~/$vreg/i;
                   2129: 	    $clientversion=$1;
                   2130:             $clientmathml=($clientversion>=$minv);
                   2131:             $clientunicode=($clientversion>=$univ);
                   2132: 	}
                   2133:     }
                   2134:     my $clientos='unknown';
                   2135:     if (($httpbrowser=~/linux/i) ||
                   2136:         ($httpbrowser=~/unix/i) ||
                   2137:         ($httpbrowser=~/ux/i) ||
                   2138:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2139:     if (($httpbrowser=~/vax/i) ||
                   2140:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2141:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2142:     if (($httpbrowser=~/mac/i) ||
                   2143:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2144:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2145:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2146:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2147:             $clientunicode,$clientos,);
                   2148: }
                   2149: 
1.32      matthew  2150: ###############################################################
                   2151: ##    Authentication changing form generation subroutines    ##
                   2152: ###############################################################
                   2153: ##
                   2154: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2155: ## hash, and have reasonable default values.
                   2156: ##
                   2157: ##    formname = the name given in the <form> tag.
1.35      matthew  2158: #-------------------------------------------
                   2159: 
1.45      matthew  2160: =pod
                   2161: 
1.112     bowersj2 2162: =head1 Authentication Routines
                   2163: 
                   2164: =over 4
                   2165: 
1.648     raeburn  2166: =item * &authform_xxxxxx()
1.35      matthew  2167: 
                   2168: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2169: handle some of the conveniences required for authentication forms.  
                   2170: This is not an optimal method, but it works.  
                   2171: 
                   2172: =over 4
                   2173: 
1.112     bowersj2 2174: =item * authform_header
1.35      matthew  2175: 
1.112     bowersj2 2176: =item * authform_authorwarning
1.35      matthew  2177: 
1.112     bowersj2 2178: =item * authform_nochange
1.35      matthew  2179: 
1.112     bowersj2 2180: =item * authform_kerberos
1.35      matthew  2181: 
1.112     bowersj2 2182: =item * authform_internal
1.35      matthew  2183: 
1.112     bowersj2 2184: =item * authform_filesystem
1.35      matthew  2185: 
                   2186: =back
                   2187: 
1.648     raeburn  2188: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2189: 
1.35      matthew  2190: =cut
                   2191: 
                   2192: #-------------------------------------------
1.32      matthew  2193: sub authform_header{  
                   2194:     my %in = (
                   2195:         formname => 'cu',
1.80      albertel 2196:         kerb_def_dom => '',
1.32      matthew  2197:         @_,
                   2198:     );
                   2199:     $in{'formname'} = 'document.' . $in{'formname'};
                   2200:     my $result='';
1.80      albertel 2201: 
                   2202: #---------------------------------------------- Code for upper case translation
                   2203:     my $Javascript_toUpperCase;
                   2204:     unless ($in{kerb_def_dom}) {
                   2205:         $Javascript_toUpperCase =<<"END";
                   2206:         switch (choice) {
                   2207:            case 'krb': currentform.elements[choicearg].value =
                   2208:                currentform.elements[choicearg].value.toUpperCase();
                   2209:                break;
                   2210:            default:
                   2211:         }
                   2212: END
                   2213:     } else {
                   2214:         $Javascript_toUpperCase = "";
                   2215:     }
                   2216: 
1.165     raeburn  2217:     my $radioval = "'nochange'";
1.591     raeburn  2218:     if (defined($in{'curr_authtype'})) {
                   2219:         if ($in{'curr_authtype'} ne '') {
                   2220:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2221:         }
1.174     matthew  2222:     }
1.165     raeburn  2223:     my $argfield = 'null';
1.591     raeburn  2224:     if (defined($in{'mode'})) {
1.165     raeburn  2225:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2226:             if (defined($in{'curr_autharg'})) {
                   2227:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2228:                     $argfield = "'$in{'curr_autharg'}'";
                   2229:                 }
                   2230:             }
                   2231:         }
                   2232:     }
                   2233: 
1.32      matthew  2234:     $result.=<<"END";
                   2235: var current = new Object();
1.165     raeburn  2236: current.radiovalue = $radioval;
                   2237: current.argfield = $argfield;
1.32      matthew  2238: 
                   2239: function changed_radio(choice,currentform) {
                   2240:     var choicearg = choice + 'arg';
                   2241:     // If a radio button in changed, we need to change the argfield
                   2242:     if (current.radiovalue != choice) {
                   2243:         current.radiovalue = choice;
                   2244:         if (current.argfield != null) {
                   2245:             currentform.elements[current.argfield].value = '';
                   2246:         }
                   2247:         if (choice == 'nochange') {
                   2248:             current.argfield = null;
                   2249:         } else {
                   2250:             current.argfield = choicearg;
                   2251:             switch(choice) {
                   2252:                 case 'krb': 
                   2253:                     currentform.elements[current.argfield].value = 
                   2254:                         "$in{'kerb_def_dom'}";
                   2255:                 break;
                   2256:               default:
                   2257:                 break;
                   2258:             }
                   2259:         }
                   2260:     }
                   2261:     return;
                   2262: }
1.22      www      2263: 
1.32      matthew  2264: function changed_text(choice,currentform) {
                   2265:     var choicearg = choice + 'arg';
                   2266:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2267:         $Javascript_toUpperCase
1.32      matthew  2268:         // clear old field
                   2269:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2270:             currentform.elements[current.argfield].value = '';
                   2271:         }
                   2272:         current.argfield = choicearg;
                   2273:     }
                   2274:     set_auth_radio_buttons(choice,currentform);
                   2275:     return;
1.20      www      2276: }
1.32      matthew  2277: 
                   2278: function set_auth_radio_buttons(newvalue,currentform) {
                   2279:     var i=0;
                   2280:     while (i < currentform.login.length) {
                   2281:         if (currentform.login[i].value == newvalue) { break; }
                   2282:         i++;
                   2283:     }
                   2284:     if (i == currentform.login.length) {
                   2285:         return;
                   2286:     }
                   2287:     current.radiovalue = newvalue;
                   2288:     currentform.login[i].checked = true;
                   2289:     return;
                   2290: }
                   2291: END
                   2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_authorwarning{
                   2296:     my $result='';
1.144     matthew  2297:     $result='<i>'.
                   2298:         &mt('As a general rule, only authors or co-authors should be '.
                   2299:             'filesystem authenticated '.
                   2300:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2301:     return $result;
                   2302: }
                   2303: 
                   2304: sub authform_nochange{  
                   2305:     my %in = (
                   2306:               formname => 'document.cu',
                   2307:               kerb_def_dom => 'MSU.EDU',
                   2308:               @_,
                   2309:           );
1.586     raeburn  2310:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2311:     my $result;
                   2312:     if (keys(%can_assign) == 0) {
                   2313:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2314:     } else {
                   2315:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2316:                   '<input type="radio" name="login" value="nochange" '.
                   2317:                   'checked="checked" onclick="'.
1.281     albertel 2318:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2319: 	    '</label>';
1.586     raeburn  2320:     }
1.32      matthew  2321:     return $result;
                   2322: }
                   2323: 
1.591     raeburn  2324: sub authform_kerberos {
1.32      matthew  2325:     my %in = (
                   2326:               formname => 'document.cu',
                   2327:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2328:               kerb_def_auth => 'krb4',
1.32      matthew  2329:               @_,
                   2330:               );
1.586     raeburn  2331:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2332:         $autharg,$jscall);
                   2333:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2334:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2335:        $check5 = ' checked="checked"';
1.80      albertel 2336:     } else {
1.772     bisitz   2337:        $check4 = ' checked="checked"';
1.80      albertel 2338:     }
1.165     raeburn  2339:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2340:     if (defined($in{'curr_authtype'})) {
                   2341:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2342:             $krbcheck = ' checked="checked"';
1.623     raeburn  2343:             if (defined($in{'mode'})) {
                   2344:                 if ($in{'mode'} eq 'modifyuser') {
                   2345:                     $krbcheck = '';
                   2346:                 }
                   2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_kerb_ver'})) {
                   2349:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2350:                     $check5 = ' checked="checked"';
1.591     raeburn  2351:                     $check4 = '';
                   2352:                 } else {
1.772     bisitz   2353:                     $check4 = ' checked="checked"';
1.591     raeburn  2354:                     $check5 = '';
                   2355:                 }
1.586     raeburn  2356:             }
1.591     raeburn  2357:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2358:                 $krbarg = $in{'curr_autharg'};
                   2359:             }
1.586     raeburn  2360:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2361:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2362:                     $result = 
                   2363:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2364:         $in{'curr_autharg'},$krbver);
                   2365:                 } else {
                   2366:                     $result =
                   2367:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2368:                 }
                   2369:                 return $result; 
                   2370:             }
                   2371:         }
                   2372:     } else {
                   2373:         if ($authnum == 1) {
1.784     bisitz   2374:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2375:         }
                   2376:     }
1.586     raeburn  2377:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2378:         return;
1.587     raeburn  2379:     } elsif ($authtype eq '') {
1.591     raeburn  2380:         if (defined($in{'mode'})) {
1.587     raeburn  2381:             if ($in{'mode'} eq 'modifycourse') {
                   2382:                 if ($authnum == 1) {
1.784     bisitz   2383:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2384:                 }
                   2385:             }
                   2386:         }
1.586     raeburn  2387:     }
                   2388:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2389:     if ($authtype eq '') {
                   2390:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2391:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2392:                     $krbcheck.' />';
                   2393:     }
                   2394:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2395:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2396:          $in{'curr_authtype'} eq 'krb5') ||
                   2397:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2398:          $in{'curr_authtype'} eq 'krb4')) {
                   2399:         $result .= &mt
1.144     matthew  2400:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2401:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2402:          '<label>'.$authtype,
1.281     albertel 2403:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2404:              'value="'.$krbarg.'" '.
1.144     matthew  2405:              'onchange="'.$jscall.'" />',
1.281     albertel 2406:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2407:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2408: 	 '</label>');
1.586     raeburn  2409:     } elsif ($can_assign{'krb4'}) {
                   2410:         $result .= &mt
                   2411:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2412:          '[_3] Version 4 [_4]',
                   2413:          '<label>'.$authtype,
                   2414:          '</label><input type="text" size="10" name="krbarg" '.
                   2415:              'value="'.$krbarg.'" '.
                   2416:              'onchange="'.$jscall.'" />',
                   2417:          '<label><input type="hidden" name="krbver" value="4" />',
                   2418:          '</label>');
                   2419:     } elsif ($can_assign{'krb5'}) {
                   2420:         $result .= &mt
                   2421:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2422:          '[_3] Version 5 [_4]',
                   2423:          '<label>'.$authtype,
                   2424:          '</label><input type="text" size="10" name="krbarg" '.
                   2425:              'value="'.$krbarg.'" '.
                   2426:              'onchange="'.$jscall.'" />',
                   2427:          '<label><input type="hidden" name="krbver" value="5" />',
                   2428:          '</label>');
                   2429:     }
1.32      matthew  2430:     return $result;
                   2431: }
                   2432: 
                   2433: sub authform_internal{  
1.586     raeburn  2434:     my %in = (
1.32      matthew  2435:                 formname => 'document.cu',
                   2436:                 kerb_def_dom => 'MSU.EDU',
                   2437:                 @_,
                   2438:                 );
1.586     raeburn  2439:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2440:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2441:     if (defined($in{'curr_authtype'})) {
                   2442:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2443:             if ($can_assign{'int'}) {
1.772     bisitz   2444:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2445:                 if (defined($in{'mode'})) {
                   2446:                     if ($in{'mode'} eq 'modifyuser') {
                   2447:                         $intcheck = '';
                   2448:                     }
                   2449:                 }
1.591     raeburn  2450:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2451:                     $intarg = $in{'curr_autharg'};
                   2452:                 }
                   2453:             } else {
                   2454:                 $result = &mt('Currently internally authenticated.');
                   2455:                 return $result;
1.165     raeburn  2456:             }
                   2457:         }
1.586     raeburn  2458:     } else {
                   2459:         if ($authnum == 1) {
1.784     bisitz   2460:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2461:         }
                   2462:     }
                   2463:     if (!$can_assign{'int'}) {
                   2464:         return;
1.587     raeburn  2465:     } elsif ($authtype eq '') {
1.591     raeburn  2466:         if (defined($in{'mode'})) {
1.587     raeburn  2467:             if ($in{'mode'} eq 'modifycourse') {
                   2468:                 if ($authnum == 1) {
1.784     bisitz   2469:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2470:                 }
                   2471:             }
                   2472:         }
1.165     raeburn  2473:     }
1.586     raeburn  2474:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2475:     if ($authtype eq '') {
                   2476:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2477:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2478:     }
1.605     bisitz   2479:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2480:                $intarg.'" onchange="'.$jscall.'" />';
1.925.2.13  raeburn  2481:     my $authtext = '[_1] Internally authenticated (with initial password [_2])';
                   2482:     if ($in{'caller'} eq 'requestcrs') {
                   2483:         $authtext = "[_1] Students' password, if none in the uploaded file: [_2]";
                   2484:     }
                   2485:     $result = &mt($authtext,'<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2486:     $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  2487:     return $result;
                   2488: }
                   2489: 
                   2490: sub authform_local{  
                   2491:     my %in = (
                   2492:               formname => 'document.cu',
                   2493:               kerb_def_dom => 'MSU.EDU',
                   2494:               @_,
                   2495:               );
1.586     raeburn  2496:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2497:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2498:     if (defined($in{'curr_authtype'})) {
                   2499:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2500:             if ($can_assign{'loc'}) {
1.772     bisitz   2501:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2502:                 if (defined($in{'mode'})) {
                   2503:                     if ($in{'mode'} eq 'modifyuser') {
                   2504:                         $loccheck = '';
                   2505:                     }
                   2506:                 }
1.591     raeburn  2507:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2508:                     $locarg = $in{'curr_autharg'};
                   2509:                 }
                   2510:             } else {
                   2511:                 $result = &mt('Currently using local (institutional) authentication.');
                   2512:                 return $result;
1.165     raeburn  2513:             }
                   2514:         }
1.586     raeburn  2515:     } else {
                   2516:         if ($authnum == 1) {
1.784     bisitz   2517:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2518:         }
                   2519:     }
                   2520:     if (!$can_assign{'loc'}) {
                   2521:         return;
1.587     raeburn  2522:     } elsif ($authtype eq '') {
1.591     raeburn  2523:         if (defined($in{'mode'})) {
1.587     raeburn  2524:             if ($in{'mode'} eq 'modifycourse') {
                   2525:                 if ($authnum == 1) {
1.784     bisitz   2526:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2527:                 }
                   2528:             }
                   2529:         }
1.165     raeburn  2530:     }
1.586     raeburn  2531:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2532:     if ($authtype eq '') {
                   2533:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2534:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2535:                     $jscall.'" />';
                   2536:     }
                   2537:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2538:                $locarg.'" onchange="'.$jscall.'" />';
                   2539:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2540:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2541:     return $result;
                   2542: }
                   2543: 
                   2544: sub authform_filesystem{  
                   2545:     my %in = (
                   2546:               formname => 'document.cu',
                   2547:               kerb_def_dom => 'MSU.EDU',
                   2548:               @_,
                   2549:               );
1.586     raeburn  2550:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2551:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2552:     if (defined($in{'curr_authtype'})) {
                   2553:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2554:             if ($can_assign{'fsys'}) {
1.772     bisitz   2555:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2556:                 if (defined($in{'mode'})) {
                   2557:                     if ($in{'mode'} eq 'modifyuser') {
                   2558:                         $fsyscheck = '';
                   2559:                     }
                   2560:                 }
1.586     raeburn  2561:             } else {
                   2562:                 $result = &mt('Currently Filesystem Authenticated.');
                   2563:                 return $result;
                   2564:             }           
                   2565:         }
                   2566:     } else {
                   2567:         if ($authnum == 1) {
1.784     bisitz   2568:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2569:         }
                   2570:     }
                   2571:     if (!$can_assign{'fsys'}) {
                   2572:         return;
1.587     raeburn  2573:     } elsif ($authtype eq '') {
1.591     raeburn  2574:         if (defined($in{'mode'})) {
1.587     raeburn  2575:             if ($in{'mode'} eq 'modifycourse') {
                   2576:                 if ($authnum == 1) {
1.784     bisitz   2577:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2578:                 }
                   2579:             }
                   2580:         }
1.586     raeburn  2581:     }
                   2582:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2583:     if ($authtype eq '') {
                   2584:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2585:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2586:                     $jscall.'" />';
                   2587:     }
                   2588:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2589:                ' onchange="'.$jscall.'" />';
                   2590:     $result = &mt
1.144     matthew  2591:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2592:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2593:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2594:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2595:                   'onchange="'.$jscall.'" />');
1.32      matthew  2596:     return $result;
                   2597: }
                   2598: 
1.586     raeburn  2599: sub get_assignable_auth {
                   2600:     my ($dom) = @_;
                   2601:     if ($dom eq '') {
                   2602:         $dom = $env{'request.role.domain'};
                   2603:     }
                   2604:     my %can_assign = (
                   2605:                           krb4 => 1,
                   2606:                           krb5 => 1,
                   2607:                           int  => 1,
                   2608:                           loc  => 1,
                   2609:                      );
                   2610:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2611:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2612:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2613:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2614:             my $context;
                   2615:             if ($env{'request.role'} =~ /^au/) {
                   2616:                 $context = 'author';
                   2617:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2618:                 $context = 'domain';
                   2619:             } elsif ($env{'request.course.id'}) {
                   2620:                 $context = 'course';
                   2621:             }
                   2622:             if ($context) {
                   2623:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2624:                    %can_assign = %{$authhash->{$context}}; 
                   2625:                 }
                   2626:             }
                   2627:         }
                   2628:     }
                   2629:     my $authnum = 0;
                   2630:     foreach my $key (keys(%can_assign)) {
                   2631:         if ($can_assign{$key}) {
                   2632:             $authnum ++;
                   2633:         }
                   2634:     }
                   2635:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2636:         $authnum --;
                   2637:     }
                   2638:     return ($authnum,%can_assign);
                   2639: }
                   2640: 
1.80      albertel 2641: ###############################################################
                   2642: ##    Get Kerberos Defaults for Domain                 ##
                   2643: ###############################################################
                   2644: ##
                   2645: ## Returns default kerberos version and an associated argument
                   2646: ## as listed in file domain.tab. If not listed, provides
                   2647: ## appropriate default domain and kerberos version.
                   2648: ##
                   2649: #-------------------------------------------
                   2650: 
                   2651: =pod
                   2652: 
1.648     raeburn  2653: =item * &get_kerberos_defaults()
1.80      albertel 2654: 
                   2655: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2656: version and domain. If not found, it defaults to version 4 and the 
                   2657: domain of the server.
1.80      albertel 2658: 
1.648     raeburn  2659: =over 4
                   2660: 
1.80      albertel 2661: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2662: 
1.648     raeburn  2663: =back
                   2664: 
                   2665: =back
                   2666: 
1.80      albertel 2667: =cut
                   2668: 
                   2669: #-------------------------------------------
                   2670: sub get_kerberos_defaults {
                   2671:     my $domain=shift;
1.641     raeburn  2672:     my ($krbdef,$krbdefdom);
                   2673:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2674:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2675:         $krbdef = $domdefaults{'auth_def'};
                   2676:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2677:     } else {
1.80      albertel 2678:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2679:         my $krbdefdom=$1;
                   2680:         $krbdefdom=~tr/a-z/A-Z/;
                   2681:         $krbdef = "krb4";
                   2682:     }
                   2683:     return ($krbdef,$krbdefdom);
                   2684: }
1.112     bowersj2 2685: 
1.32      matthew  2686: 
1.46      matthew  2687: ###############################################################
                   2688: ##                Thesaurus Functions                        ##
                   2689: ###############################################################
1.20      www      2690: 
1.46      matthew  2691: =pod
1.20      www      2692: 
1.112     bowersj2 2693: =head1 Thesaurus Functions
                   2694: 
                   2695: =over 4
                   2696: 
1.648     raeburn  2697: =item * &initialize_keywords()
1.46      matthew  2698: 
                   2699: Initializes the package variable %Keywords if it is empty.  Uses the
                   2700: package variable $thesaurus_db_file.
                   2701: 
                   2702: =cut
                   2703: 
                   2704: ###################################################
                   2705: 
                   2706: sub initialize_keywords {
                   2707:     return 1 if (scalar keys(%Keywords));
                   2708:     # If we are here, %Keywords is empty, so fill it up
                   2709:     #   Make sure the file we need exists...
                   2710:     if (! -e $thesaurus_db_file) {
                   2711:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2712:                                  " failed because it does not exist");
                   2713:         return 0;
                   2714:     }
                   2715:     #   Set up the hash as a database
                   2716:     my %thesaurus_db;
                   2717:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2718:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2719:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2720:                                  $thesaurus_db_file);
                   2721:         return 0;
                   2722:     } 
                   2723:     #  Get the average number of appearances of a word.
                   2724:     my $avecount = $thesaurus_db{'average.count'};
                   2725:     #  Put keywords (those that appear > average) into %Keywords
                   2726:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2727:         my ($count,undef) = split /:/,$data;
                   2728:         $Keywords{$word}++ if ($count > $avecount);
                   2729:     }
                   2730:     untie %thesaurus_db;
                   2731:     # Remove special values from %Keywords.
1.356     albertel 2732:     foreach my $value ('total.count','average.count') {
                   2733:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2734:   }
1.46      matthew  2735:     return 1;
                   2736: }
                   2737: 
                   2738: ###################################################
                   2739: 
                   2740: =pod
                   2741: 
1.648     raeburn  2742: =item * &keyword($word)
1.46      matthew  2743: 
                   2744: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2745: than the average number of times in the thesaurus database.  Calls 
                   2746: &initialize_keywords
                   2747: 
                   2748: =cut
                   2749: 
                   2750: ###################################################
1.20      www      2751: 
                   2752: sub keyword {
1.46      matthew  2753:     return if (!&initialize_keywords());
                   2754:     my $word=lc(shift());
                   2755:     $word=~s/\W//g;
                   2756:     return exists($Keywords{$word});
1.20      www      2757: }
1.46      matthew  2758: 
                   2759: ###############################################################
                   2760: 
                   2761: =pod 
1.20      www      2762: 
1.648     raeburn  2763: =item * &get_related_words()
1.46      matthew  2764: 
1.160     matthew  2765: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2766: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2767: will be returned.  The order of the words returned is determined by the
                   2768: database which holds them.
                   2769: 
                   2770: Uses global $thesaurus_db_file.
                   2771: 
                   2772: =cut
                   2773: 
                   2774: ###############################################################
                   2775: sub get_related_words {
                   2776:     my $keyword = shift;
                   2777:     my %thesaurus_db;
                   2778:     if (! -e $thesaurus_db_file) {
                   2779:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2780:                                  "failed because the file does not exist");
                   2781:         return ();
                   2782:     }
                   2783:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2784:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2785:         return ();
                   2786:     } 
                   2787:     my @Words=();
1.429     www      2788:     my $count=0;
1.46      matthew  2789:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2790: 	# The first element is the number of times
                   2791: 	# the word appears.  We do not need it now.
1.429     www      2792: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2793: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2794: 	my $threshold=$mostfrequentcount/10;
                   2795:         foreach my $possibleword (@RelatedWords) {
                   2796:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2797:             if ($wordcount>$threshold) {
                   2798: 		push(@Words,$word);
                   2799:                 $count++;
                   2800:                 if ($count>10) { last; }
                   2801: 	    }
1.20      www      2802:         }
                   2803:     }
1.46      matthew  2804:     untie %thesaurus_db;
                   2805:     return @Words;
1.14      harris41 2806: }
1.46      matthew  2807: 
1.112     bowersj2 2808: =pod
                   2809: 
                   2810: =back
                   2811: 
                   2812: =cut
1.61      www      2813: 
                   2814: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2815: =pod
                   2816: 
1.112     bowersj2 2817: =head1 User Name Functions
                   2818: 
                   2819: =over 4
                   2820: 
1.648     raeburn  2821: =item * &plainname($uname,$udom,$first)
1.81      albertel 2822: 
1.112     bowersj2 2823: Takes a users logon name and returns it as a string in
1.226     albertel 2824: "first middle last generation" form 
                   2825: if $first is set to 'lastname' then it returns it as
                   2826: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2827: 
                   2828: =cut
1.61      www      2829: 
1.295     www      2830: 
1.81      albertel 2831: ###############################################################
1.61      www      2832: sub plainname {
1.226     albertel 2833:     my ($uname,$udom,$first)=@_;
1.537     albertel 2834:     return if (!defined($uname) || !defined($udom));
1.295     www      2835:     my %names=&getnames($uname,$udom);
1.226     albertel 2836:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2837: 					  $names{'middlename'},
                   2838: 					  $names{'lastname'},
                   2839: 					  $names{'generation'},$first);
                   2840:     $name=~s/^\s+//;
1.62      www      2841:     $name=~s/\s+$//;
                   2842:     $name=~s/\s+/ /g;
1.353     albertel 2843:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2844:     return $name;
1.61      www      2845: }
1.66      www      2846: 
                   2847: # -------------------------------------------------------------------- Nickname
1.81      albertel 2848: =pod
                   2849: 
1.648     raeburn  2850: =item * &nickname($uname,$udom)
1.81      albertel 2851: 
                   2852: Gets a users name and returns it as a string as
                   2853: 
                   2854: "&quot;nickname&quot;"
1.66      www      2855: 
1.81      albertel 2856: if the user has a nickname or
                   2857: 
                   2858: "first middle last generation"
                   2859: 
                   2860: if the user does not
                   2861: 
                   2862: =cut
1.66      www      2863: 
                   2864: sub nickname {
                   2865:     my ($uname,$udom)=@_;
1.537     albertel 2866:     return if (!defined($uname) || !defined($udom));
1.295     www      2867:     my %names=&getnames($uname,$udom);
1.68      albertel 2868:     my $name=$names{'nickname'};
1.66      www      2869:     if ($name) {
                   2870:        $name='&quot;'.$name.'&quot;'; 
                   2871:     } else {
                   2872:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2873: 	     $names{'lastname'}.' '.$names{'generation'};
                   2874:        $name=~s/\s+$//;
                   2875:        $name=~s/\s+/ /g;
                   2876:     }
                   2877:     return $name;
                   2878: }
                   2879: 
1.295     www      2880: sub getnames {
                   2881:     my ($uname,$udom)=@_;
1.537     albertel 2882:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2883:     if ($udom eq 'public' && $uname eq 'public') {
                   2884: 	return ('lastname' => &mt('Public'));
                   2885:     }
1.295     www      2886:     my $id=$uname.':'.$udom;
                   2887:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2888:     if ($cached) {
                   2889: 	return %{$names};
                   2890:     } else {
                   2891: 	my %loadnames=&Apache::lonnet::get('environment',
                   2892:                     ['firstname','middlename','lastname','generation','nickname'],
                   2893: 					 $udom,$uname);
                   2894: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2895: 	return %loadnames;
                   2896:     }
                   2897: }
1.61      www      2898: 
1.542     raeburn  2899: # -------------------------------------------------------------------- getemails
1.648     raeburn  2900: 
1.542     raeburn  2901: =pod
                   2902: 
1.648     raeburn  2903: =item * &getemails($uname,$udom)
1.542     raeburn  2904: 
                   2905: Gets a user's email information and returns it as a hash with keys:
                   2906: notification, critnotification, permanentemail
                   2907: 
                   2908: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2909: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2910:  
1.648     raeburn  2911: 
1.542     raeburn  2912: =cut
                   2913: 
1.648     raeburn  2914: 
1.466     albertel 2915: sub getemails {
                   2916:     my ($uname,$udom)=@_;
                   2917:     if ($udom eq 'public' && $uname eq 'public') {
                   2918: 	return;
                   2919:     }
1.467     www      2920:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2921:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2922:     my $id=$uname.':'.$udom;
                   2923:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2924:     if ($cached) {
                   2925: 	return %{$names};
                   2926:     } else {
                   2927: 	my %loadnames=&Apache::lonnet::get('environment',
                   2928:                     			   ['notification','critnotification',
                   2929: 					    'permanentemail'],
                   2930: 					   $udom,$uname);
                   2931: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2932: 	return %loadnames;
                   2933:     }
                   2934: }
                   2935: 
1.551     albertel 2936: sub flush_email_cache {
                   2937:     my ($uname,$udom)=@_;
                   2938:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2939:     if (!$uname) { $uname=$env{'user.name'};   }
                   2940:     return if ($udom eq 'public' && $uname eq 'public');
                   2941:     my $id=$uname.':'.$udom;
                   2942:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2943: }
                   2944: 
1.728     raeburn  2945: # -------------------------------------------------------------------- getlangs
                   2946: 
                   2947: =pod
                   2948: 
                   2949: =item * &getlangs($uname,$udom)
                   2950: 
                   2951: Gets a user's language preference and returns it as a hash with key:
                   2952: language.
                   2953: 
                   2954: =cut
                   2955: 
                   2956: 
                   2957: sub getlangs {
                   2958:     my ($uname,$udom) = @_;
                   2959:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2960:     if (!$uname) { $uname=$env{'user.name'};   }
                   2961:     my $id=$uname.':'.$udom;
                   2962:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2963:     if ($cached) {
                   2964:         return %{$langs};
                   2965:     } else {
                   2966:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2967:                                            $udom,$uname);
                   2968:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2969:         return %loadlangs;
                   2970:     }
                   2971: }
                   2972: 
                   2973: sub flush_langs_cache {
                   2974:     my ($uname,$udom)=@_;
                   2975:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2976:     if (!$uname) { $uname=$env{'user.name'};   }
                   2977:     return if ($udom eq 'public' && $uname eq 'public');
                   2978:     my $id=$uname.':'.$udom;
                   2979:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2980: }
                   2981: 
1.61      www      2982: # ------------------------------------------------------------------ Screenname
1.81      albertel 2983: 
                   2984: =pod
                   2985: 
1.648     raeburn  2986: =item * &screenname($uname,$udom)
1.81      albertel 2987: 
                   2988: Gets a users screenname and returns it as a string
                   2989: 
                   2990: =cut
1.61      www      2991: 
                   2992: sub screenname {
                   2993:     my ($uname,$udom)=@_;
1.258     albertel 2994:     if ($uname eq $env{'user.name'} &&
                   2995: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2996:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2997:     return $names{'screenname'};
1.62      www      2998: }
                   2999: 
1.212     albertel 3000: 
1.802     bisitz   3001: # ------------------------------------------------------------- Confirm Wrapper
                   3002: =pod
                   3003: 
                   3004: =item confirmwrapper
                   3005: 
                   3006: Wrap messages about completion of operation in box
                   3007: 
                   3008: =cut
                   3009: 
                   3010: sub confirmwrapper {
                   3011:     my ($message)=@_;
                   3012:     if ($message) {
                   3013:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3014:                .$message."\n"
                   3015:                .'</div>'."\n";
                   3016:     } else {
                   3017:         return $message;
                   3018:     }
                   3019: }
                   3020: 
1.62      www      3021: # ------------------------------------------------------------- Message Wrapper
                   3022: 
                   3023: sub messagewrapper {
1.369     www      3024:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3025:     return 
1.441     albertel 3026:         '<a href="/adm/email?compose=individual&amp;'.
                   3027:         'recname='.$username.'&amp;recdom='.$domain.
                   3028: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3029:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3030: }
1.802     bisitz   3031: 
1.74      www      3032: # --------------------------------------------------------------- Notes Wrapper
                   3033: 
                   3034: sub noteswrapper {
                   3035:     my ($link,$un,$do)=@_;
                   3036:     return 
1.896     amueller 3037: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3038: }
1.802     bisitz   3039: 
1.62      www      3040: # ------------------------------------------------------------- Aboutme Wrapper
                   3041: 
                   3042: sub aboutmewrapper {
1.166     www      3043:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3044:     if (!defined($username)  && !defined($domain)) {
                   3045:         return;
                   3046:     }
1.892     amueller 3047:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3048: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3049: }
                   3050: 
                   3051: # ------------------------------------------------------------ Syllabus Wrapper
                   3052: 
                   3053: sub syllabuswrapper {
1.707     bisitz   3054:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3055:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3056: }
1.14      harris41 3057: 
1.802     bisitz   3058: # -----------------------------------------------------------------------------
                   3059: 
1.208     matthew  3060: sub track_student_link {
1.887     raeburn  3061:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3062:     my $link ="/adm/trackstudent?";
1.208     matthew  3063:     my $title = 'View recent activity';
                   3064:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3065:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3066:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3067:         $title .= ' of this student';
1.268     albertel 3068:     } 
1.208     matthew  3069:     if (defined($target) && $target !~ /^\s*$/) {
                   3070:         $target = qq{target="$target"};
                   3071:     } else {
                   3072:         $target = '';
                   3073:     }
1.268     albertel 3074:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3075:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3076:     $title = &mt($title);
                   3077:     $linktext = &mt($linktext);
1.448     albertel 3078:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3079: 	&help_open_topic('View_recent_activity');
1.208     matthew  3080: }
                   3081: 
1.781     raeburn  3082: sub slot_reservations_link {
                   3083:     my ($linktext,$sname,$sdom,$target) = @_;
                   3084:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3085:     my $title = 'View slot reservation history';
                   3086:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3087:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3088:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3089:         $title .= ' of this student';
                   3090:     }
                   3091:     if (defined($target) && $target !~ /^\s*$/) {
                   3092:         $target = qq{target="$target"};
                   3093:     } else {
                   3094:         $target = '';
                   3095:     }
                   3096:     $title = &mt($title);
                   3097:     $linktext = &mt($linktext);
                   3098:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3099: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3100: 
                   3101: }
                   3102: 
1.508     www      3103: # ===================================================== Display a student photo
                   3104: 
                   3105: 
1.509     albertel 3106: sub student_image_tag {
1.508     www      3107:     my ($domain,$user)=@_;
                   3108:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3109:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3110: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3111:     } else {
                   3112: 	return '';
                   3113:     }
                   3114: }
                   3115: 
1.112     bowersj2 3116: =pod
                   3117: 
                   3118: =back
                   3119: 
                   3120: =head1 Access .tab File Data
                   3121: 
                   3122: =over 4
                   3123: 
1.648     raeburn  3124: =item * &languageids() 
1.112     bowersj2 3125: 
                   3126: returns list of all language ids
                   3127: 
                   3128: =cut
                   3129: 
1.14      harris41 3130: sub languageids {
1.16      harris41 3131:     return sort(keys(%language));
1.14      harris41 3132: }
                   3133: 
1.112     bowersj2 3134: =pod
                   3135: 
1.648     raeburn  3136: =item * &languagedescription() 
1.112     bowersj2 3137: 
                   3138: returns description of a specified language id
                   3139: 
                   3140: =cut
                   3141: 
1.14      harris41 3142: sub languagedescription {
1.125     www      3143:     my $code=shift;
                   3144:     return  ($supported_language{$code}?'* ':'').
                   3145:             $language{$code}.
1.126     www      3146: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3147: }
                   3148: 
                   3149: sub plainlanguagedescription {
                   3150:     my $code=shift;
                   3151:     return $language{$code};
                   3152: }
                   3153: 
                   3154: sub supportedlanguagecode {
                   3155:     my $code=shift;
                   3156:     return $supported_language{$code};
1.97      www      3157: }
                   3158: 
1.112     bowersj2 3159: =pod
                   3160: 
1.648     raeburn  3161: =item * &copyrightids() 
1.112     bowersj2 3162: 
                   3163: returns list of all copyrights
                   3164: 
                   3165: =cut
                   3166: 
                   3167: sub copyrightids {
                   3168:     return sort(keys(%cprtag));
                   3169: }
                   3170: 
                   3171: =pod
                   3172: 
1.648     raeburn  3173: =item * &copyrightdescription() 
1.112     bowersj2 3174: 
                   3175: returns description of a specified copyright id
                   3176: 
                   3177: =cut
                   3178: 
                   3179: sub copyrightdescription {
1.166     www      3180:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3181: }
1.197     matthew  3182: 
                   3183: =pod
                   3184: 
1.648     raeburn  3185: =item * &source_copyrightids() 
1.192     taceyjo1 3186: 
                   3187: returns list of all source copyrights
                   3188: 
                   3189: =cut
                   3190: 
                   3191: sub source_copyrightids {
                   3192:     return sort(keys(%scprtag));
                   3193: }
                   3194: 
                   3195: =pod
                   3196: 
1.648     raeburn  3197: =item * &source_copyrightdescription() 
1.192     taceyjo1 3198: 
                   3199: returns description of a specified source copyright id
                   3200: 
                   3201: =cut
                   3202: 
                   3203: sub source_copyrightdescription {
                   3204:     return &mt($scprtag{shift(@_)});
                   3205: }
1.112     bowersj2 3206: 
                   3207: =pod
                   3208: 
1.648     raeburn  3209: =item * &filecategories() 
1.112     bowersj2 3210: 
                   3211: returns list of all file categories
                   3212: 
                   3213: =cut
                   3214: 
                   3215: sub filecategories {
                   3216:     return sort(keys(%category_extensions));
                   3217: }
                   3218: 
                   3219: =pod
                   3220: 
1.648     raeburn  3221: =item * &filecategorytypes() 
1.112     bowersj2 3222: 
                   3223: returns list of file types belonging to a given file
                   3224: category
                   3225: 
                   3226: =cut
                   3227: 
                   3228: sub filecategorytypes {
1.356     albertel 3229:     my ($cat) = @_;
                   3230:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3231: }
                   3232: 
                   3233: =pod
                   3234: 
1.648     raeburn  3235: =item * &fileembstyle() 
1.112     bowersj2 3236: 
                   3237: returns embedding style for a specified file type
                   3238: 
                   3239: =cut
                   3240: 
                   3241: sub fileembstyle {
                   3242:     return $fe{lc(shift(@_))};
1.169     www      3243: }
                   3244: 
1.351     www      3245: sub filemimetype {
                   3246:     return $fm{lc(shift(@_))};
                   3247: }
                   3248: 
1.169     www      3249: 
                   3250: sub filecategoryselect {
                   3251:     my ($name,$value)=@_;
1.189     matthew  3252:     return &select_form($value,$name,
1.169     www      3253: 			'' => &mt('Any category'),
                   3254: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3255: }
                   3256: 
                   3257: =pod
                   3258: 
1.648     raeburn  3259: =item * &filedescription() 
1.112     bowersj2 3260: 
                   3261: returns description for a specified file type
                   3262: 
                   3263: =cut
                   3264: 
                   3265: sub filedescription {
1.188     matthew  3266:     my $file_description = $fd{lc(shift())};
                   3267:     $file_description =~ s:([\[\]]):~$1:g;
                   3268:     return &mt($file_description);
1.112     bowersj2 3269: }
                   3270: 
                   3271: =pod
                   3272: 
1.648     raeburn  3273: =item * &filedescriptionex() 
1.112     bowersj2 3274: 
                   3275: returns description for a specified file type with
                   3276: extra formatting
                   3277: 
                   3278: =cut
                   3279: 
                   3280: sub filedescriptionex {
                   3281:     my $ex=shift;
1.188     matthew  3282:     my $file_description = $fd{lc($ex)};
                   3283:     $file_description =~ s:([\[\]]):~$1:g;
                   3284:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3285: }
                   3286: 
                   3287: # End of .tab access
                   3288: =pod
                   3289: 
                   3290: =back
                   3291: 
                   3292: =cut
                   3293: 
                   3294: # ------------------------------------------------------------------ File Types
                   3295: sub fileextensions {
                   3296:     return sort(keys(%fe));
                   3297: }
                   3298: 
1.97      www      3299: # ----------------------------------------------------------- Display Languages
                   3300: # returns a hash with all desired display languages
                   3301: #
                   3302: 
                   3303: sub display_languages {
                   3304:     my %languages=();
1.695     raeburn  3305:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3306: 	$languages{$lang}=1;
1.97      www      3307:     }
                   3308:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3309:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3310: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3311: 	    $languages{$lang}=1;
1.97      www      3312:         }
                   3313:     }
                   3314:     return %languages;
1.14      harris41 3315: }
                   3316: 
1.582     albertel 3317: sub languages {
                   3318:     my ($possible_langs) = @_;
1.695     raeburn  3319:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3320:     if (!ref($possible_langs)) {
                   3321: 	if( wantarray ) {
                   3322: 	    return @preferred_langs;
                   3323: 	} else {
                   3324: 	    return $preferred_langs[0];
                   3325: 	}
                   3326:     }
                   3327:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3328:     my @preferred_possibilities;
                   3329:     foreach my $preferred_lang (@preferred_langs) {
                   3330: 	if (exists($possibilities{$preferred_lang})) {
                   3331: 	    push(@preferred_possibilities, $preferred_lang);
                   3332: 	}
                   3333:     }
                   3334:     if( wantarray ) {
                   3335: 	return @preferred_possibilities;
                   3336:     }
                   3337:     return $preferred_possibilities[0];
                   3338: }
                   3339: 
1.742     raeburn  3340: sub user_lang {
                   3341:     my ($touname,$toudom,$fromcid) = @_;
                   3342:     my @userlangs;
                   3343:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3344:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3345:                     $env{'course.'.$fromcid.'.languages'}));
                   3346:     } else {
                   3347:         my %langhash = &getlangs($touname,$toudom);
                   3348:         if ($langhash{'languages'} ne '') {
                   3349:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3350:         } else {
                   3351:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3352:             if ($domdefs{'lang_def'} ne '') {
                   3353:                 @userlangs = ($domdefs{'lang_def'});
                   3354:             }
                   3355:         }
                   3356:     }
                   3357:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3358:     my $user_lh = Apache::localize->get_handle(@languages);
                   3359:     return $user_lh;
                   3360: }
                   3361: 
                   3362: 
1.112     bowersj2 3363: ###############################################################
                   3364: ##               Student Answer Attempts                     ##
                   3365: ###############################################################
                   3366: 
                   3367: =pod
                   3368: 
                   3369: =head1 Alternate Problem Views
                   3370: 
                   3371: =over 4
                   3372: 
1.648     raeburn  3373: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3374:     $getattempt, $regexp, $gradesub)
                   3375: 
                   3376: Return string with previous attempt on problem. Arguments:
                   3377: 
                   3378: =over 4
                   3379: 
                   3380: =item * $symb: Problem, including path
                   3381: 
                   3382: =item * $username: username of the desired student
                   3383: 
                   3384: =item * $domain: domain of the desired student
1.14      harris41 3385: 
1.112     bowersj2 3386: =item * $course: Course ID
1.14      harris41 3387: 
1.112     bowersj2 3388: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3389:     something
1.14      harris41 3390: 
1.112     bowersj2 3391: =item * $regexp: if string matches this regexp, the string will be
                   3392:     sent to $gradesub
1.14      harris41 3393: 
1.112     bowersj2 3394: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3395: 
1.112     bowersj2 3396: =back
1.14      harris41 3397: 
1.112     bowersj2 3398: The output string is a table containing all desired attempts, if any.
1.16      harris41 3399: 
1.112     bowersj2 3400: =cut
1.1       albertel 3401: 
                   3402: sub get_previous_attempt {
1.43      ng       3403:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3404:   my $prevattempts='';
1.43      ng       3405:   no strict 'refs';
1.1       albertel 3406:   if ($symb) {
1.3       albertel 3407:     my (%returnhash)=
                   3408:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3409:     if ($returnhash{'version'}) {
                   3410:       my %lasthash=();
                   3411:       my $version;
                   3412:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3413:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3414: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3415:         }
1.1       albertel 3416:       }
1.596     albertel 3417:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3418:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3419:       foreach my $key (sort(keys(%lasthash))) {
                   3420: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3421: 	if ($#parts > 0) {
1.31      albertel 3422: 	  my $data=$parts[-1];
                   3423: 	  pop(@parts);
1.596     albertel 3424: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3425: 	} else {
1.41      ng       3426: 	  if ($#parts == 0) {
                   3427: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3428: 	  } else {
                   3429: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3430: 	  }
1.31      albertel 3431: 	}
1.16      harris41 3432:       }
1.596     albertel 3433:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3434:       if ($getattempt eq '') {
                   3435: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3436: 	  $prevattempts.=&start_data_table_row().
                   3437: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3438: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3439: 		my $value = &format_previous_attempt_value($key,
                   3440: 							   $returnhash{$version.':'.$key});
                   3441: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3442: 	    }
1.596     albertel 3443: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3444: 	 }
1.1       albertel 3445:       }
1.596     albertel 3446:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3447:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3448: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3449: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3450: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3451:       }
1.596     albertel 3452:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3453:     } else {
1.596     albertel 3454:       $prevattempts=
                   3455: 	  &start_data_table().&start_data_table_row().
                   3456: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3457: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3458:     }
                   3459:   } else {
1.596     albertel 3460:     $prevattempts=
                   3461: 	  &start_data_table().&start_data_table_row().
                   3462: 	  '<td>'.&mt('No data.').'</td>'.
                   3463: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3464:   }
1.10      albertel 3465: }
                   3466: 
1.581     albertel 3467: sub format_previous_attempt_value {
                   3468:     my ($key,$value) = @_;
                   3469:     if ($key =~ /timestamp/) {
                   3470: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3471:     } elsif (ref($value) eq 'ARRAY') {
                   3472: 	$value = '('.join(', ', @{ $value }).')';
                   3473:     } else {
                   3474: 	$value = &unescape($value);
                   3475:     }
                   3476:     return $value;
                   3477: }
                   3478: 
                   3479: 
1.107     albertel 3480: sub relative_to_absolute {
                   3481:     my ($url,$output)=@_;
                   3482:     my $parser=HTML::TokeParser->new(\$output);
                   3483:     my $token;
                   3484:     my $thisdir=$url;
                   3485:     my @rlinks=();
                   3486:     while ($token=$parser->get_token) {
                   3487: 	if ($token->[0] eq 'S') {
                   3488: 	    if ($token->[1] eq 'a') {
                   3489: 		if ($token->[2]->{'href'}) {
                   3490: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3491: 		}
                   3492: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3493: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3494: 	    } elsif ($token->[1] eq 'base') {
                   3495: 		$thisdir=$token->[2]->{'href'};
                   3496: 	    }
                   3497: 	}
                   3498:     }
                   3499:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3500:     foreach my $link (@rlinks) {
1.726     raeburn  3501: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3502: 		($link=~/^\//) ||
                   3503: 		($link=~/^javascript:/i) ||
                   3504: 		($link=~/^mailto:/i) ||
                   3505: 		($link=~/^\#/)) {
                   3506: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3507: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3508: 	}
                   3509:     }
                   3510: # -------------------------------------------------- Deal with Applet codebases
                   3511:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3512:     return $output;
                   3513: }
                   3514: 
1.112     bowersj2 3515: =pod
                   3516: 
1.648     raeburn  3517: =item * &get_student_view()
1.112     bowersj2 3518: 
                   3519: show a snapshot of what student was looking at
                   3520: 
                   3521: =cut
                   3522: 
1.10      albertel 3523: sub get_student_view {
1.186     albertel 3524:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3525:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3526:   my (%form);
1.10      albertel 3527:   my @elements=('symb','courseid','domain','username');
                   3528:   foreach my $element (@elements) {
1.186     albertel 3529:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3530:   }
1.186     albertel 3531:   if (defined($moreenv)) {
                   3532:       %form=(%form,%{$moreenv});
                   3533:   }
1.236     albertel 3534:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3535:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3536:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3537:   $userview=~s/\<body[^\>]*\>//gi;
                   3538:   $userview=~s/\<\/body\>//gi;
                   3539:   $userview=~s/\<html\>//gi;
                   3540:   $userview=~s/\<\/html\>//gi;
                   3541:   $userview=~s/\<head\>//gi;
                   3542:   $userview=~s/\<\/head\>//gi;
                   3543:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3544:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3545:   if (wantarray) {
                   3546:      return ($userview,$response);
                   3547:   } else {
                   3548:      return $userview;
                   3549:   }
                   3550: }
                   3551: 
                   3552: sub get_student_view_with_retries {
                   3553:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3554: 
                   3555:     my $ok = 0;                 # True if we got a good response.
                   3556:     my $content;
                   3557:     my $response;
                   3558: 
                   3559:     # Try to get the student_view done. within the retries count:
                   3560:     
                   3561:     do {
                   3562:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3563:          $ok      = $response->is_success;
                   3564:          if (!$ok) {
                   3565:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3566:          }
                   3567:          $retries--;
                   3568:     } while (!$ok && ($retries > 0));
                   3569:     
                   3570:     if (!$ok) {
                   3571:        $content = '';          # On error return an empty content.
                   3572:     }
1.651     www      3573:     if (wantarray) {
                   3574:        return ($content, $response);
                   3575:     } else {
                   3576:        return $content;
                   3577:     }
1.11      albertel 3578: }
                   3579: 
1.112     bowersj2 3580: =pod
                   3581: 
1.648     raeburn  3582: =item * &get_student_answers() 
1.112     bowersj2 3583: 
                   3584: show a snapshot of how student was answering problem
                   3585: 
                   3586: =cut
                   3587: 
1.11      albertel 3588: sub get_student_answers {
1.100     sakharuk 3589:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3590:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3591:   my (%moreenv);
1.11      albertel 3592:   my @elements=('symb','courseid','domain','username');
                   3593:   foreach my $element (@elements) {
1.186     albertel 3594:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3595:   }
1.186     albertel 3596:   $moreenv{'grade_target'}='answer';
                   3597:   %moreenv=(%form,%moreenv);
1.497     raeburn  3598:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3599:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3600:   return $userview;
1.1       albertel 3601: }
1.116     albertel 3602: 
                   3603: =pod
                   3604: 
                   3605: =item * &submlink()
                   3606: 
1.242     albertel 3607: Inputs: $text $uname $udom $symb $target
1.116     albertel 3608: 
                   3609: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3610: 
                   3611: =cut
                   3612: 
                   3613: ###############################################
                   3614: sub submlink {
1.242     albertel 3615:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3616:     if (!($uname && $udom)) {
                   3617: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3618: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3619: 	if (!$symb) { $symb=$cursymb; }
                   3620:     }
1.254     matthew  3621:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3622:     $symb=&escape($symb);
1.242     albertel 3623:     if ($target) { $target="target=\"$target\""; }
                   3624:     return '<a href="/adm/grades?&command=submission&'.
                   3625: 	'symb='.$symb.'&student='.$uname.
                   3626: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3627: }
                   3628: ##############################################
                   3629: 
                   3630: =pod
                   3631: 
                   3632: =item * &pgrdlink()
                   3633: 
                   3634: Inputs: $text $uname $udom $symb $target
                   3635: 
                   3636: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3637: 
                   3638: =cut
                   3639: 
                   3640: ###############################################
                   3641: sub pgrdlink {
                   3642:     my $link=&submlink(@_);
                   3643:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3644:     return $link;
                   3645: }
                   3646: ##############################################
                   3647: 
                   3648: =pod
                   3649: 
                   3650: =item * &pprmlink()
                   3651: 
                   3652: Inputs: $text $uname $udom $symb $target
                   3653: 
                   3654: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3655: student and a specific resource
1.242     albertel 3656: 
                   3657: =cut
                   3658: 
                   3659: ###############################################
                   3660: sub pprmlink {
                   3661:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3662:     if (!($uname && $udom)) {
                   3663: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3664: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3665: 	if (!$symb) { $symb=$cursymb; }
                   3666:     }
1.254     matthew  3667:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3668:     $symb=&escape($symb);
1.242     albertel 3669:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3670:     return '<a href="/adm/parmset?command=set&amp;'.
                   3671: 	'symb='.$symb.'&amp;uname='.$uname.
                   3672: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3673: }
                   3674: ##############################################
1.37      matthew  3675: 
1.112     bowersj2 3676: =pod
                   3677: 
                   3678: =back
                   3679: 
                   3680: =cut
                   3681: 
1.37      matthew  3682: ###############################################
1.51      www      3683: 
                   3684: 
                   3685: sub timehash {
1.687     raeburn  3686:     my ($thistime) = @_;
                   3687:     my $timezone = &Apache::lonlocal::gettimezone();
                   3688:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3689:                      ->set_time_zone($timezone);
                   3690:     my $wday = $dt->day_of_week();
                   3691:     if ($wday == 7) { $wday = 0; }
                   3692:     return ( 'second' => $dt->second(),
                   3693:              'minute' => $dt->minute(),
                   3694:              'hour'   => $dt->hour(),
                   3695:              'day'     => $dt->day_of_month(),
                   3696:              'month'   => $dt->month(),
                   3697:              'year'    => $dt->year(),
                   3698:              'weekday' => $wday,
                   3699:              'dayyear' => $dt->day_of_year(),
                   3700:              'dlsav'   => $dt->is_dst() );
1.51      www      3701: }
                   3702: 
1.370     www      3703: sub utc_string {
                   3704:     my ($date)=@_;
1.371     www      3705:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3706: }
                   3707: 
1.51      www      3708: sub maketime {
                   3709:     my %th=@_;
1.687     raeburn  3710:     my ($epoch_time,$timezone,$dt);
                   3711:     $timezone = &Apache::lonlocal::gettimezone();
                   3712:     eval {
                   3713:         $dt = DateTime->new( year   => $th{'year'},
                   3714:                              month  => $th{'month'},
                   3715:                              day    => $th{'day'},
                   3716:                              hour   => $th{'hour'},
                   3717:                              minute => $th{'minute'},
                   3718:                              second => $th{'second'},
                   3719:                              time_zone => $timezone,
                   3720:                          );
                   3721:     };
                   3722:     if (!$@) {
                   3723:         $epoch_time = $dt->epoch;
                   3724:         if ($epoch_time) {
                   3725:             return $epoch_time;
                   3726:         }
                   3727:     }
1.51      www      3728:     return POSIX::mktime(
                   3729:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3730:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3731: }
                   3732: 
                   3733: #########################################
1.51      www      3734: 
                   3735: sub findallcourses {
1.482     raeburn  3736:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3737:     my %roles;
                   3738:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3739:     my %courses;
1.51      www      3740:     my $now=time;
1.482     raeburn  3741:     if (!defined($uname)) {
                   3742:         $uname = $env{'user.name'};
                   3743:     }
                   3744:     if (!defined($udom)) {
                   3745:         $udom = $env{'user.domain'};
                   3746:     }
                   3747:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3748:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3749:         if (!%roles) {
                   3750:             %roles = (
                   3751:                        cc => 1,
1.907     raeburn  3752:                        co => 1,
1.482     raeburn  3753:                        in => 1,
                   3754:                        ep => 1,
                   3755:                        ta => 1,
                   3756:                        cr => 1,
                   3757:                        st => 1,
                   3758:              );
                   3759:         }
                   3760:         foreach my $entry (keys(%roleshash)) {
                   3761:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3762:             if ($trole =~ /^cr/) { 
                   3763:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3764:             } else {
                   3765:                 next if (!exists($roles{$trole}));
                   3766:             }
                   3767:             if ($tend) {
                   3768:                 next if ($tend < $now);
                   3769:             }
                   3770:             if ($tstart) {
                   3771:                 next if ($tstart > $now);
                   3772:             }
                   3773:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3774:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3775:             if ($secpart eq '') {
                   3776:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3777:                 $sec = 'none';
                   3778:                 $realsec = '';
                   3779:             } else {
                   3780:                 $cnum = $cnumpart;
                   3781:                 ($sec,$role) = split(/_/,$secpart);
                   3782:                 $realsec = $sec;
1.490     raeburn  3783:             }
1.482     raeburn  3784:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3785:         }
                   3786:     } else {
                   3787:         foreach my $key (keys(%env)) {
1.483     albertel 3788: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3789:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3790: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3791: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3792: 	        next if (%roles && !exists($roles{$role}));
                   3793: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3794:                 my $active=1;
                   3795:                 if ($starttime) {
                   3796: 		    if ($now<$starttime) { $active=0; }
                   3797:                 }
                   3798:                 if ($endtime) {
                   3799:                     if ($now>$endtime) { $active=0; }
                   3800:                 }
                   3801:                 if ($active) {
                   3802:                     if ($sec eq '') {
                   3803:                         $sec = 'none';
                   3804:                     }
                   3805:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3806:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3807:                 }
                   3808:             }
1.51      www      3809:         }
                   3810:     }
1.474     raeburn  3811:     return %courses;
1.51      www      3812: }
1.37      matthew  3813: 
1.54      www      3814: ###############################################
1.474     raeburn  3815: 
                   3816: sub blockcheck {
1.482     raeburn  3817:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3818: 
                   3819:     if (!defined($udom)) {
                   3820:         $udom = $env{'user.domain'};
                   3821:     }
                   3822:     if (!defined($uname)) {
                   3823:         $uname = $env{'user.name'};
                   3824:     }
                   3825: 
                   3826:     # If uname and udom are for a course, check for blocks in the course.
                   3827: 
                   3828:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3829:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3830:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3831:         return ($startblock,$endblock);
                   3832:     }
1.474     raeburn  3833: 
1.502     raeburn  3834:     my $startblock = 0;
                   3835:     my $endblock = 0;
1.482     raeburn  3836:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3837: 
1.490     raeburn  3838:     # If uname is for a user, and activity is course-specific, i.e.,
                   3839:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3840: 
1.490     raeburn  3841:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3842:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3843:         foreach my $key (keys(%live_courses)) {
                   3844:             if ($key ne $env{'request.course.id'}) {
                   3845:                 delete($live_courses{$key});
                   3846:             }
                   3847:         }
                   3848:     }
                   3849: 
                   3850:     my $otheruser = 0;
                   3851:     my %own_courses;
                   3852:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3853:         # Resource belongs to user other than current user.
                   3854:         $otheruser = 1;
                   3855:         # Gather courses for current user
                   3856:         %own_courses = 
                   3857:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3858:     }
                   3859: 
                   3860:     # Gather active course roles - course coordinator, instructor, 
                   3861:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3862: 
                   3863:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3864:         my ($cdom,$cnum);
                   3865:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3866:             $cdom = $env{'course.'.$course.'.domain'};
                   3867:             $cnum = $env{'course.'.$course.'.num'};
                   3868:         } else {
1.490     raeburn  3869:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3870:         }
                   3871:         my $no_ownblock = 0;
                   3872:         my $no_userblock = 0;
1.533     raeburn  3873:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3874:             # Check if current user has 'evb' priv for this
                   3875:             if (defined($own_courses{$course})) {
                   3876:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3877:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3878:                     if ($sec ne 'none') {
                   3879:                         $checkrole .= '/'.$sec;
                   3880:                     }
                   3881:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3882:                         $no_ownblock = 1;
                   3883:                         last;
                   3884:                     }
                   3885:                 }
                   3886:             }
                   3887:             # if they have 'evb' priv and are currently not playing student
                   3888:             next if (($no_ownblock) &&
                   3889:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3890:         }
1.474     raeburn  3891:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3892:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3893:             if ($sec ne 'none') {
1.482     raeburn  3894:                 $checkrole .= '/'.$sec;
1.474     raeburn  3895:             }
1.490     raeburn  3896:             if ($otheruser) {
                   3897:                 # Resource belongs to user other than current user.
                   3898:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3899:                 my ($trole,$tdom,$tnum,$tsec);
                   3900:                 my $entry = $live_courses{$course}{$sec};
                   3901:                 if ($entry =~ /^cr/) {
                   3902:                     ($trole,$tdom,$tnum,$tsec) = 
                   3903:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3904:                 } else {
                   3905:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3906:                 }
                   3907:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3908:                 $area = '/'.$tdom.'/'.$tnum;
                   3909:                 $trest = $tnum;
                   3910:                 if ($tsec ne '') {
                   3911:                     $area .= '/'.$tsec;
                   3912:                     $trest .= '/'.$tsec;
                   3913:                 }
                   3914:                 $spec = $trole.'.'.$area;
                   3915:                 if ($trole =~ /^cr/) {
                   3916:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3917:                                                       $tdom,$spec,$trest,$area);
                   3918:                 } else {
                   3919:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3920:                                                        $tdom,$spec,$trest,$area);
                   3921:                 }
                   3922:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3923:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3924:                     if ($1) {
                   3925:                         $no_userblock = 1;
                   3926:                         last;
                   3927:                     }
                   3928:                 }
1.490     raeburn  3929:             } else {
                   3930:                 # Resource belongs to current user
                   3931:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3932:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3933:                     $no_ownblock = 1;
                   3934:                     last;
                   3935:                 }
1.474     raeburn  3936:             }
                   3937:         }
                   3938:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3939:         next if (($no_ownblock) &&
1.491     albertel 3940:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3941:         next if ($no_userblock);
1.474     raeburn  3942: 
1.866     kalberla 3943:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3944:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3945:         
                   3946:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3947:         if (($start != 0) && 
                   3948:             (($startblock == 0) || ($startblock > $start))) {
                   3949:             $startblock = $start;
                   3950:         }
                   3951:         if (($end != 0)  &&
                   3952:             (($endblock == 0) || ($endblock < $end))) {
                   3953:             $endblock = $end;
                   3954:         }
1.490     raeburn  3955:     }
                   3956:     return ($startblock,$endblock);
                   3957: }
                   3958: 
                   3959: sub get_blocks {
                   3960:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3961:     my $startblock = 0;
                   3962:     my $endblock = 0;
                   3963:     my $course = $cdom.'_'.$cnum;
                   3964:     $setters->{$course} = {};
                   3965:     $setters->{$course}{'staff'} = [];
                   3966:     $setters->{$course}{'times'} = [];
                   3967:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3968:     foreach my $record (keys(%records)) {
                   3969:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3970:         if ($start <= time && $end >= time) {
                   3971:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3972:                 &parse_block_record($records{$record});
                   3973:             if ($blocks->{$activity} eq 'on') {
                   3974:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3975:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3976:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3977:                     $startblock = $start;
1.490     raeburn  3978:                 }
1.491     albertel 3979:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3980:                     $endblock = $end;
1.474     raeburn  3981:                 }
                   3982:             }
                   3983:         }
                   3984:     }
                   3985:     return ($startblock,$endblock);
                   3986: }
                   3987: 
                   3988: sub parse_block_record {
                   3989:     my ($record) = @_;
                   3990:     my ($setuname,$setudom,$title,$blocks);
                   3991:     if (ref($record) eq 'HASH') {
                   3992:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3993:         $title = &unescape($record->{'event'});
                   3994:         $blocks = $record->{'blocks'};
                   3995:     } else {
                   3996:         my @data = split(/:/,$record,3);
                   3997:         if (scalar(@data) eq 2) {
                   3998:             $title = $data[1];
                   3999:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4000:         } else {
                   4001:             ($setuname,$setudom,$title) = @data;
                   4002:         }
                   4003:         $blocks = { 'com' => 'on' };
                   4004:     }
                   4005:     return ($setuname,$setudom,$title,$blocks);
                   4006: }
                   4007: 
1.854     kalberla 4008: sub blocking_status {
                   4009:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4010:   my %setters;
1.890     droeschl 4011: 
                   4012:   # check for active blocking
1.867     kalberla 4013:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4014: 
1.890     droeschl 4015:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4016: 
                   4017:   # caller just wants to know whether a block is active
                   4018:   if (!wantarray) { return $blocked; }
                   4019: 
                   4020:   # build a link to a popup window containing the details
                   4021:   my $querystring  = "?activity=$activity";
                   4022:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4023:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4024:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4025: 
                   4026:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4027:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4028:         var options = "width=" + w + ",height=" + h + ",";
                   4029:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4030:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4031:         var newWin = window.open(url, wdwName, options);
                   4032:         newWin.focus();
                   4033:     }
1.890     droeschl 4034: END_MYBLOCK
1.854     kalberla 4035: 
1.890     droeschl 4036:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4037:   
1.854     kalberla 4038:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4039:   my $text = mt('Communication Blocked');
                   4040: 
1.867     kalberla 4041:   $output .= <<"END_BLOCK";
                   4042: <div class='LC_comblock'>
1.869     kalberla 4043:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4044:   title='$text'>
                   4045:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4046:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4047:   title='$text'>$text</a>
1.867     kalberla 4048: </div>
                   4049: 
                   4050: END_BLOCK
1.474     raeburn  4051: 
1.854     kalberla 4052:   return ($blocked, $output);
                   4053: }
1.490     raeburn  4054: 
1.60      matthew  4055: ###############################################
                   4056: 
1.682     raeburn  4057: sub check_ip_acc {
                   4058:     my ($acc)=@_;
                   4059:     &Apache::lonxml::debug("acc is $acc");
                   4060:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4061:         return 1;
                   4062:     }
                   4063:     my $allowed=0;
                   4064:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4065: 
                   4066:     my $name;
                   4067:     foreach my $pattern (split(',',$acc)) {
                   4068:         $pattern =~ s/^\s*//;
                   4069:         $pattern =~ s/\s*$//;
                   4070:         if ($pattern =~ /\*$/) {
                   4071:             #35.8.*
                   4072:             $pattern=~s/\*//;
                   4073:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4074:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4075:             #35.8.3.[34-56]
                   4076:             my $low=$2;
                   4077:             my $high=$3;
                   4078:             $pattern=$1;
                   4079:             if ($ip =~ /^\Q$pattern\E/) {
                   4080:                 my $last=(split(/\./,$ip))[3];
                   4081:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4082:             }
                   4083:         } elsif ($pattern =~ /^\*/) {
                   4084:             #*.msu.edu
                   4085:             $pattern=~s/\*//;
                   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:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4093:             #127.0.0.1
                   4094:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4095:         } else {
                   4096:             #some.name.com
                   4097:             if (!defined($name)) {
                   4098:                 use Socket;
                   4099:                 my $netaddr=inet_aton($ip);
                   4100:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4101:             }
                   4102:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4103:         }
                   4104:         if ($allowed) { last; }
                   4105:     }
                   4106:     return $allowed;
                   4107: }
                   4108: 
                   4109: ###############################################
                   4110: 
1.60      matthew  4111: =pod
                   4112: 
1.112     bowersj2 4113: =head1 Domain Template Functions
                   4114: 
                   4115: =over 4
                   4116: 
                   4117: =item * &determinedomain()
1.60      matthew  4118: 
                   4119: Inputs: $domain (usually will be undef)
                   4120: 
1.63      www      4121: Returns: Determines which domain should be used for designs
1.60      matthew  4122: 
                   4123: =cut
1.54      www      4124: 
1.60      matthew  4125: ###############################################
1.63      www      4126: sub determinedomain {
                   4127:     my $domain=shift;
1.531     albertel 4128:     if (! $domain) {
1.60      matthew  4129:         # Determine domain if we have not been given one
1.893     raeburn  4130:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4131:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4132:         if ($env{'request.role.domain'}) { 
                   4133:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4134:         }
                   4135:     }
1.63      www      4136:     return $domain;
                   4137: }
                   4138: ###############################################
1.517     raeburn  4139: 
1.518     albertel 4140: sub devalidate_domconfig_cache {
                   4141:     my ($udom)=@_;
                   4142:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4143: }
                   4144: 
                   4145: # ---------------------- Get domain configuration for a domain
                   4146: sub get_domainconf {
                   4147:     my ($udom) = @_;
                   4148:     my $cachetime=1800;
                   4149:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4150:     if (defined($cached)) { return %{$result}; }
                   4151: 
                   4152:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4153: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4154:     my (%designhash,%legacy);
1.518     albertel 4155:     if (keys(%domconfig) > 0) {
                   4156:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4157:             if (keys(%{$domconfig{'login'}})) {
                   4158:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4159:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4160:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4161:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4162:                                 $domconfig{'login'}{$key}{$img};
                   4163:                         }
                   4164:                     } else {
                   4165:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4166:                     }
1.632     raeburn  4167:                 }
                   4168:             } else {
                   4169:                 $legacy{'login'} = 1;
1.518     albertel 4170:             }
1.632     raeburn  4171:         } else {
                   4172:             $legacy{'login'} = 1;
1.518     albertel 4173:         }
                   4174:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4175:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4176:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4177:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4178:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4179:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4180:                         }
1.518     albertel 4181:                     }
                   4182:                 }
1.632     raeburn  4183:             } else {
                   4184:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4185:             }
1.632     raeburn  4186:         } else {
                   4187:             $legacy{'rolecolors'} = 1;
1.518     albertel 4188:         }
1.632     raeburn  4189:         if (keys(%legacy) > 0) {
                   4190:             my %legacyhash = &get_legacy_domconf($udom);
                   4191:             foreach my $item (keys(%legacyhash)) {
                   4192:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4193:                     if ($legacy{'login'}) { 
                   4194:                         $designhash{$item} = $legacyhash{$item};
                   4195:                     }
                   4196:                 } else {
                   4197:                     if ($legacy{'rolecolors'}) {
                   4198:                         $designhash{$item} = $legacyhash{$item};
                   4199:                     }
1.518     albertel 4200:                 }
                   4201:             }
                   4202:         }
1.632     raeburn  4203:     } else {
                   4204:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4205:     }
                   4206:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4207: 				  $cachetime);
                   4208:     return %designhash;
                   4209: }
                   4210: 
1.632     raeburn  4211: sub get_legacy_domconf {
                   4212:     my ($udom) = @_;
                   4213:     my %legacyhash;
                   4214:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4215:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4216:     if (-e $designfile) {
                   4217:         if ( open (my $fh,"<$designfile") ) {
                   4218:             while (my $line = <$fh>) {
                   4219:                 next if ($line =~ /^\#/);
                   4220:                 chomp($line);
                   4221:                 my ($key,$val)=(split(/\=/,$line));
                   4222:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4223:             }
                   4224:             close($fh);
                   4225:         }
                   4226:     }
                   4227:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4228:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4229:     }
                   4230:     return %legacyhash;
                   4231: }
                   4232: 
1.63      www      4233: =pod
                   4234: 
1.112     bowersj2 4235: =item * &domainlogo()
1.63      www      4236: 
                   4237: Inputs: $domain (usually will be undef)
                   4238: 
                   4239: Returns: A link to a domain logo, if the domain logo exists.
                   4240: If the domain logo does not exist, a description of the domain.
                   4241: 
                   4242: =cut
1.112     bowersj2 4243: 
1.63      www      4244: ###############################################
                   4245: sub domainlogo {
1.517     raeburn  4246:     my $domain = &determinedomain(shift);
1.518     albertel 4247:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4248:     # See if there is a logo
                   4249:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4250:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4251:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4252: 	    if ($imgsrc =~ m{^/res/}) {
                   4253: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4254: 		&Apache::lonnet::repcopy($local_name);
                   4255: 	    }
                   4256: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4257:         } 
                   4258:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4259:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4260:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4261:     } else {
1.60      matthew  4262:         return '';
1.59      www      4263:     }
                   4264: }
1.63      www      4265: ##############################################
                   4266: 
                   4267: =pod
                   4268: 
1.112     bowersj2 4269: =item * &designparm()
1.63      www      4270: 
                   4271: Inputs: $which parameter; $domain (usually will be undef)
                   4272: 
                   4273: Returns: value of designparamter $which
                   4274: 
                   4275: =cut
1.112     bowersj2 4276: 
1.397     albertel 4277: 
1.400     albertel 4278: ##############################################
1.397     albertel 4279: sub designparm {
                   4280:     my ($which,$domain)=@_;
                   4281:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4282:         return $env{'environment.color.'.$which};
1.96      www      4283:     }
1.63      www      4284:     $domain=&determinedomain($domain);
1.518     albertel 4285:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4286:     my $output;
1.517     raeburn  4287:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4288:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4289:     } else {
1.520     raeburn  4290:         $output = $defaultdesign{$which};
                   4291:     }
                   4292:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4293:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4294:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4295:             if ($output =~ m{^/res/}) {
                   4296:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4297:                 &Apache::lonnet::repcopy($local_name);
                   4298:             }
1.520     raeburn  4299:             $output = &lonhttpdurl($output);
                   4300:         }
1.63      www      4301:     }
1.520     raeburn  4302:     return $output;
1.63      www      4303: }
1.59      www      4304: 
1.822     bisitz   4305: ##############################################
                   4306: =pod
                   4307: 
1.832     bisitz   4308: =item * &authorspace()
                   4309: 
                   4310: Inputs: ./.
                   4311: 
                   4312: Returns: Path to the Construction Space of the current user's
                   4313:          accessed author space
                   4314:          The author space will be that of the current user
                   4315:          when accessing the own author space
                   4316:          and that of the co-author/assistent co-author
                   4317:          when accessing the co-author's/assistent co-author's
                   4318:          space
                   4319: 
                   4320: =cut
                   4321: 
                   4322: sub authorspace {
                   4323:     my $caname = '';
                   4324:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4325:         (undef,$caname) =
                   4326:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4327:     } else {
                   4328:         $caname = $env{'user.name'};
                   4329:     }
                   4330:     return '/priv/'.$caname.'/';
                   4331: }
                   4332: 
                   4333: ##############################################
                   4334: =pod
                   4335: 
1.822     bisitz   4336: =item * &head_subbox()
                   4337: 
                   4338: Inputs: $content (contains HTML code with page functions, etc.)
                   4339: 
                   4340: Returns: HTML div with $content
                   4341:          To be included in page header
                   4342: 
                   4343: =cut
                   4344: 
                   4345: sub head_subbox {
                   4346:     my ($content)=@_;
                   4347:     my $output =
1.844     bisitz   4348:         '<div id="LC_head_subbox">'
1.822     bisitz   4349:        .$content
                   4350:        .'</div>'
                   4351: }
                   4352: 
                   4353: ##############################################
                   4354: =pod
                   4355: 
                   4356: =item * &CSTR_pageheader()
                   4357: 
                   4358: Inputs: ./.
                   4359: 
                   4360: Returns: HTML div with CSTR path and recent box
                   4361:          To be included on Construction Space pages
                   4362: 
                   4363: =cut
                   4364: 
                   4365: sub CSTR_pageheader {
                   4366:     # this is for resources; directories have customtitle, and crumbs
                   4367:             # and select recent are created in lonpubdir.pm  
                   4368:     my ($uname,$thisdisfn)=
                   4369:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4370:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4371:     $formaction=~s/\/+/\//g;
                   4372: 
                   4373:     my $parentpath = '';
                   4374:     my $lastitem = '';
                   4375:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4376:         $parentpath = $1;
                   4377:         $lastitem = $2;
                   4378:     } else {
                   4379:         $lastitem = $thisdisfn;
                   4380:     }
1.921     bisitz   4381: 
                   4382:     my $output =
1.822     bisitz   4383:          '<div>'
                   4384:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4385:         .'<b>'.&mt('Construction Space:').'</b> '
                   4386:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4387:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
                   4388:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
                   4389: 
                   4390:     if ($lastitem) {
                   4391:         $output .=
                   4392:              '<span class="LC_filename">'
                   4393:             .$lastitem
                   4394:             .'</span>';
                   4395:     }
                   4396:     $output .=
                   4397:          '<br />'
1.822     bisitz   4398:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4399:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4400:         .'</form>'
                   4401:         .&Apache::lonmenu::constspaceform()
                   4402:         .'</div>';
1.921     bisitz   4403: 
                   4404:     return $output;
1.822     bisitz   4405: }
                   4406: 
1.60      matthew  4407: ###############################################
                   4408: ###############################################
                   4409: 
                   4410: =pod
                   4411: 
1.112     bowersj2 4412: =back
                   4413: 
1.549     albertel 4414: =head1 HTML Helpers
1.112     bowersj2 4415: 
                   4416: =over 4
                   4417: 
                   4418: =item * &bodytag()
1.60      matthew  4419: 
                   4420: Returns a uniform header for LON-CAPA web pages.
                   4421: 
                   4422: Inputs: 
                   4423: 
1.112     bowersj2 4424: =over 4
                   4425: 
                   4426: =item * $title, A title to be displayed on the page.
                   4427: 
                   4428: =item * $function, the current role (can be undef).
                   4429: 
                   4430: =item * $addentries, extra parameters for the <body> tag.
                   4431: 
                   4432: =item * $bodyonly, if defined, only return the <body> tag.
                   4433: 
                   4434: =item * $domain, if defined, force a given domain.
                   4435: 
                   4436: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4437:             text interface only)
1.60      matthew  4438: 
1.814     bisitz   4439: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4440:                      navigational links
1.317     albertel 4441: 
1.338     albertel 4442: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4443: 
1.361     albertel 4444: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4445:          'Switch To Inline Menu' link
                   4446: 
1.460     albertel 4447: =item * $args, optional argument valid values are
                   4448:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4449:             inherit_jsmath -> when creating popup window in a page,
                   4450:                               should it have jsmath forced on by the
                   4451:                               current page
1.460     albertel 4452: 
1.112     bowersj2 4453: =back
                   4454: 
1.60      matthew  4455: Returns: A uniform header for LON-CAPA web pages.  
                   4456: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4457: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4458: other decorations will be returned.
                   4459: 
                   4460: =cut
                   4461: 
1.54      www      4462: sub bodytag {
1.831     bisitz   4463:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4464:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4465: 
1.925.2.19  raeburn  4466:     my $public;
                   4467:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4468:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4469:         $public = 1;
                   4470:     }
1.460     albertel 4471:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4472: 
1.183     matthew  4473:     $function = &get_users_function() if (!$function);
1.339     albertel 4474:     my $img =    &designparm($function.'.img',$domain);
                   4475:     my $font =   &designparm($function.'.font',$domain);
                   4476:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4477: 
1.803     bisitz   4478:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4479: 		   'bgcolor' => $pgbg,
1.339     albertel 4480: 		   'text'    => $font,
                   4481:                    'alink'   => &designparm($function.'.alink',$domain),
                   4482: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4483: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4484:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4485: 
1.925.2.4  raeburn  4486:     my $custommenu;
                   4487:     if ($env{'environment.remote'} eq 'off') {
                   4488:         $custommenu = &needs_gci_custom();
                   4489:     }
1.63      www      4490:  # role and realm
1.378     raeburn  4491:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4492:     if ($role  eq 'ca') {
1.479     albertel 4493:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4494:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4495:     } 
1.55      www      4496: # realm
1.258     albertel 4497:     if ($env{'request.course.id'}) {
1.378     raeburn  4498:         if ($env{'request.role'} !~ /^cr/) {
1.925.2.17  raeburn  4499:             if (($custommenu) && (($role eq 'cm') || ($env{'form.context'} eq 'requestcrs'))) {
1.925.2.4  raeburn  4500:                 undef($role);
                   4501:             } else {
                   4502:                 $role = &Apache::lonnet::plaintext($role,&course_type());
                   4503:             }
1.378     raeburn  4504:         }
1.925.2.17  raeburn  4505:         if (defined($role) && $env{'request.course.sec'}) {
1.898     raeburn  4506:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
1.925.2.17  raeburn  4507:         }
                   4508:         if ($env{'form.context'} eq 'requestcrs') {
                   4509:             undef($realm);
                   4510:         } else {
                   4511: 	    $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
                   4512:         }
1.378     raeburn  4513:     } else {
1.925.2.4  raeburn  4514:         if (($custommenu) && ($role eq 'cm')) {
                   4515:             undef($role);
                   4516:         } else {
                   4517:             $role = &Apache::lonnet::plaintext($role);
                   4518:         }
1.54      www      4519:     }
1.433     albertel 4520: 
1.359     albertel 4521:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4522: # Set messages
1.60      matthew  4523:     my $messages=&domainlogo($domain);
1.330     albertel 4524: 
1.438     albertel 4525:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4526: 
1.101     www      4527: # construct main body tag
1.359     albertel 4528:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4529: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4530: 
1.530     albertel 4531:     if ($bodyonly) {
1.60      matthew  4532:         return $bodytag;
1.798     tempelho 4533:     } 
1.359     albertel 4534: 
1.410     albertel 4535:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.925.2.19  raeburn  4536:     if ($public) {
1.433     albertel 4537: 	undef($role);
1.434     albertel 4538:     } else {
                   4539: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4540:     }
1.359     albertel 4541:     
1.762     bisitz   4542:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4543:     #
                   4544:     # Extra info if you are the DC
                   4545:     my $dc_info = '';
                   4546:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4547:                         $env{'course.'.$env{'request.course.id'}.
                   4548:                                  '.domain'}.'/'})) {
                   4549:         my $cid = $env{'request.course.id'};
1.917     raeburn  4550:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4551:         $dc_info =~ s/\s+$//;
1.359     albertel 4552:     }
                   4553: 
1.898     raeburn  4554:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4555:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4556: 
1.925.2.19  raeburn  4557:     if ($env{'environment.remote'} ne 'on') {
1.359     albertel 4558:         # No Remote
1.916     droeschl 4559:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4560:             return $bodytag; 
                   4561:         } 
1.903     droeschl 4562: 
                   4563:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4564: 
                   4565:         #    if ($env{'request.state'} eq 'construct') {
                   4566:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4567:         #    }
                   4568: 
1.925.2.4  raeburn  4569:         my $role_selector;
1.925.2.17  raeburn  4570:         if (($custommenu) && !($env{'form.context'} eq 'requestcrs') && 
                   4571:             ($env{'request.course.id'}) && 
1.925.2.14  raeburn  4572:             ($env{'course.'.$env{'request.course.id'}.'.domain'} eq 'gcitest')) {
1.925.2.4  raeburn  4573:             $role_selector = &Apache::lonmenu::roles_selector(
                   4574:                         $env{'course.' . $env{'request.course.id'} . '.domain'},
                   4575:                         $env{'course.' . $env{'request.course.id'} . '.num'}  );
                   4576:             if ($role_selector) {
                   4577:                 $role_selector = '<br />'.$role_selector;
                   4578:             }
                   4579:         }
1.925.2.14  raeburn  4580:         my $cid = $env{'request.course.id'};
                   4581:         my %gcicourses = (
                   4582:                            gci_9615072b469884921gcil1 => 'review',
                   4583:                            gci_1H96711d710194bfegcil1 => 'submit',
                   4584:                            gci_5422913620b814c90gcil1 => 'tutorial',
                   4585:                          );
1.925.2.17  raeburn  4586:         if (($custommenu && $cid && !$gcicourses{$cid}) && 
                   4587:              !($env{'form.context'} eq 'requestcrs') ||
                   4588:              ($env{'user.domain'} eq 'gcitest')) {
1.925.2.14  raeburn  4589:             my $role = 'st';
                   4590:             if ($custommenu) {
                   4591:                 $role = 'cc';
                   4592:             }
                   4593:             my ($switcher_js,$switcher,$formname);
                   4594:             $formname = 'pickrole';
                   4595:             my %courses = &existing_gcitest_courses($role);
                   4596:             my $numcourses = keys(%courses);
                   4597:             my $reqdcount = 0;
                   4598:             if ($cid) {
                   4599:                 if ($courses{$cid}) {
                   4600:                     $reqdcount = 1; 
                   4601:                 }
                   4602:             }
                   4603:             if ($numcourses > $reqdcount) {
                   4604:                 $switcher = &gcitest_switcher($role,$formname,%courses);
                   4605:                 my $current;
                   4606:                 if ($cid) {
                   4607:                     $current = $role.'./'.$env{'course.'.$cid.'.domain'}.
                   4608:                                '/'.$env{'course.'.$cid.'.num'};
                   4609:                 }
                   4610:                 $switcher_js = &Apache::loncommon::gcitest_switcher_js($current,$numcourses,$formname);
                   4611:                 if ($switcher_js) {  
                   4612:                     $switcher_js= <<"ENDSCRIPT";
                   4613: <script type="text/javascript">
                   4614: // <![CDATA[
                   4615: 
                   4616: $switcher_js
                   4617: 
                   4618: // ]]>
                   4619: </script>
                   4620: ENDSCRIPT
                   4621:                 }
                   4622:             }
                   4623:             if ($switcher) {
                   4624:                 $switcher = $switcher_js.$switcher;
                   4625:                 if ($role_selector) {
                   4626:                     $role_selector .= '&nbsp;&nbsp;&nbsp;'.$switcher;
                   4627:                 } else {
                   4628:                     $role_selector .= '<br />'.$switcher;
                   4629:                 }
                   4630:             }
                   4631:         }
1.359     albertel 4632: 
1.916     droeschl 4633:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4634:              if ($dc_info) {
                   4635:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4636:              }
1.916     droeschl 4637:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4638:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4639:             return $bodytag;
                   4640:         }
1.925.2.17  raeburn  4641:         if ($env{'request.noversionuri'} eq '/adm/navmaps' &&
                   4642:                 $env{'environment.remotenavmap'} eq 'on') {
                   4643:             return $bodytag;
                   4644:         }
1.894     droeschl 4645: 
1.925.2.14  raeburn  4646:         if ($cid && $gcicourses{$cid} eq 'tutorial') {
                   4647:             $bodytag .= '<div class="LC_page_header">';
1.925.2.17  raeburn  4648:         }
                   4649:  
1.925.2.4  raeburn  4650:         $bodytag .= qq|<div id="LC_nav_bar">$name $role $role_selector</div>|;
1.916     droeschl 4651: 
1.903     droeschl 4652:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.925.2.2  raeburn  4653:             Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
1.816     bisitz   4654: 
1.903     droeschl 4655:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4656: 
1.917     raeburn  4657:         if ($dc_info) {
                   4658:             $dc_info = &dc_courseid_toggle($dc_info);
                   4659:         }
                   4660:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.925.2.14  raeburn  4661:         if ($cid && $gcicourses{$cid} eq 'tutorial') {
                   4662:             $bodytag .= '</div>';
                   4663:         }
1.916     droeschl 4664: 
1.903     droeschl 4665:         #don't show menus for public users
1.925.2.19  raeburn  4666:         if(!$public){
1.925.2.5  raeburn  4667:             if (($custommenu) && 
                   4668:                 ($env{'request.role'} !~ m{^st\./gcitest/$match_courseid})) {
1.925.2.2  raeburn  4669:                 $bodytag .= &Apache::lonmenu::gci_secondary_menu();
1.925.2.16  raeburn  4670:             } elsif ($env{'request.role'} ne 'cm' || &check_for_gci_dc()) {    
1.925.2.2  raeburn  4671:                 $bodytag .= Apache::lonmenu::secondary_menu();
                   4672:             }
1.903     droeschl 4673:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4674:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4675:             if ($env{'request.state'} eq 'construct') {
                   4676:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
                   4677:                                 $args->{'bread_crumbs'});
                   4678:             } elsif ($forcereg) { 
                   4679:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
1.925.2.14  raeburn  4680:             } elsif ($custommenu && $env{'request.course.id'} && 
                   4681:                      &Apache::lonnet::allowed('mdc', $env{'request.course.id'})) {
1.925.2.17  raeburn  4682:                 if ((($env{'request.noversionuri'} eq '/adm/navmaps') && 
                   4683:                     ($env{'request.noversionuri'} ne 'on')) ||
                   4684:                     (($env{'request.noversionuri'} eq '/adm/coursedocs') &&
                   4685:                      (!($env{'form.context'} eq 'requestcrs'))) ||
                   4686:                     (($env{'request.noversionuri'} eq '/adm/createuser') &&
                   4687:                      (!($env{'form.context'} eq 'requestcrs'))) ||
1.925.2.16  raeburn  4688:                     ($env{'request.noversionuri'} eq '/adm/whatsnew') ||
                   4689:                     ($env{'request.noversionuri'} eq '/cgi-bin/printout.pl') ||
                   4690:                     ($env{'request.noversionuri'} eq '/adm/printout') ||
                   4691:                     ($env{'request.noversionuri'} eq '/adm/statistics')) {
                   4692: 
1.925.2.14  raeburn  4693:                     my @advtools = &concept_test_manager();
1.925.2.16  raeburn  4694:                     &Apache::lonhtmlcommon::clear_breadcrumbs();
1.925.2.14  raeburn  4695:                     &Apache::lonhtmlcommon::add_breadcrumb_tool(
                   4696:                                       'advtools',@advtools);
                   4697:                     my $advlinks;
                   4698:                     my $legendtext = '<a class="LC_menubuttons_link" href="/adm/menu">'.&mt('Management').'</a>';
                   4699:                     &Apache::lonhtmlcommon::render_advtools(\$advlinks,$legendtext);
                   4700:                     $bodytag .= $advlinks;
                   4701:                 }
1.920     raeburn  4702:             }
1.903     droeschl 4703:         }else{
                   4704:             # this is to seperate menu from content when there's no secondary
                   4705:             # menu. Especially needed for public accessible ressources.
                   4706:             $bodytag .= '<hr style="clear:both" />';
                   4707:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4708:         }
1.903     droeschl 4709: 
1.235     raeburn  4710:         return $bodytag;
1.94      www      4711:     }
1.95      www      4712: 
1.93      www      4713: #
1.95      www      4714: # Top frame rendering, Remote is up
1.93      www      4715: #
1.359     albertel 4716: 
1.517     raeburn  4717:     my $imgsrc = $img;
                   4718:     if ($img =~ /^\/adm/) {
1.575     albertel 4719:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4720:     }
                   4721:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4722: 
1.305     www      4723:     # Explicit link to get inline menu
1.361     albertel 4724:     my $menu= ($no_inline_link?''
1.883     droeschl 4725: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917     raeburn  4726: 
                   4727:     if ($dc_info) {
                   4728:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   4729:     }
                   4730: 
1.916     droeschl 4731:     $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897     wenzelju 4732:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4733:                 <li>$menu</li>
1.917     raeburn  4734:             </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94      www      4735:     return(<<ENDBODY);
1.60      matthew  4736: $bodytag
1.359     albertel 4737: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4738: <tr><td>$upperleft</td>
                   4739:     <td>$messages&nbsp;</td>
1.54      www      4740: </tr>
1.359     albertel 4741: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4742: </tr>
1.356     albertel 4743: </table>
1.54      www      4744: ENDBODY
1.182     matthew  4745: }
                   4746: 
1.925.2.14  raeburn  4747: sub concept_test_manager {
                   4748:     my @advtools;
                   4749:     my  %items = (
                   4750:                    docs => { 
                   4751:                               desc    => 'Edit Test',
                   4752:                               action  => "go('/adm/coursedocs')",
                   4753:                               tooltip => 'Assemble or modify Concept Test'
                   4754:                            },
                   4755:                    cprv => {
                   4756:                               desc => 'Enrollment/Activity',
                   4757:                               action => "go('/adm/createuser')",
                   4758:                               tooltip => 'Enrollment and student activity',
                   4759:                            },
                   4760:                    new => { 
                   4761:                               desc   => "What's New?",
                   4762:                               action => "go('/adm/whatsnew')",
                   4763:                               tooltip => 'Recent events/action items in Concept Test' ,
                   4764:                            },
                   4765:                    prnt => {
                   4766:                               desc => 'Print Test',
                   4767:                               action => "go('/adm/printout');",
                   4768:                               tooltip => 'Prepare printable Concept Test',
                   4769:                            },
                   4770:                    chrt => { 
                   4771:                               desc   => 'Test Statistics',
                   4772:                               action => "go('/adm/statistics');",
                   4773:                               tooltip => 'Concept Test Statistics',
                   4774:                            },
                   4775:                    rcrs => {
                   4776:                               desc   => 'Create New Test',
                   4777:                               action  => "switchpage('createtest');",
                   4778:                               tooltip => 'Create new Concept Test',
                   4779:                            },
                   4780:                  );
                   4781:     my @ordered = ('docs','cprv','new','prnt','chrt','rcrs');
                   4782:     foreach my $item (@ordered) {
                   4783:          push(@advtools,
                   4784:                   '<a title="'.$items{$item}{tooltip}.'" class="LC_menubuttons_link" href="javascript:'.
                   4785:                   $items{$item}{action}.';">'.
                   4786:                   '<img src="'.'/res/adm/pages/'.$item.'22.png" alt="'.$items{$item}{tooltip}.
                   4787:                   '" border="0" class="LC_icon" />'.
                   4788:                   '<span class="LC_menubuttons_inline_text">'.$items{$item}{desc}.'</span></a>');
                   4789:     }
                   4790:     return @advtools;
                   4791: }
                   4792: 
1.917     raeburn  4793: sub dc_courseid_toggle {
                   4794:     my ($dc_info) = @_;
                   4795:     return ' <span id="dccidtext" class="LC_cusr_subheading">'.
                   4796:            '<a href="javascript:showCourseID();">'.
                   4797:            &mt('(More ...)').'</a></span>'.
                   4798:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4799: }
                   4800: 
1.330     albertel 4801: sub make_attr_string {
                   4802:     my ($register,$attr_ref) = @_;
                   4803: 
                   4804:     if ($attr_ref && !ref($attr_ref)) {
                   4805: 	die("addentries Must be a hash ref ".
                   4806: 	    join(':',caller(1))." ".
                   4807: 	    join(':',caller(0))." ");
                   4808:     }
                   4809: 
                   4810:     if ($register) {
1.339     albertel 4811: 	my ($on_load,$on_unload);
                   4812: 	foreach my $key (keys(%{$attr_ref})) {
                   4813: 	    if      (lc($key) eq 'onload') {
                   4814: 		$on_load.=$attr_ref->{$key}.';';
                   4815: 		delete($attr_ref->{$key});
                   4816: 
                   4817: 	    } elsif (lc($key) eq 'onunload') {
                   4818: 		$on_unload.=$attr_ref->{$key}.';';
                   4819: 		delete($attr_ref->{$key});
                   4820: 	    }
                   4821: 	}
                   4822: 	$attr_ref->{'onload'}  =
                   4823: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4824: 	$attr_ref->{'onunload'}=
                   4825: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4826:     }
                   4827: 
                   4828: # Accessibility font enhance
                   4829:     if ($env{'browser.fontenhance'} eq 'on') {
                   4830: 	my $style;
                   4831: 	foreach my $key (keys(%{$attr_ref})) {
                   4832: 	    if (lc($key) eq 'style') {
                   4833: 		$style.=$attr_ref->{$key}.';';
                   4834: 		delete($attr_ref->{$key});
                   4835: 	    }
                   4836: 	}
                   4837: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4838:     }
1.339     albertel 4839: 
1.330     albertel 4840:     my $attr_string;
                   4841:     foreach my $attr (keys(%$attr_ref)) {
                   4842: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4843:     }
                   4844:     return $attr_string;
                   4845: }
                   4846: 
                   4847: 
1.182     matthew  4848: ###############################################
1.251     albertel 4849: ###############################################
                   4850: 
                   4851: =pod
                   4852: 
                   4853: =item * &endbodytag()
                   4854: 
                   4855: Returns a uniform footer for LON-CAPA web pages.
                   4856: 
1.635     raeburn  4857: Inputs: 1 - optional reference to an args hash
                   4858: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4859: a 'Continue' link is not displayed if the page contains an
                   4860: internal redirect in the <head></head> section,
                   4861: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4862: 
                   4863: =cut
                   4864: 
                   4865: sub endbodytag {
1.635     raeburn  4866:     my ($args) = @_;
1.251     albertel 4867:     my $endbodytag='</body>';
1.269     albertel 4868:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4869:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4870:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4871: 	    $endbodytag=
                   4872: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4873: 	        &mt('Continue').'</a>'.
                   4874: 	        $endbodytag;
                   4875:         }
1.315     albertel 4876:     }
1.251     albertel 4877:     return $endbodytag;
                   4878: }
                   4879: 
1.352     albertel 4880: =pod
                   4881: 
                   4882: =item * &standard_css()
                   4883: 
                   4884: Returns a style sheet
                   4885: 
                   4886: Inputs: (all optional)
                   4887:             domain         -> force to color decorate a page for a specific
                   4888:                                domain
                   4889:             function       -> force usage of a specific rolish color scheme
                   4890:             bgcolor        -> override the default page bgcolor
                   4891: 
                   4892: =cut
                   4893: 
1.343     albertel 4894: sub standard_css {
1.345     albertel 4895:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4896:     $function  = &get_users_function() if (!$function);
                   4897:     my $img    = &designparm($function.'.img',   $domain);
                   4898:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4899:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4900:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4901: #second colour for later usage
1.345     albertel 4902:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4903:     my $pgbg_or_bgcolor =
                   4904: 	         $bgcolor ||
1.352     albertel 4905: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4906:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4907:     my $alink  = &designparm($function.'.alink', $domain);
                   4908:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4909:     my $link   = &designparm($function.'.link',  $domain);
                   4910: 
1.704     muellerd 4911:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4912:     my $bgcol = &designparm('login.bgcol',$domain);
                   4913:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4914: 
1.602     albertel 4915:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4916:     my $mono                 = 'monospace';
1.850     bisitz   4917:     my $data_table_head      = $sidebg;
                   4918:     my $data_table_light     = '#FAFAFA';
                   4919:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4920:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4921:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4922:     my $mail_new             = '#FFBB77';
                   4923:     my $mail_new_hover       = '#DD9955';
                   4924:     my $mail_read            = '#BBBB77';
                   4925:     my $mail_read_hover      = '#999944';
                   4926:     my $mail_replied         = '#AAAA88';
                   4927:     my $mail_replied_hover   = '#888855';
                   4928:     my $mail_other           = '#99BBBB';
                   4929:     my $mail_other_hover     = '#669999';
1.391     albertel 4930:     my $table_header         = '#DDDDDD';
1.489     raeburn  4931:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4932:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4933: 
1.608     albertel 4934:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4935:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4936:                                              : '0 3px 0 4px';
1.448     albertel 4937: 
1.523     albertel 4938: 
1.343     albertel 4939:     return <<END;
1.795     www      4940: body {
1.911     bisitz   4941:   font-family: $sans;
                   4942:   line-height:130%;
                   4943:   font-size:0.83em;
                   4944:   color:$font;
1.795     www      4945: }
                   4946: 
1.911     bisitz   4947: a:focus {
1.795     www      4948:   color: red;
1.911     bisitz   4949:   background: yellow;
1.795     www      4950: }
1.698     harmsja  4951: 
1.911     bisitz   4952: form, .inline {
                   4953:   display: inline;
1.795     www      4954: }
1.721     harmsja  4955: 
1.795     www      4956: .LC_right {
1.911     bisitz   4957:   text-align:right;
1.795     www      4958: }
                   4959: 
                   4960: .LC_middle {
1.911     bisitz   4961:   vertical-align:middle;
1.795     www      4962: }
1.721     harmsja  4963: 
                   4964: /* just for tests */
1.911     bisitz   4965: .LC_400Box {
                   4966:   width:400px;
                   4967: }
1.721     harmsja  4968: /* end */
                   4969: 
1.778     bisitz   4970: .LC_filename {
                   4971:   font-family: $mono;
                   4972:   white-space:pre;
1.921     bisitz   4973:   font-size: 120%;
1.778     bisitz   4974: }
                   4975: 
                   4976: .LC_fileicon {
                   4977:   border: none;
                   4978:   height: 1.3em;
                   4979:   vertical-align: text-bottom;
                   4980:   margin-right: 0.3em;
                   4981:   text-decoration:none;
                   4982: }
                   4983: 
1.350     albertel 4984: .LC_error {
                   4985:   color: red;
                   4986:   font-size: larger;
                   4987: }
1.795     www      4988: 
1.457     albertel 4989: .LC_warning,
                   4990: .LC_diff_removed {
1.733     bisitz   4991:   color: red;
1.394     albertel 4992: }
1.532     albertel 4993: 
                   4994: .LC_info,
1.457     albertel 4995: .LC_success,
                   4996: .LC_diff_added {
1.350     albertel 4997:   color: green;
                   4998: }
1.795     www      4999: 
1.802     bisitz   5000: div.LC_confirm_box {
                   5001:   background-color: #FAFAFA;
                   5002:   border: 1px solid $lg_border_color;
                   5003:   margin-right: 0;
                   5004:   padding: 5px;
                   5005: }
                   5006: 
                   5007: div.LC_confirm_box .LC_error img,
                   5008: div.LC_confirm_box .LC_success img {
                   5009:   vertical-align: middle;
                   5010: }
                   5011: 
1.440     albertel 5012: .LC_icon {
1.771     droeschl 5013:   border: none;
1.790     droeschl 5014:   vertical-align: middle;
1.771     droeschl 5015: }
                   5016: 
1.543     albertel 5017: .LC_docs_spacer {
                   5018:   width: 25px;
                   5019:   height: 1px;
1.771     droeschl 5020:   border: none;
1.543     albertel 5021: }
1.346     albertel 5022: 
1.532     albertel 5023: .LC_internal_info {
1.735     bisitz   5024:   color: #999999;
1.532     albertel 5025: }
                   5026: 
1.794     www      5027: .LC_discussion {
1.911     bisitz   5028:   background: $tabbg;
                   5029:   border: 1px solid black;
                   5030:   margin: 2px;
1.794     www      5031: }
                   5032: 
                   5033: .LC_disc_action_links_bar {
1.911     bisitz   5034:   background: $tabbg;
                   5035:   border: none;
                   5036:   margin: 4px;
1.794     www      5037: }
                   5038: 
                   5039: .LC_disc_action_left {
1.911     bisitz   5040:   text-align: left;
1.794     www      5041: }
                   5042: 
                   5043: .LC_disc_action_right {
1.911     bisitz   5044:   text-align: right;
1.794     www      5045: }
                   5046: 
                   5047: .LC_disc_new_item {
1.911     bisitz   5048:   background: white;
                   5049:   border: 2px solid red;
                   5050:   margin: 2px;
1.794     www      5051: }
                   5052: 
                   5053: .LC_disc_old_item {
1.911     bisitz   5054:   background: white;
                   5055:   border: 1px solid black;
                   5056:   margin: 2px;
1.794     www      5057: }
                   5058: 
1.458     albertel 5059: table.LC_pastsubmission {
                   5060:   border: 1px solid black;
                   5061:   margin: 2px;
                   5062: }
                   5063: 
1.924     bisitz   5064: table#LC_menubuttons {
1.345     albertel 5065:   width: 100%;
                   5066:   background: $pgbg;
1.392     albertel 5067:   border: 2px;
1.402     albertel 5068:   border-collapse: separate;
1.803     bisitz   5069:   padding: 0;
1.345     albertel 5070: }
1.392     albertel 5071: 
1.801     tempelho 5072: table#LC_title_bar a {
                   5073:   color: $fontmenu;
                   5074: }
1.836     bisitz   5075: 
1.807     droeschl 5076: table#LC_title_bar {
1.819     tempelho 5077:   clear: both;
1.836     bisitz   5078:   display: none;
1.807     droeschl 5079: }
                   5080: 
1.795     www      5081: table#LC_title_bar,
                   5082: table.LC_breadcrumbs,
1.393     albertel 5083: table#LC_title_bar.LC_with_remote {
1.359     albertel 5084:   width: 100%;
1.392     albertel 5085:   border-color: $pgbg;
                   5086:   border-style: solid;
                   5087:   border-width: $border;
1.379     albertel 5088:   background: $pgbg;
1.801     tempelho 5089:   color: $fontmenu;
1.392     albertel 5090:   border-collapse: collapse;
1.803     bisitz   5091:   padding: 0;
1.819     tempelho 5092:   margin: 0;
1.359     albertel 5093: }
1.795     www      5094: 
1.925.2.14  raeburn  5095: ul.LC_breadcrumb_tools_outerlist {
                   5096:     margin: 0;
                   5097:     padding: 0;
                   5098:     position: relative;
                   5099:     list-style: none;
                   5100: }
                   5101: ul.LC_breadcrumb_tools_outerlist li {
                   5102:     display: inline;
                   5103: }
                   5104: 
                   5105: .LC_breadcrumb_tools_navigation {
                   5106:     padding: 0;
                   5107:     margin: 0;
                   5108:     float: left;
                   5109: }
                   5110: .LC_breadcrumb_tools_tools {
                   5111:     padding: 0;
                   5112:     margin: 0;
                   5113:     float: right;
                   5114: }
                   5115: 
                   5116: div.LC_GCI_Menu {
                   5117:     width:900px;
                   5118: }
                   5119: 
                   5120: div.LC_GCI_Menu:after {
                   5121:     content:'';
                   5122:     display:block;
                   5123:     clear:both;
                   5124: }
                   5125: 
                   5126: div.LC_GCI_Menu_left {
                   5127:     float:left;
                   5128:     width:400px;
                   5129: }
                   5130: 
                   5131: div.LC_GCI_Menu_right {
                   5132:     float:left;
                   5133:     width:400px;;
                   5134: }
                   5135: 
1.925.2.13  raeburn  5136: dl.LC_GCI_Menu {
                   5137:     width:300px;
                   5138:     float:left;
                   5139:     margin-right:2em;
                   5140: }
                   5141: 
                   5142: dl.LC_GCI_Menu dt {
                   5143:     font-weight: bold;
                   5144:     font-size:0.9em;
                   5145:     margin-bottom:0.7em;
                   5146: }
                   5147: 
1.925.2.14  raeburn  5148: dl.LC_GCI_Menu dt a {
                   5149:     color: $font;
                   5150: }
                   5151: 
1.925.2.13  raeburn  5152: dl.LC_GCI_Menu dd {
                   5153:     font-size:0.8em;
                   5154:     margin:0 0 2em 0;
                   5155:     padding-left:4.5em;
                   5156:     line-height:1.5em;
                   5157:     background:none no-repeat left top;
                   5158: }
                   5159: 
1.359     albertel 5160: table#LC_title_bar td {
                   5161:   background: $tabbg;
                   5162: }
1.795     www      5163: 
1.911     bisitz   5164: table#LC_menubuttons img {
1.803     bisitz   5165:   border: none;
1.346     albertel 5166: }
1.795     www      5167: 
1.842     droeschl 5168: .LC_breadcrumbs_component {
1.911     bisitz   5169:   float: right;
1.925.2.14  raeburn  5170:   margin: 0.25em 1em;
1.357     albertel 5171: }
1.842     droeschl 5172: .LC_breadcrumbs_component img {
1.911     bisitz   5173:   vertical-align: middle;
1.777     tempelho 5174: }
1.795     www      5175: 
1.383     albertel 5176: td.LC_table_cell_checkbox {
                   5177:   text-align: center;
                   5178: }
1.795     www      5179: 
                   5180: .LC_fontsize_small {
1.911     bisitz   5181:   font-size: 70%;
1.705     tempelho 5182: }
                   5183: 
1.844     bisitz   5184: #LC_breadcrumbs {
1.911     bisitz   5185:   clear:both;
                   5186:   background: $sidebg;
                   5187:   border-bottom: 1px solid $lg_border_color;
                   5188:   line-height: 2.5em;
1.925.2.14  raeburn  5189:   overflow: hidden;
1.911     bisitz   5190:   margin: 0;
                   5191:   padding: 0;
1.925.2.14  raeburn  5192:   text-align: left;
1.819     tempelho 5193: }
1.862     bisitz   5194: 
1.839     droeschl 5195: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5196: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5197:   display:none;
1.839     droeschl 5198: }
1.819     tempelho 5199: 
1.844     bisitz   5200: #LC_head_subbox {
1.911     bisitz   5201:   clear:both;
                   5202:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5203:   border: 1px solid $sidebg;
1.925.2.14  raeburn  5204:   margin: 0 0 0 0;      
1.822     bisitz   5205: }
                   5206: 
1.795     www      5207: .LC_fontsize_medium {
1.911     bisitz   5208:   font-size: 85%;
1.705     tempelho 5209: }
                   5210: 
1.795     www      5211: .LC_fontsize_large {
1.911     bisitz   5212:   font-size: 120%;
1.705     tempelho 5213: }
                   5214: 
1.346     albertel 5215: .LC_menubuttons_inline_text {
                   5216:   color: $font;
1.698     harmsja  5217:   font-size: 90%;
1.701     harmsja  5218:   padding-left:3px;
1.346     albertel 5219: }
                   5220: 
1.526     www      5221: .LC_menubuttons_link {
                   5222:   text-decoration: none;
                   5223: }
1.795     www      5224: 
1.522     albertel 5225: .LC_menubuttons_category {
1.521     www      5226:   color: $font;
1.526     www      5227:   background: $pgbg;
1.521     www      5228:   font-size: larger;
                   5229:   font-weight: bold;
                   5230: }
                   5231: 
1.346     albertel 5232: td.LC_menubuttons_text {
1.911     bisitz   5233:   color: $font;
1.346     albertel 5234: }
1.706     harmsja  5235: 
1.346     albertel 5236: .LC_current_location {
                   5237:   background: $tabbg;
                   5238: }
1.795     www      5239: 
                   5240: table.LC_data_table,
                   5241: table.LC_mail_list {
1.347     albertel 5242:   border: 1px solid #000000;
1.402     albertel 5243:   border-collapse: separate;
1.426     albertel 5244:   border-spacing: 1px;
1.610     albertel 5245:   background: $pgbg;
1.347     albertel 5246: }
1.795     www      5247: 
1.422     albertel 5248: .LC_data_table_dense {
                   5249:   font-size: small;
                   5250: }
1.795     www      5251: 
1.507     raeburn  5252: table.LC_nested_outer {
                   5253:   border: 1px solid #000000;
1.589     raeburn  5254:   border-collapse: collapse;
1.803     bisitz   5255:   border-spacing: 0;
1.507     raeburn  5256:   width: 100%;
                   5257: }
1.795     www      5258: 
1.879     raeburn  5259: table.LC_innerpickbox,
1.507     raeburn  5260: table.LC_nested {
1.803     bisitz   5261:   border: none;
1.589     raeburn  5262:   border-collapse: collapse;
1.803     bisitz   5263:   border-spacing: 0;
1.507     raeburn  5264:   width: 100%;
                   5265: }
1.795     www      5266: 
1.911     bisitz   5267: table.LC_data_table tr th,
                   5268: table.LC_calendar tr th,
1.795     www      5269: table.LC_mail_list tr th,
1.879     raeburn  5270: table.LC_prior_tries tr th,
                   5271: table.LC_innerpickbox tr th {
1.349     albertel 5272:   font-weight: bold;
                   5273:   background-color: $data_table_head;
1.801     tempelho 5274:   color:$fontmenu;
1.701     harmsja  5275:   font-size:90%;
1.347     albertel 5276: }
1.795     www      5277: 
1.879     raeburn  5278: table.LC_innerpickbox tr th,
                   5279: table.LC_innerpickbox tr td {
                   5280:   vertical-align: top;
                   5281: }
                   5282: 
1.711     raeburn  5283: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5284:   background-color: #CCCCCC;
1.711     raeburn  5285:   font-weight: bold;
                   5286:   text-align: left;
                   5287: }
1.795     www      5288: 
1.912     bisitz   5289: table.LC_data_table tr.LC_odd_row > td {
                   5290:   background-color: $data_table_light;
                   5291:   padding: 2px;
                   5292:   vertical-align: top;
                   5293: }
                   5294: 
1.809     bisitz   5295: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5296:   background-color: $data_table_light;
1.912     bisitz   5297:   vertical-align: top;
                   5298: }
                   5299: 
                   5300: table.LC_data_table tr.LC_even_row > td {
                   5301:   background-color: $data_table_dark;
1.425     albertel 5302:   padding: 2px;
1.900     bisitz   5303:   vertical-align: top;
1.347     albertel 5304: }
1.795     www      5305: 
1.809     bisitz   5306: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5307:   background-color: $data_table_dark;
1.900     bisitz   5308:   vertical-align: top;
1.347     albertel 5309: }
1.795     www      5310: 
1.425     albertel 5311: table.LC_data_table tr.LC_data_table_highlight td {
                   5312:   background-color: $data_table_darker;
                   5313: }
1.795     www      5314: 
1.639     raeburn  5315: table.LC_data_table tr td.LC_leftcol_header {
                   5316:   background-color: $data_table_head;
                   5317:   font-weight: bold;
                   5318: }
1.795     www      5319: 
1.451     albertel 5320: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5321: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5322:   background-color: #FFFFFF;
1.421     albertel 5323:   font-weight: bold;
                   5324:   font-style: italic;
                   5325:   text-align: center;
                   5326:   padding: 8px;
1.347     albertel 5327: }
1.795     www      5328: 
1.890     droeschl 5329: table.LC_caption {
                   5330: }
                   5331: 
1.507     raeburn  5332: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5333:   padding: 4ex
                   5334: }
1.795     www      5335: 
1.507     raeburn  5336: table.LC_nested_outer tr th {
                   5337:   font-weight: bold;
1.801     tempelho 5338:   color:$fontmenu;
1.507     raeburn  5339:   background-color: $data_table_head;
1.701     harmsja  5340:   font-size: small;
1.507     raeburn  5341:   border-bottom: 1px solid #000000;
                   5342: }
1.795     www      5343: 
1.507     raeburn  5344: table.LC_nested_outer tr td.LC_subheader {
                   5345:   background-color: $data_table_head;
                   5346:   font-weight: bold;
                   5347:   font-size: small;
                   5348:   border-bottom: 1px solid #000000;
                   5349:   text-align: right;
1.451     albertel 5350: }
1.795     www      5351: 
1.507     raeburn  5352: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5353:   background-color: #CCCCCC;
1.451     albertel 5354:   font-weight: bold;
                   5355:   font-size: small;
1.507     raeburn  5356:   text-align: center;
                   5357: }
1.795     www      5358: 
1.589     raeburn  5359: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5360: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5361:   text-align: left;
1.451     albertel 5362: }
1.795     www      5363: 
1.507     raeburn  5364: table.LC_nested td {
1.735     bisitz   5365:   background-color: #FFFFFF;
1.451     albertel 5366:   font-size: small;
1.507     raeburn  5367: }
1.795     www      5368: 
1.507     raeburn  5369: table.LC_nested_outer tr th.LC_right_item,
                   5370: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5371: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5372: table.LC_nested tr td.LC_right_item {
1.451     albertel 5373:   text-align: right;
                   5374: }
                   5375: 
1.507     raeburn  5376: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5377:   background-color: #EEEEEE;
1.451     albertel 5378: }
                   5379: 
1.473     raeburn  5380: table.LC_createuser {
                   5381: }
                   5382: 
                   5383: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5384:   font-size: small;
1.473     raeburn  5385: }
                   5386: 
                   5387: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5388:   background-color: #CCCCCC;
1.473     raeburn  5389:   font-weight: bold;
                   5390:   text-align: center;
                   5391: }
                   5392: 
1.349     albertel 5393: table.LC_calendar {
                   5394:   border: 1px solid #000000;
                   5395:   border-collapse: collapse;
1.917     raeburn  5396:   width: 98%;
1.349     albertel 5397: }
1.795     www      5398: 
1.349     albertel 5399: table.LC_calendar_pickdate {
                   5400:   font-size: xx-small;
                   5401: }
1.795     www      5402: 
1.349     albertel 5403: table.LC_calendar tr td {
                   5404:   border: 1px solid #000000;
                   5405:   vertical-align: top;
1.917     raeburn  5406:   width: 14%;
1.349     albertel 5407: }
1.795     www      5408: 
1.349     albertel 5409: table.LC_calendar tr td.LC_calendar_day_empty {
                   5410:   background-color: $data_table_dark;
                   5411: }
1.795     www      5412: 
1.779     bisitz   5413: table.LC_calendar tr td.LC_calendar_day_current {
                   5414:   background-color: $data_table_highlight;
1.777     tempelho 5415: }
1.795     www      5416: 
1.349     albertel 5417: table.LC_mail_list tr.LC_mail_new {
                   5418:   background-color: $mail_new;
                   5419: }
1.795     www      5420: 
1.349     albertel 5421: table.LC_mail_list tr.LC_mail_new:hover {
                   5422:   background-color: $mail_new_hover;
                   5423: }
1.795     www      5424: 
1.349     albertel 5425: table.LC_mail_list tr.LC_mail_read {
                   5426:   background-color: $mail_read;
                   5427: }
1.795     www      5428: 
1.349     albertel 5429: table.LC_mail_list tr.LC_mail_read:hover {
                   5430:   background-color: $mail_read_hover;
                   5431: }
1.795     www      5432: 
1.349     albertel 5433: table.LC_mail_list tr.LC_mail_replied {
                   5434:   background-color: $mail_replied;
                   5435: }
1.795     www      5436: 
1.349     albertel 5437: table.LC_mail_list tr.LC_mail_replied:hover {
                   5438:   background-color: $mail_replied_hover;
                   5439: }
1.795     www      5440: 
1.349     albertel 5441: table.LC_mail_list tr.LC_mail_other {
                   5442:   background-color: $mail_other;
                   5443: }
1.795     www      5444: 
1.349     albertel 5445: table.LC_mail_list tr.LC_mail_other:hover {
                   5446:   background-color: $mail_other_hover;
                   5447: }
1.494     raeburn  5448: 
1.777     tempelho 5449: table.LC_data_table tr > td.LC_browser_file,
                   5450: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5451:   background: #AAEE77;
1.389     albertel 5452: }
1.795     www      5453: 
1.777     tempelho 5454: table.LC_data_table tr > td.LC_browser_file_locked,
                   5455: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5456:   background: #FFAA99;
1.387     albertel 5457: }
1.795     www      5458: 
1.777     tempelho 5459: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5460:   background: #888888;
1.779     bisitz   5461: }
1.795     www      5462: 
1.777     tempelho 5463: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5464: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5465:   background: #F8F866;
1.777     tempelho 5466: }
1.795     www      5467: 
1.696     bisitz   5468: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5469:   background: #E0E8FF;
1.387     albertel 5470: }
1.696     bisitz   5471: 
1.707     bisitz   5472: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5473:   /* background: #77FF77; */
1.707     bisitz   5474: }
1.795     www      5475: 
1.707     bisitz   5476: table.LC_data_table tr > td.LC_roles_future {
                   5477:   background: #FFFF77;
                   5478: }
1.795     www      5479: 
1.707     bisitz   5480: table.LC_data_table tr > td.LC_roles_will {
                   5481:   background: #FFAA77;
                   5482: }
1.795     www      5483: 
1.707     bisitz   5484: table.LC_data_table tr > td.LC_roles_expired {
                   5485:   background: #FF7777;
                   5486: }
1.795     www      5487: 
1.707     bisitz   5488: table.LC_data_table tr > td.LC_roles_will_not {
                   5489:   background: #AAFF77;
                   5490: }
1.795     www      5491: 
1.707     bisitz   5492: table.LC_data_table tr > td.LC_roles_selected {
                   5493:   background: #11CC55;
                   5494: }
                   5495: 
1.388     albertel 5496: span.LC_current_location {
1.701     harmsja  5497:   font-size:larger;
1.388     albertel 5498:   background: $pgbg;
                   5499: }
1.387     albertel 5500: 
1.395     albertel 5501: span.LC_parm_menu_item {
                   5502:   font-size: larger;
                   5503: }
1.795     www      5504: 
1.395     albertel 5505: span.LC_parm_scope_all {
                   5506:   color: red;
                   5507: }
1.795     www      5508: 
1.395     albertel 5509: span.LC_parm_scope_folder {
                   5510:   color: green;
                   5511: }
1.795     www      5512: 
1.395     albertel 5513: span.LC_parm_scope_resource {
                   5514:   color: orange;
                   5515: }
1.795     www      5516: 
1.395     albertel 5517: span.LC_parm_part {
                   5518:   color: blue;
                   5519: }
1.795     www      5520: 
1.911     bisitz   5521: span.LC_parm_folder,
                   5522: span.LC_parm_symb {
1.395     albertel 5523:   font-size: x-small;
                   5524:   font-family: $mono;
                   5525:   color: #AAAAAA;
                   5526: }
                   5527: 
1.795     www      5528: td.LC_parm_overview_level_menu,
                   5529: td.LC_parm_overview_map_menu,
                   5530: td.LC_parm_overview_parm_selectors,
                   5531: td.LC_parm_overview_restrictions  {
1.396     albertel 5532:   border: 1px solid black;
                   5533:   border-collapse: collapse;
                   5534: }
1.795     www      5535: 
1.396     albertel 5536: table.LC_parm_overview_restrictions td {
                   5537:   border-width: 1px 4px 1px 4px;
                   5538:   border-style: solid;
                   5539:   border-color: $pgbg;
                   5540:   text-align: center;
                   5541: }
1.795     www      5542: 
1.396     albertel 5543: table.LC_parm_overview_restrictions th {
                   5544:   background: $tabbg;
                   5545:   border-width: 1px 4px 1px 4px;
                   5546:   border-style: solid;
                   5547:   border-color: $pgbg;
                   5548: }
1.795     www      5549: 
1.398     albertel 5550: table#LC_helpmenu {
1.803     bisitz   5551:   border: none;
1.398     albertel 5552:   height: 55px;
1.803     bisitz   5553:   border-spacing: 0;
1.398     albertel 5554: }
                   5555: 
                   5556: table#LC_helpmenu fieldset legend {
                   5557:   font-size: larger;
                   5558: }
1.795     www      5559: 
1.397     albertel 5560: table#LC_helpmenu_links {
                   5561:   width: 100%;
                   5562:   border: 1px solid black;
                   5563:   background: $pgbg;
1.803     bisitz   5564:   padding: 0;
1.397     albertel 5565:   border-spacing: 1px;
                   5566: }
1.795     www      5567: 
1.397     albertel 5568: table#LC_helpmenu_links tr td {
                   5569:   padding: 1px;
                   5570:   background: $tabbg;
1.399     albertel 5571:   text-align: center;
                   5572:   font-weight: bold;
1.397     albertel 5573: }
1.396     albertel 5574: 
1.795     www      5575: table#LC_helpmenu_links a:link,
                   5576: table#LC_helpmenu_links a:visited,
1.397     albertel 5577: table#LC_helpmenu_links a:active {
                   5578:   text-decoration: none;
                   5579:   color: $font;
                   5580: }
1.795     www      5581: 
1.397     albertel 5582: table#LC_helpmenu_links a:hover {
                   5583:   text-decoration: underline;
                   5584:   color: $vlink;
                   5585: }
1.396     albertel 5586: 
1.417     albertel 5587: .LC_chrt_popup_exists {
                   5588:   border: 1px solid #339933;
                   5589:   margin: -1px;
                   5590: }
1.795     www      5591: 
1.417     albertel 5592: .LC_chrt_popup_up {
                   5593:   border: 1px solid yellow;
                   5594:   margin: -1px;
                   5595: }
1.795     www      5596: 
1.417     albertel 5597: .LC_chrt_popup {
                   5598:   border: 1px solid #8888FF;
                   5599:   background: #CCCCFF;
                   5600: }
1.795     www      5601: 
1.421     albertel 5602: table.LC_pick_box {
                   5603:   border-collapse: separate;
                   5604:   background: white;
                   5605:   border: 1px solid black;
                   5606:   border-spacing: 1px;
                   5607: }
1.795     www      5608: 
1.421     albertel 5609: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5610:   background: $sidebg;
1.421     albertel 5611:   font-weight: bold;
1.900     bisitz   5612:   text-align: left;
1.740     bisitz   5613:   vertical-align: top;
1.421     albertel 5614:   width: 184px;
                   5615:   padding: 8px;
                   5616: }
1.795     www      5617: 
1.579     raeburn  5618: table.LC_pick_box td.LC_pick_box_value {
                   5619:   text-align: left;
                   5620:   padding: 8px;
                   5621: }
1.795     www      5622: 
1.579     raeburn  5623: table.LC_pick_box td.LC_pick_box_select {
                   5624:   text-align: left;
                   5625:   padding: 8px;
                   5626: }
1.795     www      5627: 
1.424     albertel 5628: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5629:   padding: 0;
1.421     albertel 5630:   height: 1px;
                   5631:   background: black;
                   5632: }
1.795     www      5633: 
1.421     albertel 5634: table.LC_pick_box td.LC_pick_box_submit {
                   5635:   text-align: right;
                   5636: }
1.795     www      5637: 
1.579     raeburn  5638: table.LC_pick_box td.LC_evenrow_value {
                   5639:   text-align: left;
                   5640:   padding: 8px;
                   5641:   background-color: $data_table_light;
                   5642: }
1.795     www      5643: 
1.579     raeburn  5644: table.LC_pick_box td.LC_oddrow_value {
                   5645:   text-align: left;
                   5646:   padding: 8px;
                   5647:   background-color: $data_table_light;
                   5648: }
1.795     www      5649: 
1.579     raeburn  5650: span.LC_helpform_receipt_cat {
                   5651:   font-weight: bold;
                   5652: }
1.795     www      5653: 
1.424     albertel 5654: table.LC_group_priv_box {
                   5655:   background: white;
                   5656:   border: 1px solid black;
                   5657:   border-spacing: 1px;
                   5658: }
1.795     www      5659: 
1.424     albertel 5660: table.LC_group_priv_box td.LC_pick_box_title {
                   5661:   background: $tabbg;
                   5662:   font-weight: bold;
                   5663:   text-align: right;
                   5664:   width: 184px;
                   5665: }
1.795     www      5666: 
1.424     albertel 5667: table.LC_group_priv_box td.LC_groups_fixed {
                   5668:   background: $data_table_light;
                   5669:   text-align: center;
                   5670: }
1.795     www      5671: 
1.424     albertel 5672: table.LC_group_priv_box td.LC_groups_optional {
                   5673:   background: $data_table_dark;
                   5674:   text-align: center;
                   5675: }
1.795     www      5676: 
1.424     albertel 5677: table.LC_group_priv_box td.LC_groups_functionality {
                   5678:   background: $data_table_darker;
                   5679:   text-align: center;
                   5680:   font-weight: bold;
                   5681: }
1.795     www      5682: 
1.424     albertel 5683: table.LC_group_priv td {
                   5684:   text-align: left;
1.803     bisitz   5685:   padding: 0;
1.424     albertel 5686: }
                   5687: 
1.421     albertel 5688: table.LC_notify_front_page {
                   5689:   background: white;
                   5690:   border: 1px solid black;
                   5691:   padding: 8px;
                   5692: }
1.795     www      5693: 
1.421     albertel 5694: table.LC_notify_front_page td {
                   5695:   padding: 8px;
                   5696: }
1.795     www      5697: 
1.424     albertel 5698: .LC_navbuttons {
                   5699:   margin: 2ex 0ex 2ex 0ex;
                   5700: }
1.795     www      5701: 
1.423     albertel 5702: .LC_topic_bar {
                   5703:   font-weight: bold;
                   5704:   background: $tabbg;
1.918     wenzelju 5705:   margin: 1em 0em 1em 2em;
1.805     bisitz   5706:   padding: 3px;
1.918     wenzelju 5707:   font-size: 1.2em;
1.423     albertel 5708: }
1.795     www      5709: 
1.423     albertel 5710: .LC_topic_bar span {
1.918     wenzelju 5711:   left: 0.5em;
                   5712:   position: absolute;
1.423     albertel 5713:   vertical-align: middle;
1.918     wenzelju 5714:   font-size: 1.2em;
1.423     albertel 5715: }
1.795     www      5716: 
1.423     albertel 5717: .LC_topic_bar img {
                   5718:   vertical-align: bottom;
                   5719: }
1.795     www      5720: 
1.423     albertel 5721: table.LC_course_group_status {
                   5722:   margin: 20px;
                   5723: }
1.795     www      5724: 
1.423     albertel 5725: table.LC_status_selector td {
                   5726:   vertical-align: top;
                   5727:   text-align: center;
1.424     albertel 5728:   padding: 4px;
                   5729: }
1.795     www      5730: 
1.599     albertel 5731: div.LC_feedback_link {
1.616     albertel 5732:   clear: both;
1.829     kalberla 5733:   background: $sidebg;
1.779     bisitz   5734:   width: 100%;
1.829     kalberla 5735:   padding-bottom: 10px;
                   5736:   border: 1px $tabbg solid;
1.833     kalberla 5737:   height: 22px;
                   5738:   line-height: 22px;
                   5739:   padding-top: 5px;
                   5740: }
                   5741: 
                   5742: div.LC_feedback_link img {
                   5743:   height: 22px;
1.867     kalberla 5744:   vertical-align:middle;
1.829     kalberla 5745: }
                   5746: 
1.911     bisitz   5747: div.LC_feedback_link a {
1.829     kalberla 5748:   text-decoration: none;
1.489     raeburn  5749: }
1.795     www      5750: 
1.867     kalberla 5751: div.LC_comblock {
1.911     bisitz   5752:   display:inline;
1.867     kalberla 5753:   color:$font;
                   5754:   font-size:90%;
                   5755: }
                   5756: 
                   5757: div.LC_feedback_link div.LC_comblock {
                   5758:   padding-left:5px;
                   5759: }
                   5760: 
                   5761: div.LC_feedback_link div.LC_comblock a {
                   5762:   color:$font;
                   5763: }
                   5764: 
1.489     raeburn  5765: span.LC_feedback_link {
1.858     bisitz   5766:   /* background: $feedback_link_bg; */
1.599     albertel 5767:   font-size: larger;
                   5768: }
1.795     www      5769: 
1.599     albertel 5770: span.LC_message_link {
1.858     bisitz   5771:   /* background: $feedback_link_bg; */
1.599     albertel 5772:   font-size: larger;
                   5773:   position: absolute;
                   5774:   right: 1em;
1.489     raeburn  5775: }
1.421     albertel 5776: 
1.515     albertel 5777: table.LC_prior_tries {
1.524     albertel 5778:   border: 1px solid #000000;
                   5779:   border-collapse: separate;
                   5780:   border-spacing: 1px;
1.515     albertel 5781: }
1.523     albertel 5782: 
1.515     albertel 5783: table.LC_prior_tries td {
1.524     albertel 5784:   padding: 2px;
1.515     albertel 5785: }
1.523     albertel 5786: 
                   5787: .LC_answer_correct {
1.795     www      5788:   background: lightgreen;
                   5789:   color: darkgreen;
                   5790:   padding: 6px;
1.523     albertel 5791: }
1.795     www      5792: 
1.523     albertel 5793: .LC_answer_charged_try {
1.797     www      5794:   background: #FFAAAA;
1.795     www      5795:   color: darkred;
                   5796:   padding: 6px;
1.523     albertel 5797: }
1.795     www      5798: 
1.779     bisitz   5799: .LC_answer_not_charged_try,
1.523     albertel 5800: .LC_answer_no_grade,
                   5801: .LC_answer_late {
1.795     www      5802:   background: lightyellow;
1.523     albertel 5803:   color: black;
1.795     www      5804:   padding: 6px;
1.523     albertel 5805: }
1.795     www      5806: 
1.523     albertel 5807: .LC_answer_previous {
1.795     www      5808:   background: lightblue;
                   5809:   color: darkblue;
                   5810:   padding: 6px;
1.523     albertel 5811: }
1.795     www      5812: 
1.779     bisitz   5813: .LC_answer_no_message {
1.777     tempelho 5814:   background: #FFFFFF;
                   5815:   color: black;
1.795     www      5816:   padding: 6px;
1.779     bisitz   5817: }
1.795     www      5818: 
1.779     bisitz   5819: .LC_answer_unknown {
                   5820:   background: orange;
                   5821:   color: black;
1.795     www      5822:   padding: 6px;
1.777     tempelho 5823: }
1.795     www      5824: 
1.529     albertel 5825: span.LC_prior_numerical,
                   5826: span.LC_prior_string,
                   5827: span.LC_prior_custom,
                   5828: span.LC_prior_reaction,
                   5829: span.LC_prior_math {
1.925     bisitz   5830:   font-family: $mono;
1.523     albertel 5831:   white-space: pre;
                   5832: }
                   5833: 
1.525     albertel 5834: span.LC_prior_string {
1.925     bisitz   5835:   font-family: $mono;
1.525     albertel 5836:   white-space: pre;
                   5837: }
                   5838: 
1.523     albertel 5839: table.LC_prior_option {
                   5840:   width: 100%;
                   5841:   border-collapse: collapse;
                   5842: }
1.795     www      5843: 
1.911     bisitz   5844: table.LC_prior_rank,
1.795     www      5845: table.LC_prior_match {
1.528     albertel 5846:   border-collapse: collapse;
                   5847: }
1.795     www      5848: 
1.528     albertel 5849: table.LC_prior_option tr td,
                   5850: table.LC_prior_rank tr td,
                   5851: table.LC_prior_match tr td {
1.524     albertel 5852:   border: 1px solid #000000;
1.515     albertel 5853: }
                   5854: 
1.855     bisitz   5855: .LC_nobreak {
1.544     albertel 5856:   white-space: nowrap;
1.519     raeburn  5857: }
                   5858: 
1.576     raeburn  5859: span.LC_cusr_emph {
                   5860:   font-style: italic;
                   5861: }
                   5862: 
1.633     raeburn  5863: span.LC_cusr_subheading {
                   5864:   font-weight: normal;
                   5865:   font-size: 85%;
                   5866: }
                   5867: 
1.861     bisitz   5868: div.LC_docs_entry_move {
1.859     bisitz   5869:   border: 1px solid #BBBBBB;
1.545     albertel 5870:   background: #DDDDDD;
1.861     bisitz   5871:   width: 22px;
1.859     bisitz   5872:   padding: 1px;
                   5873:   margin: 0;
1.545     albertel 5874: }
                   5875: 
1.861     bisitz   5876: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5877: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5878:   background: #DDDDDD;
                   5879:   font-size: x-small;
                   5880: }
1.795     www      5881: 
1.861     bisitz   5882: .LC_docs_entry_parameter {
                   5883:   white-space: nowrap;
                   5884: }
                   5885: 
1.544     albertel 5886: .LC_docs_copy {
1.545     albertel 5887:   color: #000099;
1.544     albertel 5888: }
1.795     www      5889: 
1.544     albertel 5890: .LC_docs_cut {
1.545     albertel 5891:   color: #550044;
1.544     albertel 5892: }
1.795     www      5893: 
1.544     albertel 5894: .LC_docs_rename {
1.545     albertel 5895:   color: #009900;
1.544     albertel 5896: }
1.795     www      5897: 
1.544     albertel 5898: .LC_docs_remove {
1.545     albertel 5899:   color: #990000;
                   5900: }
                   5901: 
1.547     albertel 5902: .LC_docs_reinit_warn,
                   5903: .LC_docs_ext_edit {
                   5904:   font-size: x-small;
                   5905: }
                   5906: 
1.545     albertel 5907: table.LC_docs_adddocs td,
                   5908: table.LC_docs_adddocs th {
                   5909:   border: 1px solid #BBBBBB;
                   5910:   padding: 4px;
                   5911:   background: #DDDDDD;
1.543     albertel 5912: }
                   5913: 
1.584     albertel 5914: table.LC_sty_begin {
                   5915:   background: #BBFFBB;
                   5916: }
1.795     www      5917: 
1.584     albertel 5918: table.LC_sty_end {
                   5919:   background: #FFBBBB;
                   5920: }
                   5921: 
1.589     raeburn  5922: table.LC_double_column {
1.803     bisitz   5923:   border-width: 0;
1.589     raeburn  5924:   border-collapse: collapse;
                   5925:   width: 100%;
                   5926:   padding: 2px;
                   5927: }
                   5928: 
                   5929: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5930:   top: 2px;
1.589     raeburn  5931:   left: 2px;
                   5932:   width: 47%;
                   5933:   vertical-align: top;
                   5934: }
                   5935: 
                   5936: table.LC_double_column tr td.LC_right_col {
                   5937:   top: 2px;
1.779     bisitz   5938:   right: 2px;
1.589     raeburn  5939:   width: 47%;
                   5940:   vertical-align: top;
                   5941: }
                   5942: 
1.591     raeburn  5943: div.LC_left_float {
                   5944:   float: left;
                   5945:   padding-right: 5%;
1.597     albertel 5946:   padding-bottom: 4px;
1.591     raeburn  5947: }
                   5948: 
                   5949: div.LC_clear_float_header {
1.597     albertel 5950:   padding-bottom: 2px;
1.591     raeburn  5951: }
                   5952: 
                   5953: div.LC_clear_float_footer {
1.597     albertel 5954:   padding-top: 10px;
1.591     raeburn  5955:   clear: both;
                   5956: }
                   5957: 
1.597     albertel 5958: div.LC_grade_show_user {
                   5959:   margin-top: 20px;
                   5960:   border: 1px solid black;
                   5961: }
1.795     www      5962: 
1.597     albertel 5963: div.LC_grade_user_name {
                   5964:   background: #DDDDEE;
                   5965:   border-bottom: 1px solid black;
1.705     tempelho 5966:   font-weight: bold;
                   5967:   font-size: large;
1.597     albertel 5968: }
1.795     www      5969: 
1.597     albertel 5970: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5971:   background: #DDEEDD;
                   5972: }
                   5973: 
                   5974: div.LC_grade_show_problem,
                   5975: div.LC_grade_submissions,
                   5976: div.LC_grade_message_center,
                   5977: div.LC_grade_info_links,
                   5978: div.LC_grade_assign {
                   5979:   margin: 5px;
                   5980:   width: 99%;
                   5981:   background: #FFFFFF;
                   5982: }
1.795     www      5983: 
1.597     albertel 5984: div.LC_grade_show_problem_header,
                   5985: div.LC_grade_submissions_header,
                   5986: div.LC_grade_message_center_header,
                   5987: div.LC_grade_assign_header {
1.705     tempelho 5988:   font-weight: bold;
                   5989:   font-size: large;
1.597     albertel 5990: }
1.795     www      5991: 
1.597     albertel 5992: div.LC_grade_show_problem_problem,
                   5993: div.LC_grade_submissions_body,
                   5994: div.LC_grade_message_center_body,
                   5995: div.LC_grade_assign_body {
                   5996:   border: 1px solid black;
                   5997:   width: 99%;
                   5998:   background: #FFFFFF;
                   5999: }
1.795     www      6000: 
1.598     albertel 6001: span.LC_grade_check_note {
1.705     tempelho 6002:   font-weight: normal;
                   6003:   font-size: medium;
1.598     albertel 6004:   display: inline;
                   6005:   position: absolute;
                   6006:   right: 1em;
                   6007: }
1.597     albertel 6008: 
1.613     albertel 6009: table.LC_scantron_action {
                   6010:   width: 100%;
                   6011: }
1.795     www      6012: 
1.613     albertel 6013: table.LC_scantron_action tr th {
1.698     harmsja  6014:   font-weight:bold;
                   6015:   font-style:normal;
1.613     albertel 6016: }
1.795     www      6017: 
1.779     bisitz   6018: .LC_edit_problem_header,
1.614     albertel 6019: div.LC_edit_problem_footer {
1.705     tempelho 6020:   font-weight: normal;
                   6021:   font-size:  medium;
1.602     albertel 6022:   margin: 2px;
1.600     albertel 6023: }
1.795     www      6024: 
1.600     albertel 6025: div.LC_edit_problem_header,
1.602     albertel 6026: div.LC_edit_problem_header div,
1.614     albertel 6027: div.LC_edit_problem_footer,
                   6028: div.LC_edit_problem_footer div,
1.602     albertel 6029: div.LC_edit_problem_editxml_header,
                   6030: div.LC_edit_problem_editxml_header div {
1.600     albertel 6031:   margin-top: 5px;
                   6032: }
1.795     www      6033: 
1.600     albertel 6034: div.LC_edit_problem_header_title {
1.705     tempelho 6035:   font-weight: bold;
                   6036:   font-size: larger;
1.602     albertel 6037:   background: $tabbg;
                   6038:   padding: 3px;
                   6039: }
1.795     www      6040: 
1.602     albertel 6041: table.LC_edit_problem_header_title {
1.705     tempelho 6042:   font-size: larger;
                   6043:   font-weight:  bold;
1.602     albertel 6044:   width: 100%;
                   6045:   border-color: $pgbg;
                   6046:   border-style: solid;
                   6047:   border-width: $border;
1.600     albertel 6048:   background: $tabbg;
1.602     albertel 6049:   border-collapse: collapse;
1.803     bisitz   6050:   padding: 0;
1.602     albertel 6051: }
                   6052: 
                   6053: div.LC_edit_problem_discards {
                   6054:   float: left;
                   6055:   padding-bottom: 5px;
                   6056: }
1.795     www      6057: 
1.602     albertel 6058: div.LC_edit_problem_saves {
                   6059:   float: right;
                   6060:   padding-bottom: 5px;
1.600     albertel 6061: }
1.795     www      6062: 
1.911     bisitz   6063: img.stift {
1.803     bisitz   6064:   border-width: 0;
                   6065:   vertical-align: middle;
1.677     riegler  6066: }
1.680     riegler  6067: 
1.923     bisitz   6068: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6069:   vertical-align: top;
1.777     tempelho 6070: }
1.795     www      6071: 
1.716     raeburn  6072: div.LC_createcourse {
1.911     bisitz   6073:   margin: 10px 10px 10px 10px;
1.716     raeburn  6074: }
                   6075: 
1.917     raeburn  6076: .LC_dccid {
                   6077:   margin: 0.2em 0 0 0;
                   6078:   padding: 0;
                   6079:   font-size: 90%;
                   6080:   display:none;
                   6081: }
                   6082: 
1.693     droeschl 6083: /* ---- Remove when done ----
                   6084: # The following styles is part of the redesign of LON-CAPA and are
                   6085: # subject to change during this project.
                   6086: # Don't rely on their current functionality as they might be 
                   6087: # changed or removed.
                   6088: # --------------------------*/
                   6089: 
1.698     harmsja  6090: a:hover,
1.897     wenzelju 6091: ol.LC_primary_menu a:hover,
1.721     harmsja  6092: ol#LC_MenuBreadcrumbs a:hover,
                   6093: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6094: ul#LC_secondary_menu a:hover,
1.721     harmsja  6095: .LC_FormSectionClearButton input:hover
1.795     www      6096: ul.LC_TabContent   li:hover a {
1.911     bisitz   6097:   color:#BF2317;
                   6098:   text-decoration:none;
1.693     droeschl 6099: }
                   6100: 
1.779     bisitz   6101: h1 {
1.911     bisitz   6102:   padding: 0;
                   6103:   line-height:130%;
1.693     droeschl 6104: }
1.698     harmsja  6105: 
1.911     bisitz   6106: h2,
                   6107: h3,
                   6108: h4,
                   6109: h5,
                   6110: h6 {
                   6111:   margin: 5px 0 5px 0;
                   6112:   padding: 0;
                   6113:   line-height:130%;
1.693     droeschl 6114: }
1.795     www      6115: 
                   6116: .LC_hcell {
1.911     bisitz   6117:   padding:3px 15px 3px 15px;
                   6118:   margin: 0;
                   6119:   background-color:$tabbg;
                   6120:   color:$fontmenu;
                   6121:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6122: }
1.795     www      6123: 
1.840     bisitz   6124: .LC_Box > .LC_hcell {
1.911     bisitz   6125:   margin: 0 -10px 10px -10px;
1.835     bisitz   6126: }
                   6127: 
1.721     harmsja  6128: .LC_noBorder {
1.911     bisitz   6129:   border: 0;
1.698     harmsja  6130: }
1.693     droeschl 6131: 
1.721     harmsja  6132: .LC_FormSectionClearButton input {
1.911     bisitz   6133:   background-color:transparent;
                   6134:   border: none;
                   6135:   cursor:pointer;
                   6136:   text-decoration:underline;
1.693     droeschl 6137: }
1.763     bisitz   6138: 
                   6139: .LC_help_open_topic {
1.911     bisitz   6140:   color: #FFFFFF;
                   6141:   background-color: #EEEEFF;
                   6142:   margin: 1px;
                   6143:   padding: 4px;
                   6144:   border: 1px solid #000033;
                   6145:   white-space: nowrap;
                   6146:   /* vertical-align: middle; */
1.759     neumanie 6147: }
1.693     droeschl 6148: 
1.911     bisitz   6149: dl,
                   6150: ul,
                   6151: div,
                   6152: fieldset {
                   6153:   margin: 10px 10px 10px 0;
                   6154:   /* overflow: hidden; */
1.693     droeschl 6155: }
1.795     www      6156: 
1.838     bisitz   6157: fieldset > legend {
1.911     bisitz   6158:   font-weight: bold;
                   6159:   padding: 0 5px 0 5px;
1.838     bisitz   6160: }
                   6161: 
1.925.2.14  raeburn  6162: div.LC_page_header {
                   6163:   background-color: $pgbg_or_bgcolor;
                   6164:   margin: 0 0 1.0em 0;
                   6165: }
                   6166: 
1.813     bisitz   6167: #LC_nav_bar {
1.911     bisitz   6168:   float: left;
                   6169:   margin: 0.2em 0 0 0;
1.807     droeschl 6170: }
                   6171: 
1.916     droeschl 6172: #LC_realm {
                   6173:   margin: 0.2em 0 0 0;
                   6174:   padding: 0;
                   6175:   font-weight: bold;
                   6176:   text-align: center;
                   6177: }
                   6178: 
1.911     bisitz   6179: #LC_nav_bar em {
                   6180:   font-weight: bold;
                   6181:   font-style: normal;
1.807     droeschl 6182: }
                   6183: 
1.897     wenzelju 6184: ol.LC_primary_menu {
1.911     bisitz   6185:   float: right;
                   6186:   margin: 0.2em 0 0 0;
1.807     droeschl 6187: }
                   6188: 
1.852     droeschl 6189: ol#LC_PathBreadcrumbs {
1.911     bisitz   6190:   margin: 0;
1.693     droeschl 6191: }
                   6192: 
1.897     wenzelju 6193: ol.LC_primary_menu li {
1.911     bisitz   6194:   display: inline;
                   6195:   padding: 5px 5px 0 10px;
                   6196:   vertical-align: top;
1.693     droeschl 6197: }
                   6198: 
1.897     wenzelju 6199: ol.LC_primary_menu li img {
1.911     bisitz   6200:   vertical-align: bottom;
1.693     droeschl 6201: }
                   6202: 
1.897     wenzelju 6203: ol.LC_primary_menu a {
1.911     bisitz   6204:   font-size: 90%;
                   6205:   color: RGB(80, 80, 80);
                   6206:   text-decoration: none;
1.693     droeschl 6207: }
1.795     www      6208: 
1.925.2.20! raeburn  6209: ol.LC_primary_menu a.LC_new_message {
        !          6210:   font-weight:bold;
        !          6211:   color: darkred;
        !          6212: }
        !          6213: 
1.897     wenzelju 6214: ul#LC_secondary_menu {
1.911     bisitz   6215:   clear: both;
                   6216:   color: $fontmenu;
                   6217:   background: $tabbg;
                   6218:   list-style: none;
                   6219:   padding: 0;
                   6220:   margin: 0;
                   6221:   width: 100%;
1.808     droeschl 6222: }
                   6223: 
1.897     wenzelju 6224: ul#LC_secondary_menu li {
1.911     bisitz   6225:   font-weight: bold;
                   6226:   line-height: 1.8em;
                   6227:   padding: 0 0.8em;
                   6228:   border-right: 1px solid black;
                   6229:   display: inline;
                   6230:   vertical-align: middle;
1.807     droeschl 6231: }
                   6232: 
1.847     tempelho 6233: ul.LC_TabContent {
1.911     bisitz   6234:   display:block;
                   6235:   background: $sidebg;
                   6236:   border-bottom: solid 1px $lg_border_color;
                   6237:   list-style:none;
                   6238:   margin: 0 -10px;
                   6239:   padding: 0;
1.693     droeschl 6240: }
                   6241: 
1.795     www      6242: ul.LC_TabContent li,
                   6243: ul.LC_TabContentBigger li {
1.911     bisitz   6244:   float:left;
1.741     harmsja  6245: }
1.795     www      6246: 
1.897     wenzelju 6247: ul#LC_secondary_menu li a {
1.911     bisitz   6248:   color: $fontmenu;
                   6249:   text-decoration: none;
1.693     droeschl 6250: }
1.795     www      6251: 
1.721     harmsja  6252: ul.LC_TabContent {
1.911     bisitz   6253:   min-height:1.5em;
1.721     harmsja  6254: }
1.795     www      6255: 
                   6256: ul.LC_TabContent li {
1.911     bisitz   6257:   vertical-align:middle;
                   6258:   padding: 0 10px 0 10px;
                   6259:   background-color:$tabbg;
                   6260:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6261: }
1.795     www      6262: 
1.847     tempelho 6263: ul.LC_TabContent .right {
1.911     bisitz   6264:   float:right;
1.847     tempelho 6265: }
                   6266: 
1.911     bisitz   6267: ul.LC_TabContent li a,
                   6268: ul.LC_TabContent li {
                   6269:   color:rgb(47,47,47);
                   6270:   text-decoration:none;
                   6271:   font-size:95%;
                   6272:   font-weight:bold;
                   6273:   padding-right: 16px;
1.721     harmsja  6274: }
1.795     www      6275: 
1.911     bisitz   6276: ul.LC_TabContent li:hover,
                   6277: ul.LC_TabContent li.active {
                   6278:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6279:   border-bottom:solid 2px #FFFFFF;
                   6280:   padding-right: 16px;
1.744     ehlerst  6281: }
1.795     www      6282: 
1.870     tempelho 6283: #maincoursedoc {
1.911     bisitz   6284:   clear:both;
1.870     tempelho 6285: }
                   6286: 
                   6287: ul.LC_TabContentBigger {
1.911     bisitz   6288:   display:block;
                   6289:   list-style:none;
                   6290:   padding: 0;
1.870     tempelho 6291: }
                   6292: 
1.795     www      6293: ul.LC_TabContentBigger li {
1.911     bisitz   6294:   vertical-align:bottom;
                   6295:   height: 30px;
                   6296:   font-size:110%;
                   6297:   font-weight:bold;
                   6298:   color: #737373;
1.841     tempelho 6299: }
                   6300: 
1.870     tempelho 6301: 
                   6302: ul.LC_TabContentBigger li a {
1.911     bisitz   6303:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6304:   height: 30px;
                   6305:   line-height: 30px;
                   6306:   text-align: center;
                   6307:   display: block;
                   6308:   text-decoration: none;
1.741     harmsja  6309: }
1.795     www      6310: 
1.911     bisitz   6311: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6312: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6313:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6314:   color:$font;
                   6315:   text-decoration: underline;
1.744     ehlerst  6316: }
1.795     www      6317: 
1.870     tempelho 6318: 
                   6319: ul.LC_TabContentBigger li b {
1.911     bisitz   6320:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6321:   display: block;
                   6322:   float: left;
                   6323:   padding: 0 30px;
1.870     tempelho 6324: }
                   6325: 
                   6326: ul.LC_TabContentBigger li:hover b,
                   6327: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6328:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6329:   color:$font;
                   6330:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6331: }
1.693     droeschl 6332: 
1.870     tempelho 6333: 
1.862     bisitz   6334: ul.LC_CourseBreadcrumbs {
                   6335:   background: $sidebg;
                   6336:   line-height: 32px;
                   6337:   padding-left: 10px;
                   6338:   margin: 0 0 10px 0;
                   6339:   list-style-position: inside;
                   6340: 
                   6341: }
                   6342: 
1.911     bisitz   6343: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6344: ol#LC_PathBreadcrumbs {
1.911     bisitz   6345:   padding-left: 10px;
                   6346:   margin: 0;
1.925.2.14  raeburn  6347:   margin: 0;
                   6348:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6349: }
                   6350: 
1.911     bisitz   6351: ol#LC_MenuBreadcrumbs li,
                   6352: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6353: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6354:   display: inline;
1.925.2.14  raeburn  6355:   white-space: normal;
1.693     droeschl 6356: }
                   6357: 
1.823     bisitz   6358: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6359: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6360:   text-decoration: none;
                   6361:   font-size:90%;
1.693     droeschl 6362: }
1.795     www      6363: 
1.925.2.14  raeburn  6364: ol#LC_MenuBreadcrumbs h1 {
                   6365:   display: inline;
                   6366:   font-size: 90%;
                   6367:   line-height: 2.5em;
                   6368:   margin: 0;
                   6369:   padding: 0;
                   6370: }
                   6371: 
1.795     www      6372: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6373:   text-decoration:none;
                   6374:   font-size:100%;
                   6375:   font-weight:bold;
1.693     droeschl 6376: }
1.795     www      6377: 
1.840     bisitz   6378: .LC_Box {
1.911     bisitz   6379:   border: solid 1px $lg_border_color;
                   6380:   padding: 0 10px 10px 10px;
1.746     neumanie 6381: }
1.795     www      6382: 
                   6383: .LC_AboutMe_Image {
1.911     bisitz   6384:   float:left;
                   6385:   margin-right:10px;
1.747     neumanie 6386: }
1.795     www      6387: 
                   6388: .LC_Clear_AboutMe_Image {
1.911     bisitz   6389:   clear:left;
1.747     neumanie 6390: }
1.795     www      6391: 
1.721     harmsja  6392: dl.LC_ListStyleClean dt {
1.911     bisitz   6393:   padding-right: 5px;
                   6394:   display: table-header-group;
1.693     droeschl 6395: }
                   6396: 
1.721     harmsja  6397: dl.LC_ListStyleClean dd {
1.911     bisitz   6398:   display: table-row;
1.693     droeschl 6399: }
                   6400: 
1.721     harmsja  6401: .LC_ListStyleClean,
                   6402: .LC_ListStyleSimple,
                   6403: .LC_ListStyleNormal,
1.795     www      6404: .LC_ListStyleSpecial {
1.911     bisitz   6405:   /* display:block; */
                   6406:   list-style-position: inside;
                   6407:   list-style-type: none;
                   6408:   overflow: hidden;
                   6409:   padding: 0;
1.693     droeschl 6410: }
                   6411: 
1.721     harmsja  6412: .LC_ListStyleSimple li,
                   6413: .LC_ListStyleSimple dd,
                   6414: .LC_ListStyleNormal li,
                   6415: .LC_ListStyleNormal dd,
                   6416: .LC_ListStyleSpecial li,
1.795     www      6417: .LC_ListStyleSpecial dd {
1.911     bisitz   6418:   margin: 0;
                   6419:   padding: 5px 5px 5px 10px;
                   6420:   clear: both;
1.693     droeschl 6421: }
                   6422: 
1.721     harmsja  6423: .LC_ListStyleClean li,
                   6424: .LC_ListStyleClean dd {
1.911     bisitz   6425:   padding-top: 0;
                   6426:   padding-bottom: 0;
1.693     droeschl 6427: }
                   6428: 
1.721     harmsja  6429: .LC_ListStyleSimple dd,
1.795     www      6430: .LC_ListStyleSimple li {
1.911     bisitz   6431:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6432: }
                   6433: 
1.721     harmsja  6434: .LC_ListStyleSpecial li,
                   6435: .LC_ListStyleSpecial dd {
1.911     bisitz   6436:   list-style-type: none;
                   6437:   background-color: RGB(220, 220, 220);
                   6438:   margin-bottom: 4px;
1.693     droeschl 6439: }
                   6440: 
1.721     harmsja  6441: table.LC_SimpleTable {
1.911     bisitz   6442:   margin:5px;
                   6443:   border:solid 1px $lg_border_color;
1.795     www      6444: }
1.693     droeschl 6445: 
1.721     harmsja  6446: table.LC_SimpleTable tr {
1.911     bisitz   6447:   padding: 0;
                   6448:   border:solid 1px $lg_border_color;
1.693     droeschl 6449: }
1.795     www      6450: 
                   6451: table.LC_SimpleTable thead {
1.911     bisitz   6452:   background:rgb(220,220,220);
1.693     droeschl 6453: }
                   6454: 
1.721     harmsja  6455: div.LC_columnSection {
1.911     bisitz   6456:   display: block;
                   6457:   clear: both;
                   6458:   overflow: hidden;
                   6459:   margin: 0;
1.693     droeschl 6460: }
                   6461: 
1.721     harmsja  6462: div.LC_columnSection>* {
1.911     bisitz   6463:   float: left;
                   6464:   margin: 10px 20px 10px 0;
                   6465:   overflow:hidden;
1.693     droeschl 6466: }
1.721     harmsja  6467: 
1.694     tempelho 6468: .LC_loginpage_container {
1.911     bisitz   6469:   text-align:left;
                   6470:   margin : 0 auto;
                   6471:   width:90%;
                   6472:   padding: 10px;
                   6473:   height: auto;
                   6474:   background-color:#FFFFFF;
                   6475:   border:1px solid #CCCCCC;
1.694     tempelho 6476: }
                   6477: 
                   6478: 
                   6479: .LC_loginpage_loginContainer {
1.911     bisitz   6480:   float:left;
                   6481:   width: 182px;
                   6482:   padding: 2px;
                   6483:   border:1px solid #CCCCCC;
                   6484:   background-color:$loginbg;
1.694     tempelho 6485: }
                   6486: 
1.795     www      6487: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6488:   margin-top: 0;
                   6489:   display:block;
                   6490:   background:$bgcol;
                   6491:   color:$textcol;
                   6492:   padding-left:5px;
1.712     muellerd 6493: }
1.785     tempelho 6494: 
1.694     tempelho 6495: .LC_loginpage_loginInfo {
1.911     bisitz   6496:   float:left;
                   6497:   width:182px;
                   6498:   border:1px solid #CCCCCC;
                   6499:   padding:2px;
1.712     muellerd 6500: }
                   6501: 
1.694     tempelho 6502: .LC_loginpage_space {
1.911     bisitz   6503:   clear: both;
                   6504:   margin-bottom: 20px;
                   6505:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6506: }
                   6507: 
1.785     tempelho 6508: .LC_loginpage_floatLeft {
1.911     bisitz   6509:   float: left;
                   6510:   width: 200px;
                   6511:   margin: 0;
1.785     tempelho 6512: }
                   6513: 
1.795     www      6514: table em {
1.911     bisitz   6515:   font-weight: bold;
                   6516:   font-style: normal;
1.748     schulted 6517: }
1.795     www      6518: 
1.779     bisitz   6519: table.LC_tableBrowseRes,
1.795     www      6520: table.LC_tableOfContent {
1.911     bisitz   6521:   border:none;
                   6522:   border-spacing: 1px;
                   6523:   padding: 3px;
                   6524:   background-color: #FFFFFF;
                   6525:   font-size: 90%;
1.753     droeschl 6526: }
1.789     droeschl 6527: 
1.911     bisitz   6528: table.LC_tableOfContent {
                   6529:   border-collapse: collapse;
1.789     droeschl 6530: }
                   6531: 
1.771     droeschl 6532: table.LC_tableBrowseRes a,
1.768     schulted 6533: table.LC_tableOfContent a {
1.911     bisitz   6534:   background-color: transparent;
                   6535:   text-decoration: none;
1.753     droeschl 6536: }
                   6537: 
1.795     www      6538: table.LC_tableOfContent img {
1.911     bisitz   6539:   border: none;
                   6540:   height: 1.3em;
                   6541:   vertical-align: text-bottom;
                   6542:   margin-right: 0.3em;
1.753     droeschl 6543: }
1.757     schulted 6544: 
1.795     www      6545: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6546:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6547: }
                   6548: 
1.795     www      6549: a#LC_content_toolbar_launchnav {
1.911     bisitz   6550:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6551: }
                   6552: 
1.795     www      6553: a#LC_content_toolbar_closenav {
1.911     bisitz   6554:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6555: }
                   6556: 
1.795     www      6557: a#LC_content_toolbar_everything {
1.911     bisitz   6558:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6559: }
                   6560: 
1.795     www      6561: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6562:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6563: }
                   6564: 
1.795     www      6565: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6566:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6567: }
                   6568: 
1.795     www      6569: a#LC_content_toolbar_changefolder {
1.911     bisitz   6570:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6571: }
                   6572: 
1.795     www      6573: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6574:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6575: }
                   6576: 
1.925.2.17  raeburn  6577: a#LC_content_toolbar_management {
1.925.2.18  raeburn  6578:   background-image:url(/res/adm/pages/navtomenu.png);
1.925.2.17  raeburn  6579: }
                   6580: 
1.795     www      6581: ul#LC_toolbar li a:hover {
1.911     bisitz   6582:   background-position: bottom center;
1.757     schulted 6583: }
                   6584: 
1.795     www      6585: ul#LC_toolbar {
1.911     bisitz   6586:   padding: 0;
                   6587:   margin: 2px;
                   6588:   list-style:none;
                   6589:   position:relative;
                   6590:   background-color:white;
1.757     schulted 6591: }
                   6592: 
1.795     www      6593: ul#LC_toolbar li {
1.911     bisitz   6594:   border:1px solid white;
                   6595:   padding: 0;
                   6596:   margin: 0;
                   6597:   float: left;
                   6598:   display:inline;
                   6599:   vertical-align:middle;
                   6600: }
1.757     schulted 6601: 
1.783     amueller 6602: 
1.795     www      6603: a.LC_toolbarItem {
1.911     bisitz   6604:   display:block;
                   6605:   padding: 0;
                   6606:   margin: 0;
                   6607:   height: 32px;
                   6608:   width: 32px;
                   6609:   color:white;
                   6610:   border: none;
                   6611:   background-repeat:no-repeat;
                   6612:   background-color:transparent;
1.757     schulted 6613: }
                   6614: 
1.915     droeschl 6615: ul.LC_funclist {
                   6616:     margin: 0;
                   6617:     padding: 0.5em 1em 0.5em 0;
                   6618: }
                   6619: 
1.925.2.14  raeburn  6620: ul.LC_funclist > li:first-child {
                   6621:     font-weight:bold;
                   6622:     margin-left:0.8em;
                   6623: }
                   6624: 
1.915     droeschl 6625: ul.LC_funclist + ul.LC_funclist {
                   6626:     /* 
                   6627:        left border as a seperator if we have more than
                   6628:        one list 
                   6629:     */
                   6630:     border-left: 1px solid $sidebg;
                   6631:     /* 
                   6632:        this hides the left border behind the border of the 
                   6633:        outer box if element is wrapped to the next 'line' 
                   6634:     */
                   6635:     margin-left: -1px;
                   6636: }
                   6637: 
1.843     bisitz   6638: ul.LC_funclist li {
1.915     droeschl 6639:   display: inline;
1.782     bisitz   6640:   white-space: nowrap;
1.915     droeschl 6641:   margin: 0 0 0 25px;
                   6642:   line-height: 150%;
1.782     bisitz   6643: }
                   6644: 
1.925.2.1  raeburn  6645: #gciheader {
                   6646:   float:left;
                   6647:   width:100%;
                   6648:   background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
                   6649:   font-size:93%;
                   6650:   line-height:normal;
1.925.2.14  raeburn  6651:   margin: 0.5em 0 0.5em 0;
1.925.2.1  raeburn  6652: }
                   6653: #gciheader ul {
                   6654:   margin:0;
1.925.2.16  raeburn  6655:   padding:10px 10px 0;
1.925.2.1  raeburn  6656:   list-style:none;
                   6657: }
                   6658: #gciheader li {
                   6659:   float:left;
                   6660:   background:url("/gcimenu_left.gif") no-repeat left top;
                   6661:   margin:0;
                   6662:   padding:0 0 0 9px;
                   6663: }
                   6664: #gciheader a {
                   6665:   display:block;
                   6666:   background:url("/gcimenu_right.gif") no-repeat right top;
                   6667:   padding:5px 15px 4px 6px;
                   6668: }
                   6669: #gciheader #current {
                   6670:   background-image:url("/gcimenu_left_on.gif");
                   6671: }
                   6672: #gciheader #current a {
                   6673:   background-image:url("/gcimenu_right_on.gif");
                   6674:   padding-bottom:5px;
                   6675: }
1.757     schulted 6676: 
1.343     albertel 6677: END
                   6678: }
                   6679: 
1.306     albertel 6680: =pod
                   6681: 
                   6682: =item * &headtag()
                   6683: 
                   6684: Returns a uniform footer for LON-CAPA web pages.
                   6685: 
1.307     albertel 6686: Inputs: $title - optional title for the head
                   6687:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6688:         $args - optional arguments
1.319     albertel 6689:             force_register - if is true call registerurl so the remote is 
                   6690:                              informed
1.415     albertel 6691:             redirect       -> array ref of
                   6692:                                    1- seconds before redirect occurs
                   6693:                                    2- url to redirect to
                   6694:                                    3- whether the side effect should occur
1.315     albertel 6695:                            (side effect of setting 
                   6696:                                $env{'internal.head.redirect'} to the url 
                   6697:                                redirected too)
1.352     albertel 6698:             domain         -> force to color decorate a page for a specific
                   6699:                                domain
                   6700:             function       -> force usage of a specific rolish color scheme
                   6701:             bgcolor        -> override the default page bgcolor
1.460     albertel 6702:             no_auto_mt_title
                   6703:                            -> prevent &mt()ing the title arg
1.464     albertel 6704: 
1.306     albertel 6705: =cut
                   6706: 
                   6707: sub headtag {
1.313     albertel 6708:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6709:     
1.363     albertel 6710:     my $function = $args->{'function'} || &get_users_function();
                   6711:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6712:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6713:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6714: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6715: 		   #time(),
1.418     albertel 6716: 		   $env{'environment.color.timestamp'},
1.363     albertel 6717: 		   $function,$domain,$bgcolor);
                   6718: 
1.369     www      6719:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6720: 
1.308     albertel 6721:     my $result =
                   6722: 	'<head>'.
1.461     albertel 6723: 	&font_settings();
1.319     albertel 6724: 
1.461     albertel 6725:     if (!$args->{'frameset'}) {
                   6726: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6727:     }
1.319     albertel 6728:     if ($args->{'force_register'}) {
                   6729: 	$result .= &Apache::lonmenu::registerurl(1);
                   6730:     }
1.436     albertel 6731:     if (!$args->{'no_nav_bar'} 
                   6732: 	&& !$args->{'only_body'}
                   6733: 	&& !$args->{'frameset'}) {
                   6734: 	$result .= &help_menu_js();
                   6735:     }
1.319     albertel 6736: 
1.314     albertel 6737:     if (ref($args->{'redirect'})) {
1.414     albertel 6738: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6739: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6740: 	if (!$inhibit_continue) {
                   6741: 	    $env{'internal.head.redirect'} = $url;
                   6742: 	}
1.313     albertel 6743: 	$result.=<<ADDMETA
                   6744: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6745: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6746: ADDMETA
                   6747:     }
1.306     albertel 6748:     if (!defined($title)) {
                   6749: 	$title = 'The LearningOnline Network with CAPA';
                   6750:     }
1.460     albertel 6751:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6752:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6753: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6754: 	.$head_extra;
1.306     albertel 6755:     return $result;
                   6756: }
                   6757: 
                   6758: =pod
                   6759: 
1.340     albertel 6760: =item * &font_settings()
                   6761: 
                   6762: Returns neccessary <meta> to set the proper encoding
                   6763: 
                   6764: Inputs: none
                   6765: 
                   6766: =cut
                   6767: 
                   6768: sub font_settings {
                   6769:     my $headerstring='';
1.647     www      6770:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6771: 	$headerstring.=
                   6772: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6773:     }
                   6774:     return $headerstring;
                   6775: }
                   6776: 
1.341     albertel 6777: =pod
                   6778: 
                   6779: =item * &xml_begin()
                   6780: 
                   6781: Returns the needed doctype and <html>
                   6782: 
                   6783: Inputs: none
                   6784: 
                   6785: =cut
                   6786: 
                   6787: sub xml_begin {
                   6788:     my $output='';
                   6789: 
1.592     albertel 6790:     if ($env{'internal.start_page'}==1) {
                   6791: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6792:     }
1.342     albertel 6793: 
1.341     albertel 6794:     if ($env{'browser.mathml'}) {
                   6795: 	$output='<?xml version="1.0"?>'
                   6796:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6797: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6798:             
                   6799: #	    .'<!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">] >'
                   6800: 	    .'<!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">'
                   6801:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6802: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6803:     } else {
1.849     bisitz   6804: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6805:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6806:     }
                   6807:     return $output;
                   6808: }
1.340     albertel 6809: 
                   6810: =pod
                   6811: 
1.306     albertel 6812: =item * &endheadtag()
                   6813: 
                   6814: Returns a uniform </head> for LON-CAPA web pages.
                   6815: 
                   6816: Inputs: none
                   6817: 
                   6818: =cut
                   6819: 
                   6820: sub endheadtag {
                   6821:     return '</head>';
                   6822: }
                   6823: 
                   6824: =pod
                   6825: 
                   6826: =item * &head()
                   6827: 
                   6828: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6829: 
1.648     raeburn  6830: Inputs:
                   6831: 
                   6832: =over 4
                   6833: 
                   6834: $title - optional title for the page
                   6835: 
                   6836: $head_extra - optional extra HTML to put inside the <head>
                   6837: 
                   6838: =back
1.405     albertel 6839: 
1.306     albertel 6840: =cut
                   6841: 
                   6842: sub head {
1.325     albertel 6843:     my ($title,$head_extra,$args) = @_;
                   6844:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6845: }
                   6846: 
                   6847: =pod
                   6848: 
                   6849: =item * &start_page()
                   6850: 
                   6851: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6852: 
1.648     raeburn  6853: Inputs:
                   6854: 
                   6855: =over 4
                   6856: 
                   6857: $title - optional title for the page
                   6858: 
                   6859: $head_extra - optional extra HTML to incude inside the <head>
                   6860: 
                   6861: $args - additional optional args supported are:
                   6862: 
                   6863: =over 8
                   6864: 
                   6865:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6866:                                     arg on
1.814     bisitz   6867:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6868:              add_entries    -> additional attributes to add to the  <body>
                   6869:              domain         -> force to color decorate a page for a 
1.317     albertel 6870:                                     specific domain
1.648     raeburn  6871:              function       -> force usage of a specific rolish color
1.317     albertel 6872:                                     scheme
1.648     raeburn  6873:              redirect       -> see &headtag()
                   6874:              bgcolor        -> override the default page bg color
                   6875:              js_ready       -> return a string ready for being used in 
1.317     albertel 6876:                                     a javascript writeln
1.648     raeburn  6877:              html_encode    -> return a string ready for being used in 
1.320     albertel 6878:                                     a html attribute
1.648     raeburn  6879:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6880:                                     $forcereg arg
1.648     raeburn  6881:              frameset       -> if true will start with a <frameset>
1.330     albertel 6882:                                     rather than <body>
1.648     raeburn  6883:              skip_phases    -> hash ref of 
1.338     albertel 6884:                                     head -> skip the <html><head> generation
                   6885:                                     body -> skip all <body> generation
1.648     raeburn  6886:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6887:                                     'Switch To Inline Menu' link
1.648     raeburn  6888:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6889:              inherit_jsmath -> when creating popup window in a page,
                   6890:                                     should it have jsmath forced on by the
                   6891:                                     current page
1.867     kalberla 6892:              bread_crumbs ->             Array containing breadcrumbs
                   6893:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6894: 
1.648     raeburn  6895: =back
1.460     albertel 6896: 
1.648     raeburn  6897: =back
1.562     albertel 6898: 
1.306     albertel 6899: =cut
                   6900: 
                   6901: sub start_page {
1.309     albertel 6902:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6903:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6904:     my %head_args;
1.352     albertel 6905:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6906: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6907: 		     'no_auto_mt_title') {
1.319     albertel 6908: 	if (defined($args->{$arg})) {
1.324     raeburn  6909: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6910: 	}
1.313     albertel 6911:     }
1.319     albertel 6912: 
1.315     albertel 6913:     $env{'internal.start_page'}++;
1.338     albertel 6914:     my $result;
                   6915:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6916: 	$result.=
1.341     albertel 6917: 	    &xml_begin().
1.338     albertel 6918: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6919:     }
                   6920:     
                   6921:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6922: 	if ($args->{'frameset'}) {
                   6923: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6924: 						$args->{'add_entries'});
                   6925: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6926:         } else {
                   6927:             $result .=
                   6928:                 &bodytag($title, 
                   6929:                          $args->{'function'},       $args->{'add_entries'},
                   6930:                          $args->{'only_body'},      $args->{'domain'},
                   6931:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6932:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6933:                          $args);
                   6934:         }
1.330     albertel 6935:     }
1.338     albertel 6936: 
1.315     albertel 6937:     if ($args->{'js_ready'}) {
1.713     kaisler  6938: 		$result = &js_ready($result);
1.315     albertel 6939:     }
1.320     albertel 6940:     if ($args->{'html_encode'}) {
1.713     kaisler  6941: 		$result = &html_encode($result);
                   6942:     }
                   6943: 
1.813     bisitz   6944:     # Preparation for new and consistent functionlist at top of screen
                   6945:     # if ($args->{'functionlist'}) {
                   6946:     #            $result .= &build_functionlist();
                   6947:     #}
                   6948: 
                   6949:     # Don't add anything more if only_body wanted
                   6950:     return $result if $args->{'only_body'};
                   6951: 
1.920     raeburn  6952:     #Breadcrumbs for Construction Space provided by &bodytag. 
                   6953:     if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
                   6954:         return $result;
                   6955:     }
                   6956:  
1.813     bisitz   6957:     #Breadcrumbs
1.758     kaisler  6958:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6959: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6960: 		#if any br links exists, add them to the breadcrumbs
                   6961: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6962: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6963: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6964: 			}
                   6965: 		}
                   6966: 
                   6967: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6968: 		if(exists($args->{'bread_crumbs_component'})){
                   6969: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
1.925.2.16  raeburn  6970: 		} elsif (exists($args->{'bread_crumbs_menulink'})) {
1.925.2.17  raeburn  6971: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$args->{'bread_crumbs_menulink'});
1.925.2.16  raeburn  6972:                 } else {
1.925.2.17  raeburn  6973: 			$result .= &Apache::lonhtmlcommon::breadcrumbs(); 
1.758     kaisler  6974: 		}
1.320     albertel 6975:     }
1.315     albertel 6976:     return $result;
1.306     albertel 6977: }
                   6978: 
1.330     albertel 6979: 
1.306     albertel 6980: =pod
                   6981: 
                   6982: =item * &head()
                   6983: 
                   6984: Returns a complete </body></html> section for LON-CAPA web pages.
                   6985: 
1.315     albertel 6986: Inputs:         $args - additional optional args supported are:
                   6987:                  js_ready     -> return a string ready for being used in 
                   6988:                                  a javascript writeln
1.320     albertel 6989:                  html_encode  -> return a string ready for being used in 
                   6990:                                  a html attribute
1.330     albertel 6991:                  frameset     -> if true will start with a <frameset>
                   6992:                                  rather than <body>
1.493     albertel 6993:                  dicsussion   -> if true will get discussion from
                   6994:                                   lonxml::xmlend
                   6995:                                  (you can pass the target and parser arguments
                   6996:                                   through optional 'target' and 'parser' args
                   6997:                                   to this routine)
1.306     albertel 6998: 
                   6999: =cut
                   7000: 
                   7001: sub end_page {
1.315     albertel 7002:     my ($args) = @_;
                   7003:     $env{'internal.end_page'}++;
1.330     albertel 7004:     my $result;
1.335     albertel 7005:     if ($args->{'discussion'}) {
                   7006: 	my ($target,$parser);
                   7007: 	if (ref($args->{'discussion'})) {
                   7008: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7009: 				$args->{'discussion'}{'parser'});
                   7010: 	}
                   7011: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7012:     }
                   7013: 
1.330     albertel 7014:     if ($args->{'frameset'}) {
                   7015: 	$result .= '</frameset>';
                   7016:     } else {
1.635     raeburn  7017: 	$result .= &endbodytag($args);
1.330     albertel 7018:     }
                   7019:     $result .= "\n</html>";
                   7020: 
1.315     albertel 7021:     if ($args->{'js_ready'}) {
1.317     albertel 7022: 	$result = &js_ready($result);
1.315     albertel 7023:     }
1.335     albertel 7024: 
1.320     albertel 7025:     if ($args->{'html_encode'}) {
                   7026: 	$result = &html_encode($result);
                   7027:     }
1.335     albertel 7028: 
1.315     albertel 7029:     return $result;
                   7030: }
                   7031: 
1.320     albertel 7032: sub html_encode {
                   7033:     my ($result) = @_;
                   7034: 
1.322     albertel 7035:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7036:     
                   7037:     return $result;
                   7038: }
1.317     albertel 7039: sub js_ready {
                   7040:     my ($result) = @_;
                   7041: 
1.323     albertel 7042:     $result =~ s/[\n\r]/ /xmsg;
                   7043:     $result =~ s/\\/\\\\/xmsg;
                   7044:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7045:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7046:     
                   7047:     return $result;
                   7048: }
                   7049: 
1.315     albertel 7050: sub validate_page {
                   7051:     if (  exists($env{'internal.start_page'})
1.316     albertel 7052: 	  &&     $env{'internal.start_page'} > 1) {
                   7053: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7054: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7055: 				 $ENV{'request.filename'});
1.315     albertel 7056:     }
                   7057:     if (  exists($env{'internal.end_page'})
1.316     albertel 7058: 	  &&     $env{'internal.end_page'} > 1) {
                   7059: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7060: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7061: 				 $env{'request.filename'});
1.315     albertel 7062:     }
                   7063:     if (     exists($env{'internal.start_page'})
                   7064: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7065: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7066: 				 $env{'request.filename'});
1.315     albertel 7067:     }
                   7068:     if (   ! exists($env{'internal.start_page'})
                   7069: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7070: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7071: 				 $env{'request.filename'});
1.315     albertel 7072:     }
1.306     albertel 7073: }
1.315     albertel 7074: 
1.318     albertel 7075: sub simple_error_page {
                   7076:     my ($r,$title,$msg) = @_;
                   7077:     my $page =
                   7078: 	&Apache::loncommon::start_page($title).
                   7079: 	&mt($msg).
                   7080: 	&Apache::loncommon::end_page();
                   7081:     if (ref($r)) {
                   7082: 	$r->print($page);
1.327     albertel 7083: 	return;
1.318     albertel 7084:     }
                   7085:     return $page;
                   7086: }
1.347     albertel 7087: 
                   7088: {
1.610     albertel 7089:     my @row_count;
1.347     albertel 7090:     sub start_data_table {
1.422     albertel 7091: 	my ($add_class) = @_;
                   7092: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 7093: 	unshift(@row_count,0);
1.422     albertel 7094: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 7095:     }
                   7096: 
                   7097:     sub end_data_table {
1.610     albertel 7098: 	shift(@row_count);
1.389     albertel 7099: 	return '</table>'."\n";;
1.347     albertel 7100:     }
                   7101: 
                   7102:     sub start_data_table_row {
1.422     albertel 7103: 	my ($add_class) = @_;
1.610     albertel 7104: 	$row_count[0]++;
                   7105: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7106: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 7107: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 7108:     }
1.471     banghart 7109:     
                   7110:     sub continue_data_table_row {
                   7111: 	my ($add_class) = @_;
1.610     albertel 7112: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7113: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 7114: 	return  '<tr class="'.$css_class.'">'."\n";;
                   7115:     }
1.347     albertel 7116: 
                   7117:     sub end_data_table_row {
1.389     albertel 7118: 	return '</tr>'."\n";;
1.347     albertel 7119:     }
1.367     www      7120: 
1.421     albertel 7121:     sub start_data_table_empty_row {
1.707     bisitz   7122: #	$row_count[0]++;
1.421     albertel 7123: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7124:     }
                   7125: 
                   7126:     sub end_data_table_empty_row {
                   7127: 	return '</tr>'."\n";;
                   7128:     }
                   7129: 
1.367     www      7130:     sub start_data_table_header_row {
1.389     albertel 7131: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7132:     }
                   7133: 
                   7134:     sub end_data_table_header_row {
1.389     albertel 7135: 	return '</tr>'."\n";;
1.367     www      7136:     }
1.890     droeschl 7137: 
                   7138:     sub data_table_caption {
                   7139:         my $caption = shift;
                   7140:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7141:     }
1.347     albertel 7142: }
                   7143: 
1.548     albertel 7144: =pod
                   7145: 
                   7146: =item * &inhibit_menu_check($arg)
                   7147: 
                   7148: Checks for a inhibitmenu state and generates output to preserve it
                   7149: 
                   7150: Inputs:         $arg - can be any of
                   7151:                      - undef - in which case the return value is a string 
                   7152:                                to add  into arguments list of a uri
                   7153:                      - 'input' - in which case the return value is a HTML
                   7154:                                  <form> <input> field of type hidden to
                   7155:                                  preserve the value
                   7156:                      - a url - in which case the return value is the url with
                   7157:                                the neccesary cgi args added to preserve the
                   7158:                                inhibitmenu state
                   7159:                      - a ref to a url - no return value, but the string is
                   7160:                                         updated to include the neccessary cgi
                   7161:                                         args to preserve the inhibitmenu state
                   7162: 
                   7163: =cut
                   7164: 
                   7165: sub inhibit_menu_check {
                   7166:     my ($arg) = @_;
                   7167:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7168:     if ($arg eq 'input') {
                   7169: 	if ($env{'form.inhibitmenu'}) {
                   7170: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7171: 	} else {
                   7172: 	    return
                   7173: 	}
                   7174:     }
                   7175:     if ($env{'form.inhibitmenu'}) {
                   7176: 	if (ref($arg)) {
                   7177: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7178: 	} elsif ($arg eq '') {
                   7179: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7180: 	} else {
                   7181: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7182: 	}
                   7183:     }
                   7184:     if (!ref($arg)) {
                   7185: 	return $arg;
                   7186:     }
                   7187: }
                   7188: 
1.251     albertel 7189: ###############################################
1.182     matthew  7190: 
                   7191: =pod
                   7192: 
1.549     albertel 7193: =back
                   7194: 
                   7195: =head1 User Information Routines
                   7196: 
                   7197: =over 4
                   7198: 
1.405     albertel 7199: =item * &get_users_function()
1.182     matthew  7200: 
                   7201: Used by &bodytag to determine the current users primary role.
                   7202: Returns either 'student','coordinator','admin', or 'author'.
                   7203: 
                   7204: =cut
                   7205: 
                   7206: ###############################################
                   7207: sub get_users_function {
1.815     tempelho 7208:     my $function = 'norole';
1.818     tempelho 7209:     if ($env{'request.role'}=~/^(st)/) {
                   7210:         $function='student';
                   7211:     }
1.907     raeburn  7212:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7213:         $function='coordinator';
                   7214:     }
1.258     albertel 7215:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7216:         $function='admin';
                   7217:     }
1.826     bisitz   7218:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7219:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7220:         $function='author';
                   7221:     }
                   7222:     return $function;
1.54      www      7223: }
1.99      www      7224: 
                   7225: ###############################################
                   7226: 
1.233     raeburn  7227: =pod
                   7228: 
1.821     raeburn  7229: =item * &show_course()
                   7230: 
                   7231: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7232: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7233: 
                   7234: Inputs:
                   7235: None
                   7236: 
                   7237: Outputs:
                   7238: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7239: 
                   7240: =cut
                   7241: 
                   7242: ###############################################
                   7243: sub show_course {
                   7244:     my $course = !$env{'user.adv'};
                   7245:     if (!$env{'user.adv'}) {
                   7246:         foreach my $env (keys(%env)) {
                   7247:             next if ($env !~ m/^user\.priv\./);
                   7248:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7249:                 $course = 0;
                   7250:                 last;
                   7251:             }
                   7252:         }
                   7253:     }
                   7254:     return $course;
                   7255: }
                   7256: 
                   7257: ###############################################
                   7258: 
                   7259: =pod
                   7260: 
1.542     raeburn  7261: =item * &check_user_status()
1.274     raeburn  7262: 
                   7263: Determines current status of supplied role for a
                   7264: specific user. Roles can be active, previous or future.
                   7265: 
                   7266: Inputs: 
                   7267: user's domain, user's username, course's domain,
1.375     raeburn  7268: course's number, optional section ID.
1.274     raeburn  7269: 
                   7270: Outputs:
                   7271: role status: active, previous or future. 
                   7272: 
                   7273: =cut
                   7274: 
                   7275: sub check_user_status {
1.412     raeburn  7276:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7277:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7278:     my @uroles = keys %userinfo;
                   7279:     my $srchstr;
                   7280:     my $active_chk = 'none';
1.412     raeburn  7281:     my $now = time;
1.274     raeburn  7282:     if (@uroles > 0) {
1.908     raeburn  7283:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7284:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7285:         } else {
1.412     raeburn  7286:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7287:         }
                   7288:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7289:             my $role_end = 0;
                   7290:             my $role_start = 0;
                   7291:             $active_chk = 'active';
1.412     raeburn  7292:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7293:                 $role_end = $1;
                   7294:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7295:                     $role_start = $1;
1.274     raeburn  7296:                 }
                   7297:             }
                   7298:             if ($role_start > 0) {
1.412     raeburn  7299:                 if ($now < $role_start) {
1.274     raeburn  7300:                     $active_chk = 'future';
                   7301:                 }
                   7302:             }
                   7303:             if ($role_end > 0) {
1.412     raeburn  7304:                 if ($now > $role_end) {
1.274     raeburn  7305:                     $active_chk = 'previous';
                   7306:                 }
                   7307:             }
                   7308:         }
                   7309:     }
                   7310:     return $active_chk;
                   7311: }
                   7312: 
                   7313: ###############################################
                   7314: 
                   7315: =pod
                   7316: 
1.405     albertel 7317: =item * &get_sections()
1.233     raeburn  7318: 
                   7319: Determines all the sections for a course including
                   7320: sections with students and sections containing other roles.
1.419     raeburn  7321: Incoming parameters: 
                   7322: 
                   7323: 1. domain
                   7324: 2. course number 
                   7325: 3. reference to array containing roles for which sections should 
                   7326: be gathered (optional).
                   7327: 4. reference to array containing status types for which sections 
                   7328: should be gathered (optional).
                   7329: 
                   7330: If the third argument is undefined, sections are gathered for any role. 
                   7331: If the fourth argument is undefined, sections are gathered for any status.
                   7332: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7333:  
1.374     raeburn  7334: Returns section hash (keys are section IDs, values are
                   7335: number of users in each section), subject to the
1.419     raeburn  7336: optional roles filter, optional status filter 
1.233     raeburn  7337: 
                   7338: =cut
                   7339: 
                   7340: ###############################################
                   7341: sub get_sections {
1.419     raeburn  7342:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7343:     if (!defined($cdom) || !defined($cnum)) {
                   7344:         my $cid =  $env{'request.course.id'};
                   7345: 
                   7346: 	return if (!defined($cid));
                   7347: 
                   7348:         $cdom = $env{'course.'.$cid.'.domain'};
                   7349:         $cnum = $env{'course.'.$cid.'.num'};
                   7350:     }
                   7351: 
                   7352:     my %sectioncount;
1.419     raeburn  7353:     my $now = time;
1.240     albertel 7354: 
1.366     albertel 7355:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7356: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7357: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7358: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7359:         my $start_index = &Apache::loncoursedata::CL_START();
                   7360:         my $end_index = &Apache::loncoursedata::CL_END();
                   7361:         my $status;
1.366     albertel 7362: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7363: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7364: 				                     $data->[$status_index],
                   7365:                                                      $data->[$start_index],
                   7366:                                                      $data->[$end_index]);
                   7367:             if ($stu_status eq 'Active') {
                   7368:                 $status = 'active';
                   7369:             } elsif ($end < $now) {
                   7370:                 $status = 'previous';
                   7371:             } elsif ($start > $now) {
                   7372:                 $status = 'future';
                   7373:             } 
                   7374: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7375:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7376:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7377: 		    $sectioncount{$section}++;
                   7378:                 }
1.240     albertel 7379: 	    }
                   7380: 	}
                   7381:     }
                   7382:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7383:     foreach my $user (sort(keys(%courseroles))) {
                   7384: 	if ($user !~ /^(\w{2})/) { next; }
                   7385: 	my ($role) = ($user =~ /^(\w{2})/);
                   7386: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7387: 	my ($section,$status);
1.240     albertel 7388: 	if ($role eq 'cr' &&
                   7389: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7390: 	    $section=$1;
                   7391: 	}
                   7392: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7393: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7394:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7395:         if ($end == -1 && $start == -1) {
                   7396:             next; #deleted role
                   7397:         }
                   7398:         if (!defined($possible_status)) { 
                   7399:             $sectioncount{$section}++;
                   7400:         } else {
                   7401:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7402:                 $status = 'active';
                   7403:             } elsif ($end < $now) {
                   7404:                 $status = 'future';
                   7405:             } elsif ($start > $now) {
                   7406:                 $status = 'previous';
                   7407:             }
                   7408:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7409:                 $sectioncount{$section}++;
                   7410:             }
                   7411:         }
1.233     raeburn  7412:     }
1.366     albertel 7413:     return %sectioncount;
1.233     raeburn  7414: }
                   7415: 
1.274     raeburn  7416: ###############################################
1.294     raeburn  7417: 
                   7418: =pod
1.405     albertel 7419: 
                   7420: =item * &get_course_users()
                   7421: 
1.275     raeburn  7422: Retrieves usernames:domains for users in the specified course
                   7423: with specific role(s), and access status. 
                   7424: 
                   7425: Incoming parameters:
1.277     albertel 7426: 1. course domain
                   7427: 2. course number
                   7428: 3. access status: users must have - either active, 
1.275     raeburn  7429: previous, future, or all.
1.277     albertel 7430: 4. reference to array of permissible roles
1.288     raeburn  7431: 5. reference to array of section restrictions (optional)
                   7432: 6. reference to results object (hash of hashes).
                   7433: 7. reference to optional userdata hash
1.609     raeburn  7434: 8. reference to optional statushash
1.630     raeburn  7435: 9. flag if privileged users (except those set to unhide in
                   7436:    course settings) should be excluded    
1.609     raeburn  7437: Keys of top level results hash are roles.
1.275     raeburn  7438: Keys of inner hashes are username:domain, with 
                   7439: values set to access type.
1.288     raeburn  7440: Optional userdata hash returns an array with arguments in the 
                   7441: same order as loncoursedata::get_classlist() for student data.
                   7442: 
1.609     raeburn  7443: Optional statushash returns
                   7444: 
1.288     raeburn  7445: Entries for end, start, section and status are blank because
                   7446: of the possibility of multiple values for non-student roles.
                   7447: 
1.275     raeburn  7448: =cut
1.405     albertel 7449: 
1.275     raeburn  7450: ###############################################
1.405     albertel 7451: 
1.275     raeburn  7452: sub get_course_users {
1.630     raeburn  7453:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7454:     my %idx = ();
1.419     raeburn  7455:     my %seclists;
1.288     raeburn  7456: 
                   7457:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7458:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7459:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7460:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7461:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7462:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7463:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7464:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7465: 
1.290     albertel 7466:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7467:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7468:         my $now = time;
1.277     albertel 7469:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7470:             my $match = 0;
1.412     raeburn  7471:             my $secmatch = 0;
1.419     raeburn  7472:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7473:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7474:             if ($section eq '') {
                   7475:                 $section = 'none';
                   7476:             }
1.291     albertel 7477:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7478:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7479:                     $secmatch = 1;
                   7480:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7481:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7482:                         $secmatch = 1;
                   7483:                     }
                   7484:                 } else {  
1.419     raeburn  7485: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7486: 		        $secmatch = 1;
                   7487:                     }
1.290     albertel 7488: 		}
1.412     raeburn  7489:                 if (!$secmatch) {
                   7490:                     next;
                   7491:                 }
1.419     raeburn  7492:             }
1.275     raeburn  7493:             if (defined($$types{'active'})) {
1.288     raeburn  7494:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7495:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7496:                     $match = 1;
1.275     raeburn  7497:                 }
                   7498:             }
                   7499:             if (defined($$types{'previous'})) {
1.609     raeburn  7500:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7501:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7502:                     $match = 1;
1.275     raeburn  7503:                 }
                   7504:             }
                   7505:             if (defined($$types{'future'})) {
1.609     raeburn  7506:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7507:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7508:                     $match = 1;
1.275     raeburn  7509:                 }
                   7510:             }
1.609     raeburn  7511:             if ($match) {
                   7512:                 push(@{$seclists{$student}},$section);
                   7513:                 if (ref($userdata) eq 'HASH') {
                   7514:                     $$userdata{$student} = $$classlist{$student};
                   7515:                 }
                   7516:                 if (ref($statushash) eq 'HASH') {
                   7517:                     $statushash->{$student}{'st'}{$section} = $status;
                   7518:                 }
1.288     raeburn  7519:             }
1.275     raeburn  7520:         }
                   7521:     }
1.412     raeburn  7522:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7523:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7524:         my $now = time;
1.609     raeburn  7525:         my %displaystatus = ( previous => 'Expired',
                   7526:                               active   => 'Active',
                   7527:                               future   => 'Future',
                   7528:                             );
1.630     raeburn  7529:         my %nothide;
                   7530:         if ($hidepriv) {
                   7531:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7532:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7533:                 if ($user !~ /:/) {
                   7534:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7535:                 } else {
                   7536:                     $nothide{$user} = 1;
                   7537:                 }
                   7538:             }
                   7539:         }
1.439     raeburn  7540:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7541:             my $match = 0;
1.412     raeburn  7542:             my $secmatch = 0;
1.439     raeburn  7543:             my $status;
1.412     raeburn  7544:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7545:             $user =~ s/:$//;
1.439     raeburn  7546:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7547:             if ($end == -1 || $start == -1) {
                   7548:                 next;
                   7549:             }
                   7550:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7551:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7552:                 my ($uname,$udom) = split(/:/,$user);
                   7553:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7554:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7555:                         $secmatch = 1;
                   7556:                     } elsif ($usec eq '') {
1.420     albertel 7557:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7558:                             $secmatch = 1;
                   7559:                         }
                   7560:                     } else {
                   7561:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7562:                             $secmatch = 1;
                   7563:                         }
                   7564:                     }
                   7565:                     if (!$secmatch) {
                   7566:                         next;
                   7567:                     }
1.288     raeburn  7568:                 }
1.419     raeburn  7569:                 if ($usec eq '') {
                   7570:                     $usec = 'none';
                   7571:                 }
1.275     raeburn  7572:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7573:                     if ($hidepriv) {
                   7574:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7575:                             (!$nothide{$uname.':'.$udom})) {
                   7576:                             next;
                   7577:                         }
                   7578:                     }
1.503     raeburn  7579:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7580:                         $status = 'previous';
                   7581:                     } elsif ($start > $now) {
                   7582:                         $status = 'future';
                   7583:                     } else {
                   7584:                         $status = 'active';
                   7585:                     }
1.277     albertel 7586:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7587:                         if ($status eq $type) {
1.420     albertel 7588:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7589:                                 push(@{$$users{$role}{$user}},$type);
                   7590:                             }
1.288     raeburn  7591:                             $match = 1;
                   7592:                         }
                   7593:                     }
1.419     raeburn  7594:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7595:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7596: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7597:                         }
1.420     albertel 7598:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7599:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7600:                         }
1.609     raeburn  7601:                         if (ref($statushash) eq 'HASH') {
                   7602:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7603:                         }
1.275     raeburn  7604:                     }
                   7605:                 }
                   7606:             }
                   7607:         }
1.290     albertel 7608:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7609:             if ((defined($cdom)) && (defined($cnum))) {
                   7610:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7611:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7612:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7613:                     next if ($owner eq '');
                   7614:                     my ($ownername,$ownerdom);
                   7615:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7616:                         $ownername = $1;
                   7617:                         $ownerdom = $2;
                   7618:                     } else {
                   7619:                         $ownername = $owner;
                   7620:                         $ownerdom = $cdom;
                   7621:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7622:                     }
                   7623:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7624:                     if (defined($userdata) && 
1.609     raeburn  7625: 			!exists($$userdata{$owner})) {
                   7626: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7627:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7628:                             push(@{$seclists{$owner}},'none');
                   7629:                         }
                   7630:                         if (ref($statushash) eq 'HASH') {
                   7631:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7632:                         }
1.290     albertel 7633: 		    }
1.279     raeburn  7634:                 }
                   7635:             }
                   7636:         }
1.419     raeburn  7637:         foreach my $user (keys(%seclists)) {
                   7638:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7639:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7640:         }
1.275     raeburn  7641:     }
                   7642:     return;
                   7643: }
                   7644: 
1.288     raeburn  7645: sub get_user_info {
                   7646:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7647:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7648: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7649:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7650:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7651:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7652:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7653:     return;
                   7654: }
1.275     raeburn  7655: 
1.472     raeburn  7656: ###############################################
                   7657: 
                   7658: =pod
                   7659: 
                   7660: =item * &get_user_quota()
                   7661: 
                   7662: Retrieves quota assigned for storage of portfolio files for a user  
                   7663: 
                   7664: Incoming parameters:
                   7665: 1. user's username
                   7666: 2. user's domain
                   7667: 
                   7668: Returns:
1.536     raeburn  7669: 1. Disk quota (in Mb) assigned to student.
                   7670: 2. (Optional) Type of setting: custom or default
                   7671:    (individually assigned or default for user's 
                   7672:    institutional status).
                   7673: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7674:    or student - types as defined in localenroll::inst_usertypes 
                   7675:    for user's domain, which determines default quota for user.
                   7676: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7677: 
                   7678: If a value has been stored in the user's environment, 
1.536     raeburn  7679: it will return that, otherwise it returns the maximal default
                   7680: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7681: 
                   7682: =cut
                   7683: 
                   7684: ###############################################
                   7685: 
                   7686: 
                   7687: sub get_user_quota {
                   7688:     my ($uname,$udom) = @_;
1.536     raeburn  7689:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7690:     if (!defined($udom)) {
                   7691:         $udom = $env{'user.domain'};
                   7692:     }
                   7693:     if (!defined($uname)) {
                   7694:         $uname = $env{'user.name'};
                   7695:     }
                   7696:     if (($udom eq '' || $uname eq '') ||
                   7697:         ($udom eq 'public') && ($uname eq 'public')) {
                   7698:         $quota = 0;
1.536     raeburn  7699:         $quotatype = 'default';
                   7700:         $defquota = 0; 
1.472     raeburn  7701:     } else {
1.536     raeburn  7702:         my $inststatus;
1.472     raeburn  7703:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7704:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7705:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7706:         } else {
1.536     raeburn  7707:             my %userenv = 
                   7708:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7709:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7710:             my ($tmp) = keys(%userenv);
                   7711:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7712:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7713:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7714:             } else {
                   7715:                 undef(%userenv);
                   7716:             }
                   7717:         }
1.536     raeburn  7718:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7719:         if ($quota eq '') {
1.536     raeburn  7720:             $quota = $defquota;
                   7721:             $quotatype = 'default';
                   7722:         } else {
                   7723:             $quotatype = 'custom';
1.472     raeburn  7724:         }
                   7725:     }
1.536     raeburn  7726:     if (wantarray) {
                   7727:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7728:     } else {
                   7729:         return $quota;
                   7730:     }
1.472     raeburn  7731: }
                   7732: 
                   7733: ###############################################
                   7734: 
                   7735: =pod
                   7736: 
                   7737: =item * &default_quota()
                   7738: 
1.536     raeburn  7739: Retrieves default quota assigned for storage of user portfolio files,
                   7740: given an (optional) user's institutional status.
1.472     raeburn  7741: 
                   7742: Incoming parameters:
                   7743: 1. domain
1.536     raeburn  7744: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7745:    status types (e.g., faculty, staff, student etc.)
                   7746:    which apply to the user for whom the default is being retrieved.
                   7747:    If the institutional status string in undefined, the domain
                   7748:    default quota will be returned. 
1.472     raeburn  7749: 
                   7750: Returns:
                   7751: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7752: 2. (Optional) institutional type which determined the value of the
                   7753:    default quota.
1.472     raeburn  7754: 
                   7755: If a value has been stored in the domain's configuration db,
                   7756: it will return that, otherwise it returns 20 (for backwards 
                   7757: compatibility with domains which have not set up a configuration
                   7758: db file; the original statically defined portfolio quota was 20 Mb). 
                   7759: 
1.536     raeburn  7760: If the user's status includes multiple types (e.g., staff and student),
                   7761: the largest default quota which applies to the user determines the
                   7762: default quota returned.
                   7763: 
1.780     raeburn  7764: =back
                   7765: 
1.472     raeburn  7766: =cut
                   7767: 
                   7768: ###############################################
                   7769: 
                   7770: 
                   7771: sub default_quota {
1.536     raeburn  7772:     my ($udom,$inststatus) = @_;
                   7773:     my ($defquota,$settingstatus);
                   7774:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7775:                                             ['quotas'],$udom);
                   7776:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7777:         if ($inststatus ne '') {
1.765     raeburn  7778:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7779:             foreach my $item (@statuses) {
1.711     raeburn  7780:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7781:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7782:                         if ($defquota eq '') {
                   7783:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7784:                             $settingstatus = $item;
                   7785:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7786:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7787:                             $settingstatus = $item;
                   7788:                         }
                   7789:                     }
                   7790:                 } else {
                   7791:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7792:                         if ($defquota eq '') {
                   7793:                             $defquota = $quotahash{'quotas'}{$item};
                   7794:                             $settingstatus = $item;
                   7795:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7796:                             $defquota = $quotahash{'quotas'}{$item};
                   7797:                             $settingstatus = $item;
                   7798:                         }
1.536     raeburn  7799:                     }
                   7800:                 }
                   7801:             }
                   7802:         }
                   7803:         if ($defquota eq '') {
1.711     raeburn  7804:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7805:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7806:             } else {
                   7807:                 $defquota = $quotahash{'quotas'}{'default'};
                   7808:             }
1.536     raeburn  7809:             $settingstatus = 'default';
                   7810:         }
                   7811:     } else {
                   7812:         $settingstatus = 'default';
                   7813:         $defquota = 20;
                   7814:     }
                   7815:     if (wantarray) {
                   7816:         return ($defquota,$settingstatus);
1.472     raeburn  7817:     } else {
1.536     raeburn  7818:         return $defquota;
1.472     raeburn  7819:     }
                   7820: }
                   7821: 
1.384     raeburn  7822: sub get_secgrprole_info {
                   7823:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7824:     my %sections_count = &get_sections($cdom,$cnum);
                   7825:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7826:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7827:     my @groups = sort(keys(%curr_groups));
                   7828:     my $allroles = [];
                   7829:     my $rolehash;
                   7830:     my $accesshash = {
                   7831:                      active => 'Currently has access',
                   7832:                      future => 'Will have future access',
                   7833:                      previous => 'Previously had access',
                   7834:                   };
                   7835:     if ($needroles) {
                   7836:         $rolehash = {'all' => 'all'};
1.385     albertel 7837:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7838: 	if (&Apache::lonnet::error(%user_roles)) {
                   7839: 	    undef(%user_roles);
                   7840: 	}
                   7841:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7842:             my ($role)=split(/\:/,$item,2);
                   7843:             if ($role eq 'cr') { next; }
                   7844:             if ($role =~ /^cr/) {
                   7845:                 $$rolehash{$role} = (split('/',$role))[3];
                   7846:             } else {
                   7847:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7848:             }
                   7849:         }
                   7850:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7851:             push(@{$allroles},$key);
                   7852:         }
                   7853:         push (@{$allroles},'st');
                   7854:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7855:     }
                   7856:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7857: }
                   7858: 
1.555     raeburn  7859: sub user_picker {
1.627     raeburn  7860:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7861:     my $currdom = $dom;
                   7862:     my %curr_selected = (
                   7863:                         srchin => 'dom',
1.580     raeburn  7864:                         srchby => 'lastname',
1.555     raeburn  7865:                       );
                   7866:     my $srchterm;
1.625     raeburn  7867:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7868:         if ($srch->{'srchby'} ne '') {
                   7869:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7870:         }
                   7871:         if ($srch->{'srchin'} ne '') {
                   7872:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7873:         }
                   7874:         if ($srch->{'srchtype'} ne '') {
                   7875:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7876:         }
                   7877:         if ($srch->{'srchdomain'} ne '') {
                   7878:             $currdom = $srch->{'srchdomain'};
                   7879:         }
                   7880:         $srchterm = $srch->{'srchterm'};
                   7881:     }
                   7882:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7883:                     'usr'       => 'Search criteria',
1.563     raeburn  7884:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7885:                     'uname'     => 'username',
                   7886:                     'lastname'  => 'last name',
1.555     raeburn  7887:                     'lastfirst' => 'last name, first name',
1.558     albertel 7888:                     'crs'       => 'in this course',
1.576     raeburn  7889:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7890:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7891:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7892:                     'exact'     => 'is',
                   7893:                     'contains'  => 'contains',
1.569     raeburn  7894:                     'begins'    => 'begins with',
1.571     raeburn  7895:                     'youm'      => "You must include some text to search for.",
                   7896:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7897:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7898:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7899:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7900:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7901:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7902:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7903:                                        );
1.925.2.13  raeburn  7904:     my $domform = &select_dom_form($currdom,'srchdomain',undef,1);
1.563     raeburn  7905:     my $srchinsel = ' <select name="srchin">';
1.925.2.13  raeburn  7906:      
1.555     raeburn  7907:     my @srchins = ('crs','dom','alc','instd');
                   7908: 
                   7909:     foreach my $option (@srchins) {
                   7910:         # FIXME 'alc' option unavailable until 
                   7911:         #       loncreateuser::print_user_query_page()
                   7912:         #       has been completed.
                   7913:         next if ($option eq 'alc');
1.880     raeburn  7914:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7915:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.925.2.13  raeburn  7916:         next if ($option eq 'instd');
1.563     raeburn  7917:         if ($curr_selected{'srchin'} eq $option) {
                   7918:             $srchinsel .= ' 
1.925.2.13  raeburn  7919:        <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
1.563     raeburn  7920:         } else {
                   7921:             $srchinsel .= '
1.925.2.13  raeburn  7922:     <option value="'.$option.'">'.$lt{$option}.'</option>';
1.563     raeburn  7923:         }
1.555     raeburn  7924:     }
1.563     raeburn  7925:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7926: 
                   7927:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7928:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7929:         if ($curr_selected{'srchby'} eq $option) {
                   7930:             $srchbysel .= '
                   7931:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7932:         } else {
                   7933:             $srchbysel .= '
                   7934:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7935:          }
                   7936:     }
                   7937:     $srchbysel .= "\n  </select>\n";
                   7938: 
                   7939:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7940:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7941:         if ($curr_selected{'srchtype'} eq $option) {
                   7942:             $srchtypesel .= '
                   7943:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7944:         } else {
                   7945:             $srchtypesel .= '
                   7946:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7947:         }
                   7948:     }
                   7949:     $srchtypesel .= "\n  </select>\n";
                   7950: 
1.558     albertel 7951:     my ($newuserscript,$new_user_create);
1.556     raeburn  7952: 
                   7953:     if ($forcenewuser) {
1.576     raeburn  7954:         if (ref($srch) eq 'HASH') {
                   7955:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7956:                 if ($cancreate) {
                   7957:                     $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>';
                   7958:                 } else {
1.799     bisitz   7959:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7960:                     my %usertypetext = (
                   7961:                         official   => 'institutional',
                   7962:                         unofficial => 'non-institutional',
                   7963:                     );
1.799     bisitz   7964:                     $new_user_create = '<p class="LC_warning">'
                   7965:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
1.925.2.13  raeburn  7966:                                       .'<br />'
                   7967:                                       .&mt('Enter a valid e-mail address as the username for the new user.').' '.&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7968:                                       ,'<a href="'.$helplink.'">','</a>')
1.799     bisitz   7969:                                       .'</p><br />';
1.627     raeburn  7970:                 }
1.576     raeburn  7971:             }
                   7972:         }
                   7973: 
1.556     raeburn  7974:         $newuserscript = <<"ENDSCRIPT";
                   7975: 
1.570     raeburn  7976: function setSearch(createnew,callingForm) {
1.556     raeburn  7977:     if (createnew == 1) {
1.570     raeburn  7978:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7979:             if (callingForm.srchby.options[i].value == 'uname') {
                   7980:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7981:             }
                   7982:         }
1.570     raeburn  7983:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7984:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7985: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7986:             }
                   7987:         }
1.570     raeburn  7988:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7989:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7990:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7991:             }
                   7992:         }
1.570     raeburn  7993:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7994:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7995:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7996:             }
                   7997:         }
                   7998:     }
                   7999: }
                   8000: ENDSCRIPT
1.558     albertel 8001: 
1.556     raeburn  8002:     }
                   8003: 
1.555     raeburn  8004:     my $output = <<"END_BLOCK";
1.556     raeburn  8005: <script type="text/javascript">
1.824     bisitz   8006: // <![CDATA[
1.570     raeburn  8007: function validateEntry(callingForm) {
1.558     albertel 8008: 
1.556     raeburn  8009:     var checkok = 1;
1.558     albertel 8010:     var srchin;
1.570     raeburn  8011:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8012: 	if ( callingForm.srchin[i].checked ) {
                   8013: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8014: 	}
                   8015:     }
                   8016: 
1.570     raeburn  8017:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8018:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8019:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8020:     var srchterm =  callingForm.srchterm.value;
                   8021:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8022:     var msg = "";
                   8023: 
                   8024:     if (srchterm == "") {
                   8025:         checkok = 0;
1.571     raeburn  8026:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8027:     }
                   8028: 
1.569     raeburn  8029:     if (srchtype== 'begins') {
                   8030:         if (srchterm.length < 2) {
                   8031:             checkok = 0;
1.571     raeburn  8032:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8033:         }
                   8034:     }
                   8035: 
1.556     raeburn  8036:     if (srchtype== 'contains') {
                   8037:         if (srchterm.length < 3) {
                   8038:             checkok = 0;
1.571     raeburn  8039:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8040:         }
                   8041:     }
                   8042:     if (srchin == 'instd') {
                   8043:         if (srchdomain == '') {
                   8044:             checkok = 0;
1.571     raeburn  8045:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8046:         }
                   8047:     }
                   8048:     if (srchin == 'dom') {
                   8049:         if (srchdomain == '') {
                   8050:             checkok = 0;
1.571     raeburn  8051:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8052:         }
                   8053:     }
                   8054:     if (srchby == 'lastfirst') {
                   8055:         if (srchterm.indexOf(",") == -1) {
                   8056:             checkok = 0;
1.571     raeburn  8057:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8058:         }
                   8059:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8060:             checkok = 0;
1.571     raeburn  8061:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8062:         }
                   8063:     }
                   8064:     if (checkok == 0) {
1.571     raeburn  8065:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8066:         return;
                   8067:     }
                   8068:     if (checkok == 1) {
1.570     raeburn  8069:         callingForm.submit();
1.556     raeburn  8070:     }
                   8071: }
                   8072: 
                   8073: $newuserscript
                   8074: 
1.824     bisitz   8075: // ]]>
1.556     raeburn  8076: </script>
1.558     albertel 8077: 
                   8078: $new_user_create
                   8079: 
1.555     raeburn  8080: END_BLOCK
1.558     albertel 8081: 
1.876     raeburn  8082:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8083:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8084:                $domform.
                   8085:                &Apache::lonhtmlcommon::row_closure().
                   8086:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8087:                $srchbysel.
                   8088:                $srchtypesel. 
                   8089:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8090:                $srchinsel.
                   8091:                &Apache::lonhtmlcommon::row_closure(1). 
                   8092:                &Apache::lonhtmlcommon::end_pick_box().
                   8093:                '<br />';
1.555     raeburn  8094:     return $output;
                   8095: }
                   8096: 
1.612     raeburn  8097: sub user_rule_check {
1.615     raeburn  8098:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8099:     my $response;
                   8100:     if (ref($usershash) eq 'HASH') {
                   8101:         foreach my $user (keys(%{$usershash})) {
                   8102:             my ($uname,$udom) = split(/:/,$user);
                   8103:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8104:             my ($id,$newuser);
1.612     raeburn  8105:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8106:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8107:                 $id = $usershash->{$user}->{'id'};
                   8108:             }
                   8109:             my $inst_response;
                   8110:             if (ref($checks) eq 'HASH') {
                   8111:                 if (defined($checks->{'username'})) {
1.615     raeburn  8112:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8113:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8114:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8115:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8116:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8117:                 }
1.615     raeburn  8118:             } else {
                   8119:                 ($inst_response,%{$inst_results->{$user}}) =
                   8120:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8121:                 return;
1.612     raeburn  8122:             }
1.615     raeburn  8123:             if (!$got_rules->{$udom}) {
1.612     raeburn  8124:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8125:                                                   ['usercreation'],$udom);
                   8126:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8127:                     foreach my $item ('username','id') {
1.612     raeburn  8128:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8129:                             $$curr_rules{$udom}{$item} = 
                   8130:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8131:                         }
                   8132:                     }
                   8133:                 }
1.615     raeburn  8134:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8135:             }
1.612     raeburn  8136:             foreach my $item (keys(%{$checks})) {
                   8137:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8138:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8139:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8140:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8141:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8142:                                 if ($rule_check{$rule}) {
                   8143:                                     $$rulematch{$user}{$item} = $rule;
                   8144:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8145:                                         if (ref($inst_results) eq 'HASH') {
                   8146:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8147:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8148:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8149:                                                 }
1.612     raeburn  8150:                                             }
                   8151:                                         }
1.615     raeburn  8152:                                     }
                   8153:                                     last;
1.585     raeburn  8154:                                 }
                   8155:                             }
                   8156:                         }
                   8157:                     }
                   8158:                 }
                   8159:             }
                   8160:         }
                   8161:     }
1.612     raeburn  8162:     return;
                   8163: }
                   8164: 
                   8165: sub user_rule_formats {
                   8166:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8167:     my %text = ( 
                   8168:                  'username' => 'Usernames',
                   8169:                  'id'       => 'IDs',
                   8170:                );
                   8171:     my $output;
                   8172:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8173:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8174:         if (@{$ruleorder} > 0) {
                   8175:             $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>';
                   8176:             foreach my $rule (@{$ruleorder}) {
                   8177:                 if (ref($curr_rules) eq 'ARRAY') {
                   8178:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8179:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8180:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8181:                                         $rules->{$rule}{'desc'}.'</li>';
                   8182:                         }
                   8183:                     }
                   8184:                 }
                   8185:             }
                   8186:             $output .= '</ul>';
                   8187:         }
                   8188:     }
                   8189:     return $output;
                   8190: }
                   8191: 
                   8192: sub instrule_disallow_msg {
1.615     raeburn  8193:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8194:     my $response;
                   8195:     my %text = (
                   8196:                   item   => 'username',
                   8197:                   items  => 'usernames',
                   8198:                   match  => 'matches',
                   8199:                   do     => 'does',
                   8200:                   action => 'a username',
                   8201:                   one    => 'one',
                   8202:                );
                   8203:     if ($count > 1) {
                   8204:         $text{'item'} = 'usernames';
                   8205:         $text{'match'} ='match';
                   8206:         $text{'do'} = 'do';
                   8207:         $text{'action'} = 'usernames',
                   8208:         $text{'one'} = 'ones';
                   8209:     }
                   8210:     if ($checkitem eq 'id') {
                   8211:         $text{'items'} = 'IDs';
                   8212:         $text{'item'} = 'ID';
                   8213:         $text{'action'} = 'an ID';
1.615     raeburn  8214:         if ($count > 1) {
                   8215:             $text{'item'} = 'IDs';
                   8216:             $text{'action'} = 'IDs';
                   8217:         }
1.612     raeburn  8218:     }
1.674     bisitz   8219:     $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  8220:     if ($mode eq 'upload') {
                   8221:         if ($checkitem eq 'username') {
                   8222:             $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'}.");
                   8223:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8224:             $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  8225:         }
1.669     raeburn  8226:     } elsif ($mode eq 'selfcreate') {
                   8227:         if ($checkitem eq 'id') {
                   8228:             $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.");
                   8229:         }
1.615     raeburn  8230:     } else {
                   8231:         if ($checkitem eq 'username') {
                   8232:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8233:         } elsif ($checkitem eq 'id') {
                   8234:             $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.");
                   8235:         }
1.612     raeburn  8236:     }
                   8237:     return $response;
1.585     raeburn  8238: }
                   8239: 
1.624     raeburn  8240: sub personal_data_fieldtitles {
                   8241:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8242:                         id => 'Student/Employee ID',
                   8243:                         permanentemail => 'E-mail address',
                   8244:                         lastname => 'Last Name',
                   8245:                         firstname => 'First Name',
                   8246:                         middlename => 'Middle Name',
                   8247:                         generation => 'Generation',
                   8248:                         gen => 'Generation',
1.765     raeburn  8249:                         inststatus => 'Affiliation',
1.624     raeburn  8250:                    );
                   8251:     return %fieldtitles;
                   8252: }
                   8253: 
1.642     raeburn  8254: sub sorted_inst_types {
                   8255:     my ($dom) = @_;
                   8256:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8257:     my $othertitle = &mt('All users');
                   8258:     if ($env{'request.course.id'}) {
1.668     raeburn  8259:         $othertitle  = &mt('Any users');
1.642     raeburn  8260:     }
                   8261:     my @types;
                   8262:     if (ref($order) eq 'ARRAY') {
                   8263:         @types = @{$order};
                   8264:     }
                   8265:     if (@types == 0) {
                   8266:         if (ref($usertypes) eq 'HASH') {
                   8267:             @types = sort(keys(%{$usertypes}));
                   8268:         }
                   8269:     }
                   8270:     if (keys(%{$usertypes}) > 0) {
                   8271:         $othertitle = &mt('Other users');
                   8272:     }
                   8273:     return ($othertitle,$usertypes,\@types);
                   8274: }
                   8275: 
1.645     raeburn  8276: sub get_institutional_codes {
                   8277:     my ($settings,$allcourses,$LC_code) = @_;
                   8278: # Get complete list of course sections to update
                   8279:     my @currsections = ();
                   8280:     my @currxlists = ();
                   8281:     my $coursecode = $$settings{'internal.coursecode'};
                   8282: 
                   8283:     if ($$settings{'internal.sectionnums'} ne '') {
                   8284:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8285:     }
                   8286: 
                   8287:     if ($$settings{'internal.crosslistings'} ne '') {
                   8288:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8289:     }
                   8290: 
                   8291:     if (@currxlists > 0) {
                   8292:         foreach (@currxlists) {
                   8293:             if (m/^([^:]+):(\w*)$/) {
                   8294:                 unless (grep/^$1$/,@{$allcourses}) {
                   8295:                     push @{$allcourses},$1;
                   8296:                     $$LC_code{$1} = $2;
                   8297:                 }
                   8298:             }
                   8299:         }
                   8300:     }
                   8301:  
                   8302:     if (@currsections > 0) {
                   8303:         foreach (@currsections) {
                   8304:             if (m/^(\w+):(\w*)$/) {
                   8305:                 my $sec = $coursecode.$1;
                   8306:                 my $lc_sec = $2;
                   8307:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8308:                     push @{$allcourses},$sec;
                   8309:                     $$LC_code{$sec} = $lc_sec;
                   8310:                 }
                   8311:             }
                   8312:         }
                   8313:     }
                   8314:     return;
                   8315: }
                   8316: 
1.112     bowersj2 8317: =pod
                   8318: 
1.780     raeburn  8319: =head1 Slot Helpers
                   8320: 
                   8321: =over 4
                   8322: 
                   8323: =item * sorted_slots()
                   8324: 
                   8325: Sorts an array of slot names in order of slot start time (earliest first). 
                   8326: 
                   8327: Inputs:
                   8328: 
                   8329: =over 4
                   8330: 
                   8331: slotsarr  - Reference to array of unsorted slot names.
                   8332: 
                   8333: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8334: 
1.549     albertel 8335: =back
                   8336: 
1.780     raeburn  8337: Returns:
                   8338: 
                   8339: =over 4
                   8340: 
                   8341: sorted   - An array of slot names sorted by the start time of the slot.
                   8342: 
                   8343: =back
                   8344: 
                   8345: =back
                   8346: 
                   8347: =cut
                   8348: 
                   8349: 
                   8350: sub sorted_slots {
                   8351:     my ($slotsarr,$slots) = @_;
                   8352:     my @sorted;
                   8353:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8354:         @sorted =
                   8355:             sort {
                   8356:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8357:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8358:                      }
                   8359:                      if (ref($slots->{$a})) { return -1;}
                   8360:                      if (ref($slots->{$b})) { return 1;}
                   8361:                      return 0;
                   8362:                  } @{$slotsarr};
                   8363:     }
                   8364:     return @sorted;
                   8365: }
                   8366: 
                   8367: 
                   8368: =pod
                   8369: 
1.549     albertel 8370: =head1 HTTP Helpers
                   8371: 
                   8372: =over 4
                   8373: 
1.648     raeburn  8374: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8375: 
1.258     albertel 8376: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8377: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8378: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8379: 
                   8380: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8381: $possible_names is an ref to an array of form element names.  As an example:
                   8382: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8383: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8384: 
                   8385: =cut
1.1       albertel 8386: 
1.6       albertel 8387: sub get_unprocessed_cgi {
1.25      albertel 8388:   my ($query,$possible_names)= @_;
1.26      matthew  8389:   # $Apache::lonxml::debug=1;
1.356     albertel 8390:   foreach my $pair (split(/&/,$query)) {
                   8391:     my ($name, $value) = split(/=/,$pair);
1.369     www      8392:     $name = &unescape($name);
1.25      albertel 8393:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8394:       $value =~ tr/+/ /;
                   8395:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8396:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8397:     }
1.16      harris41 8398:   }
1.6       albertel 8399: }
                   8400: 
1.112     bowersj2 8401: =pod
                   8402: 
1.648     raeburn  8403: =item * &cacheheader() 
1.112     bowersj2 8404: 
                   8405: returns cache-controlling header code
                   8406: 
                   8407: =cut
                   8408: 
1.7       albertel 8409: sub cacheheader {
1.258     albertel 8410:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8411:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8412:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8413:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8414:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8415:     return $output;
1.7       albertel 8416: }
                   8417: 
1.112     bowersj2 8418: =pod
                   8419: 
1.648     raeburn  8420: =item * &no_cache($r) 
1.112     bowersj2 8421: 
                   8422: specifies header code to not have cache
                   8423: 
                   8424: =cut
                   8425: 
1.9       albertel 8426: sub no_cache {
1.216     albertel 8427:     my ($r) = @_;
                   8428:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8429: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8430:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8431:     $r->no_cache(1);
                   8432:     $r->header_out("Expires" => $date);
                   8433:     $r->header_out("Pragma" => "no-cache");
1.123     www      8434: }
                   8435: 
                   8436: sub content_type {
1.181     albertel 8437:     my ($r,$type,$charset) = @_;
1.299     foxr     8438:     if ($r) {
                   8439: 	#  Note that printout.pl calls this with undef for $r.
                   8440: 	&no_cache($r);
                   8441:     }
1.258     albertel 8442:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8443:     unless ($charset) {
                   8444: 	$charset=&Apache::lonlocal::current_encoding;
                   8445:     }
                   8446:     if ($charset) { $type.='; charset='.$charset; }
                   8447:     if ($r) {
                   8448: 	$r->content_type($type);
                   8449:     } else {
                   8450: 	print("Content-type: $type\n\n");
                   8451:     }
1.9       albertel 8452: }
1.25      albertel 8453: 
1.112     bowersj2 8454: =pod
                   8455: 
1.648     raeburn  8456: =item * &add_to_env($name,$value) 
1.112     bowersj2 8457: 
1.258     albertel 8458: adds $name to the %env hash with value
1.112     bowersj2 8459: $value, if $name already exists, the entry is converted to an array
                   8460: reference and $value is added to the array.
                   8461: 
                   8462: =cut
                   8463: 
1.25      albertel 8464: sub add_to_env {
                   8465:   my ($name,$value)=@_;
1.258     albertel 8466:   if (defined($env{$name})) {
                   8467:     if (ref($env{$name})) {
1.25      albertel 8468:       #already have multiple values
1.258     albertel 8469:       push(@{ $env{$name} },$value);
1.25      albertel 8470:     } else {
                   8471:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8472:       my $first=$env{$name};
                   8473:       undef($env{$name});
                   8474:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8475:     }
                   8476:   } else {
1.258     albertel 8477:     $env{$name}=$value;
1.25      albertel 8478:   }
1.31      albertel 8479: }
1.149     albertel 8480: 
                   8481: =pod
                   8482: 
1.648     raeburn  8483: =item * &get_env_multiple($name) 
1.149     albertel 8484: 
1.258     albertel 8485: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8486: values may be defined and end up as an array ref.
                   8487: 
                   8488: returns an array of values
                   8489: 
                   8490: =cut
                   8491: 
                   8492: sub get_env_multiple {
                   8493:     my ($name) = @_;
                   8494:     my @values;
1.258     albertel 8495:     if (defined($env{$name})) {
1.149     albertel 8496:         # exists is it an array
1.258     albertel 8497:         if (ref($env{$name})) {
                   8498:             @values=@{ $env{$name} };
1.149     albertel 8499:         } else {
1.258     albertel 8500:             $values[0]=$env{$name};
1.149     albertel 8501:         }
                   8502:     }
                   8503:     return(@values);
                   8504: }
                   8505: 
1.660     raeburn  8506: sub ask_for_embedded_content {
                   8507:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8508:     my $upload_output = '
                   8509:    <form name="upload_embedded" action="'.$actionurl.'"
                   8510:                   method="post" enctype="multipart/form-data">';
                   8511:     $upload_output .= $state;
1.661     raeburn  8512:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8513: 
                   8514:     my $num = 0;
                   8515:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8516:         $upload_output .= &start_data_table_row().
                   8517:             '<td>'.$embed_file.'</td><td>';
                   8518:         if ($args->{'ignore_remote_references'}
                   8519:             && $embed_file =~ m{^\w+://}) {
                   8520:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8521:         } elsif ($args->{'error_on_invalid_names'}
                   8522:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8523: 
                   8524:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8525: 
                   8526:         } else {
                   8527:             $upload_output .='
1.661     raeburn  8528:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8529:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8530:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8531:             $upload_output .=
                   8532:                 "\n\t\t".
                   8533:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8534:                 $attrib.'" />';
                   8535:             if (exists($$codebase{$embed_file})) {
                   8536:                 $upload_output .=
                   8537:                     "\n\t\t".
                   8538:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8539:                     &escape($$codebase{$embed_file}).'" />';
                   8540:             }
                   8541:         }
                   8542:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8543:         $num++;
                   8544:     }
                   8545:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8546:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8547:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8548:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8549:    </form>';
                   8550:     return $upload_output;
                   8551: }
                   8552: 
1.661     raeburn  8553: sub upload_embedded {
                   8554:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8555:         $current_disk_usage) = @_;
                   8556:     my $output;
                   8557:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8558:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8559:         my $orig_uploaded_filename =
                   8560:             $env{'form.embedded_item_'.$i.'.filename'};
                   8561: 
                   8562:         $env{'form.embedded_orig_'.$i} =
                   8563:             &unescape($env{'form.embedded_orig_'.$i});
                   8564:         my ($path,$fname) =
                   8565:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8566:         # no path, whole string is fname
                   8567:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8568: 
                   8569:         $path = $env{'form.currentpath'}.$path;
                   8570:         $fname = &Apache::lonnet::clean_filename($fname);
                   8571:         # See if there is anything left
                   8572:         next if ($fname eq '');
                   8573: 
                   8574:         # Check if file already exists as a file or directory.
                   8575:         my ($state,$msg);
                   8576:         if ($context eq 'portfolio') {
                   8577:             my $port_path = $dirpath;
                   8578:             if ($group ne '') {
                   8579:                 $port_path = "groups/$group/$port_path";
                   8580:             }
                   8581:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8582:                                               $dir_root,$port_path,$disk_quota,
                   8583:                                               $current_disk_usage,$uname,$udom);
                   8584:             if ($state eq 'will_exceed_quota'
                   8585:                 || $state eq 'file_locked'
                   8586:                 || $state eq 'file_exists' ) {
                   8587:                 $output .= $msg;
                   8588:                 next;
                   8589:             }
                   8590:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8591:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8592:             if ($state eq 'exists') {
                   8593:                 $output .= $msg;
                   8594:                 next;
                   8595:             }
                   8596:         }
                   8597:         # Check if extension is valid
                   8598:         if (($fname =~ /\.(\w+)$/) &&
                   8599:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8600:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8601:             next;
                   8602:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8603:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8604:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8605:             next;
                   8606:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8607:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8608:             next;
                   8609:         }
                   8610: 
                   8611:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8612:         if ($context eq 'portfolio') {
                   8613:             my $result=
                   8614:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8615:                                                 $dirpath.$path);
                   8616:             if ($result !~ m|^/uploaded/|) {
                   8617:                 $output .= '<span class="LC_error">'
                   8618:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8619:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8620:                       .'</span><br />';
                   8621:                 next;
                   8622:             } else {
                   8623:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8624:                            $path.$fname.'</span>').'</p>';     
                   8625:             }
                   8626:         } else {
                   8627: # Save the file
                   8628:             my $target = $env{'form.embedded_item_'.$i};
                   8629:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8630:             my $dest = $fullpath.$fname;
                   8631:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8632:             my @parts=split(/\//,$fullpath);
                   8633:             my $count;
                   8634:             my $filepath = $dir_root;
                   8635:             for ($count=4;$count<=$#parts;$count++) {
                   8636:                 $filepath .= "/$parts[$count]";
                   8637:                 if ((-e $filepath)!=1) {
                   8638:                     mkdir($filepath,0770);
                   8639:                 }
                   8640:             }
                   8641:             my $fh;
                   8642:             if (!open($fh,'>'.$dest)) {
                   8643:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8644:                 $output .= '<span class="LC_error">'.
                   8645:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8646:                            '</span><br />';
                   8647:             } else {
                   8648:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8649:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8650:                     $output .= '<span class="LC_error">'.
                   8651:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8652:                               '</span><br />';
                   8653:                 } else {
                   8654:                     if ($context eq 'testbank') {
                   8655:                         $output .= &mt('Embedded file uploaded successfully:').
                   8656:                                    '&nbsp;<a href="'.$url.'">'.
                   8657:                                    $orig_uploaded_filename.'</a><br />';
                   8658:                     } else {
1.705     tempelho 8659:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8660:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8661:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8662:                     }
                   8663:                 }
                   8664:                 close($fh);
                   8665:             }
                   8666:         }
                   8667:     }
                   8668:     return $output;
                   8669: }
                   8670: 
                   8671: sub check_for_existing {
                   8672:     my ($path,$fname,$element) = @_;
                   8673:     my ($state,$msg);
                   8674:     if (-d $path.'/'.$fname) {
                   8675:         $state = 'exists';
                   8676:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8677:     } elsif (-e $path.'/'.$fname) {
                   8678:         $state = 'exists';
                   8679:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8680:     }
                   8681:     if ($state eq 'exists') {
                   8682:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8683:     }
                   8684:     return ($state,$msg);
                   8685: }
                   8686: 
                   8687: sub check_for_upload {
                   8688:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8689:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8690:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8691:     my $getpropath = 1;
                   8692:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8693:                                             $getpropath);
                   8694:     my $found_file = 0;
                   8695:     my $locked_file = 0;
                   8696:     foreach my $line (@dir_list) {
                   8697:         my ($file_name)=split(/\&/,$line,2);
                   8698:         if ($file_name eq $fname){
                   8699:             $file_name = $path.$file_name;
                   8700:             if ($group ne '') {
                   8701:                 $file_name = $group.$file_name;
                   8702:             }
                   8703:             $found_file = 1;
                   8704:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8705:                 $locked_file = 1;
                   8706:             }
                   8707:         }
                   8708:     }
                   8709:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8710:         my $msg = '<span class="LC_error">'.
                   8711:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8712:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8713:         return ('will_exceed_quota',$msg);
                   8714:     } elsif ($found_file) {
                   8715:         if ($locked_file) {
                   8716:             my $msg = '<span class="LC_error">';
                   8717:             $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>');
                   8718:             $msg .= '</span><br />';
                   8719:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8720:             return ('file_locked',$msg);
                   8721:         } else {
                   8722:             my $msg = '<span class="LC_error">';
                   8723:             $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'});
                   8724:             $msg .= '</span>';
                   8725:             $msg .= '<br />';
                   8726:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8727:             return ('file_exists',$msg);
                   8728:         }
                   8729:     }
                   8730: }
                   8731: 
1.31      albertel 8732: 
1.41      ng       8733: =pod
1.45      matthew  8734: 
1.464     albertel 8735: =back
1.41      ng       8736: 
1.112     bowersj2 8737: =head1 CSV Upload/Handling functions
1.38      albertel 8738: 
1.41      ng       8739: =over 4
                   8740: 
1.648     raeburn  8741: =item * &upfile_store($r)
1.41      ng       8742: 
                   8743: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8744: needs $env{'form.upfile'}
1.41      ng       8745: returns $datatoken to be put into hidden field
                   8746: 
                   8747: =cut
1.31      albertel 8748: 
                   8749: sub upfile_store {
                   8750:     my $r=shift;
1.258     albertel 8751:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8752:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8753:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8754:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8755: 
1.258     albertel 8756:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8757: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8758:     {
1.158     raeburn  8759:         my $datafile = $r->dir_config('lonDaemons').
                   8760:                            '/tmp/'.$datatoken.'.tmp';
                   8761:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8762:             print $fh $env{'form.upfile'};
1.158     raeburn  8763:             close($fh);
                   8764:         }
1.31      albertel 8765:     }
                   8766:     return $datatoken;
                   8767: }
                   8768: 
1.56      matthew  8769: =pod
                   8770: 
1.648     raeburn  8771: =item * &load_tmp_file($r)
1.41      ng       8772: 
                   8773: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8774: needs $env{'form.datatoken'},
                   8775: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8776: 
                   8777: =cut
1.31      albertel 8778: 
                   8779: sub load_tmp_file {
                   8780:     my $r=shift;
                   8781:     my @studentdata=();
                   8782:     {
1.158     raeburn  8783:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8784:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8785:         if ( open(my $fh,"<$studentfile") ) {
                   8786:             @studentdata=<$fh>;
                   8787:             close($fh);
                   8788:         }
1.31      albertel 8789:     }
1.258     albertel 8790:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8791: }
                   8792: 
1.56      matthew  8793: =pod
                   8794: 
1.648     raeburn  8795: =item * &upfile_record_sep()
1.41      ng       8796: 
                   8797: Separate uploaded file into records
                   8798: returns array of records,
1.258     albertel 8799: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8800: 
                   8801: =cut
1.31      albertel 8802: 
                   8803: sub upfile_record_sep {
1.258     albertel 8804:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8805:     } else {
1.248     albertel 8806: 	my @records;
1.258     albertel 8807: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8808: 	    if ($line=~/^\s*$/) { next; }
                   8809: 	    push(@records,$line);
                   8810: 	}
                   8811: 	return @records;
1.31      albertel 8812:     }
                   8813: }
                   8814: 
1.56      matthew  8815: =pod
                   8816: 
1.648     raeburn  8817: =item * &record_sep($record)
1.41      ng       8818: 
1.258     albertel 8819: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8820: 
                   8821: =cut
                   8822: 
1.263     www      8823: sub takeleft {
                   8824:     my $index=shift;
                   8825:     return substr('0000'.$index,-4,4);
                   8826: }
                   8827: 
1.31      albertel 8828: sub record_sep {
                   8829:     my $record=shift;
                   8830:     my %components=();
1.258     albertel 8831:     if ($env{'form.upfiletype'} eq 'xml') {
                   8832:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8833:         my $i=0;
1.356     albertel 8834:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8835:             $field=~s/^(\"|\')//;
                   8836:             $field=~s/(\"|\')$//;
1.263     www      8837:             $components{&takeleft($i)}=$field;
1.31      albertel 8838:             $i++;
                   8839:         }
1.258     albertel 8840:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8841:         my $i=0;
1.356     albertel 8842:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8843:             $field=~s/^(\"|\')//;
                   8844:             $field=~s/(\"|\')$//;
1.263     www      8845:             $components{&takeleft($i)}=$field;
1.31      albertel 8846:             $i++;
                   8847:         }
                   8848:     } else {
1.561     www      8849:         my $separator=',';
1.480     banghart 8850:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8851:             $separator=';';
1.480     banghart 8852:         }
1.31      albertel 8853:         my $i=0;
1.561     www      8854: # the character we are looking for to indicate the end of a quote or a record 
                   8855:         my $looking_for=$separator;
                   8856: # do not add the characters to the fields
                   8857:         my $ignore=0;
                   8858: # we just encountered a separator (or the beginning of the record)
                   8859:         my $just_found_separator=1;
                   8860: # store the field we are working on here
                   8861:         my $field='';
                   8862: # work our way through all characters in record
                   8863:         foreach my $character ($record=~/(.)/g) {
                   8864:             if ($character eq $looking_for) {
                   8865:                if ($character ne $separator) {
                   8866: # Found the end of a quote, again looking for separator
                   8867:                   $looking_for=$separator;
                   8868:                   $ignore=1;
                   8869:                } else {
                   8870: # Found a separator, store away what we got
                   8871:                   $components{&takeleft($i)}=$field;
                   8872: 	          $i++;
                   8873:                   $just_found_separator=1;
                   8874:                   $ignore=0;
                   8875:                   $field='';
                   8876:                }
                   8877:                next;
                   8878:             }
                   8879: # single or double quotation marks after a separator indicate beginning of a quote
                   8880: # we are now looking for the end of the quote and need to ignore separators
                   8881:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8882:                $looking_for=$character;
                   8883:                next;
                   8884:             }
                   8885: # ignore would be true after we reached the end of a quote
                   8886:             if ($ignore) { next; }
                   8887:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8888:             $field.=$character;
                   8889:             $just_found_separator=0; 
1.31      albertel 8890:         }
1.561     www      8891: # catch the very last entry, since we never encountered the separator
                   8892:         $components{&takeleft($i)}=$field;
1.31      albertel 8893:     }
                   8894:     return %components;
                   8895: }
                   8896: 
1.144     matthew  8897: ######################################################
                   8898: ######################################################
                   8899: 
1.56      matthew  8900: =pod
                   8901: 
1.648     raeburn  8902: =item * &upfile_select_html()
1.41      ng       8903: 
1.144     matthew  8904: Return HTML code to select a file from the users machine and specify 
                   8905: the file type.
1.41      ng       8906: 
                   8907: =cut
                   8908: 
1.144     matthew  8909: ######################################################
                   8910: ######################################################
1.31      albertel 8911: sub upfile_select_html {
1.144     matthew  8912:     my %Types = (
                   8913:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8914:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8915:                  space => &mt('Space separated'),
                   8916:                  tab   => &mt('Tabulator separated'),
                   8917: #                 xml   => &mt('HTML/XML'),
                   8918:                  );
                   8919:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8920:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8921:     foreach my $type (sort(keys(%Types))) {
                   8922:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8923:     }
                   8924:     $Str .= "</select>\n";
                   8925:     return $Str;
1.31      albertel 8926: }
                   8927: 
1.301     albertel 8928: sub get_samples {
                   8929:     my ($records,$toget) = @_;
                   8930:     my @samples=({});
                   8931:     my $got=0;
                   8932:     foreach my $rec (@$records) {
                   8933: 	my %temp = &record_sep($rec);
                   8934: 	if (! grep(/\S/, values(%temp))) { next; }
                   8935: 	if (%temp) {
                   8936: 	    $samples[$got]=\%temp;
                   8937: 	    $got++;
                   8938: 	    if ($got == $toget) { last; }
                   8939: 	}
                   8940:     }
                   8941:     return \@samples;
                   8942: }
                   8943: 
1.144     matthew  8944: ######################################################
                   8945: ######################################################
                   8946: 
1.56      matthew  8947: =pod
                   8948: 
1.648     raeburn  8949: =item * &csv_print_samples($r,$records)
1.41      ng       8950: 
                   8951: Prints a table of sample values from each column uploaded $r is an
                   8952: Apache Request ref, $records is an arrayref from
                   8953: &Apache::loncommon::upfile_record_sep
                   8954: 
                   8955: =cut
                   8956: 
1.144     matthew  8957: ######################################################
                   8958: ######################################################
1.31      albertel 8959: sub csv_print_samples {
                   8960:     my ($r,$records) = @_;
1.662     bisitz   8961:     my $samples = &get_samples($records,5);
1.301     albertel 8962: 
1.594     raeburn  8963:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8964:               &start_data_table_header_row());
1.356     albertel 8965:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8966:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8967:     $r->print(&end_data_table_header_row());
1.301     albertel 8968:     foreach my $hash (@$samples) {
1.594     raeburn  8969: 	$r->print(&start_data_table_row());
1.356     albertel 8970: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8971: 	    $r->print('<td>');
1.356     albertel 8972: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8973: 	    $r->print('</td>');
                   8974: 	}
1.594     raeburn  8975: 	$r->print(&end_data_table_row());
1.31      albertel 8976:     }
1.594     raeburn  8977:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8978: }
                   8979: 
1.144     matthew  8980: ######################################################
                   8981: ######################################################
                   8982: 
1.56      matthew  8983: =pod
                   8984: 
1.648     raeburn  8985: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8986: 
                   8987: Prints a table to create associations between values and table columns.
1.144     matthew  8988: 
1.41      ng       8989: $r is an Apache Request ref,
                   8990: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8991: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8992: 
                   8993: =cut
                   8994: 
1.144     matthew  8995: ######################################################
                   8996: ######################################################
1.31      albertel 8997: sub csv_print_select_table {
                   8998:     my ($r,$records,$d) = @_;
1.301     albertel 8999:     my $i=0;
                   9000:     my $samples = &get_samples($records,1);
1.144     matthew  9001:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  9002: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  9003:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  9004:               '<th>'.&mt('Column').'</th>'.
                   9005:               &end_data_table_header_row()."\n");
1.356     albertel 9006:     foreach my $array_ref (@$d) {
                   9007: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  9008: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 9009: 
1.875     bisitz   9010: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  9011: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 9012: 	$r->print('<option value="none"></option>');
1.356     albertel 9013: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   9014: 	    $r->print('<option value="'.$sample.'"'.
                   9015:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   9016:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 9017: 	}
1.594     raeburn  9018: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 9019: 	$i++;
                   9020:     }
1.594     raeburn  9021:     $r->print(&end_data_table());
1.31      albertel 9022:     $i--;
                   9023:     return $i;
                   9024: }
1.56      matthew  9025: 
1.144     matthew  9026: ######################################################
                   9027: ######################################################
                   9028: 
1.56      matthew  9029: =pod
1.31      albertel 9030: 
1.648     raeburn  9031: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       9032: 
                   9033: Prints a table of sample values from the upload and can make associate samples to internal names.
                   9034: 
                   9035: $r is an Apache Request ref,
                   9036: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   9037: $d is an array of 2 element arrays (internal name, displayed name)
                   9038: 
                   9039: =cut
                   9040: 
1.144     matthew  9041: ######################################################
                   9042: ######################################################
1.31      albertel 9043: sub csv_samples_select_table {
                   9044:     my ($r,$records,$d) = @_;
                   9045:     my $i=0;
1.144     matthew  9046:     #
1.662     bisitz   9047:     my $max_samples = 5;
                   9048:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  9049:     $r->print(&start_data_table().
                   9050:               &start_data_table_header_row().'<th>'.
                   9051:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   9052:               &end_data_table_header_row());
1.301     albertel 9053: 
                   9054:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  9055: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  9056: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 9057: 	foreach my $option (@$d) {
                   9058: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  9059: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 9060:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  9061:                       $display.'</option>');
1.31      albertel 9062: 	}
                   9063: 	$r->print('</select></td><td>');
1.662     bisitz   9064: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 9065: 	    if (defined($samples->[$line]{$key})) { 
                   9066: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   9067: 	    }
                   9068: 	}
1.594     raeburn  9069: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 9070: 	$i++;
                   9071:     }
1.594     raeburn  9072:     $r->print(&end_data_table());
1.31      albertel 9073:     $i--;
                   9074:     return($i);
1.115     matthew  9075: }
                   9076: 
1.144     matthew  9077: ######################################################
                   9078: ######################################################
                   9079: 
1.115     matthew  9080: =pod
                   9081: 
1.648     raeburn  9082: =item * &clean_excel_name($name)
1.115     matthew  9083: 
                   9084: Returns a replacement for $name which does not contain any illegal characters.
                   9085: 
                   9086: =cut
                   9087: 
1.144     matthew  9088: ######################################################
                   9089: ######################################################
1.115     matthew  9090: sub clean_excel_name {
                   9091:     my ($name) = @_;
                   9092:     $name =~ s/[:\*\?\/\\]//g;
                   9093:     if (length($name) > 31) {
                   9094:         $name = substr($name,0,31);
                   9095:     }
                   9096:     return $name;
1.25      albertel 9097: }
1.84      albertel 9098: 
1.85      albertel 9099: =pod
                   9100: 
1.648     raeburn  9101: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 9102: 
                   9103: Returns either 1 or undef
                   9104: 
                   9105: 1 if the part is to be hidden, undef if it is to be shown
                   9106: 
                   9107: Arguments are:
                   9108: 
                   9109: $id the id of the part to be checked
                   9110: $symb, optional the symb of the resource to check
                   9111: $udom, optional the domain of the user to check for
                   9112: $uname, optional the username of the user to check for
                   9113: 
                   9114: =cut
1.84      albertel 9115: 
                   9116: sub check_if_partid_hidden {
                   9117:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 9118:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 9119: 					 $symb,$udom,$uname);
1.141     albertel 9120:     my $truth=1;
                   9121:     #if the string starts with !, then the list is the list to show not hide
                   9122:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 9123:     my @hiddenlist=split(/,/,$hiddenparts);
                   9124:     foreach my $checkid (@hiddenlist) {
1.141     albertel 9125: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 9126:     }
1.141     albertel 9127:     return !$truth;
1.84      albertel 9128: }
1.127     matthew  9129: 
1.138     matthew  9130: 
                   9131: ############################################################
                   9132: ############################################################
                   9133: 
                   9134: =pod
                   9135: 
1.157     matthew  9136: =back 
                   9137: 
1.138     matthew  9138: =head1 cgi-bin script and graphing routines
                   9139: 
1.157     matthew  9140: =over 4
                   9141: 
1.648     raeburn  9142: =item * &get_cgi_id()
1.138     matthew  9143: 
                   9144: Inputs: none
                   9145: 
                   9146: Returns an id which can be used to pass environment variables
                   9147: to various cgi-bin scripts.  These environment variables will
                   9148: be removed from the users environment after a given time by
                   9149: the routine &Apache::lonnet::transfer_profile_to_env.
                   9150: 
                   9151: =cut
                   9152: 
                   9153: ############################################################
                   9154: ############################################################
1.152     albertel 9155: my $uniq=0;
1.136     matthew  9156: sub get_cgi_id {
1.154     albertel 9157:     $uniq=($uniq+1)%100000;
1.280     albertel 9158:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  9159: }
                   9160: 
1.127     matthew  9161: ############################################################
                   9162: ############################################################
                   9163: 
                   9164: =pod
                   9165: 
1.648     raeburn  9166: =item * &DrawBarGraph()
1.127     matthew  9167: 
1.138     matthew  9168: Facilitates the plotting of data in a (stacked) bar graph.
                   9169: Puts plot definition data into the users environment in order for 
                   9170: graph.png to plot it.  Returns an <img> tag for the plot.
                   9171: The bars on the plot are labeled '1','2',...,'n'.
                   9172: 
                   9173: Inputs:
                   9174: 
                   9175: =over 4
                   9176: 
                   9177: =item $Title: string, the title of the plot
                   9178: 
                   9179: =item $xlabel: string, text describing the X-axis of the plot
                   9180: 
                   9181: =item $ylabel: string, text describing the Y-axis of the plot
                   9182: 
                   9183: =item $Max: scalar, the maximum Y value to use in the plot
                   9184: If $Max is < any data point, the graph will not be rendered.
                   9185: 
1.140     matthew  9186: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  9187: they are plotted.  If undefined, default values will be used.
                   9188: 
1.178     matthew  9189: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   9190: 
1.138     matthew  9191: =item @Values: An array of array references.  Each array reference holds data
                   9192: to be plotted in a stacked bar chart.
                   9193: 
1.239     matthew  9194: =item If the final element of @Values is a hash reference the key/value
                   9195: pairs will be added to the graph definition.
                   9196: 
1.138     matthew  9197: =back
                   9198: 
                   9199: Returns:
                   9200: 
                   9201: An <img> tag which references graph.png and the appropriate identifying
                   9202: information for the plot.
                   9203: 
1.127     matthew  9204: =cut
                   9205: 
                   9206: ############################################################
                   9207: ############################################################
1.134     matthew  9208: sub DrawBarGraph {
1.178     matthew  9209:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  9210:     #
                   9211:     if (! defined($colors)) {
                   9212:         $colors = ['#33ff00', 
                   9213:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9214:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9215:                   ]; 
                   9216:     }
1.228     matthew  9217:     my $extra_settings = {};
                   9218:     if (ref($Values[-1]) eq 'HASH') {
                   9219:         $extra_settings = pop(@Values);
                   9220:     }
1.127     matthew  9221:     #
1.136     matthew  9222:     my $identifier = &get_cgi_id();
                   9223:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9224:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9225:         return '';
                   9226:     }
1.225     matthew  9227:     #
                   9228:     my @Labels;
                   9229:     if (defined($labels)) {
                   9230:         @Labels = @$labels;
                   9231:     } else {
                   9232:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9233:             push (@Labels,$i+1);
                   9234:         }
                   9235:     }
                   9236:     #
1.129     matthew  9237:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9238:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9239:     my %ValuesHash;
                   9240:     my $NumSets=1;
                   9241:     foreach my $array (@Values) {
                   9242:         next if (! ref($array));
1.136     matthew  9243:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9244:             join(',',@$array);
1.129     matthew  9245:     }
1.127     matthew  9246:     #
1.136     matthew  9247:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9248:     if ($NumBars < 3) {
                   9249:         $width = 120+$NumBars*32;
1.220     matthew  9250:         $xskip = 1;
1.225     matthew  9251:         $bar_width = 30;
                   9252:     } elsif ($NumBars < 5) {
                   9253:         $width = 120+$NumBars*20;
                   9254:         $xskip = 1;
                   9255:         $bar_width = 20;
1.220     matthew  9256:     } elsif ($NumBars < 10) {
1.136     matthew  9257:         $width = 120+$NumBars*15;
                   9258:         $xskip = 1;
                   9259:         $bar_width = 15;
                   9260:     } elsif ($NumBars <= 25) {
                   9261:         $width = 120+$NumBars*11;
                   9262:         $xskip = 5;
                   9263:         $bar_width = 8;
                   9264:     } elsif ($NumBars <= 50) {
                   9265:         $width = 120+$NumBars*8;
                   9266:         $xskip = 5;
                   9267:         $bar_width = 4;
                   9268:     } else {
                   9269:         $width = 120+$NumBars*8;
                   9270:         $xskip = 5;
                   9271:         $bar_width = 4;
                   9272:     }
                   9273:     #
1.137     matthew  9274:     $Max = 1 if ($Max < 1);
                   9275:     if ( int($Max) < $Max ) {
                   9276:         $Max++;
                   9277:         $Max = int($Max);
                   9278:     }
1.127     matthew  9279:     $Title  = '' if (! defined($Title));
                   9280:     $xlabel = '' if (! defined($xlabel));
                   9281:     $ylabel = '' if (! defined($ylabel));
1.369     www      9282:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9283:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9284:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9285:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9286:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9287:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9288:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9289:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9290:     $ValuesHash{$id.'.height'}   = $height;
                   9291:     $ValuesHash{$id.'.width'}    = $width;
                   9292:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9293:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9294:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9295:     #
1.228     matthew  9296:     # Deal with other parameters
                   9297:     while (my ($key,$value) = each(%$extra_settings)) {
                   9298:         $ValuesHash{$id.'.'.$key} = $value;
                   9299:     }
                   9300:     #
1.646     raeburn  9301:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9302:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9303: }
                   9304: 
                   9305: ############################################################
                   9306: ############################################################
                   9307: 
                   9308: =pod
                   9309: 
1.648     raeburn  9310: =item * &DrawXYGraph()
1.137     matthew  9311: 
1.138     matthew  9312: Facilitates the plotting of data in an XY graph.
                   9313: Puts plot definition data into the users environment in order for 
                   9314: graph.png to plot it.  Returns an <img> tag for the plot.
                   9315: 
                   9316: Inputs:
                   9317: 
                   9318: =over 4
                   9319: 
                   9320: =item $Title: string, the title of the plot
                   9321: 
                   9322: =item $xlabel: string, text describing the X-axis of the plot
                   9323: 
                   9324: =item $ylabel: string, text describing the Y-axis of the plot
                   9325: 
                   9326: =item $Max: scalar, the maximum Y value to use in the plot
                   9327: If $Max is < any data point, the graph will not be rendered.
                   9328: 
                   9329: =item $colors: Array ref containing the hex color codes for the data to be 
                   9330: plotted in.  If undefined, default values will be used.
                   9331: 
                   9332: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9333: 
                   9334: =item $Ydata: Array ref containing Array refs.  
1.185     www      9335: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9336: 
                   9337: =item %Values: hash indicating or overriding any default values which are 
                   9338: passed to graph.png.  
                   9339: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9340: 
                   9341: =back
                   9342: 
                   9343: Returns:
                   9344: 
                   9345: An <img> tag which references graph.png and the appropriate identifying
                   9346: information for the plot.
                   9347: 
1.137     matthew  9348: =cut
                   9349: 
                   9350: ############################################################
                   9351: ############################################################
                   9352: sub DrawXYGraph {
                   9353:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9354:     #
                   9355:     # Create the identifier for the graph
                   9356:     my $identifier = &get_cgi_id();
                   9357:     my $id = 'cgi.'.$identifier;
                   9358:     #
                   9359:     $Title  = '' if (! defined($Title));
                   9360:     $xlabel = '' if (! defined($xlabel));
                   9361:     $ylabel = '' if (! defined($ylabel));
                   9362:     my %ValuesHash = 
                   9363:         (
1.369     www      9364:          $id.'.title'  => &escape($Title),
                   9365:          $id.'.xlabel' => &escape($xlabel),
                   9366:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9367:          $id.'.y_max_value'=> $Max,
                   9368:          $id.'.labels'     => join(',',@$Xlabels),
                   9369:          $id.'.PlotType'   => 'XY',
                   9370:          );
                   9371:     #
                   9372:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9373:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9374:     }
                   9375:     #
                   9376:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9377:         return '';
                   9378:     }
                   9379:     my $NumSets=1;
1.138     matthew  9380:     foreach my $array (@{$Ydata}){
1.137     matthew  9381:         next if (! ref($array));
                   9382:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9383:     }
1.138     matthew  9384:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9385:     #
                   9386:     # Deal with other parameters
                   9387:     while (my ($key,$value) = each(%Values)) {
                   9388:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9389:     }
                   9390:     #
1.646     raeburn  9391:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9392:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9393: }
                   9394: 
                   9395: ############################################################
                   9396: ############################################################
                   9397: 
                   9398: =pod
                   9399: 
1.648     raeburn  9400: =item * &DrawXYYGraph()
1.138     matthew  9401: 
                   9402: Facilitates the plotting of data in an XY graph with two Y axes.
                   9403: Puts plot definition data into the users environment in order for 
                   9404: graph.png to plot it.  Returns an <img> tag for the plot.
                   9405: 
                   9406: Inputs:
                   9407: 
                   9408: =over 4
                   9409: 
                   9410: =item $Title: string, the title of the plot
                   9411: 
                   9412: =item $xlabel: string, text describing the X-axis of the plot
                   9413: 
                   9414: =item $ylabel: string, text describing the Y-axis of the plot
                   9415: 
                   9416: =item $colors: Array ref containing the hex color codes for the data to be 
                   9417: plotted in.  If undefined, default values will be used.
                   9418: 
                   9419: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9420: 
                   9421: =item $Ydata1: The first data set
                   9422: 
                   9423: =item $Min1: The minimum value of the left Y-axis
                   9424: 
                   9425: =item $Max1: The maximum value of the left Y-axis
                   9426: 
                   9427: =item $Ydata2: The second data set
                   9428: 
                   9429: =item $Min2: The minimum value of the right Y-axis
                   9430: 
                   9431: =item $Max2: The maximum value of the left Y-axis
                   9432: 
                   9433: =item %Values: hash indicating or overriding any default values which are 
                   9434: passed to graph.png.  
                   9435: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9436: 
                   9437: =back
                   9438: 
                   9439: Returns:
                   9440: 
                   9441: An <img> tag which references graph.png and the appropriate identifying
                   9442: information for the plot.
1.136     matthew  9443: 
                   9444: =cut
                   9445: 
                   9446: ############################################################
                   9447: ############################################################
1.137     matthew  9448: sub DrawXYYGraph {
                   9449:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9450:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9451:     #
                   9452:     # Create the identifier for the graph
                   9453:     my $identifier = &get_cgi_id();
                   9454:     my $id = 'cgi.'.$identifier;
                   9455:     #
                   9456:     $Title  = '' if (! defined($Title));
                   9457:     $xlabel = '' if (! defined($xlabel));
                   9458:     $ylabel = '' if (! defined($ylabel));
                   9459:     my %ValuesHash = 
                   9460:         (
1.369     www      9461:          $id.'.title'  => &escape($Title),
                   9462:          $id.'.xlabel' => &escape($xlabel),
                   9463:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9464:          $id.'.labels' => join(',',@$Xlabels),
                   9465:          $id.'.PlotType' => 'XY',
                   9466:          $id.'.NumSets' => 2,
1.137     matthew  9467:          $id.'.two_axes' => 1,
                   9468:          $id.'.y1_max_value' => $Max1,
                   9469:          $id.'.y1_min_value' => $Min1,
                   9470:          $id.'.y2_max_value' => $Max2,
                   9471:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9472:          );
                   9473:     #
1.137     matthew  9474:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9475:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9476:     }
                   9477:     #
                   9478:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9479:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9480:         return '';
                   9481:     }
                   9482:     my $NumSets=1;
1.137     matthew  9483:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9484:         next if (! ref($array));
                   9485:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9486:     }
                   9487:     #
                   9488:     # Deal with other parameters
                   9489:     while (my ($key,$value) = each(%Values)) {
                   9490:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9491:     }
                   9492:     #
1.646     raeburn  9493:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9494:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9495: }
                   9496: 
                   9497: ############################################################
                   9498: ############################################################
                   9499: 
                   9500: =pod
                   9501: 
1.157     matthew  9502: =back 
                   9503: 
1.139     matthew  9504: =head1 Statistics helper routines?  
                   9505: 
                   9506: Bad place for them but what the hell.
                   9507: 
1.157     matthew  9508: =over 4
                   9509: 
1.648     raeburn  9510: =item * &chartlink()
1.139     matthew  9511: 
                   9512: Returns a link to the chart for a specific student.  
                   9513: 
                   9514: Inputs:
                   9515: 
                   9516: =over 4
                   9517: 
                   9518: =item $linktext: The text of the link
                   9519: 
                   9520: =item $sname: The students username
                   9521: 
                   9522: =item $sdomain: The students domain
                   9523: 
                   9524: =back
                   9525: 
1.157     matthew  9526: =back
                   9527: 
1.139     matthew  9528: =cut
                   9529: 
                   9530: ############################################################
                   9531: ############################################################
                   9532: sub chartlink {
                   9533:     my ($linktext, $sname, $sdomain) = @_;
                   9534:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9535:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9536:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9537:        '">'.$linktext.'</a>';
1.153     matthew  9538: }
                   9539: 
                   9540: #######################################################
                   9541: #######################################################
                   9542: 
                   9543: =pod
                   9544: 
                   9545: =head1 Course Environment Routines
1.157     matthew  9546: 
                   9547: =over 4
1.153     matthew  9548: 
1.648     raeburn  9549: =item * &restore_course_settings()
1.153     matthew  9550: 
1.648     raeburn  9551: =item * &store_course_settings()
1.153     matthew  9552: 
                   9553: Restores/Store indicated form parameters from the course environment.
                   9554: Will not overwrite existing values of the form parameters.
                   9555: 
                   9556: Inputs: 
                   9557: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9558: 
                   9559: a hash ref describing the data to be stored.  For example:
                   9560:    
                   9561: %Save_Parameters = ('Status' => 'scalar',
                   9562:     'chartoutputmode' => 'scalar',
                   9563:     'chartoutputdata' => 'scalar',
                   9564:     'Section' => 'array',
1.373     raeburn  9565:     'Group' => 'array',
1.153     matthew  9566:     'StudentData' => 'array',
                   9567:     'Maps' => 'array');
                   9568: 
                   9569: Returns: both routines return nothing
                   9570: 
1.631     raeburn  9571: =back
                   9572: 
1.153     matthew  9573: =cut
                   9574: 
                   9575: #######################################################
                   9576: #######################################################
                   9577: sub store_course_settings {
1.496     albertel 9578:     return &store_settings($env{'request.course.id'},@_);
                   9579: }
                   9580: 
                   9581: sub store_settings {
1.153     matthew  9582:     # save to the environment
                   9583:     # appenv the same items, just to be safe
1.300     albertel 9584:     my $udom  = $env{'user.domain'};
                   9585:     my $uname = $env{'user.name'};
1.496     albertel 9586:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9587:     my %SaveHash;
                   9588:     my %AppHash;
                   9589:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9590:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9591:         my $envname = 'environment.'.$basename;
1.258     albertel 9592:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9593:             # Save this value away
                   9594:             if ($type eq 'scalar' &&
1.258     albertel 9595:                 (! exists($env{$envname}) || 
                   9596:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9597:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9598:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9599:             } elsif ($type eq 'array') {
                   9600:                 my $stored_form;
1.258     albertel 9601:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9602:                     $stored_form = join(',',
                   9603:                                         map {
1.369     www      9604:                                             &escape($_);
1.258     albertel 9605:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9606:                 } else {
                   9607:                     $stored_form = 
1.369     www      9608:                         &escape($env{'form.'.$setting});
1.153     matthew  9609:                 }
                   9610:                 # Determine if the array contents are the same.
1.258     albertel 9611:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9612:                     $SaveHash{$basename} = $stored_form;
                   9613:                     $AppHash{$envname}   = $stored_form;
                   9614:                 }
                   9615:             }
                   9616:         }
                   9617:     }
                   9618:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9619:                                           $udom,$uname);
1.153     matthew  9620:     if ($put_result !~ /^(ok|delayed)/) {
                   9621:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9622:                                  'got error:'.$put_result);
                   9623:     }
                   9624:     # Make sure these settings stick around in this session, too
1.646     raeburn  9625:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9626:     return;
                   9627: }
                   9628: 
                   9629: sub restore_course_settings {
1.499     albertel 9630:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9631: }
                   9632: 
                   9633: sub restore_settings {
                   9634:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9635:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9636:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9637:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9638:             '.'.$setting;
1.258     albertel 9639:         if (exists($env{$envname})) {
1.153     matthew  9640:             if ($type eq 'scalar') {
1.258     albertel 9641:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9642:             } elsif ($type eq 'array') {
1.258     albertel 9643:                 $env{'form.'.$setting} = [ 
1.153     matthew  9644:                                            map { 
1.369     www      9645:                                                &unescape($_); 
1.258     albertel 9646:                                            } split(',',$env{$envname})
1.153     matthew  9647:                                            ];
                   9648:             }
                   9649:         }
                   9650:     }
1.127     matthew  9651: }
                   9652: 
1.618     raeburn  9653: #######################################################
                   9654: #######################################################
                   9655: 
                   9656: =pod
                   9657: 
                   9658: =head1 Domain E-mail Routines  
                   9659: 
                   9660: =over 4
                   9661: 
1.648     raeburn  9662: =item * &build_recipient_list()
1.618     raeburn  9663: 
1.884     raeburn  9664: Build recipient lists for five types of e-mail:
1.766     raeburn  9665: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9666: (d) Help requests, (e) Course requests needing approval,  generated by
                   9667: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9668: loncoursequeueadmin.pm respectively.
1.618     raeburn  9669: 
                   9670: Inputs:
1.619     raeburn  9671: defmail (scalar - email address of default recipient), 
1.618     raeburn  9672: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9673: defdom (domain for which to retrieve configuration settings),
                   9674: origmail (scalar - email address of recipient from loncapa.conf, 
                   9675: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9676: 
1.655     raeburn  9677: Returns: comma separated list of addresses to which to send e-mail.
                   9678: 
                   9679: =back
1.618     raeburn  9680: 
                   9681: =cut
                   9682: 
                   9683: ############################################################
                   9684: ############################################################
                   9685: sub build_recipient_list {
1.619     raeburn  9686:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9687:     my @recipients;
                   9688:     my $otheremails;
                   9689:     my %domconfig =
                   9690:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9691:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9692:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9693:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9694:                 my @contacts = ('adminemail','supportemail');
                   9695:                 foreach my $item (@contacts) {
                   9696:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9697:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9698:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9699:                             push(@recipients,$addr);
                   9700:                         }
1.619     raeburn  9701:                     }
1.766     raeburn  9702:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9703:                 }
                   9704:             }
1.766     raeburn  9705:         } elsif ($origmail ne '') {
                   9706:             push(@recipients,$origmail);
1.618     raeburn  9707:         }
1.619     raeburn  9708:     } elsif ($origmail ne '') {
                   9709:         push(@recipients,$origmail);
1.618     raeburn  9710:     }
1.688     raeburn  9711:     if (defined($defmail)) {
                   9712:         if ($defmail ne '') {
                   9713:             push(@recipients,$defmail);
                   9714:         }
1.618     raeburn  9715:     }
                   9716:     if ($otheremails) {
1.619     raeburn  9717:         my @others;
                   9718:         if ($otheremails =~ /,/) {
                   9719:             @others = split(/,/,$otheremails);
1.618     raeburn  9720:         } else {
1.619     raeburn  9721:             push(@others,$otheremails);
                   9722:         }
                   9723:         foreach my $addr (@others) {
                   9724:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9725:                 push(@recipients,$addr);
                   9726:             }
1.618     raeburn  9727:         }
                   9728:     }
1.619     raeburn  9729:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9730:     return $recipientlist;
                   9731: }
                   9732: 
1.127     matthew  9733: ############################################################
                   9734: ############################################################
1.154     albertel 9735: 
1.655     raeburn  9736: =pod
                   9737: 
                   9738: =head1 Course Catalog Routines
                   9739: 
                   9740: =over 4
                   9741: 
                   9742: =item * &gather_categories()
                   9743: 
                   9744: Converts category definitions - keys of categories hash stored in  
                   9745: coursecategories in configuration.db on the primary library server in a 
                   9746: domain - to an array.  Also generates javascript and idx hash used to 
                   9747: generate Domain Coordinator interface for editing Course Categories.
                   9748: 
                   9749: Inputs:
1.663     raeburn  9750: 
1.655     raeburn  9751: categories (reference to hash of category definitions).
1.663     raeburn  9752: 
1.655     raeburn  9753: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9754:       categories and subcategories).
1.663     raeburn  9755: 
1.655     raeburn  9756: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9757:       editing Course Categories).
1.663     raeburn  9758: 
1.655     raeburn  9759: jsarray (reference to array of categories used to create Javascript arrays for
                   9760:          Domain Coordinator interface for editing Course Categories).
                   9761: 
                   9762: Returns: nothing
                   9763: 
                   9764: Side effects: populates cats, idx and jsarray. 
                   9765: 
                   9766: =cut
                   9767: 
                   9768: sub gather_categories {
                   9769:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9770:     my %counters;
                   9771:     my $num = 0;
                   9772:     foreach my $item (keys(%{$categories})) {
                   9773:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9774:         if ($container eq '' && $depth == 0) {
                   9775:             $cats->[$depth][$categories->{$item}] = $cat;
                   9776:         } else {
                   9777:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9778:         }
                   9779:         my ($escitem,$tail) = split(/:/,$item,2);
                   9780:         if ($counters{$tail} eq '') {
                   9781:             $counters{$tail} = $num;
                   9782:             $num ++;
                   9783:         }
                   9784:         if (ref($idx) eq 'HASH') {
                   9785:             $idx->{$item} = $counters{$tail};
                   9786:         }
                   9787:         if (ref($jsarray) eq 'ARRAY') {
                   9788:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9789:         }
                   9790:     }
                   9791:     return;
                   9792: }
                   9793: 
                   9794: =pod
                   9795: 
                   9796: =item * &extract_categories()
                   9797: 
                   9798: Used to generate breadcrumb trails for course categories.
                   9799: 
                   9800: Inputs:
1.663     raeburn  9801: 
1.655     raeburn  9802: categories (reference to hash of category definitions).
1.663     raeburn  9803: 
1.655     raeburn  9804: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9805:       categories and subcategories).
1.663     raeburn  9806: 
1.655     raeburn  9807: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9808: 
1.655     raeburn  9809: allitems (reference to hash - key is category key 
                   9810:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9811: 
1.655     raeburn  9812: idx (reference to hash of counters used in Domain Coordinator interface for
                   9813:       editing Course Categories).
1.663     raeburn  9814: 
1.655     raeburn  9815: jsarray (reference to array of categories used to create Javascript arrays for
                   9816:          Domain Coordinator interface for editing Course Categories).
                   9817: 
1.665     raeburn  9818: subcats (reference to hash of arrays containing all subcategories within each 
                   9819:          category, -recursive)
                   9820: 
1.655     raeburn  9821: Returns: nothing
                   9822: 
                   9823: Side effects: populates trails and allitems hash references.
                   9824: 
                   9825: =cut
                   9826: 
                   9827: sub extract_categories {
1.665     raeburn  9828:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9829:     if (ref($categories) eq 'HASH') {
                   9830:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9831:         if (ref($cats->[0]) eq 'ARRAY') {
                   9832:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9833:                 my $name = $cats->[0][$i];
                   9834:                 my $item = &escape($name).'::0';
                   9835:                 my $trailstr;
                   9836:                 if ($name eq 'instcode') {
                   9837:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9838:                 } elsif ($name eq 'communities') {
                   9839:                     $trailstr = &mt('Communities');
1.655     raeburn  9840:                 } else {
                   9841:                     $trailstr = $name;
                   9842:                 }
                   9843:                 if ($allitems->{$item} eq '') {
                   9844:                     push(@{$trails},$trailstr);
                   9845:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9846:                 }
                   9847:                 my @parents = ($name);
                   9848:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9849:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9850:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9851:                         if (ref($subcats) eq 'HASH') {
                   9852:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9853:                         }
                   9854:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9855:                     }
                   9856:                 } else {
                   9857:                     if (ref($subcats) eq 'HASH') {
                   9858:                         $subcats->{$item} = [];
1.655     raeburn  9859:                     }
                   9860:                 }
                   9861:             }
                   9862:         }
                   9863:     }
                   9864:     return;
                   9865: }
                   9866: 
                   9867: =pod
                   9868: 
                   9869: =item *&recurse_categories()
                   9870: 
                   9871: Recursively used to generate breadcrumb trails for course categories.
                   9872: 
                   9873: Inputs:
1.663     raeburn  9874: 
1.655     raeburn  9875: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9876:       categories and subcategories).
1.663     raeburn  9877: 
1.655     raeburn  9878: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9879: 
                   9880: category (current course category, for which breadcrumb trail is being generated).
                   9881: 
                   9882: trails (reference to array of breadcrumb trails for each category).
                   9883: 
1.655     raeburn  9884: allitems (reference to hash - key is category key
                   9885:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9886: 
1.655     raeburn  9887: parents (array containing containers directories for current category, 
                   9888:          back to top level). 
                   9889: 
                   9890: Returns: nothing
                   9891: 
                   9892: Side effects: populates trails and allitems hash references
                   9893: 
                   9894: =cut
                   9895: 
                   9896: sub recurse_categories {
1.665     raeburn  9897:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9898:     my $shallower = $depth - 1;
                   9899:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9900:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9901:             my $name = $cats->[$depth]{$category}[$k];
                   9902:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9903:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9904:             if ($allitems->{$item} eq '') {
                   9905:                 push(@{$trails},$trailstr);
                   9906:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9907:             }
                   9908:             my $deeper = $depth+1;
                   9909:             push(@{$parents},$category);
1.665     raeburn  9910:             if (ref($subcats) eq 'HASH') {
                   9911:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9912:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9913:                     my $higher;
                   9914:                     if ($j > 0) {
                   9915:                         $higher = &escape($parents->[$j]).':'.
                   9916:                                   &escape($parents->[$j-1]).':'.$j;
                   9917:                     } else {
                   9918:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9919:                     }
                   9920:                     push(@{$subcats->{$higher}},$subcat);
                   9921:                 }
                   9922:             }
                   9923:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9924:                                 $subcats);
1.655     raeburn  9925:             pop(@{$parents});
                   9926:         }
                   9927:     } else {
                   9928:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9929:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9930:         if ($allitems->{$item} eq '') {
                   9931:             push(@{$trails},$trailstr);
                   9932:             $allitems->{$item} = scalar(@{$trails})-1;
                   9933:         }
                   9934:     }
                   9935:     return;
                   9936: }
                   9937: 
1.663     raeburn  9938: =pod
                   9939: 
                   9940: =item *&assign_categories_table()
                   9941: 
                   9942: Create a datatable for display of hierarchical categories in a domain,
                   9943: with checkboxes to allow a course to be categorized. 
                   9944: 
                   9945: Inputs:
                   9946: 
                   9947: cathash - reference to hash of categories defined for the domain (from
                   9948:           configuration.db)
                   9949: 
                   9950: currcat - scalar with an & separated list of categories assigned to a course. 
                   9951: 
1.919     raeburn  9952: type    - scalar contains course type (Course or Community).
                   9953: 
1.663     raeburn  9954: Returns: $output (markup to be displayed) 
                   9955: 
                   9956: =cut
                   9957: 
                   9958: sub assign_categories_table {
1.919     raeburn  9959:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9960:     my $output;
                   9961:     if (ref($cathash) eq 'HASH') {
                   9962:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9963:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9964:         $maxdepth = scalar(@cats);
                   9965:         if (@cats > 0) {
                   9966:             my $itemcount = 0;
                   9967:             if (ref($cats[0]) eq 'ARRAY') {
                   9968:                 my @currcategories;
                   9969:                 if ($currcat ne '') {
                   9970:                     @currcategories = split('&',$currcat);
                   9971:                 }
1.919     raeburn  9972:                 my $table;
1.663     raeburn  9973:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9974:                     my $parent = $cats[0][$i];
1.919     raeburn  9975:                     next if ($parent eq 'instcode');
                   9976:                     if ($type eq 'Community') {
                   9977:                         next unless ($parent eq 'communities');
                   9978:                     } else {
                   9979:                         next if ($parent eq 'communities');
                   9980:                     }
1.663     raeburn  9981:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9982:                     my $item = &escape($parent).'::0';
                   9983:                     my $checked = '';
                   9984:                     if (@currcategories > 0) {
                   9985:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9986:                             $checked = ' checked="checked"';
1.663     raeburn  9987:                         }
                   9988:                     }
1.919     raeburn  9989:                     my $parent_title = $parent;
                   9990:                     if ($parent eq 'communities') {
                   9991:                         $parent_title = &mt('Communities');
                   9992:                     }
                   9993:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9994:                               '<input type="checkbox" name="usecategory" value="'.
                   9995:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9996:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9997:                     my $depth = 1;
                   9998:                     push(@path,$parent);
1.919     raeburn  9999:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  10000:                     pop(@path);
1.919     raeburn  10001:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  10002:                     $itemcount ++;
                   10003:                 }
1.919     raeburn  10004:                 if ($itemcount) {
                   10005:                     $output = &Apache::loncommon::start_data_table().
                   10006:                               $table.
                   10007:                               &Apache::loncommon::end_data_table();
                   10008:                 }
1.663     raeburn  10009:             }
                   10010:         }
                   10011:     }
                   10012:     return $output;
                   10013: }
                   10014: 
                   10015: =pod
                   10016: 
                   10017: =item *&assign_category_rows()
                   10018: 
                   10019: Create a datatable row for display of nested categories in a domain,
                   10020: with checkboxes to allow a course to be categorized,called recursively.
                   10021: 
                   10022: Inputs:
                   10023: 
                   10024: itemcount - track row number for alternating colors
                   10025: 
                   10026: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   10027:       categories and subcategories.
                   10028: 
                   10029: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   10030: 
                   10031: parent - parent of current category item
                   10032: 
                   10033: path - Array containing all categories back up through the hierarchy from the
                   10034:        current category to the top level.
                   10035: 
                   10036: currcategories - reference to array of current categories assigned to the course
                   10037: 
                   10038: Returns: $output (markup to be displayed).
                   10039: 
                   10040: =cut
                   10041: 
                   10042: sub assign_category_rows {
                   10043:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   10044:     my ($text,$name,$item,$chgstr);
                   10045:     if (ref($cats) eq 'ARRAY') {
                   10046:         my $maxdepth = scalar(@{$cats});
                   10047:         if (ref($cats->[$depth]) eq 'HASH') {
                   10048:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   10049:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   10050:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   10051:                 $text .= '<td><table class="LC_datatable">';
                   10052:                 for (my $j=0; $j<$numchildren; $j++) {
                   10053:                     $name = $cats->[$depth]{$parent}[$j];
                   10054:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   10055:                     my $deeper = $depth+1;
                   10056:                     my $checked = '';
                   10057:                     if (ref($currcategories) eq 'ARRAY') {
                   10058:                         if (@{$currcategories} > 0) {
                   10059:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   10060:                                 $checked = ' checked="checked"';
1.663     raeburn  10061:                             }
                   10062:                         }
                   10063:                     }
1.664     raeburn  10064:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   10065:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  10066:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   10067:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   10068:                              '</td><td>';
1.663     raeburn  10069:                     if (ref($path) eq 'ARRAY') {
                   10070:                         push(@{$path},$name);
                   10071:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   10072:                         pop(@{$path});
                   10073:                     }
                   10074:                     $text .= '</td></tr>';
                   10075:                 }
                   10076:                 $text .= '</table></td>';
                   10077:             }
                   10078:         }
                   10079:     }
                   10080:     return $text;
                   10081: }
                   10082: 
1.655     raeburn  10083: ############################################################
                   10084: ############################################################
                   10085: 
                   10086: 
1.443     albertel 10087: sub commit_customrole {
1.664     raeburn  10088:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  10089:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 10090:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   10091:                          ($end?', ending '.localtime($end):'').': <b>'.
                   10092:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  10093:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 10094:                  '</b><br />';
                   10095:     return $output;
                   10096: }
                   10097: 
                   10098: sub commit_standardrole {
1.541     raeburn  10099:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   10100:     my ($output,$logmsg,$linefeed);
                   10101:     if ($context eq 'auto') {
                   10102:         $linefeed = "\n";
                   10103:     } else {
                   10104:         $linefeed = "<br />\n";
                   10105:     }  
1.443     albertel 10106:     if ($three eq 'st') {
1.541     raeburn  10107:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   10108:                                          $one,$two,$sec,$context);
                   10109:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  10110:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   10111:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 10112:         } else {
1.541     raeburn  10113:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 10114:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10115:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   10116:             if ($context eq 'auto') {
                   10117:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   10118:             } else {
                   10119:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   10120:                &mt('Add to classlist').': <b>ok</b>';
                   10121:             }
                   10122:             $output .= $linefeed;
1.443     albertel 10123:         }
                   10124:     } else {
                   10125:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   10126:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10127:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  10128:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  10129:         if ($context eq 'auto') {
                   10130:             $output .= $result.$linefeed;
                   10131:         } else {
                   10132:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   10133:         }
1.443     albertel 10134:     }
                   10135:     return $output;
                   10136: }
                   10137: 
                   10138: sub commit_studentrole {
1.541     raeburn  10139:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  10140:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  10141:     if ($context eq 'auto') {
                   10142:         $linefeed = "\n";
                   10143:     } else {
                   10144:         $linefeed = '<br />'."\n";
                   10145:     }
1.443     albertel 10146:     if (defined($one) && defined($two)) {
                   10147:         my $cid=$one.'_'.$two;
                   10148:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   10149:         my $secchange = 0;
                   10150:         my $expire_role_result;
                   10151:         my $modify_section_result;
1.628     raeburn  10152:         if ($oldsec ne '-1') { 
                   10153:             if ($oldsec ne $sec) {
1.443     albertel 10154:                 $secchange = 1;
1.628     raeburn  10155:                 my $now = time;
1.443     albertel 10156:                 my $uurl='/'.$cid;
                   10157:                 $uurl=~s/\_/\//g;
                   10158:                 if ($oldsec) {
                   10159:                     $uurl.='/'.$oldsec;
                   10160:                 }
1.626     raeburn  10161:                 $oldsecurl = $uurl;
1.628     raeburn  10162:                 $expire_role_result = 
1.652     raeburn  10163:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  10164:                 if ($env{'request.course.sec'} ne '') { 
                   10165:                     if ($expire_role_result eq 'refused') {
                   10166:                         my @roles = ('st');
                   10167:                         my @statuses = ('previous');
                   10168:                         my @roledoms = ($one);
                   10169:                         my $withsec = 1;
                   10170:                         my %roleshash = 
                   10171:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   10172:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   10173:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   10174:                             my ($oldstart,$oldend) = 
                   10175:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   10176:                             if ($oldend > 0 && $oldend <= $now) {
                   10177:                                 $expire_role_result = 'ok';
                   10178:                             }
                   10179:                         }
                   10180:                     }
                   10181:                 }
1.443     albertel 10182:                 $result = $expire_role_result;
                   10183:             }
                   10184:         }
                   10185:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  10186:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 10187:             if ($modify_section_result =~ /^ok/) {
                   10188:                 if ($secchange == 1) {
1.628     raeburn  10189:                     if ($sec eq '') {
                   10190:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   10191:                     } else {
                   10192:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   10193:                     }
1.443     albertel 10194:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  10195:                     if ($sec eq '') {
                   10196:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   10197:                     } else {
                   10198:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10199:                     }
1.443     albertel 10200:                 } else {
1.628     raeburn  10201:                     if ($sec eq '') {
                   10202:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   10203:                     } else {
                   10204:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10205:                     }
1.443     albertel 10206:                 }
                   10207:             } else {
1.628     raeburn  10208:                 if ($secchange) {       
                   10209:                     $$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;
                   10210:                 } else {
                   10211:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10212:                 }
1.443     albertel 10213:             }
                   10214:             $result = $modify_section_result;
                   10215:         } elsif ($secchange == 1) {
1.628     raeburn  10216:             if ($oldsec eq '') {
                   10217:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10218:             } else {
                   10219:                 $$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;
                   10220:             }
1.626     raeburn  10221:             if ($expire_role_result eq 'refused') {
                   10222:                 my $newsecurl = '/'.$cid;
                   10223:                 $newsecurl =~ s/\_/\//g;
                   10224:                 if ($sec ne '') {
                   10225:                     $newsecurl.='/'.$sec;
                   10226:                 }
                   10227:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10228:                     if ($sec eq '') {
                   10229:                         $$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;
                   10230:                     } else {
                   10231:                         $$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;
                   10232:                     }
                   10233:                 }
                   10234:             }
1.443     albertel 10235:         }
                   10236:     } else {
1.626     raeburn  10237:         $$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 10238:         $result = "error: incomplete course id\n";
                   10239:     }
                   10240:     return $result;
                   10241: }
                   10242: 
                   10243: ############################################################
                   10244: ############################################################
                   10245: 
1.566     albertel 10246: sub check_clone {
1.578     raeburn  10247:     my ($args,$linefeed) = @_;
1.566     albertel 10248:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10249:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10250:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10251:     my $clonemsg;
                   10252:     my $can_clone = 0;
1.925.2.11  raeburn  10253:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10254:     if ($lctype ne 'community') {
                   10255:         $lctype = 'course';
                   10256:     }
1.566     albertel 10257:     if ($clonehome eq 'no_host') {
1.925.2.11  raeburn  10258:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10259:             $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'});
                   10260:         } else {
                   10261:             $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'});
                   10262:         }     
1.566     albertel 10263:     } else {
                   10264: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.925.2.11  raeburn  10265:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10266:             if ($clonedesc{'type'} ne 'Community') {
                   10267:                  $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'});
                   10268:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10269:             }
                   10270:         }
1.882     raeburn  10271: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10272:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10273: 	    $can_clone = 1;
                   10274: 	} else {
                   10275: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10276: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10277: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10278:             if (grep(/^\*$/,@cloners)) {
                   10279:                 $can_clone = 1;
                   10280:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10281:                 $can_clone = 1;
                   10282:             } else {
1.908     raeburn  10283:                 my $ccrole = 'cc';
1.925.2.11  raeburn  10284:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10285:                     $ccrole = 'co';
                   10286:                 }
1.578     raeburn  10287: 	        my %roleshash =
                   10288: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10289: 					 $args->{'ccdomain'},
1.908     raeburn  10290:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10291: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10292: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10293: 		    $can_clone = 1;
                   10294: 	        } else {
1.925.2.11  raeburn  10295:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10296:                         $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'});
                   10297:                     } else {
                   10298:                         $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'});
                   10299:                     }
1.578     raeburn  10300: 	        }
1.566     albertel 10301: 	    }
1.578     raeburn  10302:         }
1.566     albertel 10303:     }
                   10304:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10305: }
                   10306: 
1.444     albertel 10307: sub construct_course {
1.885     raeburn  10308:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10309:     my $outcome;
1.541     raeburn  10310:     my $linefeed =  '<br />'."\n";
                   10311:     if ($context eq 'auto') {
                   10312:         $linefeed = "\n";
                   10313:     }
1.566     albertel 10314: 
                   10315: #
                   10316: # Are we cloning?
                   10317: #
                   10318:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10319:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10320: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10321: 	if ($context ne 'auto') {
1.578     raeburn  10322:             if ($clonemsg ne '') {
                   10323: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10324:             }
1.566     albertel 10325: 	}
                   10326: 	$outcome .= $clonemsg.$linefeed;
                   10327: 
                   10328:         if (!$can_clone) {
                   10329: 	    return (0,$outcome);
                   10330: 	}
                   10331:     }
                   10332: 
1.444     albertel 10333: #
                   10334: # Open course
                   10335: #
                   10336:     my $crstype = lc($args->{'crstype'});
                   10337:     my %cenv=();
                   10338:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10339:                                              $args->{'cdescr'},
                   10340:                                              $args->{'curl'},
                   10341:                                              $args->{'course_home'},
                   10342:                                              $args->{'nonstandard'},
                   10343:                                              $args->{'crscode'},
                   10344:                                              $args->{'ccuname'}.':'.
                   10345:                                              $args->{'ccdomain'},
1.882     raeburn  10346:                                              $args->{'crstype'},
1.885     raeburn  10347:                                              $cnum,$context,$category);
1.444     albertel 10348: 
                   10349:     # Note: The testing routines depend on this being output; see 
                   10350:     # Utils::Course. This needs to at least be output as a comment
                   10351:     # if anyone ever decides to not show this, and Utils::Course::new
                   10352:     # will need to be suitably modified.
1.541     raeburn  10353:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10354: #
                   10355: # Check if created correctly
                   10356: #
1.479     albertel 10357:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10358:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10359:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10360: 
1.444     albertel 10361: #
1.566     albertel 10362: # Do the cloning
                   10363: #   
                   10364:     if ($can_clone && $cloneid) {
                   10365: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10366: 	if ($context ne 'auto') {
                   10367: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10368: 	}
                   10369: 	$outcome .= $clonemsg.$linefeed;
                   10370: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10371: # Copy all files
1.637     www      10372: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10373: # Restore URL
1.566     albertel 10374: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10375: # Restore title
1.566     albertel 10376: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10377: # Mark as cloned
1.566     albertel 10378: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10379: # Need to clone grading mode
                   10380:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10381:         $cenv{'grading'}=$newenv{'grading'};
                   10382: # Do not clone these environment entries
                   10383:         &Apache::lonnet::del('environment',
                   10384:                   ['default_enrollment_start_date',
                   10385:                    'default_enrollment_end_date',
                   10386:                    'question.email',
                   10387:                    'policy.email',
                   10388:                    'comment.email',
                   10389:                    'pch.users.denied',
1.725     raeburn  10390:                    'plc.users.denied',
                   10391:                    'hidefromcat',
                   10392:                    'categories'],
1.638     www      10393:                    $$crsudom,$$crsunum);
1.444     albertel 10394:     }
1.566     albertel 10395: 
1.444     albertel 10396: #
                   10397: # Set environment (will override cloned, if existing)
                   10398: #
                   10399:     my @sections = ();
                   10400:     my @xlists = ();
                   10401:     if ($args->{'crstype'}) {
                   10402:         $cenv{'type'}=$args->{'crstype'};
                   10403:     }
                   10404:     if ($args->{'crsid'}) {
                   10405:         $cenv{'courseid'}=$args->{'crsid'};
                   10406:     }
                   10407:     if ($args->{'crscode'}) {
                   10408:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10409:     }
                   10410:     if ($args->{'crsquota'} ne '') {
                   10411:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10412:     } else {
                   10413:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10414:     }
                   10415:     if ($args->{'ccuname'}) {
                   10416:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10417:                                         ':'.$args->{'ccdomain'};
                   10418:     } else {
                   10419:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10420:     }
                   10421:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10422:     if ($args->{'crssections'}) {
                   10423:         $cenv{'internal.sectionnums'} = '';
                   10424:         if ($args->{'crssections'} =~ m/,/) {
                   10425:             @sections = split/,/,$args->{'crssections'};
                   10426:         } else {
                   10427:             $sections[0] = $args->{'crssections'};
                   10428:         }
                   10429:         if (@sections > 0) {
                   10430:             foreach my $item (@sections) {
                   10431:                 my ($sec,$gp) = split/:/,$item;
                   10432:                 my $class = $args->{'crscode'}.$sec;
                   10433:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10434:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10435:                 unless ($addcheck eq 'ok') {
                   10436:                     push @badclasses, $class;
                   10437:                 }
                   10438:             }
                   10439:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10440:         }
                   10441:     }
                   10442: # do not hide course coordinator from staff listing, 
                   10443: # even if privileged
                   10444:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10445: # add crosslistings
                   10446:     if ($args->{'crsxlist'}) {
                   10447:         $cenv{'internal.crosslistings'}='';
                   10448:         if ($args->{'crsxlist'} =~ m/,/) {
                   10449:             @xlists = split/,/,$args->{'crsxlist'};
                   10450:         } else {
                   10451:             $xlists[0] = $args->{'crsxlist'};
                   10452:         }
                   10453:         if (@xlists > 0) {
                   10454:             foreach my $item (@xlists) {
                   10455:                 my ($xl,$gp) = split/:/,$item;
                   10456:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10457:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10458:                 unless ($addcheck eq 'ok') {
                   10459:                     push @badclasses, $xl;
                   10460:                 }
                   10461:             }
                   10462:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10463:         }
                   10464:     }
                   10465:     if ($args->{'autoadds'}) {
                   10466:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10467:     }
                   10468:     if ($args->{'autodrops'}) {
                   10469:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10470:     }
                   10471: # check for notification of enrollment changes
                   10472:     my @notified = ();
                   10473:     if ($args->{'notify_owner'}) {
                   10474:         if ($args->{'ccuname'} ne '') {
                   10475:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10476:         }
                   10477:     }
                   10478:     if ($args->{'notify_dc'}) {
                   10479:         if ($uname ne '') { 
1.630     raeburn  10480:             push(@notified,$uname.':'.$udom);
1.444     albertel 10481:         }
                   10482:     }
                   10483:     if (@notified > 0) {
                   10484:         my $notifylist;
                   10485:         if (@notified > 1) {
                   10486:             $notifylist = join(',',@notified);
                   10487:         } else {
                   10488:             $notifylist = $notified[0];
                   10489:         }
                   10490:         $cenv{'internal.notifylist'} = $notifylist;
                   10491:     }
                   10492:     if (@badclasses > 0) {
                   10493:         my %lt=&Apache::lonlocal::texthash(
                   10494:                 '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',
                   10495:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10496:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10497:         );
1.541     raeburn  10498:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10499:                            ' ('.$lt{'adby'}.')';
                   10500:         if ($context eq 'auto') {
                   10501:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10502:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10503:             foreach my $item (@badclasses) {
                   10504:                 if ($context eq 'auto') {
                   10505:                     $outcome .= " - $item\n";
                   10506:                 } else {
                   10507:                     $outcome .= "<li>$item</li>\n";
                   10508:                 }
                   10509:             }
                   10510:             if ($context eq 'auto') {
                   10511:                 $outcome .= $linefeed;
                   10512:             } else {
1.566     albertel 10513:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10514:             }
                   10515:         } 
1.444     albertel 10516:     }
                   10517:     if ($args->{'no_end_date'}) {
                   10518:         $args->{'endaccess'} = 0;
                   10519:     }
                   10520:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10521:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10522:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10523:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10524:     if ($args->{'showphotos'}) {
                   10525:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10526:     }
                   10527:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10528:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10529:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10530:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10531:             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'); 
                   10532:             if ($context eq 'auto') {
                   10533:                 $outcome .= $krb_msg;
                   10534:             } else {
1.566     albertel 10535:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10536:             }
                   10537:             $outcome .= $linefeed;
1.444     albertel 10538:         }
                   10539:     }
                   10540:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10541:        if ($args->{'setpolicy'}) {
                   10542:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10543:        }
                   10544:        if ($args->{'setcontent'}) {
                   10545:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10546:        }
                   10547:     }
                   10548:     if ($args->{'reshome'}) {
                   10549: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10550: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10551:     }
                   10552: #
                   10553: # course has keyed access
                   10554: #
                   10555:     if ($args->{'setkeys'}) {
                   10556:        $cenv{'keyaccess'}='yes';
                   10557:     }
                   10558: # if specified, key authority is not course, but user
                   10559: # only active if keyaccess is yes
                   10560:     if ($args->{'keyauth'}) {
1.487     albertel 10561: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10562: 	$user = &LONCAPA::clean_username($user);
                   10563: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10564: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10565: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10566: 	}
                   10567:     }
                   10568: 
                   10569:     if ($args->{'disresdis'}) {
                   10570:         $cenv{'pch.roles.denied'}='st';
                   10571:     }
                   10572:     if ($args->{'disablechat'}) {
                   10573:         $cenv{'plc.roles.denied'}='st';
                   10574:     }
                   10575: 
                   10576:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10577:     # course
                   10578:     $cenv{'course.helper.not.run'} = 1;
                   10579:     #
                   10580:     # Use new Randomseed
                   10581:     #
                   10582:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10583:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10584:     #
                   10585:     # The encryption code and receipt prefix for this course
                   10586:     #
                   10587:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10588:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10589:     #
                   10590:     # By default, use standard grading
                   10591:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10592: 
1.541     raeburn  10593:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10594:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10595: #
                   10596: # Open all assignments
                   10597: #
                   10598:     if ($args->{'openall'}) {
                   10599:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10600:        my %storecontent = ($storeunder         => time,
                   10601:                            $storeunder.'.type' => 'date_start');
                   10602:        
                   10603:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10604:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10605:    }
                   10606: #
                   10607: # Set first page
                   10608: #
                   10609:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10610: 	    || ($cloneid)) {
1.445     albertel 10611: 	use LONCAPA::map;
1.444     albertel 10612: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10613: 
                   10614: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10615:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10616: 
1.444     albertel 10617:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10618:         my $title; my $url;
                   10619:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10620: 	    $title=&mt('Syllabus');
1.444     albertel 10621:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10622:         } else {
1.690     bisitz   10623:             $title=&mt('Navigate Contents');
1.444     albertel 10624:             $url='/adm/navmaps';
                   10625:         }
1.445     albertel 10626: 
                   10627:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10628: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10629: 
                   10630: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10631:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10632:     }
1.566     albertel 10633: 
1.925.2.12  raeburn  10634:     if ($args->{'cloneroster'}) {
                   10635:         my ($numadded,$clisterror) = &Apache::lonclonecourse::copyroster($cloneid,$$courseid,$args->{'startaccess'},$args->{'endaccess'});
                   10636:         if ($clisterror) {
                   10637:             $outcome .= "\0".&mt('An error occurred when copying the student roster from the old course to the new course; the error was: [_1].',$clisterror).$linefeed;
                   10638:             if ($numadded) {
                   10639:                 $outcome .= &mt('Although [quant,_1,student] have received roles in the new course the roster does not report this. It is  ').$linefeed;
                   10640:             } 
                   10641:         } else {
                   10642:             if ($numadded) {
                   10643:                 $outcome .= "\0".&mt('[quant,_1,student] copied from roster for old course to roster for new course.',$numadded).$linefeed;
                   10644:             } else {
                   10645:                 $outcome .= "\0".&mt('No students have been enrolled in the new Concept Test.').' '.&mt('This is because either (a) an error occurred, or (b) there were no students with either current access or access which ended on/after the current default end date set for access to the old course.').$linefeed;
                   10646:             }
                   10647:         }
                   10648:     }
1.566     albertel 10649:     return (1,$outcome);
1.444     albertel 10650: }
                   10651: 
                   10652: ############################################################
                   10653: ############################################################
                   10654: 
1.378     raeburn  10655: sub course_type {
                   10656:     my ($cid) = @_;
                   10657:     if (!defined($cid)) {
                   10658:         $cid = $env{'request.course.id'};
                   10659:     }
1.404     albertel 10660:     if (defined($env{'course.'.$cid.'.type'})) {
                   10661:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10662:     } else {
                   10663:         return 'Course';
1.377     raeburn  10664:     }
                   10665: }
1.156     albertel 10666: 
1.406     raeburn  10667: sub group_term {
                   10668:     my $crstype = &course_type();
                   10669:     my %names = (
                   10670:                   'Course' => 'group',
1.865     raeburn  10671:                   'Community' => 'group',
1.406     raeburn  10672:                 );
                   10673:     return $names{$crstype};
                   10674: }
                   10675: 
1.902     raeburn  10676: sub course_types {
                   10677:     my @types = ('official','unofficial','community');
                   10678:     my %typename = (
                   10679:                          official   => 'Official course',
                   10680:                          unofficial => 'Unofficial course',
                   10681:                          community  => 'Community',
                   10682:                    );
                   10683:     return (\@types,\%typename);
                   10684: }
                   10685: 
1.156     albertel 10686: sub icon {
                   10687:     my ($file)=@_;
1.505     albertel 10688:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10689:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10690:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10691:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10692: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10693: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10694: 	            $curfext.".gif") {
                   10695: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10696: 		$curfext.".gif";
                   10697: 	}
                   10698:     }
1.249     albertel 10699:     return &lonhttpdurl($iconname);
1.154     albertel 10700: } 
1.84      albertel 10701: 
1.575     albertel 10702: sub lonhttpdurl {
1.692     www      10703: #
                   10704: # Had been used for "small fry" static images on separate port 8080.
                   10705: # Modify here if lightweight http functionality desired again.
                   10706: # Currently eliminated due to increasing firewall issues.
                   10707: #
1.575     albertel 10708:     my ($url)=@_;
1.692     www      10709:     return $url;
1.215     albertel 10710: }
                   10711: 
1.213     albertel 10712: sub connection_aborted {
                   10713:     my ($r)=@_;
                   10714:     $r->print(" ");$r->rflush();
                   10715:     my $c = $r->connection;
                   10716:     return $c->aborted();
                   10717: }
                   10718: 
1.221     foxr     10719: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10720: #    strings as 'strings'.
                   10721: sub escape_single {
1.221     foxr     10722:     my ($input) = @_;
1.223     albertel 10723:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10724:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10725:     return $input;
                   10726: }
1.223     albertel 10727: 
1.222     foxr     10728: #  Same as escape_single, but escape's "'s  This 
                   10729: #  can be used for  "strings"
                   10730: sub escape_double {
                   10731:     my ($input) = @_;
                   10732:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10733:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10734:     return $input;
                   10735: }
1.223     albertel 10736:  
1.222     foxr     10737: #   Escapes the last element of a full URL.
                   10738: sub escape_url {
                   10739:     my ($url)   = @_;
1.238     raeburn  10740:     my @urlslices = split(/\//, $url,-1);
1.369     www      10741:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10742:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10743: }
1.462     albertel 10744: 
1.820     raeburn  10745: sub compare_arrays {
                   10746:     my ($arrayref1,$arrayref2) = @_;
                   10747:     my (@difference,%count);
                   10748:     @difference = ();
                   10749:     %count = ();
                   10750:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10751:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10752:         foreach my $element (keys(%count)) {
                   10753:             if ($count{$element} == 1) {
                   10754:                 push(@difference,$element);
                   10755:             }
                   10756:         }
                   10757:     }
                   10758:     return @difference;
                   10759: }
                   10760: 
1.817     bisitz   10761: # -------------------------------------------------------- Initialize user login
1.462     albertel 10762: sub init_user_environment {
1.463     albertel 10763:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10764:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10765: 
                   10766:     my $public=($username eq 'public' && $domain eq 'public');
                   10767: 
                   10768: # See if old ID present, if so, remove
                   10769: 
                   10770:     my ($filename,$cookie,$userroles);
                   10771:     my $now=time;
                   10772: 
                   10773:     if ($public) {
                   10774: 	my $max_public=100;
                   10775: 	my $oldest;
                   10776: 	my $oldest_time=0;
                   10777: 	for(my $next=1;$next<=$max_public;$next++) {
                   10778: 	    if (-e $lonids."/publicuser_$next.id") {
                   10779: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10780: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10781: 		    $oldest_time=$mtime;
                   10782: 		    $oldest=$next;
                   10783: 		}
                   10784: 	    } else {
                   10785: 		$cookie="publicuser_$next";
                   10786: 		last;
                   10787: 	    }
                   10788: 	}
                   10789: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10790:     } else {
1.463     albertel 10791: 	# if this isn't a robot, kill any existing non-robot sessions
                   10792: 	if (!$args->{'robot'}) {
                   10793: 	    opendir(DIR,$lonids);
                   10794: 	    while ($filename=readdir(DIR)) {
                   10795: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10796: 		    unlink($lonids.'/'.$filename);
                   10797: 		}
1.462     albertel 10798: 	    }
1.463     albertel 10799: 	    closedir(DIR);
1.462     albertel 10800: 	}
                   10801: # Give them a new cookie
1.463     albertel 10802: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10803: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10804: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10805:     
                   10806: # Initialize roles
                   10807: 
                   10808: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10809:     }
                   10810: # ------------------------------------ Check browser type and MathML capability
                   10811: 
                   10812:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10813:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10814: 
                   10815: # ------------------------------------------------------------- Get environment
                   10816: 
                   10817:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10818:     my ($tmp) = keys(%userenv);
                   10819:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10820: 	# default remote control to off
                   10821: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10822:     } else {
                   10823: 	undef(%userenv);
                   10824:     }
                   10825:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10826: 	$form->{'interface'}=$userenv{'interface'};
                   10827:     }
                   10828:     $env{'environment.remote'}=$userenv{'remote'};
                   10829:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10830: 
                   10831: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10832:     foreach my $option ('interface','localpath','localres') {
                   10833:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10834:     }
                   10835: # --------------------------------------------------------- Write first profile
                   10836: 
                   10837:     {
                   10838: 	my %initial_env = 
                   10839: 	    ("user.name"          => $username,
                   10840: 	     "user.domain"        => $domain,
                   10841: 	     "user.home"          => $authhost,
                   10842: 	     "browser.type"       => $clientbrowser,
                   10843: 	     "browser.version"    => $clientversion,
                   10844: 	     "browser.mathml"     => $clientmathml,
                   10845: 	     "browser.unicode"    => $clientunicode,
                   10846: 	     "browser.os"         => $clientos,
                   10847: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10848: 	     "request.course.fn"  => '',
                   10849: 	     "request.course.uri" => '',
                   10850: 	     "request.course.sec" => '',
                   10851: 	     "request.role"       => 'cm',
                   10852: 	     "request.role.adv"   => $env{'user.adv'},
                   10853: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10854: 
                   10855:         if ($form->{'localpath'}) {
                   10856: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10857: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10858:         }
                   10859: 	
                   10860: 	if ($public) {
                   10861: 	    $initial_env{"environment.remote"} = "off";
                   10862: 	}
                   10863: 	if ($form->{'interface'}) {
                   10864: 	    $form->{'interface'}=~s/\W//gs;
                   10865: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10866: 	    $env{'browser.interface'}=$form->{'interface'};
                   10867: 	}
                   10868: 
1.724     raeburn  10869:         foreach my $tool ('aboutme','blog','portfolio') {
                   10870:             $userenv{'availabletools.'.$tool} = 
                   10871:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10872:         }
                   10873: 
1.864     raeburn  10874:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10875:             $userenv{'canrequest.'.$crstype} =
                   10876:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10877:                                                   'reload','requestcourses');
                   10878:         }
                   10879: 
1.462     albertel 10880: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10881: 	
                   10882: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10883: 		 &GDBM_WRCREAT(),0640)) {
                   10884: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10885: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10886: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10887: 	    if (ref($args->{'extra_env'})) {
                   10888: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10889: 	    }
1.462     albertel 10890: 	    untie(%disk_env);
                   10891: 	} else {
1.705     tempelho 10892: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10893: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10894: 	    return 'error: '.$!;
                   10895: 	}
                   10896:     }
                   10897:     $env{'request.role'}='cm';
                   10898:     $env{'request.role.adv'}=$env{'user.adv'};
                   10899:     $env{'browser.type'}=$clientbrowser;
                   10900: 
                   10901:     return $cookie;
                   10902: 
                   10903: }
                   10904: 
                   10905: sub _add_to_env {
                   10906:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10907:     if (ref($env_data) eq 'HASH') {
                   10908:         while (my ($key,$value) = each(%$env_data)) {
                   10909: 	    $idf->{$prefix.$key} = $value;
                   10910: 	    $env{$prefix.$key}   = $value;
                   10911:         }
1.462     albertel 10912:     }
                   10913: }
                   10914: 
1.925.2.8  raeburn  10915: sub new_roles_update {
                   10916:     my $rolecount = 0;
                   10917:     foreach my $envkey (keys(%env)) {
                   10918:         next unless ($envkey =~ /^user\.role\./);
                   10919:         $rolecount ++;
                   10920:     }
1.925.2.9  raeburn  10921:     my $newrolecount = 0;
1.925.2.8  raeburn  10922:     if (!$rolecount) {
                   10923:         my %userenv;
                   10924:         foreach my $crstype ('official','unofficial','community') {
                   10925:             $userenv{'canrequest.'.$crstype} =
                   10926:                 &Apache::lonnet::usertools_access($env{'user.name'},
                   10927:                 $env{'user.domain'},$crstype,'reload','requestcourses');
                   10928:         }
                   10929:         my $then=$env{'user.login.time'};
                   10930:         my $refresh=time;
                   10931:         my (%userroles,%allroles,%allgroups,@newroles);
                   10932:         my %roleshash =
                   10933:             &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active','future','previous'],undef,undef,1);
                   10934:         foreach my $item (keys(%roleshash)) {
                   10935:             my ($uname,$udom,$role,$section) = split(':',$item);
                   10936:             my $where = '/'.$udom.'/'.$uname;
                   10937:             my ($tstart,$tend) = split(':',$roleshash{$item});
                   10938:             if ($section ne '') {
                   10939:                 $where .= '/'.$section;
                   10940:             }
                   10941:             my $spec = $role.'.'.$where;
                   10942:             &Apache::lonnet::set_arearole($role,$where,$tstart,$tend,
                   10943:                                           $env{'user.domain'},$env{'user.name'});
                   10944:             $userroles{'user.role.'.$spec} = $tstart.'.'.$tend;
1.925.2.9  raeburn  10945:             $newrolecount ++;
1.925.2.8  raeburn  10946:             unless (grep(/^\Q$role\E$/,@newroles)) {
                   10947:                 push(@newroles,$role);
                   10948:             }
                   10949:             my $status =
                   10950:                 &Apache::lonnet::curr_role_status($tstart,$tend,$refresh,$then);
                   10951:             if ($status eq 'active') {
                   10952:                 &Apache::lonnet::gather_roleprivs(\%allroles,\%allgroups,\%userroles,
                   10953:                                                   $where,$role,$tstart,$tend);
                   10954:             }
                   10955:         }
                   10956:         if (@newroles) {
                   10957:             my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles,
                   10958:                                                                \%allgroups);
1.925.2.10  raeburn  10959:             &Apache::lonnet::appenv(\%userroles,[@newroles,'cm']);
1.925.2.8  raeburn  10960:             $userenv{'user.adv'} = $adv;
                   10961:             $userenv{'user.author'} = $author;
                   10962:             $userenv{'user.refresh.time'} = $refresh;
                   10963:         }
                   10964:         &Apache::lonnet::appenv(\%userenv);
                   10965:     }
1.925.2.9  raeburn  10966:     return $newrolecount;
1.925.2.8  raeburn  10967: }
                   10968: 
1.685     tempelho 10969: # --- Get the symbolic name of a problem and the url
                   10970: sub get_symb {
                   10971:     my ($request,$silent) = @_;
1.726     raeburn  10972:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10973:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10974:     if ($symb eq '') {
                   10975:         if (!$silent) {
                   10976:             $request->print("Unable to handle ambiguous references:$url:.");
                   10977:             return ();
                   10978:         }
                   10979:     }
                   10980:     &Apache::lonenc::check_decrypt(\$symb);
                   10981:     return ($symb);
                   10982: }
                   10983: 
                   10984: # --------------------------------------------------------------Get annotation
                   10985: 
                   10986: sub get_annotation {
                   10987:     my ($symb,$enc) = @_;
                   10988: 
                   10989:     my $key = $symb;
                   10990:     if (!$enc) {
                   10991:         $key =
                   10992:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10993:     }
                   10994:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10995:     return $annotation{$key};
                   10996: }
                   10997: 
                   10998: sub clean_symb {
1.731     raeburn  10999:     my ($symb,$delete_enc) = @_;
1.685     tempelho 11000: 
                   11001:     &Apache::lonenc::check_decrypt(\$symb);
                   11002:     my $enc = $env{'request.enc'};
1.731     raeburn  11003:     if ($delete_enc) {
1.730     raeburn  11004:         delete($env{'request.enc'});
                   11005:     }
1.685     tempelho 11006: 
                   11007:     return ($symb,$enc);
                   11008: }
1.462     albertel 11009: 
1.925.2.1  raeburn  11010: sub needs_gci_custom {
                   11011:     my $custommenu;
                   11012:     my $numdc = &check_for_gci_dc();
                   11013:     unless ($numdc) {
                   11014:         my $then=$env{'user.login.time'};
                   11015:         my $now = time;
                   11016:         my %cnums = (
                   11017:                         review => '9615072b469884921gcil1',
                   11018:                         submit => '1H96711d710194bfegcil1',
                   11019:                     );
                   11020:         if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
                   11021:             my ($start,$end) =
                   11022:                 split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
                   11023:             if (((!$start) || ($start && $start <= $now)) &&
                   11024:                 ((!$end) || ($end > $now))) {
                   11025:                 $custommenu = 1;
                   11026:                 if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
                   11027:                     my ($ccstart,$ccend) =
                   11028:                         split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
                   11029:                     if (((!$start) || ($start && $start <= $now)) &&
                   11030:                             ((!$end) || ($end > $now))) {
                   11031:                         $custommenu = '';
                   11032:                     }
                   11033:                 }
                   11034:             }
                   11035:         }
                   11036:     }
                   11037:     return $custommenu;
                   11038: }
                   11039: 
                   11040: sub check_for_gci_dc {
                   11041:     my $then=$env{'user.login.time'};
                   11042:     my $numdc = 0;
                   11043:     foreach my $dom ('gci','gcitest') {
                   11044:         if ($env{'user.role.dc./'.$dom.'/'}) {
                   11045:             my $livedc = 1;
                   11046:             my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
                   11047:             if ($tstart && $tstart>$then) { $livedc = 0; }
                   11048:             if ($tend   && $tend  <$then) { $livedc = 0; }
                   11049:             if ($livedc) {
                   11050:                 $numdc++;
                   11051:             }
                   11052:         }
                   11053:     }
                   11054:     return $numdc;
                   11055: }
                   11056: 
                   11057: sub existing_gcitest_courses {
1.925.2.6  raeburn  11058:     my ($role) = @_;
1.925.2.1  raeburn  11059:     my %courses;
                   11060:     my $cdom = 'gcitest';
                   11061:     my $now = time;
                   11062:     foreach my $envkey (keys(%env)) {
                   11063:         my $cnum;
                   11064:         if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
                   11065:             $cnum = $1;
                   11066:         } else {
                   11067:             next;
                   11068:         }
1.925.2.16  raeburn  11069:         my ($tstart,$tend) = split(/\./,$env{$envkey});
1.925.2.1  raeburn  11070:         if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
1.925.2.3  raeburn  11071:             my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
                   11072:             if ($descr ne '') {
                   11073:                 $courses{$cdom.'_'.$cnum}{'description'} = $descr;
1.925.2.1  raeburn  11074:             }
                   11075:         }
                   11076:     }
                   11077:     return %courses;
                   11078: }
                   11079: 
1.925.2.14  raeburn  11080: sub gcitest_switcher {
                   11081:     my ($role,$formname,%courses) = @_;
                   11082:     my $output;
                   11083:     my %Sortby;
                   11084:     foreach my $course (sort(keys(%courses))) {
                   11085:         next unless (ref($courses{$course}) eq 'HASH');
                   11086:         my $clean_title = $courses{$course}{'description'};
                   11087:         $clean_title =~ s/\W+//g;
                   11088:         if ($clean_title eq '') {
                   11089:             $clean_title = $courses{$course}{'description'};
                   11090:         }
                   11091:         push(@{$Sortby{$clean_title}},$course);
                   11092:     }
                   11093:     my @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby));
                   11094:     my $default;
                   11095:     if (@sorted_courses > 1) {
                   11096:         if (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11097:             $default = &mt('Switch concept test ...');
                   11098:         } else {
                   11099:             $default = &mt('Select a concept test ...');
                   11100:         }
                   11101:     } else {
                   11102:         unless (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11103:             $default = &mt('Select concept test ...');
                   11104:         }
                   11105:     }
                   11106:     if ($default) {
                   11107:         $output = '<form name="'.$formname.'" action="/adm/roles" method="post">'.
                   11108:                   '<select name="newrole" onchange="javascript:courseswitcher();">'.
                   11109:                   '<option value="" selected="selected">'.$default.'</option>';
                   11110:         foreach my $item (@sorted_courses) {
                   11111:             foreach my $course (@{$Sortby{$item}}) {
                   11112:                 my ($cdom,$cnum) = split('_',$course);
                   11113:                 $output .= '<option value="'.$role.'./'.$cdom.'/'.$cnum.'">'.$courses{$course}{'description'}.'</option>';
                   11114:             }
                   11115:         }
                   11116:         $output .= '</select><input type="hidden" name="selectrole" value="" /></form>';
                   11117:     }
                   11118:     return $output;
                   11119: }
                   11120: 
                   11121: sub gcitest_switcher_js {
                   11122:     my ($current,$numcourses,$formname) = @_;
                   11123:     my $output = <<"ENDJS";
                   11124: 
                   11125: function courseswitcher(caller) {
                   11126:     var numcourses = $numcourses;
                   11127:     var current = '$current';
                   11128:     var choice = document.$formname.newrole.options[document.$formname.newrole.selectedIndex].value;
                   11129:     if (choice == '') {
                   11130:         if (caller == 'icon') {
                   11131:             alert('No Concept Test selected');
                   11132:         }
                   11133:         document.$formname.selectrole.value = '';
                   11134:         return;
                   11135:     }
                   11136:     if (choice == current) {
                   11137:         if ((caller != 'icon') && (numcourses > 1)) {
                   11138:             alert('You have selected the current course.\\nPlease select a different Concept Test course');
                   11139:         }
                   11140:         document.$formname.newrole.selectedIndex = 0;
                   11141:         document.$formname.selectrole.value = '';
                   11142:         return;
                   11143:     }
                   11144:     document.$formname.selectrole.value = '1';
                   11145:     document.$formname.submit();
                   11146:     return;
                   11147: }
                   11148: 
                   11149: ENDJS
                   11150:     return $output;
                   11151: }
                   11152: 
                   11153: 
                   11154: 
1.41      ng       11155: =pod
                   11156: 
                   11157: =back
                   11158: 
1.112     bowersj2 11159: =cut
1.41      ng       11160: 
1.112     bowersj2 11161: 1;
                   11162: __END__;
1.41      ng       11163: 

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