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

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

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