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

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.14! raeburn     4: # $Id: loncommon.pm,v 1.925.2.13 2010/09/19 18:50:48 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.852     droeschl 6161: ol#LC_PathBreadcrumbs {
1.911     bisitz   6162:   margin: 0;
1.693     droeschl 6163: }
                   6164: 
1.897     wenzelju 6165: ol.LC_primary_menu li {
1.911     bisitz   6166:   display: inline;
                   6167:   padding: 5px 5px 0 10px;
                   6168:   vertical-align: top;
1.693     droeschl 6169: }
                   6170: 
1.897     wenzelju 6171: ol.LC_primary_menu li img {
1.911     bisitz   6172:   vertical-align: bottom;
1.693     droeschl 6173: }
                   6174: 
1.897     wenzelju 6175: ol.LC_primary_menu a {
1.911     bisitz   6176:   font-size: 90%;
                   6177:   color: RGB(80, 80, 80);
                   6178:   text-decoration: none;
1.693     droeschl 6179: }
1.795     www      6180: 
1.897     wenzelju 6181: ul#LC_secondary_menu {
1.911     bisitz   6182:   clear: both;
                   6183:   color: $fontmenu;
                   6184:   background: $tabbg;
                   6185:   list-style: none;
                   6186:   padding: 0;
                   6187:   margin: 0;
                   6188:   width: 100%;
1.808     droeschl 6189: }
                   6190: 
1.897     wenzelju 6191: ul#LC_secondary_menu li {
1.911     bisitz   6192:   font-weight: bold;
                   6193:   line-height: 1.8em;
                   6194:   padding: 0 0.8em;
                   6195:   border-right: 1px solid black;
                   6196:   display: inline;
                   6197:   vertical-align: middle;
1.807     droeschl 6198: }
                   6199: 
1.847     tempelho 6200: ul.LC_TabContent {
1.911     bisitz   6201:   display:block;
                   6202:   background: $sidebg;
                   6203:   border-bottom: solid 1px $lg_border_color;
                   6204:   list-style:none;
                   6205:   margin: 0 -10px;
                   6206:   padding: 0;
1.693     droeschl 6207: }
                   6208: 
1.795     www      6209: ul.LC_TabContent li,
                   6210: ul.LC_TabContentBigger li {
1.911     bisitz   6211:   float:left;
1.741     harmsja  6212: }
1.795     www      6213: 
1.897     wenzelju 6214: ul#LC_secondary_menu li a {
1.911     bisitz   6215:   color: $fontmenu;
                   6216:   text-decoration: none;
1.693     droeschl 6217: }
1.795     www      6218: 
1.721     harmsja  6219: ul.LC_TabContent {
1.911     bisitz   6220:   min-height:1.5em;
1.721     harmsja  6221: }
1.795     www      6222: 
                   6223: ul.LC_TabContent li {
1.911     bisitz   6224:   vertical-align:middle;
                   6225:   padding: 0 10px 0 10px;
                   6226:   background-color:$tabbg;
                   6227:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6228: }
1.795     www      6229: 
1.847     tempelho 6230: ul.LC_TabContent .right {
1.911     bisitz   6231:   float:right;
1.847     tempelho 6232: }
                   6233: 
1.911     bisitz   6234: ul.LC_TabContent li a,
                   6235: ul.LC_TabContent li {
                   6236:   color:rgb(47,47,47);
                   6237:   text-decoration:none;
                   6238:   font-size:95%;
                   6239:   font-weight:bold;
                   6240:   padding-right: 16px;
1.721     harmsja  6241: }
1.795     www      6242: 
1.911     bisitz   6243: ul.LC_TabContent li:hover,
                   6244: ul.LC_TabContent li.active {
                   6245:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6246:   border-bottom:solid 2px #FFFFFF;
                   6247:   padding-right: 16px;
1.744     ehlerst  6248: }
1.795     www      6249: 
1.870     tempelho 6250: #maincoursedoc {
1.911     bisitz   6251:   clear:both;
1.870     tempelho 6252: }
                   6253: 
                   6254: ul.LC_TabContentBigger {
1.911     bisitz   6255:   display:block;
                   6256:   list-style:none;
                   6257:   padding: 0;
1.870     tempelho 6258: }
                   6259: 
1.795     www      6260: ul.LC_TabContentBigger li {
1.911     bisitz   6261:   vertical-align:bottom;
                   6262:   height: 30px;
                   6263:   font-size:110%;
                   6264:   font-weight:bold;
                   6265:   color: #737373;
1.841     tempelho 6266: }
                   6267: 
1.870     tempelho 6268: 
                   6269: ul.LC_TabContentBigger li a {
1.911     bisitz   6270:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6271:   height: 30px;
                   6272:   line-height: 30px;
                   6273:   text-align: center;
                   6274:   display: block;
                   6275:   text-decoration: none;
1.741     harmsja  6276: }
1.795     www      6277: 
1.911     bisitz   6278: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6279: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6280:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6281:   color:$font;
                   6282:   text-decoration: underline;
1.744     ehlerst  6283: }
1.795     www      6284: 
1.870     tempelho 6285: 
                   6286: ul.LC_TabContentBigger li b {
1.911     bisitz   6287:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6288:   display: block;
                   6289:   float: left;
                   6290:   padding: 0 30px;
1.870     tempelho 6291: }
                   6292: 
                   6293: ul.LC_TabContentBigger li:hover b,
                   6294: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6295:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6296:   color:$font;
                   6297:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6298: }
1.693     droeschl 6299: 
1.870     tempelho 6300: 
1.862     bisitz   6301: ul.LC_CourseBreadcrumbs {
                   6302:   background: $sidebg;
                   6303:   line-height: 32px;
                   6304:   padding-left: 10px;
                   6305:   margin: 0 0 10px 0;
                   6306:   list-style-position: inside;
                   6307: 
                   6308: }
                   6309: 
1.911     bisitz   6310: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6311: ol#LC_PathBreadcrumbs {
1.911     bisitz   6312:   padding-left: 10px;
                   6313:   margin: 0;
1.925.2.14! raeburn  6314:   margin: 0;
        !          6315:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6316: }
                   6317: 
1.911     bisitz   6318: ol#LC_MenuBreadcrumbs li,
                   6319: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6320: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6321:   display: inline;
1.925.2.14! raeburn  6322:   white-space: normal;
1.693     droeschl 6323: }
                   6324: 
1.823     bisitz   6325: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6326: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6327:   text-decoration: none;
                   6328:   font-size:90%;
1.693     droeschl 6329: }
1.795     www      6330: 
1.925.2.14! raeburn  6331: ol#LC_MenuBreadcrumbs h1 {
        !          6332:   display: inline;
        !          6333:   font-size: 90%;
        !          6334:   line-height: 2.5em;
        !          6335:   margin: 0;
        !          6336:   padding: 0;
        !          6337: }
        !          6338: 
1.795     www      6339: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6340:   text-decoration:none;
                   6341:   font-size:100%;
                   6342:   font-weight:bold;
1.693     droeschl 6343: }
1.795     www      6344: 
1.840     bisitz   6345: .LC_Box {
1.911     bisitz   6346:   border: solid 1px $lg_border_color;
                   6347:   padding: 0 10px 10px 10px;
1.746     neumanie 6348: }
1.795     www      6349: 
                   6350: .LC_AboutMe_Image {
1.911     bisitz   6351:   float:left;
                   6352:   margin-right:10px;
1.747     neumanie 6353: }
1.795     www      6354: 
                   6355: .LC_Clear_AboutMe_Image {
1.911     bisitz   6356:   clear:left;
1.747     neumanie 6357: }
1.795     www      6358: 
1.721     harmsja  6359: dl.LC_ListStyleClean dt {
1.911     bisitz   6360:   padding-right: 5px;
                   6361:   display: table-header-group;
1.693     droeschl 6362: }
                   6363: 
1.721     harmsja  6364: dl.LC_ListStyleClean dd {
1.911     bisitz   6365:   display: table-row;
1.693     droeschl 6366: }
                   6367: 
1.721     harmsja  6368: .LC_ListStyleClean,
                   6369: .LC_ListStyleSimple,
                   6370: .LC_ListStyleNormal,
1.795     www      6371: .LC_ListStyleSpecial {
1.911     bisitz   6372:   /* display:block; */
                   6373:   list-style-position: inside;
                   6374:   list-style-type: none;
                   6375:   overflow: hidden;
                   6376:   padding: 0;
1.693     droeschl 6377: }
                   6378: 
1.721     harmsja  6379: .LC_ListStyleSimple li,
                   6380: .LC_ListStyleSimple dd,
                   6381: .LC_ListStyleNormal li,
                   6382: .LC_ListStyleNormal dd,
                   6383: .LC_ListStyleSpecial li,
1.795     www      6384: .LC_ListStyleSpecial dd {
1.911     bisitz   6385:   margin: 0;
                   6386:   padding: 5px 5px 5px 10px;
                   6387:   clear: both;
1.693     droeschl 6388: }
                   6389: 
1.721     harmsja  6390: .LC_ListStyleClean li,
                   6391: .LC_ListStyleClean dd {
1.911     bisitz   6392:   padding-top: 0;
                   6393:   padding-bottom: 0;
1.693     droeschl 6394: }
                   6395: 
1.721     harmsja  6396: .LC_ListStyleSimple dd,
1.795     www      6397: .LC_ListStyleSimple li {
1.911     bisitz   6398:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6399: }
                   6400: 
1.721     harmsja  6401: .LC_ListStyleSpecial li,
                   6402: .LC_ListStyleSpecial dd {
1.911     bisitz   6403:   list-style-type: none;
                   6404:   background-color: RGB(220, 220, 220);
                   6405:   margin-bottom: 4px;
1.693     droeschl 6406: }
                   6407: 
1.721     harmsja  6408: table.LC_SimpleTable {
1.911     bisitz   6409:   margin:5px;
                   6410:   border:solid 1px $lg_border_color;
1.795     www      6411: }
1.693     droeschl 6412: 
1.721     harmsja  6413: table.LC_SimpleTable tr {
1.911     bisitz   6414:   padding: 0;
                   6415:   border:solid 1px $lg_border_color;
1.693     droeschl 6416: }
1.795     www      6417: 
                   6418: table.LC_SimpleTable thead {
1.911     bisitz   6419:   background:rgb(220,220,220);
1.693     droeschl 6420: }
                   6421: 
1.721     harmsja  6422: div.LC_columnSection {
1.911     bisitz   6423:   display: block;
                   6424:   clear: both;
                   6425:   overflow: hidden;
                   6426:   margin: 0;
1.693     droeschl 6427: }
                   6428: 
1.721     harmsja  6429: div.LC_columnSection>* {
1.911     bisitz   6430:   float: left;
                   6431:   margin: 10px 20px 10px 0;
                   6432:   overflow:hidden;
1.693     droeschl 6433: }
1.721     harmsja  6434: 
1.694     tempelho 6435: .LC_loginpage_container {
1.911     bisitz   6436:   text-align:left;
                   6437:   margin : 0 auto;
                   6438:   width:90%;
                   6439:   padding: 10px;
                   6440:   height: auto;
                   6441:   background-color:#FFFFFF;
                   6442:   border:1px solid #CCCCCC;
1.694     tempelho 6443: }
                   6444: 
                   6445: 
                   6446: .LC_loginpage_loginContainer {
1.911     bisitz   6447:   float:left;
                   6448:   width: 182px;
                   6449:   padding: 2px;
                   6450:   border:1px solid #CCCCCC;
                   6451:   background-color:$loginbg;
1.694     tempelho 6452: }
                   6453: 
1.795     www      6454: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6455:   margin-top: 0;
                   6456:   display:block;
                   6457:   background:$bgcol;
                   6458:   color:$textcol;
                   6459:   padding-left:5px;
1.712     muellerd 6460: }
1.785     tempelho 6461: 
1.694     tempelho 6462: .LC_loginpage_loginInfo {
1.911     bisitz   6463:   float:left;
                   6464:   width:182px;
                   6465:   border:1px solid #CCCCCC;
                   6466:   padding:2px;
1.712     muellerd 6467: }
                   6468: 
1.694     tempelho 6469: .LC_loginpage_space {
1.911     bisitz   6470:   clear: both;
                   6471:   margin-bottom: 20px;
                   6472:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6473: }
                   6474: 
1.785     tempelho 6475: .LC_loginpage_floatLeft {
1.911     bisitz   6476:   float: left;
                   6477:   width: 200px;
                   6478:   margin: 0;
1.785     tempelho 6479: }
                   6480: 
1.795     www      6481: table em {
1.911     bisitz   6482:   font-weight: bold;
                   6483:   font-style: normal;
1.748     schulted 6484: }
1.795     www      6485: 
1.779     bisitz   6486: table.LC_tableBrowseRes,
1.795     www      6487: table.LC_tableOfContent {
1.911     bisitz   6488:   border:none;
                   6489:   border-spacing: 1px;
                   6490:   padding: 3px;
                   6491:   background-color: #FFFFFF;
                   6492:   font-size: 90%;
1.753     droeschl 6493: }
1.789     droeschl 6494: 
1.911     bisitz   6495: table.LC_tableOfContent {
                   6496:   border-collapse: collapse;
1.789     droeschl 6497: }
                   6498: 
1.771     droeschl 6499: table.LC_tableBrowseRes a,
1.768     schulted 6500: table.LC_tableOfContent a {
1.911     bisitz   6501:   background-color: transparent;
                   6502:   text-decoration: none;
1.753     droeschl 6503: }
                   6504: 
1.795     www      6505: table.LC_tableOfContent img {
1.911     bisitz   6506:   border: none;
                   6507:   height: 1.3em;
                   6508:   vertical-align: text-bottom;
                   6509:   margin-right: 0.3em;
1.753     droeschl 6510: }
1.757     schulted 6511: 
1.795     www      6512: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6513:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6514: }
                   6515: 
1.795     www      6516: a#LC_content_toolbar_launchnav {
1.911     bisitz   6517:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6518: }
                   6519: 
1.795     www      6520: a#LC_content_toolbar_closenav {
1.911     bisitz   6521:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6522: }
                   6523: 
1.795     www      6524: a#LC_content_toolbar_everything {
1.911     bisitz   6525:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6526: }
                   6527: 
1.795     www      6528: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6529:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6530: }
                   6531: 
1.795     www      6532: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6533:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6534: }
                   6535: 
1.795     www      6536: a#LC_content_toolbar_changefolder {
1.911     bisitz   6537:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6538: }
                   6539: 
1.795     www      6540: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6541:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6542: }
                   6543: 
1.795     www      6544: ul#LC_toolbar li a:hover {
1.911     bisitz   6545:   background-position: bottom center;
1.757     schulted 6546: }
                   6547: 
1.795     www      6548: ul#LC_toolbar {
1.911     bisitz   6549:   padding: 0;
                   6550:   margin: 2px;
                   6551:   list-style:none;
                   6552:   position:relative;
                   6553:   background-color:white;
1.757     schulted 6554: }
                   6555: 
1.795     www      6556: ul#LC_toolbar li {
1.911     bisitz   6557:   border:1px solid white;
                   6558:   padding: 0;
                   6559:   margin: 0;
                   6560:   float: left;
                   6561:   display:inline;
                   6562:   vertical-align:middle;
                   6563: }
1.757     schulted 6564: 
1.783     amueller 6565: 
1.795     www      6566: a.LC_toolbarItem {
1.911     bisitz   6567:   display:block;
                   6568:   padding: 0;
                   6569:   margin: 0;
                   6570:   height: 32px;
                   6571:   width: 32px;
                   6572:   color:white;
                   6573:   border: none;
                   6574:   background-repeat:no-repeat;
                   6575:   background-color:transparent;
1.757     schulted 6576: }
                   6577: 
1.915     droeschl 6578: ul.LC_funclist {
                   6579:     margin: 0;
                   6580:     padding: 0.5em 1em 0.5em 0;
                   6581: }
                   6582: 
1.925.2.14! raeburn  6583: ul.LC_funclist > li:first-child {
        !          6584:     font-weight:bold;
        !          6585:     margin-left:0.8em;
        !          6586: }
        !          6587: 
1.915     droeschl 6588: ul.LC_funclist + ul.LC_funclist {
                   6589:     /* 
                   6590:        left border as a seperator if we have more than
                   6591:        one list 
                   6592:     */
                   6593:     border-left: 1px solid $sidebg;
                   6594:     /* 
                   6595:        this hides the left border behind the border of the 
                   6596:        outer box if element is wrapped to the next 'line' 
                   6597:     */
                   6598:     margin-left: -1px;
                   6599: }
                   6600: 
1.843     bisitz   6601: ul.LC_funclist li {
1.915     droeschl 6602:   display: inline;
1.782     bisitz   6603:   white-space: nowrap;
1.915     droeschl 6604:   margin: 0 0 0 25px;
                   6605:   line-height: 150%;
1.782     bisitz   6606: }
                   6607: 
1.925.2.1  raeburn  6608: #gciheader {
                   6609:   float:left;
                   6610:   width:100%;
                   6611:   background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
                   6612:   font-size:93%;
                   6613:   line-height:normal;
1.925.2.14! raeburn  6614:   margin: 0.5em 0 0.5em 0;
1.925.2.1  raeburn  6615: }
                   6616: #gciheader ul {
                   6617:   margin:0;
1.925.2.14! raeburn  6618:   padding:10px 5px 0;
1.925.2.1  raeburn  6619:   list-style:none;
                   6620: }
                   6621: #gciheader li {
                   6622:   float:left;
                   6623:   background:url("/gcimenu_left.gif") no-repeat left top;
                   6624:   margin:0;
                   6625:   padding:0 0 0 9px;
                   6626: }
                   6627: #gciheader a {
                   6628:   display:block;
                   6629:   background:url("/gcimenu_right.gif") no-repeat right top;
                   6630:   padding:5px 15px 4px 6px;
                   6631: }
                   6632: #gciheader #current {
                   6633:   background-image:url("/gcimenu_left_on.gif");
                   6634: }
                   6635: #gciheader #current a {
                   6636:   background-image:url("/gcimenu_right_on.gif");
                   6637:   padding-bottom:5px;
                   6638: }
1.757     schulted 6639: 
1.343     albertel 6640: END
                   6641: }
                   6642: 
1.306     albertel 6643: =pod
                   6644: 
                   6645: =item * &headtag()
                   6646: 
                   6647: Returns a uniform footer for LON-CAPA web pages.
                   6648: 
1.307     albertel 6649: Inputs: $title - optional title for the head
                   6650:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6651:         $args - optional arguments
1.319     albertel 6652:             force_register - if is true call registerurl so the remote is 
                   6653:                              informed
1.415     albertel 6654:             redirect       -> array ref of
                   6655:                                    1- seconds before redirect occurs
                   6656:                                    2- url to redirect to
                   6657:                                    3- whether the side effect should occur
1.315     albertel 6658:                            (side effect of setting 
                   6659:                                $env{'internal.head.redirect'} to the url 
                   6660:                                redirected too)
1.352     albertel 6661:             domain         -> force to color decorate a page for a specific
                   6662:                                domain
                   6663:             function       -> force usage of a specific rolish color scheme
                   6664:             bgcolor        -> override the default page bgcolor
1.460     albertel 6665:             no_auto_mt_title
                   6666:                            -> prevent &mt()ing the title arg
1.464     albertel 6667: 
1.306     albertel 6668: =cut
                   6669: 
                   6670: sub headtag {
1.313     albertel 6671:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6672:     
1.363     albertel 6673:     my $function = $args->{'function'} || &get_users_function();
                   6674:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6675:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6676:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6677: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6678: 		   #time(),
1.418     albertel 6679: 		   $env{'environment.color.timestamp'},
1.363     albertel 6680: 		   $function,$domain,$bgcolor);
                   6681: 
1.369     www      6682:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6683: 
1.308     albertel 6684:     my $result =
                   6685: 	'<head>'.
1.461     albertel 6686: 	&font_settings();
1.319     albertel 6687: 
1.461     albertel 6688:     if (!$args->{'frameset'}) {
                   6689: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6690:     }
1.319     albertel 6691:     if ($args->{'force_register'}) {
                   6692: 	$result .= &Apache::lonmenu::registerurl(1);
                   6693:     }
1.436     albertel 6694:     if (!$args->{'no_nav_bar'} 
                   6695: 	&& !$args->{'only_body'}
                   6696: 	&& !$args->{'frameset'}) {
                   6697: 	$result .= &help_menu_js();
                   6698:     }
1.319     albertel 6699: 
1.314     albertel 6700:     if (ref($args->{'redirect'})) {
1.414     albertel 6701: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6702: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6703: 	if (!$inhibit_continue) {
                   6704: 	    $env{'internal.head.redirect'} = $url;
                   6705: 	}
1.313     albertel 6706: 	$result.=<<ADDMETA
                   6707: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6708: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6709: ADDMETA
                   6710:     }
1.306     albertel 6711:     if (!defined($title)) {
                   6712: 	$title = 'The LearningOnline Network with CAPA';
                   6713:     }
1.460     albertel 6714:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6715:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6716: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6717: 	.$head_extra;
1.306     albertel 6718:     return $result;
                   6719: }
                   6720: 
                   6721: =pod
                   6722: 
1.340     albertel 6723: =item * &font_settings()
                   6724: 
                   6725: Returns neccessary <meta> to set the proper encoding
                   6726: 
                   6727: Inputs: none
                   6728: 
                   6729: =cut
                   6730: 
                   6731: sub font_settings {
                   6732:     my $headerstring='';
1.647     www      6733:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6734: 	$headerstring.=
                   6735: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6736:     }
                   6737:     return $headerstring;
                   6738: }
                   6739: 
1.341     albertel 6740: =pod
                   6741: 
                   6742: =item * &xml_begin()
                   6743: 
                   6744: Returns the needed doctype and <html>
                   6745: 
                   6746: Inputs: none
                   6747: 
                   6748: =cut
                   6749: 
                   6750: sub xml_begin {
                   6751:     my $output='';
                   6752: 
1.592     albertel 6753:     if ($env{'internal.start_page'}==1) {
                   6754: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6755:     }
1.342     albertel 6756: 
1.341     albertel 6757:     if ($env{'browser.mathml'}) {
                   6758: 	$output='<?xml version="1.0"?>'
                   6759:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6760: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6761:             
                   6762: #	    .'<!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">] >'
                   6763: 	    .'<!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">'
                   6764:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6765: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6766:     } else {
1.849     bisitz   6767: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6768:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6769:     }
                   6770:     return $output;
                   6771: }
1.340     albertel 6772: 
                   6773: =pod
                   6774: 
1.306     albertel 6775: =item * &endheadtag()
                   6776: 
                   6777: Returns a uniform </head> for LON-CAPA web pages.
                   6778: 
                   6779: Inputs: none
                   6780: 
                   6781: =cut
                   6782: 
                   6783: sub endheadtag {
                   6784:     return '</head>';
                   6785: }
                   6786: 
                   6787: =pod
                   6788: 
                   6789: =item * &head()
                   6790: 
                   6791: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6792: 
1.648     raeburn  6793: Inputs:
                   6794: 
                   6795: =over 4
                   6796: 
                   6797: $title - optional title for the page
                   6798: 
                   6799: $head_extra - optional extra HTML to put inside the <head>
                   6800: 
                   6801: =back
1.405     albertel 6802: 
1.306     albertel 6803: =cut
                   6804: 
                   6805: sub head {
1.325     albertel 6806:     my ($title,$head_extra,$args) = @_;
                   6807:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6808: }
                   6809: 
                   6810: =pod
                   6811: 
                   6812: =item * &start_page()
                   6813: 
                   6814: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6815: 
1.648     raeburn  6816: Inputs:
                   6817: 
                   6818: =over 4
                   6819: 
                   6820: $title - optional title for the page
                   6821: 
                   6822: $head_extra - optional extra HTML to incude inside the <head>
                   6823: 
                   6824: $args - additional optional args supported are:
                   6825: 
                   6826: =over 8
                   6827: 
                   6828:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6829:                                     arg on
1.814     bisitz   6830:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6831:              add_entries    -> additional attributes to add to the  <body>
                   6832:              domain         -> force to color decorate a page for a 
1.317     albertel 6833:                                     specific domain
1.648     raeburn  6834:              function       -> force usage of a specific rolish color
1.317     albertel 6835:                                     scheme
1.648     raeburn  6836:              redirect       -> see &headtag()
                   6837:              bgcolor        -> override the default page bg color
                   6838:              js_ready       -> return a string ready for being used in 
1.317     albertel 6839:                                     a javascript writeln
1.648     raeburn  6840:              html_encode    -> return a string ready for being used in 
1.320     albertel 6841:                                     a html attribute
1.648     raeburn  6842:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6843:                                     $forcereg arg
1.648     raeburn  6844:              frameset       -> if true will start with a <frameset>
1.330     albertel 6845:                                     rather than <body>
1.648     raeburn  6846:              skip_phases    -> hash ref of 
1.338     albertel 6847:                                     head -> skip the <html><head> generation
                   6848:                                     body -> skip all <body> generation
1.648     raeburn  6849:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6850:                                     'Switch To Inline Menu' link
1.648     raeburn  6851:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6852:              inherit_jsmath -> when creating popup window in a page,
                   6853:                                     should it have jsmath forced on by the
                   6854:                                     current page
1.867     kalberla 6855:              bread_crumbs ->             Array containing breadcrumbs
                   6856:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6857: 
1.648     raeburn  6858: =back
1.460     albertel 6859: 
1.648     raeburn  6860: =back
1.562     albertel 6861: 
1.306     albertel 6862: =cut
                   6863: 
                   6864: sub start_page {
1.309     albertel 6865:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6866:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6867:     my %head_args;
1.352     albertel 6868:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6869: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6870: 		     'no_auto_mt_title') {
1.319     albertel 6871: 	if (defined($args->{$arg})) {
1.324     raeburn  6872: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6873: 	}
1.313     albertel 6874:     }
1.319     albertel 6875: 
1.315     albertel 6876:     $env{'internal.start_page'}++;
1.338     albertel 6877:     my $result;
                   6878:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6879: 	$result.=
1.341     albertel 6880: 	    &xml_begin().
1.338     albertel 6881: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6882:     }
                   6883:     
                   6884:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6885: 	if ($args->{'frameset'}) {
                   6886: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6887: 						$args->{'add_entries'});
                   6888: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6889:         } else {
                   6890:             $result .=
                   6891:                 &bodytag($title, 
                   6892:                          $args->{'function'},       $args->{'add_entries'},
                   6893:                          $args->{'only_body'},      $args->{'domain'},
                   6894:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6895:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6896:                          $args);
                   6897:         }
1.330     albertel 6898:     }
1.338     albertel 6899: 
1.315     albertel 6900:     if ($args->{'js_ready'}) {
1.713     kaisler  6901: 		$result = &js_ready($result);
1.315     albertel 6902:     }
1.320     albertel 6903:     if ($args->{'html_encode'}) {
1.713     kaisler  6904: 		$result = &html_encode($result);
                   6905:     }
                   6906: 
1.813     bisitz   6907:     # Preparation for new and consistent functionlist at top of screen
                   6908:     # if ($args->{'functionlist'}) {
                   6909:     #            $result .= &build_functionlist();
                   6910:     #}
                   6911: 
                   6912:     # Don't add anything more if only_body wanted
                   6913:     return $result if $args->{'only_body'};
                   6914: 
1.920     raeburn  6915:     #Breadcrumbs for Construction Space provided by &bodytag. 
                   6916:     if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
                   6917:         return $result;
                   6918:     }
                   6919:  
1.813     bisitz   6920:     #Breadcrumbs
1.758     kaisler  6921:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6922: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6923: 		#if any br links exists, add them to the breadcrumbs
                   6924: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6925: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6926: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6927: 			}
                   6928: 		}
                   6929: 
                   6930: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6931: 		if(exists($args->{'bread_crumbs_component'})){
                   6932: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
1.925.2.14! raeburn  6933: 		} else {
        !          6934:                 	$result .= &Apache::lonhtmlcommon::breadcrumbs(); 
1.758     kaisler  6935: 		}
1.320     albertel 6936:     }
1.315     albertel 6937:     return $result;
1.306     albertel 6938: }
                   6939: 
1.330     albertel 6940: 
1.306     albertel 6941: =pod
                   6942: 
                   6943: =item * &head()
                   6944: 
                   6945: Returns a complete </body></html> section for LON-CAPA web pages.
                   6946: 
1.315     albertel 6947: Inputs:         $args - additional optional args supported are:
                   6948:                  js_ready     -> return a string ready for being used in 
                   6949:                                  a javascript writeln
1.320     albertel 6950:                  html_encode  -> return a string ready for being used in 
                   6951:                                  a html attribute
1.330     albertel 6952:                  frameset     -> if true will start with a <frameset>
                   6953:                                  rather than <body>
1.493     albertel 6954:                  dicsussion   -> if true will get discussion from
                   6955:                                   lonxml::xmlend
                   6956:                                  (you can pass the target and parser arguments
                   6957:                                   through optional 'target' and 'parser' args
                   6958:                                   to this routine)
1.306     albertel 6959: 
                   6960: =cut
                   6961: 
                   6962: sub end_page {
1.315     albertel 6963:     my ($args) = @_;
                   6964:     $env{'internal.end_page'}++;
1.330     albertel 6965:     my $result;
1.335     albertel 6966:     if ($args->{'discussion'}) {
                   6967: 	my ($target,$parser);
                   6968: 	if (ref($args->{'discussion'})) {
                   6969: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6970: 				$args->{'discussion'}{'parser'});
                   6971: 	}
                   6972: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6973:     }
                   6974: 
1.330     albertel 6975:     if ($args->{'frameset'}) {
                   6976: 	$result .= '</frameset>';
                   6977:     } else {
1.635     raeburn  6978: 	$result .= &endbodytag($args);
1.330     albertel 6979:     }
                   6980:     $result .= "\n</html>";
                   6981: 
1.315     albertel 6982:     if ($args->{'js_ready'}) {
1.317     albertel 6983: 	$result = &js_ready($result);
1.315     albertel 6984:     }
1.335     albertel 6985: 
1.320     albertel 6986:     if ($args->{'html_encode'}) {
                   6987: 	$result = &html_encode($result);
                   6988:     }
1.335     albertel 6989: 
1.315     albertel 6990:     return $result;
                   6991: }
                   6992: 
1.320     albertel 6993: sub html_encode {
                   6994:     my ($result) = @_;
                   6995: 
1.322     albertel 6996:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6997:     
                   6998:     return $result;
                   6999: }
1.317     albertel 7000: sub js_ready {
                   7001:     my ($result) = @_;
                   7002: 
1.323     albertel 7003:     $result =~ s/[\n\r]/ /xmsg;
                   7004:     $result =~ s/\\/\\\\/xmsg;
                   7005:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7006:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7007:     
                   7008:     return $result;
                   7009: }
                   7010: 
1.315     albertel 7011: sub validate_page {
                   7012:     if (  exists($env{'internal.start_page'})
1.316     albertel 7013: 	  &&     $env{'internal.start_page'} > 1) {
                   7014: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7015: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7016: 				 $ENV{'request.filename'});
1.315     albertel 7017:     }
                   7018:     if (  exists($env{'internal.end_page'})
1.316     albertel 7019: 	  &&     $env{'internal.end_page'} > 1) {
                   7020: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7021: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7022: 				 $env{'request.filename'});
1.315     albertel 7023:     }
                   7024:     if (     exists($env{'internal.start_page'})
                   7025: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7026: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   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('end_page called without start_page'.
                   7032: 				 $env{'request.filename'});
1.315     albertel 7033:     }
1.306     albertel 7034: }
1.315     albertel 7035: 
1.318     albertel 7036: sub simple_error_page {
                   7037:     my ($r,$title,$msg) = @_;
                   7038:     my $page =
                   7039: 	&Apache::loncommon::start_page($title).
                   7040: 	&mt($msg).
                   7041: 	&Apache::loncommon::end_page();
                   7042:     if (ref($r)) {
                   7043: 	$r->print($page);
1.327     albertel 7044: 	return;
1.318     albertel 7045:     }
                   7046:     return $page;
                   7047: }
1.347     albertel 7048: 
                   7049: {
1.610     albertel 7050:     my @row_count;
1.347     albertel 7051:     sub start_data_table {
1.422     albertel 7052: 	my ($add_class) = @_;
                   7053: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 7054: 	unshift(@row_count,0);
1.422     albertel 7055: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 7056:     }
                   7057: 
                   7058:     sub end_data_table {
1.610     albertel 7059: 	shift(@row_count);
1.389     albertel 7060: 	return '</table>'."\n";;
1.347     albertel 7061:     }
                   7062: 
                   7063:     sub start_data_table_row {
1.422     albertel 7064: 	my ($add_class) = @_;
1.610     albertel 7065: 	$row_count[0]++;
                   7066: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7067: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 7068: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 7069:     }
1.471     banghart 7070:     
                   7071:     sub continue_data_table_row {
                   7072: 	my ($add_class) = @_;
1.610     albertel 7073: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7074: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 7075: 	return  '<tr class="'.$css_class.'">'."\n";;
                   7076:     }
1.347     albertel 7077: 
                   7078:     sub end_data_table_row {
1.389     albertel 7079: 	return '</tr>'."\n";;
1.347     albertel 7080:     }
1.367     www      7081: 
1.421     albertel 7082:     sub start_data_table_empty_row {
1.707     bisitz   7083: #	$row_count[0]++;
1.421     albertel 7084: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7085:     }
                   7086: 
                   7087:     sub end_data_table_empty_row {
                   7088: 	return '</tr>'."\n";;
                   7089:     }
                   7090: 
1.367     www      7091:     sub start_data_table_header_row {
1.389     albertel 7092: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7093:     }
                   7094: 
                   7095:     sub end_data_table_header_row {
1.389     albertel 7096: 	return '</tr>'."\n";;
1.367     www      7097:     }
1.890     droeschl 7098: 
                   7099:     sub data_table_caption {
                   7100:         my $caption = shift;
                   7101:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7102:     }
1.347     albertel 7103: }
                   7104: 
1.548     albertel 7105: =pod
                   7106: 
                   7107: =item * &inhibit_menu_check($arg)
                   7108: 
                   7109: Checks for a inhibitmenu state and generates output to preserve it
                   7110: 
                   7111: Inputs:         $arg - can be any of
                   7112:                      - undef - in which case the return value is a string 
                   7113:                                to add  into arguments list of a uri
                   7114:                      - 'input' - in which case the return value is a HTML
                   7115:                                  <form> <input> field of type hidden to
                   7116:                                  preserve the value
                   7117:                      - a url - in which case the return value is the url with
                   7118:                                the neccesary cgi args added to preserve the
                   7119:                                inhibitmenu state
                   7120:                      - a ref to a url - no return value, but the string is
                   7121:                                         updated to include the neccessary cgi
                   7122:                                         args to preserve the inhibitmenu state
                   7123: 
                   7124: =cut
                   7125: 
                   7126: sub inhibit_menu_check {
                   7127:     my ($arg) = @_;
                   7128:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7129:     if ($arg eq 'input') {
                   7130: 	if ($env{'form.inhibitmenu'}) {
                   7131: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7132: 	} else {
                   7133: 	    return
                   7134: 	}
                   7135:     }
                   7136:     if ($env{'form.inhibitmenu'}) {
                   7137: 	if (ref($arg)) {
                   7138: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7139: 	} elsif ($arg eq '') {
                   7140: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7141: 	} else {
                   7142: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7143: 	}
                   7144:     }
                   7145:     if (!ref($arg)) {
                   7146: 	return $arg;
                   7147:     }
                   7148: }
                   7149: 
1.251     albertel 7150: ###############################################
1.182     matthew  7151: 
                   7152: =pod
                   7153: 
1.549     albertel 7154: =back
                   7155: 
                   7156: =head1 User Information Routines
                   7157: 
                   7158: =over 4
                   7159: 
1.405     albertel 7160: =item * &get_users_function()
1.182     matthew  7161: 
                   7162: Used by &bodytag to determine the current users primary role.
                   7163: Returns either 'student','coordinator','admin', or 'author'.
                   7164: 
                   7165: =cut
                   7166: 
                   7167: ###############################################
                   7168: sub get_users_function {
1.815     tempelho 7169:     my $function = 'norole';
1.818     tempelho 7170:     if ($env{'request.role'}=~/^(st)/) {
                   7171:         $function='student';
                   7172:     }
1.907     raeburn  7173:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7174:         $function='coordinator';
                   7175:     }
1.258     albertel 7176:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7177:         $function='admin';
                   7178:     }
1.826     bisitz   7179:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7180:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7181:         $function='author';
                   7182:     }
                   7183:     return $function;
1.54      www      7184: }
1.99      www      7185: 
                   7186: ###############################################
                   7187: 
1.233     raeburn  7188: =pod
                   7189: 
1.821     raeburn  7190: =item * &show_course()
                   7191: 
                   7192: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7193: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7194: 
                   7195: Inputs:
                   7196: None
                   7197: 
                   7198: Outputs:
                   7199: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7200: 
                   7201: =cut
                   7202: 
                   7203: ###############################################
                   7204: sub show_course {
                   7205:     my $course = !$env{'user.adv'};
                   7206:     if (!$env{'user.adv'}) {
                   7207:         foreach my $env (keys(%env)) {
                   7208:             next if ($env !~ m/^user\.priv\./);
                   7209:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7210:                 $course = 0;
                   7211:                 last;
                   7212:             }
                   7213:         }
                   7214:     }
                   7215:     return $course;
                   7216: }
                   7217: 
                   7218: ###############################################
                   7219: 
                   7220: =pod
                   7221: 
1.542     raeburn  7222: =item * &check_user_status()
1.274     raeburn  7223: 
                   7224: Determines current status of supplied role for a
                   7225: specific user. Roles can be active, previous or future.
                   7226: 
                   7227: Inputs: 
                   7228: user's domain, user's username, course's domain,
1.375     raeburn  7229: course's number, optional section ID.
1.274     raeburn  7230: 
                   7231: Outputs:
                   7232: role status: active, previous or future. 
                   7233: 
                   7234: =cut
                   7235: 
                   7236: sub check_user_status {
1.412     raeburn  7237:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7238:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7239:     my @uroles = keys %userinfo;
                   7240:     my $srchstr;
                   7241:     my $active_chk = 'none';
1.412     raeburn  7242:     my $now = time;
1.274     raeburn  7243:     if (@uroles > 0) {
1.908     raeburn  7244:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7245:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7246:         } else {
1.412     raeburn  7247:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7248:         }
                   7249:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7250:             my $role_end = 0;
                   7251:             my $role_start = 0;
                   7252:             $active_chk = 'active';
1.412     raeburn  7253:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7254:                 $role_end = $1;
                   7255:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7256:                     $role_start = $1;
1.274     raeburn  7257:                 }
                   7258:             }
                   7259:             if ($role_start > 0) {
1.412     raeburn  7260:                 if ($now < $role_start) {
1.274     raeburn  7261:                     $active_chk = 'future';
                   7262:                 }
                   7263:             }
                   7264:             if ($role_end > 0) {
1.412     raeburn  7265:                 if ($now > $role_end) {
1.274     raeburn  7266:                     $active_chk = 'previous';
                   7267:                 }
                   7268:             }
                   7269:         }
                   7270:     }
                   7271:     return $active_chk;
                   7272: }
                   7273: 
                   7274: ###############################################
                   7275: 
                   7276: =pod
                   7277: 
1.405     albertel 7278: =item * &get_sections()
1.233     raeburn  7279: 
                   7280: Determines all the sections for a course including
                   7281: sections with students and sections containing other roles.
1.419     raeburn  7282: Incoming parameters: 
                   7283: 
                   7284: 1. domain
                   7285: 2. course number 
                   7286: 3. reference to array containing roles for which sections should 
                   7287: be gathered (optional).
                   7288: 4. reference to array containing status types for which sections 
                   7289: should be gathered (optional).
                   7290: 
                   7291: If the third argument is undefined, sections are gathered for any role. 
                   7292: If the fourth argument is undefined, sections are gathered for any status.
                   7293: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7294:  
1.374     raeburn  7295: Returns section hash (keys are section IDs, values are
                   7296: number of users in each section), subject to the
1.419     raeburn  7297: optional roles filter, optional status filter 
1.233     raeburn  7298: 
                   7299: =cut
                   7300: 
                   7301: ###############################################
                   7302: sub get_sections {
1.419     raeburn  7303:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7304:     if (!defined($cdom) || !defined($cnum)) {
                   7305:         my $cid =  $env{'request.course.id'};
                   7306: 
                   7307: 	return if (!defined($cid));
                   7308: 
                   7309:         $cdom = $env{'course.'.$cid.'.domain'};
                   7310:         $cnum = $env{'course.'.$cid.'.num'};
                   7311:     }
                   7312: 
                   7313:     my %sectioncount;
1.419     raeburn  7314:     my $now = time;
1.240     albertel 7315: 
1.366     albertel 7316:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7317: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7318: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7319: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7320:         my $start_index = &Apache::loncoursedata::CL_START();
                   7321:         my $end_index = &Apache::loncoursedata::CL_END();
                   7322:         my $status;
1.366     albertel 7323: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7324: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7325: 				                     $data->[$status_index],
                   7326:                                                      $data->[$start_index],
                   7327:                                                      $data->[$end_index]);
                   7328:             if ($stu_status eq 'Active') {
                   7329:                 $status = 'active';
                   7330:             } elsif ($end < $now) {
                   7331:                 $status = 'previous';
                   7332:             } elsif ($start > $now) {
                   7333:                 $status = 'future';
                   7334:             } 
                   7335: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7336:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7337:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7338: 		    $sectioncount{$section}++;
                   7339:                 }
1.240     albertel 7340: 	    }
                   7341: 	}
                   7342:     }
                   7343:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7344:     foreach my $user (sort(keys(%courseroles))) {
                   7345: 	if ($user !~ /^(\w{2})/) { next; }
                   7346: 	my ($role) = ($user =~ /^(\w{2})/);
                   7347: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7348: 	my ($section,$status);
1.240     albertel 7349: 	if ($role eq 'cr' &&
                   7350: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7351: 	    $section=$1;
                   7352: 	}
                   7353: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7354: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7355:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7356:         if ($end == -1 && $start == -1) {
                   7357:             next; #deleted role
                   7358:         }
                   7359:         if (!defined($possible_status)) { 
                   7360:             $sectioncount{$section}++;
                   7361:         } else {
                   7362:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7363:                 $status = 'active';
                   7364:             } elsif ($end < $now) {
                   7365:                 $status = 'future';
                   7366:             } elsif ($start > $now) {
                   7367:                 $status = 'previous';
                   7368:             }
                   7369:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7370:                 $sectioncount{$section}++;
                   7371:             }
                   7372:         }
1.233     raeburn  7373:     }
1.366     albertel 7374:     return %sectioncount;
1.233     raeburn  7375: }
                   7376: 
1.274     raeburn  7377: ###############################################
1.294     raeburn  7378: 
                   7379: =pod
1.405     albertel 7380: 
                   7381: =item * &get_course_users()
                   7382: 
1.275     raeburn  7383: Retrieves usernames:domains for users in the specified course
                   7384: with specific role(s), and access status. 
                   7385: 
                   7386: Incoming parameters:
1.277     albertel 7387: 1. course domain
                   7388: 2. course number
                   7389: 3. access status: users must have - either active, 
1.275     raeburn  7390: previous, future, or all.
1.277     albertel 7391: 4. reference to array of permissible roles
1.288     raeburn  7392: 5. reference to array of section restrictions (optional)
                   7393: 6. reference to results object (hash of hashes).
                   7394: 7. reference to optional userdata hash
1.609     raeburn  7395: 8. reference to optional statushash
1.630     raeburn  7396: 9. flag if privileged users (except those set to unhide in
                   7397:    course settings) should be excluded    
1.609     raeburn  7398: Keys of top level results hash are roles.
1.275     raeburn  7399: Keys of inner hashes are username:domain, with 
                   7400: values set to access type.
1.288     raeburn  7401: Optional userdata hash returns an array with arguments in the 
                   7402: same order as loncoursedata::get_classlist() for student data.
                   7403: 
1.609     raeburn  7404: Optional statushash returns
                   7405: 
1.288     raeburn  7406: Entries for end, start, section and status are blank because
                   7407: of the possibility of multiple values for non-student roles.
                   7408: 
1.275     raeburn  7409: =cut
1.405     albertel 7410: 
1.275     raeburn  7411: ###############################################
1.405     albertel 7412: 
1.275     raeburn  7413: sub get_course_users {
1.630     raeburn  7414:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7415:     my %idx = ();
1.419     raeburn  7416:     my %seclists;
1.288     raeburn  7417: 
                   7418:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7419:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7420:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7421:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7422:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7423:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7424:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7425:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7426: 
1.290     albertel 7427:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7428:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7429:         my $now = time;
1.277     albertel 7430:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7431:             my $match = 0;
1.412     raeburn  7432:             my $secmatch = 0;
1.419     raeburn  7433:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7434:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7435:             if ($section eq '') {
                   7436:                 $section = 'none';
                   7437:             }
1.291     albertel 7438:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7439:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7440:                     $secmatch = 1;
                   7441:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7442:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7443:                         $secmatch = 1;
                   7444:                     }
                   7445:                 } else {  
1.419     raeburn  7446: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7447: 		        $secmatch = 1;
                   7448:                     }
1.290     albertel 7449: 		}
1.412     raeburn  7450:                 if (!$secmatch) {
                   7451:                     next;
                   7452:                 }
1.419     raeburn  7453:             }
1.275     raeburn  7454:             if (defined($$types{'active'})) {
1.288     raeburn  7455:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7456:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7457:                     $match = 1;
1.275     raeburn  7458:                 }
                   7459:             }
                   7460:             if (defined($$types{'previous'})) {
1.609     raeburn  7461:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7462:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7463:                     $match = 1;
1.275     raeburn  7464:                 }
                   7465:             }
                   7466:             if (defined($$types{'future'})) {
1.609     raeburn  7467:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7468:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7469:                     $match = 1;
1.275     raeburn  7470:                 }
                   7471:             }
1.609     raeburn  7472:             if ($match) {
                   7473:                 push(@{$seclists{$student}},$section);
                   7474:                 if (ref($userdata) eq 'HASH') {
                   7475:                     $$userdata{$student} = $$classlist{$student};
                   7476:                 }
                   7477:                 if (ref($statushash) eq 'HASH') {
                   7478:                     $statushash->{$student}{'st'}{$section} = $status;
                   7479:                 }
1.288     raeburn  7480:             }
1.275     raeburn  7481:         }
                   7482:     }
1.412     raeburn  7483:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7484:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7485:         my $now = time;
1.609     raeburn  7486:         my %displaystatus = ( previous => 'Expired',
                   7487:                               active   => 'Active',
                   7488:                               future   => 'Future',
                   7489:                             );
1.630     raeburn  7490:         my %nothide;
                   7491:         if ($hidepriv) {
                   7492:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7493:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7494:                 if ($user !~ /:/) {
                   7495:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7496:                 } else {
                   7497:                     $nothide{$user} = 1;
                   7498:                 }
                   7499:             }
                   7500:         }
1.439     raeburn  7501:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7502:             my $match = 0;
1.412     raeburn  7503:             my $secmatch = 0;
1.439     raeburn  7504:             my $status;
1.412     raeburn  7505:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7506:             $user =~ s/:$//;
1.439     raeburn  7507:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7508:             if ($end == -1 || $start == -1) {
                   7509:                 next;
                   7510:             }
                   7511:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7512:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7513:                 my ($uname,$udom) = split(/:/,$user);
                   7514:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7515:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7516:                         $secmatch = 1;
                   7517:                     } elsif ($usec eq '') {
1.420     albertel 7518:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7519:                             $secmatch = 1;
                   7520:                         }
                   7521:                     } else {
                   7522:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7523:                             $secmatch = 1;
                   7524:                         }
                   7525:                     }
                   7526:                     if (!$secmatch) {
                   7527:                         next;
                   7528:                     }
1.288     raeburn  7529:                 }
1.419     raeburn  7530:                 if ($usec eq '') {
                   7531:                     $usec = 'none';
                   7532:                 }
1.275     raeburn  7533:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7534:                     if ($hidepriv) {
                   7535:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7536:                             (!$nothide{$uname.':'.$udom})) {
                   7537:                             next;
                   7538:                         }
                   7539:                     }
1.503     raeburn  7540:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7541:                         $status = 'previous';
                   7542:                     } elsif ($start > $now) {
                   7543:                         $status = 'future';
                   7544:                     } else {
                   7545:                         $status = 'active';
                   7546:                     }
1.277     albertel 7547:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7548:                         if ($status eq $type) {
1.420     albertel 7549:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7550:                                 push(@{$$users{$role}{$user}},$type);
                   7551:                             }
1.288     raeburn  7552:                             $match = 1;
                   7553:                         }
                   7554:                     }
1.419     raeburn  7555:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7556:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7557: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7558:                         }
1.420     albertel 7559:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7560:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7561:                         }
1.609     raeburn  7562:                         if (ref($statushash) eq 'HASH') {
                   7563:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7564:                         }
1.275     raeburn  7565:                     }
                   7566:                 }
                   7567:             }
                   7568:         }
1.290     albertel 7569:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7570:             if ((defined($cdom)) && (defined($cnum))) {
                   7571:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7572:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7573:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7574:                     next if ($owner eq '');
                   7575:                     my ($ownername,$ownerdom);
                   7576:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7577:                         $ownername = $1;
                   7578:                         $ownerdom = $2;
                   7579:                     } else {
                   7580:                         $ownername = $owner;
                   7581:                         $ownerdom = $cdom;
                   7582:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7583:                     }
                   7584:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7585:                     if (defined($userdata) && 
1.609     raeburn  7586: 			!exists($$userdata{$owner})) {
                   7587: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7588:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7589:                             push(@{$seclists{$owner}},'none');
                   7590:                         }
                   7591:                         if (ref($statushash) eq 'HASH') {
                   7592:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7593:                         }
1.290     albertel 7594: 		    }
1.279     raeburn  7595:                 }
                   7596:             }
                   7597:         }
1.419     raeburn  7598:         foreach my $user (keys(%seclists)) {
                   7599:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7600:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7601:         }
1.275     raeburn  7602:     }
                   7603:     return;
                   7604: }
                   7605: 
1.288     raeburn  7606: sub get_user_info {
                   7607:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7608:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7609: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7610:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7611:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7612:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7613:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7614:     return;
                   7615: }
1.275     raeburn  7616: 
1.472     raeburn  7617: ###############################################
                   7618: 
                   7619: =pod
                   7620: 
                   7621: =item * &get_user_quota()
                   7622: 
                   7623: Retrieves quota assigned for storage of portfolio files for a user  
                   7624: 
                   7625: Incoming parameters:
                   7626: 1. user's username
                   7627: 2. user's domain
                   7628: 
                   7629: Returns:
1.536     raeburn  7630: 1. Disk quota (in Mb) assigned to student.
                   7631: 2. (Optional) Type of setting: custom or default
                   7632:    (individually assigned or default for user's 
                   7633:    institutional status).
                   7634: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7635:    or student - types as defined in localenroll::inst_usertypes 
                   7636:    for user's domain, which determines default quota for user.
                   7637: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7638: 
                   7639: If a value has been stored in the user's environment, 
1.536     raeburn  7640: it will return that, otherwise it returns the maximal default
                   7641: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7642: 
                   7643: =cut
                   7644: 
                   7645: ###############################################
                   7646: 
                   7647: 
                   7648: sub get_user_quota {
                   7649:     my ($uname,$udom) = @_;
1.536     raeburn  7650:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7651:     if (!defined($udom)) {
                   7652:         $udom = $env{'user.domain'};
                   7653:     }
                   7654:     if (!defined($uname)) {
                   7655:         $uname = $env{'user.name'};
                   7656:     }
                   7657:     if (($udom eq '' || $uname eq '') ||
                   7658:         ($udom eq 'public') && ($uname eq 'public')) {
                   7659:         $quota = 0;
1.536     raeburn  7660:         $quotatype = 'default';
                   7661:         $defquota = 0; 
1.472     raeburn  7662:     } else {
1.536     raeburn  7663:         my $inststatus;
1.472     raeburn  7664:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7665:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7666:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7667:         } else {
1.536     raeburn  7668:             my %userenv = 
                   7669:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7670:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7671:             my ($tmp) = keys(%userenv);
                   7672:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7673:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7674:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7675:             } else {
                   7676:                 undef(%userenv);
                   7677:             }
                   7678:         }
1.536     raeburn  7679:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7680:         if ($quota eq '') {
1.536     raeburn  7681:             $quota = $defquota;
                   7682:             $quotatype = 'default';
                   7683:         } else {
                   7684:             $quotatype = 'custom';
1.472     raeburn  7685:         }
                   7686:     }
1.536     raeburn  7687:     if (wantarray) {
                   7688:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7689:     } else {
                   7690:         return $quota;
                   7691:     }
1.472     raeburn  7692: }
                   7693: 
                   7694: ###############################################
                   7695: 
                   7696: =pod
                   7697: 
                   7698: =item * &default_quota()
                   7699: 
1.536     raeburn  7700: Retrieves default quota assigned for storage of user portfolio files,
                   7701: given an (optional) user's institutional status.
1.472     raeburn  7702: 
                   7703: Incoming parameters:
                   7704: 1. domain
1.536     raeburn  7705: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7706:    status types (e.g., faculty, staff, student etc.)
                   7707:    which apply to the user for whom the default is being retrieved.
                   7708:    If the institutional status string in undefined, the domain
                   7709:    default quota will be returned. 
1.472     raeburn  7710: 
                   7711: Returns:
                   7712: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7713: 2. (Optional) institutional type which determined the value of the
                   7714:    default quota.
1.472     raeburn  7715: 
                   7716: If a value has been stored in the domain's configuration db,
                   7717: it will return that, otherwise it returns 20 (for backwards 
                   7718: compatibility with domains which have not set up a configuration
                   7719: db file; the original statically defined portfolio quota was 20 Mb). 
                   7720: 
1.536     raeburn  7721: If the user's status includes multiple types (e.g., staff and student),
                   7722: the largest default quota which applies to the user determines the
                   7723: default quota returned.
                   7724: 
1.780     raeburn  7725: =back
                   7726: 
1.472     raeburn  7727: =cut
                   7728: 
                   7729: ###############################################
                   7730: 
                   7731: 
                   7732: sub default_quota {
1.536     raeburn  7733:     my ($udom,$inststatus) = @_;
                   7734:     my ($defquota,$settingstatus);
                   7735:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7736:                                             ['quotas'],$udom);
                   7737:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7738:         if ($inststatus ne '') {
1.765     raeburn  7739:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7740:             foreach my $item (@statuses) {
1.711     raeburn  7741:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7742:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7743:                         if ($defquota eq '') {
                   7744:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7745:                             $settingstatus = $item;
                   7746:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7747:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7748:                             $settingstatus = $item;
                   7749:                         }
                   7750:                     }
                   7751:                 } else {
                   7752:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7753:                         if ($defquota eq '') {
                   7754:                             $defquota = $quotahash{'quotas'}{$item};
                   7755:                             $settingstatus = $item;
                   7756:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7757:                             $defquota = $quotahash{'quotas'}{$item};
                   7758:                             $settingstatus = $item;
                   7759:                         }
1.536     raeburn  7760:                     }
                   7761:                 }
                   7762:             }
                   7763:         }
                   7764:         if ($defquota eq '') {
1.711     raeburn  7765:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7766:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7767:             } else {
                   7768:                 $defquota = $quotahash{'quotas'}{'default'};
                   7769:             }
1.536     raeburn  7770:             $settingstatus = 'default';
                   7771:         }
                   7772:     } else {
                   7773:         $settingstatus = 'default';
                   7774:         $defquota = 20;
                   7775:     }
                   7776:     if (wantarray) {
                   7777:         return ($defquota,$settingstatus);
1.472     raeburn  7778:     } else {
1.536     raeburn  7779:         return $defquota;
1.472     raeburn  7780:     }
                   7781: }
                   7782: 
1.384     raeburn  7783: sub get_secgrprole_info {
                   7784:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7785:     my %sections_count = &get_sections($cdom,$cnum);
                   7786:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7787:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7788:     my @groups = sort(keys(%curr_groups));
                   7789:     my $allroles = [];
                   7790:     my $rolehash;
                   7791:     my $accesshash = {
                   7792:                      active => 'Currently has access',
                   7793:                      future => 'Will have future access',
                   7794:                      previous => 'Previously had access',
                   7795:                   };
                   7796:     if ($needroles) {
                   7797:         $rolehash = {'all' => 'all'};
1.385     albertel 7798:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7799: 	if (&Apache::lonnet::error(%user_roles)) {
                   7800: 	    undef(%user_roles);
                   7801: 	}
                   7802:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7803:             my ($role)=split(/\:/,$item,2);
                   7804:             if ($role eq 'cr') { next; }
                   7805:             if ($role =~ /^cr/) {
                   7806:                 $$rolehash{$role} = (split('/',$role))[3];
                   7807:             } else {
                   7808:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7809:             }
                   7810:         }
                   7811:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7812:             push(@{$allroles},$key);
                   7813:         }
                   7814:         push (@{$allroles},'st');
                   7815:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7816:     }
                   7817:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7818: }
                   7819: 
1.555     raeburn  7820: sub user_picker {
1.627     raeburn  7821:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7822:     my $currdom = $dom;
                   7823:     my %curr_selected = (
                   7824:                         srchin => 'dom',
1.580     raeburn  7825:                         srchby => 'lastname',
1.555     raeburn  7826:                       );
                   7827:     my $srchterm;
1.625     raeburn  7828:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7829:         if ($srch->{'srchby'} ne '') {
                   7830:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7831:         }
                   7832:         if ($srch->{'srchin'} ne '') {
                   7833:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7834:         }
                   7835:         if ($srch->{'srchtype'} ne '') {
                   7836:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7837:         }
                   7838:         if ($srch->{'srchdomain'} ne '') {
                   7839:             $currdom = $srch->{'srchdomain'};
                   7840:         }
                   7841:         $srchterm = $srch->{'srchterm'};
                   7842:     }
                   7843:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7844:                     'usr'       => 'Search criteria',
1.563     raeburn  7845:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7846:                     'uname'     => 'username',
                   7847:                     'lastname'  => 'last name',
1.555     raeburn  7848:                     'lastfirst' => 'last name, first name',
1.558     albertel 7849:                     'crs'       => 'in this course',
1.576     raeburn  7850:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7851:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7852:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7853:                     'exact'     => 'is',
                   7854:                     'contains'  => 'contains',
1.569     raeburn  7855:                     'begins'    => 'begins with',
1.571     raeburn  7856:                     'youm'      => "You must include some text to search for.",
                   7857:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7858:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7859:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7860:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7861:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7862:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7863:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7864:                                        );
1.925.2.13  raeburn  7865:     my $domform = &select_dom_form($currdom,'srchdomain',undef,1);
1.563     raeburn  7866:     my $srchinsel = ' <select name="srchin">';
1.925.2.13  raeburn  7867:      
1.555     raeburn  7868:     my @srchins = ('crs','dom','alc','instd');
                   7869: 
                   7870:     foreach my $option (@srchins) {
                   7871:         # FIXME 'alc' option unavailable until 
                   7872:         #       loncreateuser::print_user_query_page()
                   7873:         #       has been completed.
                   7874:         next if ($option eq 'alc');
1.880     raeburn  7875:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7876:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.925.2.13  raeburn  7877:         next if ($option eq 'instd');
1.563     raeburn  7878:         if ($curr_selected{'srchin'} eq $option) {
                   7879:             $srchinsel .= ' 
1.925.2.13  raeburn  7880:        <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
1.563     raeburn  7881:         } else {
                   7882:             $srchinsel .= '
1.925.2.13  raeburn  7883:     <option value="'.$option.'">'.$lt{$option}.'</option>';
1.563     raeburn  7884:         }
1.555     raeburn  7885:     }
1.563     raeburn  7886:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7887: 
                   7888:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7889:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7890:         if ($curr_selected{'srchby'} eq $option) {
                   7891:             $srchbysel .= '
                   7892:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7893:         } else {
                   7894:             $srchbysel .= '
                   7895:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7896:          }
                   7897:     }
                   7898:     $srchbysel .= "\n  </select>\n";
                   7899: 
                   7900:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7901:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7902:         if ($curr_selected{'srchtype'} eq $option) {
                   7903:             $srchtypesel .= '
                   7904:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7905:         } else {
                   7906:             $srchtypesel .= '
                   7907:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7908:         }
                   7909:     }
                   7910:     $srchtypesel .= "\n  </select>\n";
                   7911: 
1.558     albertel 7912:     my ($newuserscript,$new_user_create);
1.556     raeburn  7913: 
                   7914:     if ($forcenewuser) {
1.576     raeburn  7915:         if (ref($srch) eq 'HASH') {
                   7916:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7917:                 if ($cancreate) {
                   7918:                     $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>';
                   7919:                 } else {
1.799     bisitz   7920:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7921:                     my %usertypetext = (
                   7922:                         official   => 'institutional',
                   7923:                         unofficial => 'non-institutional',
                   7924:                     );
1.799     bisitz   7925:                     $new_user_create = '<p class="LC_warning">'
                   7926:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
1.925.2.13  raeburn  7927:                                       .'<br />'
                   7928:                                       .&mt('Enter a valid e-mail address as the username for the new user.').' '.&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7929:                                       ,'<a href="'.$helplink.'">','</a>')
1.799     bisitz   7930:                                       .'</p><br />';
1.627     raeburn  7931:                 }
1.576     raeburn  7932:             }
                   7933:         }
                   7934: 
1.556     raeburn  7935:         $newuserscript = <<"ENDSCRIPT";
                   7936: 
1.570     raeburn  7937: function setSearch(createnew,callingForm) {
1.556     raeburn  7938:     if (createnew == 1) {
1.570     raeburn  7939:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7940:             if (callingForm.srchby.options[i].value == 'uname') {
                   7941:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7942:             }
                   7943:         }
1.570     raeburn  7944:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7945:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7946: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7947:             }
                   7948:         }
1.570     raeburn  7949:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7950:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7951:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7952:             }
                   7953:         }
1.570     raeburn  7954:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7955:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7956:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7957:             }
                   7958:         }
                   7959:     }
                   7960: }
                   7961: ENDSCRIPT
1.558     albertel 7962: 
1.556     raeburn  7963:     }
                   7964: 
1.555     raeburn  7965:     my $output = <<"END_BLOCK";
1.556     raeburn  7966: <script type="text/javascript">
1.824     bisitz   7967: // <![CDATA[
1.570     raeburn  7968: function validateEntry(callingForm) {
1.558     albertel 7969: 
1.556     raeburn  7970:     var checkok = 1;
1.558     albertel 7971:     var srchin;
1.570     raeburn  7972:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7973: 	if ( callingForm.srchin[i].checked ) {
                   7974: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7975: 	}
                   7976:     }
                   7977: 
1.570     raeburn  7978:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7979:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7980:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7981:     var srchterm =  callingForm.srchterm.value;
                   7982:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7983:     var msg = "";
                   7984: 
                   7985:     if (srchterm == "") {
                   7986:         checkok = 0;
1.571     raeburn  7987:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7988:     }
                   7989: 
1.569     raeburn  7990:     if (srchtype== 'begins') {
                   7991:         if (srchterm.length < 2) {
                   7992:             checkok = 0;
1.571     raeburn  7993:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7994:         }
                   7995:     }
                   7996: 
1.556     raeburn  7997:     if (srchtype== 'contains') {
                   7998:         if (srchterm.length < 3) {
                   7999:             checkok = 0;
1.571     raeburn  8000:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8001:         }
                   8002:     }
                   8003:     if (srchin == 'instd') {
                   8004:         if (srchdomain == '') {
                   8005:             checkok = 0;
1.571     raeburn  8006:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8007:         }
                   8008:     }
                   8009:     if (srchin == 'dom') {
                   8010:         if (srchdomain == '') {
                   8011:             checkok = 0;
1.571     raeburn  8012:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8013:         }
                   8014:     }
                   8015:     if (srchby == 'lastfirst') {
                   8016:         if (srchterm.indexOf(",") == -1) {
                   8017:             checkok = 0;
1.571     raeburn  8018:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8019:         }
                   8020:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8021:             checkok = 0;
1.571     raeburn  8022:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8023:         }
                   8024:     }
                   8025:     if (checkok == 0) {
1.571     raeburn  8026:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8027:         return;
                   8028:     }
                   8029:     if (checkok == 1) {
1.570     raeburn  8030:         callingForm.submit();
1.556     raeburn  8031:     }
                   8032: }
                   8033: 
                   8034: $newuserscript
                   8035: 
1.824     bisitz   8036: // ]]>
1.556     raeburn  8037: </script>
1.558     albertel 8038: 
                   8039: $new_user_create
                   8040: 
1.555     raeburn  8041: END_BLOCK
1.558     albertel 8042: 
1.876     raeburn  8043:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8044:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8045:                $domform.
                   8046:                &Apache::lonhtmlcommon::row_closure().
                   8047:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8048:                $srchbysel.
                   8049:                $srchtypesel. 
                   8050:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8051:                $srchinsel.
                   8052:                &Apache::lonhtmlcommon::row_closure(1). 
                   8053:                &Apache::lonhtmlcommon::end_pick_box().
                   8054:                '<br />';
1.555     raeburn  8055:     return $output;
                   8056: }
                   8057: 
1.612     raeburn  8058: sub user_rule_check {
1.615     raeburn  8059:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8060:     my $response;
                   8061:     if (ref($usershash) eq 'HASH') {
                   8062:         foreach my $user (keys(%{$usershash})) {
                   8063:             my ($uname,$udom) = split(/:/,$user);
                   8064:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8065:             my ($id,$newuser);
1.612     raeburn  8066:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8067:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8068:                 $id = $usershash->{$user}->{'id'};
                   8069:             }
                   8070:             my $inst_response;
                   8071:             if (ref($checks) eq 'HASH') {
                   8072:                 if (defined($checks->{'username'})) {
1.615     raeburn  8073:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8074:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8075:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8076:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8077:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8078:                 }
1.615     raeburn  8079:             } else {
                   8080:                 ($inst_response,%{$inst_results->{$user}}) =
                   8081:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8082:                 return;
1.612     raeburn  8083:             }
1.615     raeburn  8084:             if (!$got_rules->{$udom}) {
1.612     raeburn  8085:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8086:                                                   ['usercreation'],$udom);
                   8087:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8088:                     foreach my $item ('username','id') {
1.612     raeburn  8089:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8090:                             $$curr_rules{$udom}{$item} = 
                   8091:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8092:                         }
                   8093:                     }
                   8094:                 }
1.615     raeburn  8095:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8096:             }
1.612     raeburn  8097:             foreach my $item (keys(%{$checks})) {
                   8098:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8099:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8100:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8101:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8102:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8103:                                 if ($rule_check{$rule}) {
                   8104:                                     $$rulematch{$user}{$item} = $rule;
                   8105:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8106:                                         if (ref($inst_results) eq 'HASH') {
                   8107:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8108:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8109:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8110:                                                 }
1.612     raeburn  8111:                                             }
                   8112:                                         }
1.615     raeburn  8113:                                     }
                   8114:                                     last;
1.585     raeburn  8115:                                 }
                   8116:                             }
                   8117:                         }
                   8118:                     }
                   8119:                 }
                   8120:             }
                   8121:         }
                   8122:     }
1.612     raeburn  8123:     return;
                   8124: }
                   8125: 
                   8126: sub user_rule_formats {
                   8127:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8128:     my %text = ( 
                   8129:                  'username' => 'Usernames',
                   8130:                  'id'       => 'IDs',
                   8131:                );
                   8132:     my $output;
                   8133:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8134:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8135:         if (@{$ruleorder} > 0) {
                   8136:             $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>';
                   8137:             foreach my $rule (@{$ruleorder}) {
                   8138:                 if (ref($curr_rules) eq 'ARRAY') {
                   8139:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8140:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8141:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8142:                                         $rules->{$rule}{'desc'}.'</li>';
                   8143:                         }
                   8144:                     }
                   8145:                 }
                   8146:             }
                   8147:             $output .= '</ul>';
                   8148:         }
                   8149:     }
                   8150:     return $output;
                   8151: }
                   8152: 
                   8153: sub instrule_disallow_msg {
1.615     raeburn  8154:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8155:     my $response;
                   8156:     my %text = (
                   8157:                   item   => 'username',
                   8158:                   items  => 'usernames',
                   8159:                   match  => 'matches',
                   8160:                   do     => 'does',
                   8161:                   action => 'a username',
                   8162:                   one    => 'one',
                   8163:                );
                   8164:     if ($count > 1) {
                   8165:         $text{'item'} = 'usernames';
                   8166:         $text{'match'} ='match';
                   8167:         $text{'do'} = 'do';
                   8168:         $text{'action'} = 'usernames',
                   8169:         $text{'one'} = 'ones';
                   8170:     }
                   8171:     if ($checkitem eq 'id') {
                   8172:         $text{'items'} = 'IDs';
                   8173:         $text{'item'} = 'ID';
                   8174:         $text{'action'} = 'an ID';
1.615     raeburn  8175:         if ($count > 1) {
                   8176:             $text{'item'} = 'IDs';
                   8177:             $text{'action'} = 'IDs';
                   8178:         }
1.612     raeburn  8179:     }
1.674     bisitz   8180:     $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  8181:     if ($mode eq 'upload') {
                   8182:         if ($checkitem eq 'username') {
                   8183:             $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'}.");
                   8184:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8185:             $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  8186:         }
1.669     raeburn  8187:     } elsif ($mode eq 'selfcreate') {
                   8188:         if ($checkitem eq 'id') {
                   8189:             $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.");
                   8190:         }
1.615     raeburn  8191:     } else {
                   8192:         if ($checkitem eq 'username') {
                   8193:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8194:         } elsif ($checkitem eq 'id') {
                   8195:             $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.");
                   8196:         }
1.612     raeburn  8197:     }
                   8198:     return $response;
1.585     raeburn  8199: }
                   8200: 
1.624     raeburn  8201: sub personal_data_fieldtitles {
                   8202:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8203:                         id => 'Student/Employee ID',
                   8204:                         permanentemail => 'E-mail address',
                   8205:                         lastname => 'Last Name',
                   8206:                         firstname => 'First Name',
                   8207:                         middlename => 'Middle Name',
                   8208:                         generation => 'Generation',
                   8209:                         gen => 'Generation',
1.765     raeburn  8210:                         inststatus => 'Affiliation',
1.624     raeburn  8211:                    );
                   8212:     return %fieldtitles;
                   8213: }
                   8214: 
1.642     raeburn  8215: sub sorted_inst_types {
                   8216:     my ($dom) = @_;
                   8217:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8218:     my $othertitle = &mt('All users');
                   8219:     if ($env{'request.course.id'}) {
1.668     raeburn  8220:         $othertitle  = &mt('Any users');
1.642     raeburn  8221:     }
                   8222:     my @types;
                   8223:     if (ref($order) eq 'ARRAY') {
                   8224:         @types = @{$order};
                   8225:     }
                   8226:     if (@types == 0) {
                   8227:         if (ref($usertypes) eq 'HASH') {
                   8228:             @types = sort(keys(%{$usertypes}));
                   8229:         }
                   8230:     }
                   8231:     if (keys(%{$usertypes}) > 0) {
                   8232:         $othertitle = &mt('Other users');
                   8233:     }
                   8234:     return ($othertitle,$usertypes,\@types);
                   8235: }
                   8236: 
1.645     raeburn  8237: sub get_institutional_codes {
                   8238:     my ($settings,$allcourses,$LC_code) = @_;
                   8239: # Get complete list of course sections to update
                   8240:     my @currsections = ();
                   8241:     my @currxlists = ();
                   8242:     my $coursecode = $$settings{'internal.coursecode'};
                   8243: 
                   8244:     if ($$settings{'internal.sectionnums'} ne '') {
                   8245:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8246:     }
                   8247: 
                   8248:     if ($$settings{'internal.crosslistings'} ne '') {
                   8249:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8250:     }
                   8251: 
                   8252:     if (@currxlists > 0) {
                   8253:         foreach (@currxlists) {
                   8254:             if (m/^([^:]+):(\w*)$/) {
                   8255:                 unless (grep/^$1$/,@{$allcourses}) {
                   8256:                     push @{$allcourses},$1;
                   8257:                     $$LC_code{$1} = $2;
                   8258:                 }
                   8259:             }
                   8260:         }
                   8261:     }
                   8262:  
                   8263:     if (@currsections > 0) {
                   8264:         foreach (@currsections) {
                   8265:             if (m/^(\w+):(\w*)$/) {
                   8266:                 my $sec = $coursecode.$1;
                   8267:                 my $lc_sec = $2;
                   8268:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8269:                     push @{$allcourses},$sec;
                   8270:                     $$LC_code{$sec} = $lc_sec;
                   8271:                 }
                   8272:             }
                   8273:         }
                   8274:     }
                   8275:     return;
                   8276: }
                   8277: 
1.112     bowersj2 8278: =pod
                   8279: 
1.780     raeburn  8280: =head1 Slot Helpers
                   8281: 
                   8282: =over 4
                   8283: 
                   8284: =item * sorted_slots()
                   8285: 
                   8286: Sorts an array of slot names in order of slot start time (earliest first). 
                   8287: 
                   8288: Inputs:
                   8289: 
                   8290: =over 4
                   8291: 
                   8292: slotsarr  - Reference to array of unsorted slot names.
                   8293: 
                   8294: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8295: 
1.549     albertel 8296: =back
                   8297: 
1.780     raeburn  8298: Returns:
                   8299: 
                   8300: =over 4
                   8301: 
                   8302: sorted   - An array of slot names sorted by the start time of the slot.
                   8303: 
                   8304: =back
                   8305: 
                   8306: =back
                   8307: 
                   8308: =cut
                   8309: 
                   8310: 
                   8311: sub sorted_slots {
                   8312:     my ($slotsarr,$slots) = @_;
                   8313:     my @sorted;
                   8314:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8315:         @sorted =
                   8316:             sort {
                   8317:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8318:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8319:                      }
                   8320:                      if (ref($slots->{$a})) { return -1;}
                   8321:                      if (ref($slots->{$b})) { return 1;}
                   8322:                      return 0;
                   8323:                  } @{$slotsarr};
                   8324:     }
                   8325:     return @sorted;
                   8326: }
                   8327: 
                   8328: 
                   8329: =pod
                   8330: 
1.549     albertel 8331: =head1 HTTP Helpers
                   8332: 
                   8333: =over 4
                   8334: 
1.648     raeburn  8335: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8336: 
1.258     albertel 8337: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8338: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8339: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8340: 
                   8341: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8342: $possible_names is an ref to an array of form element names.  As an example:
                   8343: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8344: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8345: 
                   8346: =cut
1.1       albertel 8347: 
1.6       albertel 8348: sub get_unprocessed_cgi {
1.25      albertel 8349:   my ($query,$possible_names)= @_;
1.26      matthew  8350:   # $Apache::lonxml::debug=1;
1.356     albertel 8351:   foreach my $pair (split(/&/,$query)) {
                   8352:     my ($name, $value) = split(/=/,$pair);
1.369     www      8353:     $name = &unescape($name);
1.25      albertel 8354:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8355:       $value =~ tr/+/ /;
                   8356:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8357:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8358:     }
1.16      harris41 8359:   }
1.6       albertel 8360: }
                   8361: 
1.112     bowersj2 8362: =pod
                   8363: 
1.648     raeburn  8364: =item * &cacheheader() 
1.112     bowersj2 8365: 
                   8366: returns cache-controlling header code
                   8367: 
                   8368: =cut
                   8369: 
1.7       albertel 8370: sub cacheheader {
1.258     albertel 8371:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8372:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8373:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8374:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8375:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8376:     return $output;
1.7       albertel 8377: }
                   8378: 
1.112     bowersj2 8379: =pod
                   8380: 
1.648     raeburn  8381: =item * &no_cache($r) 
1.112     bowersj2 8382: 
                   8383: specifies header code to not have cache
                   8384: 
                   8385: =cut
                   8386: 
1.9       albertel 8387: sub no_cache {
1.216     albertel 8388:     my ($r) = @_;
                   8389:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8390: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8391:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8392:     $r->no_cache(1);
                   8393:     $r->header_out("Expires" => $date);
                   8394:     $r->header_out("Pragma" => "no-cache");
1.123     www      8395: }
                   8396: 
                   8397: sub content_type {
1.181     albertel 8398:     my ($r,$type,$charset) = @_;
1.299     foxr     8399:     if ($r) {
                   8400: 	#  Note that printout.pl calls this with undef for $r.
                   8401: 	&no_cache($r);
                   8402:     }
1.258     albertel 8403:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8404:     unless ($charset) {
                   8405: 	$charset=&Apache::lonlocal::current_encoding;
                   8406:     }
                   8407:     if ($charset) { $type.='; charset='.$charset; }
                   8408:     if ($r) {
                   8409: 	$r->content_type($type);
                   8410:     } else {
                   8411: 	print("Content-type: $type\n\n");
                   8412:     }
1.9       albertel 8413: }
1.25      albertel 8414: 
1.112     bowersj2 8415: =pod
                   8416: 
1.648     raeburn  8417: =item * &add_to_env($name,$value) 
1.112     bowersj2 8418: 
1.258     albertel 8419: adds $name to the %env hash with value
1.112     bowersj2 8420: $value, if $name already exists, the entry is converted to an array
                   8421: reference and $value is added to the array.
                   8422: 
                   8423: =cut
                   8424: 
1.25      albertel 8425: sub add_to_env {
                   8426:   my ($name,$value)=@_;
1.258     albertel 8427:   if (defined($env{$name})) {
                   8428:     if (ref($env{$name})) {
1.25      albertel 8429:       #already have multiple values
1.258     albertel 8430:       push(@{ $env{$name} },$value);
1.25      albertel 8431:     } else {
                   8432:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8433:       my $first=$env{$name};
                   8434:       undef($env{$name});
                   8435:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8436:     }
                   8437:   } else {
1.258     albertel 8438:     $env{$name}=$value;
1.25      albertel 8439:   }
1.31      albertel 8440: }
1.149     albertel 8441: 
                   8442: =pod
                   8443: 
1.648     raeburn  8444: =item * &get_env_multiple($name) 
1.149     albertel 8445: 
1.258     albertel 8446: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8447: values may be defined and end up as an array ref.
                   8448: 
                   8449: returns an array of values
                   8450: 
                   8451: =cut
                   8452: 
                   8453: sub get_env_multiple {
                   8454:     my ($name) = @_;
                   8455:     my @values;
1.258     albertel 8456:     if (defined($env{$name})) {
1.149     albertel 8457:         # exists is it an array
1.258     albertel 8458:         if (ref($env{$name})) {
                   8459:             @values=@{ $env{$name} };
1.149     albertel 8460:         } else {
1.258     albertel 8461:             $values[0]=$env{$name};
1.149     albertel 8462:         }
                   8463:     }
                   8464:     return(@values);
                   8465: }
                   8466: 
1.660     raeburn  8467: sub ask_for_embedded_content {
                   8468:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8469:     my $upload_output = '
                   8470:    <form name="upload_embedded" action="'.$actionurl.'"
                   8471:                   method="post" enctype="multipart/form-data">';
                   8472:     $upload_output .= $state;
1.661     raeburn  8473:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8474: 
                   8475:     my $num = 0;
                   8476:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8477:         $upload_output .= &start_data_table_row().
                   8478:             '<td>'.$embed_file.'</td><td>';
                   8479:         if ($args->{'ignore_remote_references'}
                   8480:             && $embed_file =~ m{^\w+://}) {
                   8481:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8482:         } elsif ($args->{'error_on_invalid_names'}
                   8483:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8484: 
                   8485:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8486: 
                   8487:         } else {
                   8488:             $upload_output .='
1.661     raeburn  8489:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8490:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8491:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8492:             $upload_output .=
                   8493:                 "\n\t\t".
                   8494:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8495:                 $attrib.'" />';
                   8496:             if (exists($$codebase{$embed_file})) {
                   8497:                 $upload_output .=
                   8498:                     "\n\t\t".
                   8499:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8500:                     &escape($$codebase{$embed_file}).'" />';
                   8501:             }
                   8502:         }
                   8503:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8504:         $num++;
                   8505:     }
                   8506:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8507:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8508:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8509:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8510:    </form>';
                   8511:     return $upload_output;
                   8512: }
                   8513: 
1.661     raeburn  8514: sub upload_embedded {
                   8515:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8516:         $current_disk_usage) = @_;
                   8517:     my $output;
                   8518:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8519:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8520:         my $orig_uploaded_filename =
                   8521:             $env{'form.embedded_item_'.$i.'.filename'};
                   8522: 
                   8523:         $env{'form.embedded_orig_'.$i} =
                   8524:             &unescape($env{'form.embedded_orig_'.$i});
                   8525:         my ($path,$fname) =
                   8526:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8527:         # no path, whole string is fname
                   8528:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8529: 
                   8530:         $path = $env{'form.currentpath'}.$path;
                   8531:         $fname = &Apache::lonnet::clean_filename($fname);
                   8532:         # See if there is anything left
                   8533:         next if ($fname eq '');
                   8534: 
                   8535:         # Check if file already exists as a file or directory.
                   8536:         my ($state,$msg);
                   8537:         if ($context eq 'portfolio') {
                   8538:             my $port_path = $dirpath;
                   8539:             if ($group ne '') {
                   8540:                 $port_path = "groups/$group/$port_path";
                   8541:             }
                   8542:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8543:                                               $dir_root,$port_path,$disk_quota,
                   8544:                                               $current_disk_usage,$uname,$udom);
                   8545:             if ($state eq 'will_exceed_quota'
                   8546:                 || $state eq 'file_locked'
                   8547:                 || $state eq 'file_exists' ) {
                   8548:                 $output .= $msg;
                   8549:                 next;
                   8550:             }
                   8551:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8552:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8553:             if ($state eq 'exists') {
                   8554:                 $output .= $msg;
                   8555:                 next;
                   8556:             }
                   8557:         }
                   8558:         # Check if extension is valid
                   8559:         if (($fname =~ /\.(\w+)$/) &&
                   8560:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8561:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8562:             next;
                   8563:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8564:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8565:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8566:             next;
                   8567:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8568:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8569:             next;
                   8570:         }
                   8571: 
                   8572:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8573:         if ($context eq 'portfolio') {
                   8574:             my $result=
                   8575:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8576:                                                 $dirpath.$path);
                   8577:             if ($result !~ m|^/uploaded/|) {
                   8578:                 $output .= '<span class="LC_error">'
                   8579:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8580:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8581:                       .'</span><br />';
                   8582:                 next;
                   8583:             } else {
                   8584:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8585:                            $path.$fname.'</span>').'</p>';     
                   8586:             }
                   8587:         } else {
                   8588: # Save the file
                   8589:             my $target = $env{'form.embedded_item_'.$i};
                   8590:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8591:             my $dest = $fullpath.$fname;
                   8592:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8593:             my @parts=split(/\//,$fullpath);
                   8594:             my $count;
                   8595:             my $filepath = $dir_root;
                   8596:             for ($count=4;$count<=$#parts;$count++) {
                   8597:                 $filepath .= "/$parts[$count]";
                   8598:                 if ((-e $filepath)!=1) {
                   8599:                     mkdir($filepath,0770);
                   8600:                 }
                   8601:             }
                   8602:             my $fh;
                   8603:             if (!open($fh,'>'.$dest)) {
                   8604:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8605:                 $output .= '<span class="LC_error">'.
                   8606:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8607:                            '</span><br />';
                   8608:             } else {
                   8609:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8610:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8611:                     $output .= '<span class="LC_error">'.
                   8612:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8613:                               '</span><br />';
                   8614:                 } else {
                   8615:                     if ($context eq 'testbank') {
                   8616:                         $output .= &mt('Embedded file uploaded successfully:').
                   8617:                                    '&nbsp;<a href="'.$url.'">'.
                   8618:                                    $orig_uploaded_filename.'</a><br />';
                   8619:                     } else {
1.705     tempelho 8620:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8621:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8622:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8623:                     }
                   8624:                 }
                   8625:                 close($fh);
                   8626:             }
                   8627:         }
                   8628:     }
                   8629:     return $output;
                   8630: }
                   8631: 
                   8632: sub check_for_existing {
                   8633:     my ($path,$fname,$element) = @_;
                   8634:     my ($state,$msg);
                   8635:     if (-d $path.'/'.$fname) {
                   8636:         $state = 'exists';
                   8637:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8638:     } elsif (-e $path.'/'.$fname) {
                   8639:         $state = 'exists';
                   8640:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8641:     }
                   8642:     if ($state eq 'exists') {
                   8643:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8644:     }
                   8645:     return ($state,$msg);
                   8646: }
                   8647: 
                   8648: sub check_for_upload {
                   8649:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8650:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8651:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8652:     my $getpropath = 1;
                   8653:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8654:                                             $getpropath);
                   8655:     my $found_file = 0;
                   8656:     my $locked_file = 0;
                   8657:     foreach my $line (@dir_list) {
                   8658:         my ($file_name)=split(/\&/,$line,2);
                   8659:         if ($file_name eq $fname){
                   8660:             $file_name = $path.$file_name;
                   8661:             if ($group ne '') {
                   8662:                 $file_name = $group.$file_name;
                   8663:             }
                   8664:             $found_file = 1;
                   8665:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8666:                 $locked_file = 1;
                   8667:             }
                   8668:         }
                   8669:     }
                   8670:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8671:         my $msg = '<span class="LC_error">'.
                   8672:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8673:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8674:         return ('will_exceed_quota',$msg);
                   8675:     } elsif ($found_file) {
                   8676:         if ($locked_file) {
                   8677:             my $msg = '<span class="LC_error">';
                   8678:             $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>');
                   8679:             $msg .= '</span><br />';
                   8680:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8681:             return ('file_locked',$msg);
                   8682:         } else {
                   8683:             my $msg = '<span class="LC_error">';
                   8684:             $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'});
                   8685:             $msg .= '</span>';
                   8686:             $msg .= '<br />';
                   8687:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8688:             return ('file_exists',$msg);
                   8689:         }
                   8690:     }
                   8691: }
                   8692: 
1.31      albertel 8693: 
1.41      ng       8694: =pod
1.45      matthew  8695: 
1.464     albertel 8696: =back
1.41      ng       8697: 
1.112     bowersj2 8698: =head1 CSV Upload/Handling functions
1.38      albertel 8699: 
1.41      ng       8700: =over 4
                   8701: 
1.648     raeburn  8702: =item * &upfile_store($r)
1.41      ng       8703: 
                   8704: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8705: needs $env{'form.upfile'}
1.41      ng       8706: returns $datatoken to be put into hidden field
                   8707: 
                   8708: =cut
1.31      albertel 8709: 
                   8710: sub upfile_store {
                   8711:     my $r=shift;
1.258     albertel 8712:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8713:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8714:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8715:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8716: 
1.258     albertel 8717:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8718: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8719:     {
1.158     raeburn  8720:         my $datafile = $r->dir_config('lonDaemons').
                   8721:                            '/tmp/'.$datatoken.'.tmp';
                   8722:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8723:             print $fh $env{'form.upfile'};
1.158     raeburn  8724:             close($fh);
                   8725:         }
1.31      albertel 8726:     }
                   8727:     return $datatoken;
                   8728: }
                   8729: 
1.56      matthew  8730: =pod
                   8731: 
1.648     raeburn  8732: =item * &load_tmp_file($r)
1.41      ng       8733: 
                   8734: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8735: needs $env{'form.datatoken'},
                   8736: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8737: 
                   8738: =cut
1.31      albertel 8739: 
                   8740: sub load_tmp_file {
                   8741:     my $r=shift;
                   8742:     my @studentdata=();
                   8743:     {
1.158     raeburn  8744:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8745:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8746:         if ( open(my $fh,"<$studentfile") ) {
                   8747:             @studentdata=<$fh>;
                   8748:             close($fh);
                   8749:         }
1.31      albertel 8750:     }
1.258     albertel 8751:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8752: }
                   8753: 
1.56      matthew  8754: =pod
                   8755: 
1.648     raeburn  8756: =item * &upfile_record_sep()
1.41      ng       8757: 
                   8758: Separate uploaded file into records
                   8759: returns array of records,
1.258     albertel 8760: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8761: 
                   8762: =cut
1.31      albertel 8763: 
                   8764: sub upfile_record_sep {
1.258     albertel 8765:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8766:     } else {
1.248     albertel 8767: 	my @records;
1.258     albertel 8768: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8769: 	    if ($line=~/^\s*$/) { next; }
                   8770: 	    push(@records,$line);
                   8771: 	}
                   8772: 	return @records;
1.31      albertel 8773:     }
                   8774: }
                   8775: 
1.56      matthew  8776: =pod
                   8777: 
1.648     raeburn  8778: =item * &record_sep($record)
1.41      ng       8779: 
1.258     albertel 8780: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8781: 
                   8782: =cut
                   8783: 
1.263     www      8784: sub takeleft {
                   8785:     my $index=shift;
                   8786:     return substr('0000'.$index,-4,4);
                   8787: }
                   8788: 
1.31      albertel 8789: sub record_sep {
                   8790:     my $record=shift;
                   8791:     my %components=();
1.258     albertel 8792:     if ($env{'form.upfiletype'} eq 'xml') {
                   8793:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8794:         my $i=0;
1.356     albertel 8795:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8796:             $field=~s/^(\"|\')//;
                   8797:             $field=~s/(\"|\')$//;
1.263     www      8798:             $components{&takeleft($i)}=$field;
1.31      albertel 8799:             $i++;
                   8800:         }
1.258     albertel 8801:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8802:         my $i=0;
1.356     albertel 8803:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8804:             $field=~s/^(\"|\')//;
                   8805:             $field=~s/(\"|\')$//;
1.263     www      8806:             $components{&takeleft($i)}=$field;
1.31      albertel 8807:             $i++;
                   8808:         }
                   8809:     } else {
1.561     www      8810:         my $separator=',';
1.480     banghart 8811:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8812:             $separator=';';
1.480     banghart 8813:         }
1.31      albertel 8814:         my $i=0;
1.561     www      8815: # the character we are looking for to indicate the end of a quote or a record 
                   8816:         my $looking_for=$separator;
                   8817: # do not add the characters to the fields
                   8818:         my $ignore=0;
                   8819: # we just encountered a separator (or the beginning of the record)
                   8820:         my $just_found_separator=1;
                   8821: # store the field we are working on here
                   8822:         my $field='';
                   8823: # work our way through all characters in record
                   8824:         foreach my $character ($record=~/(.)/g) {
                   8825:             if ($character eq $looking_for) {
                   8826:                if ($character ne $separator) {
                   8827: # Found the end of a quote, again looking for separator
                   8828:                   $looking_for=$separator;
                   8829:                   $ignore=1;
                   8830:                } else {
                   8831: # Found a separator, store away what we got
                   8832:                   $components{&takeleft($i)}=$field;
                   8833: 	          $i++;
                   8834:                   $just_found_separator=1;
                   8835:                   $ignore=0;
                   8836:                   $field='';
                   8837:                }
                   8838:                next;
                   8839:             }
                   8840: # single or double quotation marks after a separator indicate beginning of a quote
                   8841: # we are now looking for the end of the quote and need to ignore separators
                   8842:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8843:                $looking_for=$character;
                   8844:                next;
                   8845:             }
                   8846: # ignore would be true after we reached the end of a quote
                   8847:             if ($ignore) { next; }
                   8848:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8849:             $field.=$character;
                   8850:             $just_found_separator=0; 
1.31      albertel 8851:         }
1.561     www      8852: # catch the very last entry, since we never encountered the separator
                   8853:         $components{&takeleft($i)}=$field;
1.31      albertel 8854:     }
                   8855:     return %components;
                   8856: }
                   8857: 
1.144     matthew  8858: ######################################################
                   8859: ######################################################
                   8860: 
1.56      matthew  8861: =pod
                   8862: 
1.648     raeburn  8863: =item * &upfile_select_html()
1.41      ng       8864: 
1.144     matthew  8865: Return HTML code to select a file from the users machine and specify 
                   8866: the file type.
1.41      ng       8867: 
                   8868: =cut
                   8869: 
1.144     matthew  8870: ######################################################
                   8871: ######################################################
1.31      albertel 8872: sub upfile_select_html {
1.144     matthew  8873:     my %Types = (
                   8874:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8875:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8876:                  space => &mt('Space separated'),
                   8877:                  tab   => &mt('Tabulator separated'),
                   8878: #                 xml   => &mt('HTML/XML'),
                   8879:                  );
                   8880:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8881:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8882:     foreach my $type (sort(keys(%Types))) {
                   8883:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8884:     }
                   8885:     $Str .= "</select>\n";
                   8886:     return $Str;
1.31      albertel 8887: }
                   8888: 
1.301     albertel 8889: sub get_samples {
                   8890:     my ($records,$toget) = @_;
                   8891:     my @samples=({});
                   8892:     my $got=0;
                   8893:     foreach my $rec (@$records) {
                   8894: 	my %temp = &record_sep($rec);
                   8895: 	if (! grep(/\S/, values(%temp))) { next; }
                   8896: 	if (%temp) {
                   8897: 	    $samples[$got]=\%temp;
                   8898: 	    $got++;
                   8899: 	    if ($got == $toget) { last; }
                   8900: 	}
                   8901:     }
                   8902:     return \@samples;
                   8903: }
                   8904: 
1.144     matthew  8905: ######################################################
                   8906: ######################################################
                   8907: 
1.56      matthew  8908: =pod
                   8909: 
1.648     raeburn  8910: =item * &csv_print_samples($r,$records)
1.41      ng       8911: 
                   8912: Prints a table of sample values from each column uploaded $r is an
                   8913: Apache Request ref, $records is an arrayref from
                   8914: &Apache::loncommon::upfile_record_sep
                   8915: 
                   8916: =cut
                   8917: 
1.144     matthew  8918: ######################################################
                   8919: ######################################################
1.31      albertel 8920: sub csv_print_samples {
                   8921:     my ($r,$records) = @_;
1.662     bisitz   8922:     my $samples = &get_samples($records,5);
1.301     albertel 8923: 
1.594     raeburn  8924:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8925:               &start_data_table_header_row());
1.356     albertel 8926:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8927:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8928:     $r->print(&end_data_table_header_row());
1.301     albertel 8929:     foreach my $hash (@$samples) {
1.594     raeburn  8930: 	$r->print(&start_data_table_row());
1.356     albertel 8931: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8932: 	    $r->print('<td>');
1.356     albertel 8933: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8934: 	    $r->print('</td>');
                   8935: 	}
1.594     raeburn  8936: 	$r->print(&end_data_table_row());
1.31      albertel 8937:     }
1.594     raeburn  8938:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8939: }
                   8940: 
1.144     matthew  8941: ######################################################
                   8942: ######################################################
                   8943: 
1.56      matthew  8944: =pod
                   8945: 
1.648     raeburn  8946: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8947: 
                   8948: Prints a table to create associations between values and table columns.
1.144     matthew  8949: 
1.41      ng       8950: $r is an Apache Request ref,
                   8951: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8952: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8953: 
                   8954: =cut
                   8955: 
1.144     matthew  8956: ######################################################
                   8957: ######################################################
1.31      albertel 8958: sub csv_print_select_table {
                   8959:     my ($r,$records,$d) = @_;
1.301     albertel 8960:     my $i=0;
                   8961:     my $samples = &get_samples($records,1);
1.144     matthew  8962:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8963: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8964:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8965:               '<th>'.&mt('Column').'</th>'.
                   8966:               &end_data_table_header_row()."\n");
1.356     albertel 8967:     foreach my $array_ref (@$d) {
                   8968: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8969: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8970: 
1.875     bisitz   8971: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8972: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8973: 	$r->print('<option value="none"></option>');
1.356     albertel 8974: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8975: 	    $r->print('<option value="'.$sample.'"'.
                   8976:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8977:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8978: 	}
1.594     raeburn  8979: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8980: 	$i++;
                   8981:     }
1.594     raeburn  8982:     $r->print(&end_data_table());
1.31      albertel 8983:     $i--;
                   8984:     return $i;
                   8985: }
1.56      matthew  8986: 
1.144     matthew  8987: ######################################################
                   8988: ######################################################
                   8989: 
1.56      matthew  8990: =pod
1.31      albertel 8991: 
1.648     raeburn  8992: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8993: 
                   8994: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8995: 
                   8996: $r is an Apache Request ref,
                   8997: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8998: $d is an array of 2 element arrays (internal name, displayed name)
                   8999: 
                   9000: =cut
                   9001: 
1.144     matthew  9002: ######################################################
                   9003: ######################################################
1.31      albertel 9004: sub csv_samples_select_table {
                   9005:     my ($r,$records,$d) = @_;
                   9006:     my $i=0;
1.144     matthew  9007:     #
1.662     bisitz   9008:     my $max_samples = 5;
                   9009:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  9010:     $r->print(&start_data_table().
                   9011:               &start_data_table_header_row().'<th>'.
                   9012:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   9013:               &end_data_table_header_row());
1.301     albertel 9014: 
                   9015:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  9016: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  9017: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 9018: 	foreach my $option (@$d) {
                   9019: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  9020: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 9021:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  9022:                       $display.'</option>');
1.31      albertel 9023: 	}
                   9024: 	$r->print('</select></td><td>');
1.662     bisitz   9025: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 9026: 	    if (defined($samples->[$line]{$key})) { 
                   9027: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   9028: 	    }
                   9029: 	}
1.594     raeburn  9030: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 9031: 	$i++;
                   9032:     }
1.594     raeburn  9033:     $r->print(&end_data_table());
1.31      albertel 9034:     $i--;
                   9035:     return($i);
1.115     matthew  9036: }
                   9037: 
1.144     matthew  9038: ######################################################
                   9039: ######################################################
                   9040: 
1.115     matthew  9041: =pod
                   9042: 
1.648     raeburn  9043: =item * &clean_excel_name($name)
1.115     matthew  9044: 
                   9045: Returns a replacement for $name which does not contain any illegal characters.
                   9046: 
                   9047: =cut
                   9048: 
1.144     matthew  9049: ######################################################
                   9050: ######################################################
1.115     matthew  9051: sub clean_excel_name {
                   9052:     my ($name) = @_;
                   9053:     $name =~ s/[:\*\?\/\\]//g;
                   9054:     if (length($name) > 31) {
                   9055:         $name = substr($name,0,31);
                   9056:     }
                   9057:     return $name;
1.25      albertel 9058: }
1.84      albertel 9059: 
1.85      albertel 9060: =pod
                   9061: 
1.648     raeburn  9062: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 9063: 
                   9064: Returns either 1 or undef
                   9065: 
                   9066: 1 if the part is to be hidden, undef if it is to be shown
                   9067: 
                   9068: Arguments are:
                   9069: 
                   9070: $id the id of the part to be checked
                   9071: $symb, optional the symb of the resource to check
                   9072: $udom, optional the domain of the user to check for
                   9073: $uname, optional the username of the user to check for
                   9074: 
                   9075: =cut
1.84      albertel 9076: 
                   9077: sub check_if_partid_hidden {
                   9078:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 9079:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 9080: 					 $symb,$udom,$uname);
1.141     albertel 9081:     my $truth=1;
                   9082:     #if the string starts with !, then the list is the list to show not hide
                   9083:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 9084:     my @hiddenlist=split(/,/,$hiddenparts);
                   9085:     foreach my $checkid (@hiddenlist) {
1.141     albertel 9086: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 9087:     }
1.141     albertel 9088:     return !$truth;
1.84      albertel 9089: }
1.127     matthew  9090: 
1.138     matthew  9091: 
                   9092: ############################################################
                   9093: ############################################################
                   9094: 
                   9095: =pod
                   9096: 
1.157     matthew  9097: =back 
                   9098: 
1.138     matthew  9099: =head1 cgi-bin script and graphing routines
                   9100: 
1.157     matthew  9101: =over 4
                   9102: 
1.648     raeburn  9103: =item * &get_cgi_id()
1.138     matthew  9104: 
                   9105: Inputs: none
                   9106: 
                   9107: Returns an id which can be used to pass environment variables
                   9108: to various cgi-bin scripts.  These environment variables will
                   9109: be removed from the users environment after a given time by
                   9110: the routine &Apache::lonnet::transfer_profile_to_env.
                   9111: 
                   9112: =cut
                   9113: 
                   9114: ############################################################
                   9115: ############################################################
1.152     albertel 9116: my $uniq=0;
1.136     matthew  9117: sub get_cgi_id {
1.154     albertel 9118:     $uniq=($uniq+1)%100000;
1.280     albertel 9119:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  9120: }
                   9121: 
1.127     matthew  9122: ############################################################
                   9123: ############################################################
                   9124: 
                   9125: =pod
                   9126: 
1.648     raeburn  9127: =item * &DrawBarGraph()
1.127     matthew  9128: 
1.138     matthew  9129: Facilitates the plotting of data in a (stacked) bar graph.
                   9130: Puts plot definition data into the users environment in order for 
                   9131: graph.png to plot it.  Returns an <img> tag for the plot.
                   9132: The bars on the plot are labeled '1','2',...,'n'.
                   9133: 
                   9134: Inputs:
                   9135: 
                   9136: =over 4
                   9137: 
                   9138: =item $Title: string, the title of the plot
                   9139: 
                   9140: =item $xlabel: string, text describing the X-axis of the plot
                   9141: 
                   9142: =item $ylabel: string, text describing the Y-axis of the plot
                   9143: 
                   9144: =item $Max: scalar, the maximum Y value to use in the plot
                   9145: If $Max is < any data point, the graph will not be rendered.
                   9146: 
1.140     matthew  9147: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  9148: they are plotted.  If undefined, default values will be used.
                   9149: 
1.178     matthew  9150: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   9151: 
1.138     matthew  9152: =item @Values: An array of array references.  Each array reference holds data
                   9153: to be plotted in a stacked bar chart.
                   9154: 
1.239     matthew  9155: =item If the final element of @Values is a hash reference the key/value
                   9156: pairs will be added to the graph definition.
                   9157: 
1.138     matthew  9158: =back
                   9159: 
                   9160: Returns:
                   9161: 
                   9162: An <img> tag which references graph.png and the appropriate identifying
                   9163: information for the plot.
                   9164: 
1.127     matthew  9165: =cut
                   9166: 
                   9167: ############################################################
                   9168: ############################################################
1.134     matthew  9169: sub DrawBarGraph {
1.178     matthew  9170:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  9171:     #
                   9172:     if (! defined($colors)) {
                   9173:         $colors = ['#33ff00', 
                   9174:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9175:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9176:                   ]; 
                   9177:     }
1.228     matthew  9178:     my $extra_settings = {};
                   9179:     if (ref($Values[-1]) eq 'HASH') {
                   9180:         $extra_settings = pop(@Values);
                   9181:     }
1.127     matthew  9182:     #
1.136     matthew  9183:     my $identifier = &get_cgi_id();
                   9184:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9185:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9186:         return '';
                   9187:     }
1.225     matthew  9188:     #
                   9189:     my @Labels;
                   9190:     if (defined($labels)) {
                   9191:         @Labels = @$labels;
                   9192:     } else {
                   9193:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9194:             push (@Labels,$i+1);
                   9195:         }
                   9196:     }
                   9197:     #
1.129     matthew  9198:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9199:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9200:     my %ValuesHash;
                   9201:     my $NumSets=1;
                   9202:     foreach my $array (@Values) {
                   9203:         next if (! ref($array));
1.136     matthew  9204:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9205:             join(',',@$array);
1.129     matthew  9206:     }
1.127     matthew  9207:     #
1.136     matthew  9208:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9209:     if ($NumBars < 3) {
                   9210:         $width = 120+$NumBars*32;
1.220     matthew  9211:         $xskip = 1;
1.225     matthew  9212:         $bar_width = 30;
                   9213:     } elsif ($NumBars < 5) {
                   9214:         $width = 120+$NumBars*20;
                   9215:         $xskip = 1;
                   9216:         $bar_width = 20;
1.220     matthew  9217:     } elsif ($NumBars < 10) {
1.136     matthew  9218:         $width = 120+$NumBars*15;
                   9219:         $xskip = 1;
                   9220:         $bar_width = 15;
                   9221:     } elsif ($NumBars <= 25) {
                   9222:         $width = 120+$NumBars*11;
                   9223:         $xskip = 5;
                   9224:         $bar_width = 8;
                   9225:     } elsif ($NumBars <= 50) {
                   9226:         $width = 120+$NumBars*8;
                   9227:         $xskip = 5;
                   9228:         $bar_width = 4;
                   9229:     } else {
                   9230:         $width = 120+$NumBars*8;
                   9231:         $xskip = 5;
                   9232:         $bar_width = 4;
                   9233:     }
                   9234:     #
1.137     matthew  9235:     $Max = 1 if ($Max < 1);
                   9236:     if ( int($Max) < $Max ) {
                   9237:         $Max++;
                   9238:         $Max = int($Max);
                   9239:     }
1.127     matthew  9240:     $Title  = '' if (! defined($Title));
                   9241:     $xlabel = '' if (! defined($xlabel));
                   9242:     $ylabel = '' if (! defined($ylabel));
1.369     www      9243:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9244:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9245:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9246:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9247:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9248:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9249:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9250:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9251:     $ValuesHash{$id.'.height'}   = $height;
                   9252:     $ValuesHash{$id.'.width'}    = $width;
                   9253:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9254:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9255:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9256:     #
1.228     matthew  9257:     # Deal with other parameters
                   9258:     while (my ($key,$value) = each(%$extra_settings)) {
                   9259:         $ValuesHash{$id.'.'.$key} = $value;
                   9260:     }
                   9261:     #
1.646     raeburn  9262:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9263:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9264: }
                   9265: 
                   9266: ############################################################
                   9267: ############################################################
                   9268: 
                   9269: =pod
                   9270: 
1.648     raeburn  9271: =item * &DrawXYGraph()
1.137     matthew  9272: 
1.138     matthew  9273: Facilitates the plotting of data in an XY graph.
                   9274: Puts plot definition data into the users environment in order for 
                   9275: graph.png to plot it.  Returns an <img> tag for the plot.
                   9276: 
                   9277: Inputs:
                   9278: 
                   9279: =over 4
                   9280: 
                   9281: =item $Title: string, the title of the plot
                   9282: 
                   9283: =item $xlabel: string, text describing the X-axis of the plot
                   9284: 
                   9285: =item $ylabel: string, text describing the Y-axis of the plot
                   9286: 
                   9287: =item $Max: scalar, the maximum Y value to use in the plot
                   9288: If $Max is < any data point, the graph will not be rendered.
                   9289: 
                   9290: =item $colors: Array ref containing the hex color codes for the data to be 
                   9291: plotted in.  If undefined, default values will be used.
                   9292: 
                   9293: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9294: 
                   9295: =item $Ydata: Array ref containing Array refs.  
1.185     www      9296: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9297: 
                   9298: =item %Values: hash indicating or overriding any default values which are 
                   9299: passed to graph.png.  
                   9300: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9301: 
                   9302: =back
                   9303: 
                   9304: Returns:
                   9305: 
                   9306: An <img> tag which references graph.png and the appropriate identifying
                   9307: information for the plot.
                   9308: 
1.137     matthew  9309: =cut
                   9310: 
                   9311: ############################################################
                   9312: ############################################################
                   9313: sub DrawXYGraph {
                   9314:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9315:     #
                   9316:     # Create the identifier for the graph
                   9317:     my $identifier = &get_cgi_id();
                   9318:     my $id = 'cgi.'.$identifier;
                   9319:     #
                   9320:     $Title  = '' if (! defined($Title));
                   9321:     $xlabel = '' if (! defined($xlabel));
                   9322:     $ylabel = '' if (! defined($ylabel));
                   9323:     my %ValuesHash = 
                   9324:         (
1.369     www      9325:          $id.'.title'  => &escape($Title),
                   9326:          $id.'.xlabel' => &escape($xlabel),
                   9327:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9328:          $id.'.y_max_value'=> $Max,
                   9329:          $id.'.labels'     => join(',',@$Xlabels),
                   9330:          $id.'.PlotType'   => 'XY',
                   9331:          );
                   9332:     #
                   9333:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9334:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9335:     }
                   9336:     #
                   9337:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9338:         return '';
                   9339:     }
                   9340:     my $NumSets=1;
1.138     matthew  9341:     foreach my $array (@{$Ydata}){
1.137     matthew  9342:         next if (! ref($array));
                   9343:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9344:     }
1.138     matthew  9345:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9346:     #
                   9347:     # Deal with other parameters
                   9348:     while (my ($key,$value) = each(%Values)) {
                   9349:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9350:     }
                   9351:     #
1.646     raeburn  9352:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9353:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9354: }
                   9355: 
                   9356: ############################################################
                   9357: ############################################################
                   9358: 
                   9359: =pod
                   9360: 
1.648     raeburn  9361: =item * &DrawXYYGraph()
1.138     matthew  9362: 
                   9363: Facilitates the plotting of data in an XY graph with two Y axes.
                   9364: Puts plot definition data into the users environment in order for 
                   9365: graph.png to plot it.  Returns an <img> tag for the plot.
                   9366: 
                   9367: Inputs:
                   9368: 
                   9369: =over 4
                   9370: 
                   9371: =item $Title: string, the title of the plot
                   9372: 
                   9373: =item $xlabel: string, text describing the X-axis of the plot
                   9374: 
                   9375: =item $ylabel: string, text describing the Y-axis of the plot
                   9376: 
                   9377: =item $colors: Array ref containing the hex color codes for the data to be 
                   9378: plotted in.  If undefined, default values will be used.
                   9379: 
                   9380: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9381: 
                   9382: =item $Ydata1: The first data set
                   9383: 
                   9384: =item $Min1: The minimum value of the left Y-axis
                   9385: 
                   9386: =item $Max1: The maximum value of the left Y-axis
                   9387: 
                   9388: =item $Ydata2: The second data set
                   9389: 
                   9390: =item $Min2: The minimum value of the right Y-axis
                   9391: 
                   9392: =item $Max2: The maximum value of the left Y-axis
                   9393: 
                   9394: =item %Values: hash indicating or overriding any default values which are 
                   9395: passed to graph.png.  
                   9396: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9397: 
                   9398: =back
                   9399: 
                   9400: Returns:
                   9401: 
                   9402: An <img> tag which references graph.png and the appropriate identifying
                   9403: information for the plot.
1.136     matthew  9404: 
                   9405: =cut
                   9406: 
                   9407: ############################################################
                   9408: ############################################################
1.137     matthew  9409: sub DrawXYYGraph {
                   9410:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9411:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9412:     #
                   9413:     # Create the identifier for the graph
                   9414:     my $identifier = &get_cgi_id();
                   9415:     my $id = 'cgi.'.$identifier;
                   9416:     #
                   9417:     $Title  = '' if (! defined($Title));
                   9418:     $xlabel = '' if (! defined($xlabel));
                   9419:     $ylabel = '' if (! defined($ylabel));
                   9420:     my %ValuesHash = 
                   9421:         (
1.369     www      9422:          $id.'.title'  => &escape($Title),
                   9423:          $id.'.xlabel' => &escape($xlabel),
                   9424:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9425:          $id.'.labels' => join(',',@$Xlabels),
                   9426:          $id.'.PlotType' => 'XY',
                   9427:          $id.'.NumSets' => 2,
1.137     matthew  9428:          $id.'.two_axes' => 1,
                   9429:          $id.'.y1_max_value' => $Max1,
                   9430:          $id.'.y1_min_value' => $Min1,
                   9431:          $id.'.y2_max_value' => $Max2,
                   9432:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9433:          );
                   9434:     #
1.137     matthew  9435:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9436:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9437:     }
                   9438:     #
                   9439:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9440:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9441:         return '';
                   9442:     }
                   9443:     my $NumSets=1;
1.137     matthew  9444:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9445:         next if (! ref($array));
                   9446:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9447:     }
                   9448:     #
                   9449:     # Deal with other parameters
                   9450:     while (my ($key,$value) = each(%Values)) {
                   9451:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9452:     }
                   9453:     #
1.646     raeburn  9454:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9455:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9456: }
                   9457: 
                   9458: ############################################################
                   9459: ############################################################
                   9460: 
                   9461: =pod
                   9462: 
1.157     matthew  9463: =back 
                   9464: 
1.139     matthew  9465: =head1 Statistics helper routines?  
                   9466: 
                   9467: Bad place for them but what the hell.
                   9468: 
1.157     matthew  9469: =over 4
                   9470: 
1.648     raeburn  9471: =item * &chartlink()
1.139     matthew  9472: 
                   9473: Returns a link to the chart for a specific student.  
                   9474: 
                   9475: Inputs:
                   9476: 
                   9477: =over 4
                   9478: 
                   9479: =item $linktext: The text of the link
                   9480: 
                   9481: =item $sname: The students username
                   9482: 
                   9483: =item $sdomain: The students domain
                   9484: 
                   9485: =back
                   9486: 
1.157     matthew  9487: =back
                   9488: 
1.139     matthew  9489: =cut
                   9490: 
                   9491: ############################################################
                   9492: ############################################################
                   9493: sub chartlink {
                   9494:     my ($linktext, $sname, $sdomain) = @_;
                   9495:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9496:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9497:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9498:        '">'.$linktext.'</a>';
1.153     matthew  9499: }
                   9500: 
                   9501: #######################################################
                   9502: #######################################################
                   9503: 
                   9504: =pod
                   9505: 
                   9506: =head1 Course Environment Routines
1.157     matthew  9507: 
                   9508: =over 4
1.153     matthew  9509: 
1.648     raeburn  9510: =item * &restore_course_settings()
1.153     matthew  9511: 
1.648     raeburn  9512: =item * &store_course_settings()
1.153     matthew  9513: 
                   9514: Restores/Store indicated form parameters from the course environment.
                   9515: Will not overwrite existing values of the form parameters.
                   9516: 
                   9517: Inputs: 
                   9518: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9519: 
                   9520: a hash ref describing the data to be stored.  For example:
                   9521:    
                   9522: %Save_Parameters = ('Status' => 'scalar',
                   9523:     'chartoutputmode' => 'scalar',
                   9524:     'chartoutputdata' => 'scalar',
                   9525:     'Section' => 'array',
1.373     raeburn  9526:     'Group' => 'array',
1.153     matthew  9527:     'StudentData' => 'array',
                   9528:     'Maps' => 'array');
                   9529: 
                   9530: Returns: both routines return nothing
                   9531: 
1.631     raeburn  9532: =back
                   9533: 
1.153     matthew  9534: =cut
                   9535: 
                   9536: #######################################################
                   9537: #######################################################
                   9538: sub store_course_settings {
1.496     albertel 9539:     return &store_settings($env{'request.course.id'},@_);
                   9540: }
                   9541: 
                   9542: sub store_settings {
1.153     matthew  9543:     # save to the environment
                   9544:     # appenv the same items, just to be safe
1.300     albertel 9545:     my $udom  = $env{'user.domain'};
                   9546:     my $uname = $env{'user.name'};
1.496     albertel 9547:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9548:     my %SaveHash;
                   9549:     my %AppHash;
                   9550:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9551:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9552:         my $envname = 'environment.'.$basename;
1.258     albertel 9553:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9554:             # Save this value away
                   9555:             if ($type eq 'scalar' &&
1.258     albertel 9556:                 (! exists($env{$envname}) || 
                   9557:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9558:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9559:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9560:             } elsif ($type eq 'array') {
                   9561:                 my $stored_form;
1.258     albertel 9562:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9563:                     $stored_form = join(',',
                   9564:                                         map {
1.369     www      9565:                                             &escape($_);
1.258     albertel 9566:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9567:                 } else {
                   9568:                     $stored_form = 
1.369     www      9569:                         &escape($env{'form.'.$setting});
1.153     matthew  9570:                 }
                   9571:                 # Determine if the array contents are the same.
1.258     albertel 9572:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9573:                     $SaveHash{$basename} = $stored_form;
                   9574:                     $AppHash{$envname}   = $stored_form;
                   9575:                 }
                   9576:             }
                   9577:         }
                   9578:     }
                   9579:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9580:                                           $udom,$uname);
1.153     matthew  9581:     if ($put_result !~ /^(ok|delayed)/) {
                   9582:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9583:                                  'got error:'.$put_result);
                   9584:     }
                   9585:     # Make sure these settings stick around in this session, too
1.646     raeburn  9586:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9587:     return;
                   9588: }
                   9589: 
                   9590: sub restore_course_settings {
1.499     albertel 9591:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9592: }
                   9593: 
                   9594: sub restore_settings {
                   9595:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9596:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9597:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9598:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9599:             '.'.$setting;
1.258     albertel 9600:         if (exists($env{$envname})) {
1.153     matthew  9601:             if ($type eq 'scalar') {
1.258     albertel 9602:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9603:             } elsif ($type eq 'array') {
1.258     albertel 9604:                 $env{'form.'.$setting} = [ 
1.153     matthew  9605:                                            map { 
1.369     www      9606:                                                &unescape($_); 
1.258     albertel 9607:                                            } split(',',$env{$envname})
1.153     matthew  9608:                                            ];
                   9609:             }
                   9610:         }
                   9611:     }
1.127     matthew  9612: }
                   9613: 
1.618     raeburn  9614: #######################################################
                   9615: #######################################################
                   9616: 
                   9617: =pod
                   9618: 
                   9619: =head1 Domain E-mail Routines  
                   9620: 
                   9621: =over 4
                   9622: 
1.648     raeburn  9623: =item * &build_recipient_list()
1.618     raeburn  9624: 
1.884     raeburn  9625: Build recipient lists for five types of e-mail:
1.766     raeburn  9626: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9627: (d) Help requests, (e) Course requests needing approval,  generated by
                   9628: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9629: loncoursequeueadmin.pm respectively.
1.618     raeburn  9630: 
                   9631: Inputs:
1.619     raeburn  9632: defmail (scalar - email address of default recipient), 
1.618     raeburn  9633: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9634: defdom (domain for which to retrieve configuration settings),
                   9635: origmail (scalar - email address of recipient from loncapa.conf, 
                   9636: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9637: 
1.655     raeburn  9638: Returns: comma separated list of addresses to which to send e-mail.
                   9639: 
                   9640: =back
1.618     raeburn  9641: 
                   9642: =cut
                   9643: 
                   9644: ############################################################
                   9645: ############################################################
                   9646: sub build_recipient_list {
1.619     raeburn  9647:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9648:     my @recipients;
                   9649:     my $otheremails;
                   9650:     my %domconfig =
                   9651:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9652:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9653:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9654:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9655:                 my @contacts = ('adminemail','supportemail');
                   9656:                 foreach my $item (@contacts) {
                   9657:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9658:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9659:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9660:                             push(@recipients,$addr);
                   9661:                         }
1.619     raeburn  9662:                     }
1.766     raeburn  9663:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9664:                 }
                   9665:             }
1.766     raeburn  9666:         } elsif ($origmail ne '') {
                   9667:             push(@recipients,$origmail);
1.618     raeburn  9668:         }
1.619     raeburn  9669:     } elsif ($origmail ne '') {
                   9670:         push(@recipients,$origmail);
1.618     raeburn  9671:     }
1.688     raeburn  9672:     if (defined($defmail)) {
                   9673:         if ($defmail ne '') {
                   9674:             push(@recipients,$defmail);
                   9675:         }
1.618     raeburn  9676:     }
                   9677:     if ($otheremails) {
1.619     raeburn  9678:         my @others;
                   9679:         if ($otheremails =~ /,/) {
                   9680:             @others = split(/,/,$otheremails);
1.618     raeburn  9681:         } else {
1.619     raeburn  9682:             push(@others,$otheremails);
                   9683:         }
                   9684:         foreach my $addr (@others) {
                   9685:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9686:                 push(@recipients,$addr);
                   9687:             }
1.618     raeburn  9688:         }
                   9689:     }
1.619     raeburn  9690:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9691:     return $recipientlist;
                   9692: }
                   9693: 
1.127     matthew  9694: ############################################################
                   9695: ############################################################
1.154     albertel 9696: 
1.655     raeburn  9697: =pod
                   9698: 
                   9699: =head1 Course Catalog Routines
                   9700: 
                   9701: =over 4
                   9702: 
                   9703: =item * &gather_categories()
                   9704: 
                   9705: Converts category definitions - keys of categories hash stored in  
                   9706: coursecategories in configuration.db on the primary library server in a 
                   9707: domain - to an array.  Also generates javascript and idx hash used to 
                   9708: generate Domain Coordinator interface for editing Course Categories.
                   9709: 
                   9710: Inputs:
1.663     raeburn  9711: 
1.655     raeburn  9712: categories (reference to hash of category definitions).
1.663     raeburn  9713: 
1.655     raeburn  9714: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9715:       categories and subcategories).
1.663     raeburn  9716: 
1.655     raeburn  9717: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9718:       editing Course Categories).
1.663     raeburn  9719: 
1.655     raeburn  9720: jsarray (reference to array of categories used to create Javascript arrays for
                   9721:          Domain Coordinator interface for editing Course Categories).
                   9722: 
                   9723: Returns: nothing
                   9724: 
                   9725: Side effects: populates cats, idx and jsarray. 
                   9726: 
                   9727: =cut
                   9728: 
                   9729: sub gather_categories {
                   9730:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9731:     my %counters;
                   9732:     my $num = 0;
                   9733:     foreach my $item (keys(%{$categories})) {
                   9734:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9735:         if ($container eq '' && $depth == 0) {
                   9736:             $cats->[$depth][$categories->{$item}] = $cat;
                   9737:         } else {
                   9738:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9739:         }
                   9740:         my ($escitem,$tail) = split(/:/,$item,2);
                   9741:         if ($counters{$tail} eq '') {
                   9742:             $counters{$tail} = $num;
                   9743:             $num ++;
                   9744:         }
                   9745:         if (ref($idx) eq 'HASH') {
                   9746:             $idx->{$item} = $counters{$tail};
                   9747:         }
                   9748:         if (ref($jsarray) eq 'ARRAY') {
                   9749:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9750:         }
                   9751:     }
                   9752:     return;
                   9753: }
                   9754: 
                   9755: =pod
                   9756: 
                   9757: =item * &extract_categories()
                   9758: 
                   9759: Used to generate breadcrumb trails for course categories.
                   9760: 
                   9761: Inputs:
1.663     raeburn  9762: 
1.655     raeburn  9763: categories (reference to hash of category definitions).
1.663     raeburn  9764: 
1.655     raeburn  9765: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9766:       categories and subcategories).
1.663     raeburn  9767: 
1.655     raeburn  9768: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9769: 
1.655     raeburn  9770: allitems (reference to hash - key is category key 
                   9771:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9772: 
1.655     raeburn  9773: idx (reference to hash of counters used in Domain Coordinator interface for
                   9774:       editing Course Categories).
1.663     raeburn  9775: 
1.655     raeburn  9776: jsarray (reference to array of categories used to create Javascript arrays for
                   9777:          Domain Coordinator interface for editing Course Categories).
                   9778: 
1.665     raeburn  9779: subcats (reference to hash of arrays containing all subcategories within each 
                   9780:          category, -recursive)
                   9781: 
1.655     raeburn  9782: Returns: nothing
                   9783: 
                   9784: Side effects: populates trails and allitems hash references.
                   9785: 
                   9786: =cut
                   9787: 
                   9788: sub extract_categories {
1.665     raeburn  9789:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9790:     if (ref($categories) eq 'HASH') {
                   9791:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9792:         if (ref($cats->[0]) eq 'ARRAY') {
                   9793:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9794:                 my $name = $cats->[0][$i];
                   9795:                 my $item = &escape($name).'::0';
                   9796:                 my $trailstr;
                   9797:                 if ($name eq 'instcode') {
                   9798:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9799:                 } elsif ($name eq 'communities') {
                   9800:                     $trailstr = &mt('Communities');
1.655     raeburn  9801:                 } else {
                   9802:                     $trailstr = $name;
                   9803:                 }
                   9804:                 if ($allitems->{$item} eq '') {
                   9805:                     push(@{$trails},$trailstr);
                   9806:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9807:                 }
                   9808:                 my @parents = ($name);
                   9809:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9810:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9811:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9812:                         if (ref($subcats) eq 'HASH') {
                   9813:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9814:                         }
                   9815:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9816:                     }
                   9817:                 } else {
                   9818:                     if (ref($subcats) eq 'HASH') {
                   9819:                         $subcats->{$item} = [];
1.655     raeburn  9820:                     }
                   9821:                 }
                   9822:             }
                   9823:         }
                   9824:     }
                   9825:     return;
                   9826: }
                   9827: 
                   9828: =pod
                   9829: 
                   9830: =item *&recurse_categories()
                   9831: 
                   9832: Recursively used to generate breadcrumb trails for course categories.
                   9833: 
                   9834: Inputs:
1.663     raeburn  9835: 
1.655     raeburn  9836: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9837:       categories and subcategories).
1.663     raeburn  9838: 
1.655     raeburn  9839: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9840: 
                   9841: category (current course category, for which breadcrumb trail is being generated).
                   9842: 
                   9843: trails (reference to array of breadcrumb trails for each category).
                   9844: 
1.655     raeburn  9845: allitems (reference to hash - key is category key
                   9846:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9847: 
1.655     raeburn  9848: parents (array containing containers directories for current category, 
                   9849:          back to top level). 
                   9850: 
                   9851: Returns: nothing
                   9852: 
                   9853: Side effects: populates trails and allitems hash references
                   9854: 
                   9855: =cut
                   9856: 
                   9857: sub recurse_categories {
1.665     raeburn  9858:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9859:     my $shallower = $depth - 1;
                   9860:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9861:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9862:             my $name = $cats->[$depth]{$category}[$k];
                   9863:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9864:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9865:             if ($allitems->{$item} eq '') {
                   9866:                 push(@{$trails},$trailstr);
                   9867:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9868:             }
                   9869:             my $deeper = $depth+1;
                   9870:             push(@{$parents},$category);
1.665     raeburn  9871:             if (ref($subcats) eq 'HASH') {
                   9872:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9873:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9874:                     my $higher;
                   9875:                     if ($j > 0) {
                   9876:                         $higher = &escape($parents->[$j]).':'.
                   9877:                                   &escape($parents->[$j-1]).':'.$j;
                   9878:                     } else {
                   9879:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9880:                     }
                   9881:                     push(@{$subcats->{$higher}},$subcat);
                   9882:                 }
                   9883:             }
                   9884:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9885:                                 $subcats);
1.655     raeburn  9886:             pop(@{$parents});
                   9887:         }
                   9888:     } else {
                   9889:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9890:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9891:         if ($allitems->{$item} eq '') {
                   9892:             push(@{$trails},$trailstr);
                   9893:             $allitems->{$item} = scalar(@{$trails})-1;
                   9894:         }
                   9895:     }
                   9896:     return;
                   9897: }
                   9898: 
1.663     raeburn  9899: =pod
                   9900: 
                   9901: =item *&assign_categories_table()
                   9902: 
                   9903: Create a datatable for display of hierarchical categories in a domain,
                   9904: with checkboxes to allow a course to be categorized. 
                   9905: 
                   9906: Inputs:
                   9907: 
                   9908: cathash - reference to hash of categories defined for the domain (from
                   9909:           configuration.db)
                   9910: 
                   9911: currcat - scalar with an & separated list of categories assigned to a course. 
                   9912: 
1.919     raeburn  9913: type    - scalar contains course type (Course or Community).
                   9914: 
1.663     raeburn  9915: Returns: $output (markup to be displayed) 
                   9916: 
                   9917: =cut
                   9918: 
                   9919: sub assign_categories_table {
1.919     raeburn  9920:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9921:     my $output;
                   9922:     if (ref($cathash) eq 'HASH') {
                   9923:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9924:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9925:         $maxdepth = scalar(@cats);
                   9926:         if (@cats > 0) {
                   9927:             my $itemcount = 0;
                   9928:             if (ref($cats[0]) eq 'ARRAY') {
                   9929:                 my @currcategories;
                   9930:                 if ($currcat ne '') {
                   9931:                     @currcategories = split('&',$currcat);
                   9932:                 }
1.919     raeburn  9933:                 my $table;
1.663     raeburn  9934:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9935:                     my $parent = $cats[0][$i];
1.919     raeburn  9936:                     next if ($parent eq 'instcode');
                   9937:                     if ($type eq 'Community') {
                   9938:                         next unless ($parent eq 'communities');
                   9939:                     } else {
                   9940:                         next if ($parent eq 'communities');
                   9941:                     }
1.663     raeburn  9942:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9943:                     my $item = &escape($parent).'::0';
                   9944:                     my $checked = '';
                   9945:                     if (@currcategories > 0) {
                   9946:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9947:                             $checked = ' checked="checked"';
1.663     raeburn  9948:                         }
                   9949:                     }
1.919     raeburn  9950:                     my $parent_title = $parent;
                   9951:                     if ($parent eq 'communities') {
                   9952:                         $parent_title = &mt('Communities');
                   9953:                     }
                   9954:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9955:                               '<input type="checkbox" name="usecategory" value="'.
                   9956:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9957:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9958:                     my $depth = 1;
                   9959:                     push(@path,$parent);
1.919     raeburn  9960:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  9961:                     pop(@path);
1.919     raeburn  9962:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  9963:                     $itemcount ++;
                   9964:                 }
1.919     raeburn  9965:                 if ($itemcount) {
                   9966:                     $output = &Apache::loncommon::start_data_table().
                   9967:                               $table.
                   9968:                               &Apache::loncommon::end_data_table();
                   9969:                 }
1.663     raeburn  9970:             }
                   9971:         }
                   9972:     }
                   9973:     return $output;
                   9974: }
                   9975: 
                   9976: =pod
                   9977: 
                   9978: =item *&assign_category_rows()
                   9979: 
                   9980: Create a datatable row for display of nested categories in a domain,
                   9981: with checkboxes to allow a course to be categorized,called recursively.
                   9982: 
                   9983: Inputs:
                   9984: 
                   9985: itemcount - track row number for alternating colors
                   9986: 
                   9987: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9988:       categories and subcategories.
                   9989: 
                   9990: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9991: 
                   9992: parent - parent of current category item
                   9993: 
                   9994: path - Array containing all categories back up through the hierarchy from the
                   9995:        current category to the top level.
                   9996: 
                   9997: currcategories - reference to array of current categories assigned to the course
                   9998: 
                   9999: Returns: $output (markup to be displayed).
                   10000: 
                   10001: =cut
                   10002: 
                   10003: sub assign_category_rows {
                   10004:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   10005:     my ($text,$name,$item,$chgstr);
                   10006:     if (ref($cats) eq 'ARRAY') {
                   10007:         my $maxdepth = scalar(@{$cats});
                   10008:         if (ref($cats->[$depth]) eq 'HASH') {
                   10009:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   10010:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   10011:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   10012:                 $text .= '<td><table class="LC_datatable">';
                   10013:                 for (my $j=0; $j<$numchildren; $j++) {
                   10014:                     $name = $cats->[$depth]{$parent}[$j];
                   10015:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   10016:                     my $deeper = $depth+1;
                   10017:                     my $checked = '';
                   10018:                     if (ref($currcategories) eq 'ARRAY') {
                   10019:                         if (@{$currcategories} > 0) {
                   10020:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   10021:                                 $checked = ' checked="checked"';
1.663     raeburn  10022:                             }
                   10023:                         }
                   10024:                     }
1.664     raeburn  10025:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   10026:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  10027:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   10028:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   10029:                              '</td><td>';
1.663     raeburn  10030:                     if (ref($path) eq 'ARRAY') {
                   10031:                         push(@{$path},$name);
                   10032:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   10033:                         pop(@{$path});
                   10034:                     }
                   10035:                     $text .= '</td></tr>';
                   10036:                 }
                   10037:                 $text .= '</table></td>';
                   10038:             }
                   10039:         }
                   10040:     }
                   10041:     return $text;
                   10042: }
                   10043: 
1.655     raeburn  10044: ############################################################
                   10045: ############################################################
                   10046: 
                   10047: 
1.443     albertel 10048: sub commit_customrole {
1.664     raeburn  10049:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  10050:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 10051:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   10052:                          ($end?', ending '.localtime($end):'').': <b>'.
                   10053:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  10054:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 10055:                  '</b><br />';
                   10056:     return $output;
                   10057: }
                   10058: 
                   10059: sub commit_standardrole {
1.541     raeburn  10060:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   10061:     my ($output,$logmsg,$linefeed);
                   10062:     if ($context eq 'auto') {
                   10063:         $linefeed = "\n";
                   10064:     } else {
                   10065:         $linefeed = "<br />\n";
                   10066:     }  
1.443     albertel 10067:     if ($three eq 'st') {
1.541     raeburn  10068:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   10069:                                          $one,$two,$sec,$context);
                   10070:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  10071:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   10072:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 10073:         } else {
1.541     raeburn  10074:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 10075:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10076:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   10077:             if ($context eq 'auto') {
                   10078:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   10079:             } else {
                   10080:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   10081:                &mt('Add to classlist').': <b>ok</b>';
                   10082:             }
                   10083:             $output .= $linefeed;
1.443     albertel 10084:         }
                   10085:     } else {
                   10086:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   10087:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10088:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  10089:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  10090:         if ($context eq 'auto') {
                   10091:             $output .= $result.$linefeed;
                   10092:         } else {
                   10093:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   10094:         }
1.443     albertel 10095:     }
                   10096:     return $output;
                   10097: }
                   10098: 
                   10099: sub commit_studentrole {
1.541     raeburn  10100:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  10101:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  10102:     if ($context eq 'auto') {
                   10103:         $linefeed = "\n";
                   10104:     } else {
                   10105:         $linefeed = '<br />'."\n";
                   10106:     }
1.443     albertel 10107:     if (defined($one) && defined($two)) {
                   10108:         my $cid=$one.'_'.$two;
                   10109:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   10110:         my $secchange = 0;
                   10111:         my $expire_role_result;
                   10112:         my $modify_section_result;
1.628     raeburn  10113:         if ($oldsec ne '-1') { 
                   10114:             if ($oldsec ne $sec) {
1.443     albertel 10115:                 $secchange = 1;
1.628     raeburn  10116:                 my $now = time;
1.443     albertel 10117:                 my $uurl='/'.$cid;
                   10118:                 $uurl=~s/\_/\//g;
                   10119:                 if ($oldsec) {
                   10120:                     $uurl.='/'.$oldsec;
                   10121:                 }
1.626     raeburn  10122:                 $oldsecurl = $uurl;
1.628     raeburn  10123:                 $expire_role_result = 
1.652     raeburn  10124:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  10125:                 if ($env{'request.course.sec'} ne '') { 
                   10126:                     if ($expire_role_result eq 'refused') {
                   10127:                         my @roles = ('st');
                   10128:                         my @statuses = ('previous');
                   10129:                         my @roledoms = ($one);
                   10130:                         my $withsec = 1;
                   10131:                         my %roleshash = 
                   10132:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   10133:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   10134:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   10135:                             my ($oldstart,$oldend) = 
                   10136:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   10137:                             if ($oldend > 0 && $oldend <= $now) {
                   10138:                                 $expire_role_result = 'ok';
                   10139:                             }
                   10140:                         }
                   10141:                     }
                   10142:                 }
1.443     albertel 10143:                 $result = $expire_role_result;
                   10144:             }
                   10145:         }
                   10146:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  10147:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 10148:             if ($modify_section_result =~ /^ok/) {
                   10149:                 if ($secchange == 1) {
1.628     raeburn  10150:                     if ($sec eq '') {
                   10151:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   10152:                     } else {
                   10153:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   10154:                     }
1.443     albertel 10155:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  10156:                     if ($sec eq '') {
                   10157:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   10158:                     } else {
                   10159:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10160:                     }
1.443     albertel 10161:                 } else {
1.628     raeburn  10162:                     if ($sec eq '') {
                   10163:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   10164:                     } else {
                   10165:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10166:                     }
1.443     albertel 10167:                 }
                   10168:             } else {
1.628     raeburn  10169:                 if ($secchange) {       
                   10170:                     $$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;
                   10171:                 } else {
                   10172:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10173:                 }
1.443     albertel 10174:             }
                   10175:             $result = $modify_section_result;
                   10176:         } elsif ($secchange == 1) {
1.628     raeburn  10177:             if ($oldsec eq '') {
                   10178:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10179:             } else {
                   10180:                 $$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;
                   10181:             }
1.626     raeburn  10182:             if ($expire_role_result eq 'refused') {
                   10183:                 my $newsecurl = '/'.$cid;
                   10184:                 $newsecurl =~ s/\_/\//g;
                   10185:                 if ($sec ne '') {
                   10186:                     $newsecurl.='/'.$sec;
                   10187:                 }
                   10188:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10189:                     if ($sec eq '') {
                   10190:                         $$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;
                   10191:                     } else {
                   10192:                         $$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;
                   10193:                     }
                   10194:                 }
                   10195:             }
1.443     albertel 10196:         }
                   10197:     } else {
1.626     raeburn  10198:         $$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 10199:         $result = "error: incomplete course id\n";
                   10200:     }
                   10201:     return $result;
                   10202: }
                   10203: 
                   10204: ############################################################
                   10205: ############################################################
                   10206: 
1.566     albertel 10207: sub check_clone {
1.578     raeburn  10208:     my ($args,$linefeed) = @_;
1.566     albertel 10209:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10210:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10211:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10212:     my $clonemsg;
                   10213:     my $can_clone = 0;
1.925.2.11  raeburn  10214:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10215:     if ($lctype ne 'community') {
                   10216:         $lctype = 'course';
                   10217:     }
1.566     albertel 10218:     if ($clonehome eq 'no_host') {
1.925.2.11  raeburn  10219:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10220:             $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'});
                   10221:         } else {
                   10222:             $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'});
                   10223:         }     
1.566     albertel 10224:     } else {
                   10225: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.925.2.11  raeburn  10226:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10227:             if ($clonedesc{'type'} ne 'Community') {
                   10228:                  $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'});
                   10229:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10230:             }
                   10231:         }
1.882     raeburn  10232: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10233:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10234: 	    $can_clone = 1;
                   10235: 	} else {
                   10236: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10237: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10238: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10239:             if (grep(/^\*$/,@cloners)) {
                   10240:                 $can_clone = 1;
                   10241:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10242:                 $can_clone = 1;
                   10243:             } else {
1.908     raeburn  10244:                 my $ccrole = 'cc';
1.925.2.11  raeburn  10245:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10246:                     $ccrole = 'co';
                   10247:                 }
1.578     raeburn  10248: 	        my %roleshash =
                   10249: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10250: 					 $args->{'ccdomain'},
1.908     raeburn  10251:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10252: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10253: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10254: 		    $can_clone = 1;
                   10255: 	        } else {
1.925.2.11  raeburn  10256:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10257:                         $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'});
                   10258:                     } else {
                   10259:                         $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'});
                   10260:                     }
1.578     raeburn  10261: 	        }
1.566     albertel 10262: 	    }
1.578     raeburn  10263:         }
1.566     albertel 10264:     }
                   10265:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10266: }
                   10267: 
1.444     albertel 10268: sub construct_course {
1.885     raeburn  10269:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10270:     my $outcome;
1.541     raeburn  10271:     my $linefeed =  '<br />'."\n";
                   10272:     if ($context eq 'auto') {
                   10273:         $linefeed = "\n";
                   10274:     }
1.566     albertel 10275: 
                   10276: #
                   10277: # Are we cloning?
                   10278: #
                   10279:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10280:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10281: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10282: 	if ($context ne 'auto') {
1.578     raeburn  10283:             if ($clonemsg ne '') {
                   10284: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10285:             }
1.566     albertel 10286: 	}
                   10287: 	$outcome .= $clonemsg.$linefeed;
                   10288: 
                   10289:         if (!$can_clone) {
                   10290: 	    return (0,$outcome);
                   10291: 	}
                   10292:     }
                   10293: 
1.444     albertel 10294: #
                   10295: # Open course
                   10296: #
                   10297:     my $crstype = lc($args->{'crstype'});
                   10298:     my %cenv=();
                   10299:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10300:                                              $args->{'cdescr'},
                   10301:                                              $args->{'curl'},
                   10302:                                              $args->{'course_home'},
                   10303:                                              $args->{'nonstandard'},
                   10304:                                              $args->{'crscode'},
                   10305:                                              $args->{'ccuname'}.':'.
                   10306:                                              $args->{'ccdomain'},
1.882     raeburn  10307:                                              $args->{'crstype'},
1.885     raeburn  10308:                                              $cnum,$context,$category);
1.444     albertel 10309: 
                   10310:     # Note: The testing routines depend on this being output; see 
                   10311:     # Utils::Course. This needs to at least be output as a comment
                   10312:     # if anyone ever decides to not show this, and Utils::Course::new
                   10313:     # will need to be suitably modified.
1.541     raeburn  10314:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10315: #
                   10316: # Check if created correctly
                   10317: #
1.479     albertel 10318:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10319:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10320:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10321: 
1.444     albertel 10322: #
1.566     albertel 10323: # Do the cloning
                   10324: #   
                   10325:     if ($can_clone && $cloneid) {
                   10326: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10327: 	if ($context ne 'auto') {
                   10328: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10329: 	}
                   10330: 	$outcome .= $clonemsg.$linefeed;
                   10331: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10332: # Copy all files
1.637     www      10333: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10334: # Restore URL
1.566     albertel 10335: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10336: # Restore title
1.566     albertel 10337: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10338: # Mark as cloned
1.566     albertel 10339: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10340: # Need to clone grading mode
                   10341:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10342:         $cenv{'grading'}=$newenv{'grading'};
                   10343: # Do not clone these environment entries
                   10344:         &Apache::lonnet::del('environment',
                   10345:                   ['default_enrollment_start_date',
                   10346:                    'default_enrollment_end_date',
                   10347:                    'question.email',
                   10348:                    'policy.email',
                   10349:                    'comment.email',
                   10350:                    'pch.users.denied',
1.725     raeburn  10351:                    'plc.users.denied',
                   10352:                    'hidefromcat',
                   10353:                    'categories'],
1.638     www      10354:                    $$crsudom,$$crsunum);
1.444     albertel 10355:     }
1.566     albertel 10356: 
1.444     albertel 10357: #
                   10358: # Set environment (will override cloned, if existing)
                   10359: #
                   10360:     my @sections = ();
                   10361:     my @xlists = ();
                   10362:     if ($args->{'crstype'}) {
                   10363:         $cenv{'type'}=$args->{'crstype'};
                   10364:     }
                   10365:     if ($args->{'crsid'}) {
                   10366:         $cenv{'courseid'}=$args->{'crsid'};
                   10367:     }
                   10368:     if ($args->{'crscode'}) {
                   10369:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10370:     }
                   10371:     if ($args->{'crsquota'} ne '') {
                   10372:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10373:     } else {
                   10374:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10375:     }
                   10376:     if ($args->{'ccuname'}) {
                   10377:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10378:                                         ':'.$args->{'ccdomain'};
                   10379:     } else {
                   10380:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10381:     }
                   10382:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10383:     if ($args->{'crssections'}) {
                   10384:         $cenv{'internal.sectionnums'} = '';
                   10385:         if ($args->{'crssections'} =~ m/,/) {
                   10386:             @sections = split/,/,$args->{'crssections'};
                   10387:         } else {
                   10388:             $sections[0] = $args->{'crssections'};
                   10389:         }
                   10390:         if (@sections > 0) {
                   10391:             foreach my $item (@sections) {
                   10392:                 my ($sec,$gp) = split/:/,$item;
                   10393:                 my $class = $args->{'crscode'}.$sec;
                   10394:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10395:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10396:                 unless ($addcheck eq 'ok') {
                   10397:                     push @badclasses, $class;
                   10398:                 }
                   10399:             }
                   10400:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10401:         }
                   10402:     }
                   10403: # do not hide course coordinator from staff listing, 
                   10404: # even if privileged
                   10405:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10406: # add crosslistings
                   10407:     if ($args->{'crsxlist'}) {
                   10408:         $cenv{'internal.crosslistings'}='';
                   10409:         if ($args->{'crsxlist'} =~ m/,/) {
                   10410:             @xlists = split/,/,$args->{'crsxlist'};
                   10411:         } else {
                   10412:             $xlists[0] = $args->{'crsxlist'};
                   10413:         }
                   10414:         if (@xlists > 0) {
                   10415:             foreach my $item (@xlists) {
                   10416:                 my ($xl,$gp) = split/:/,$item;
                   10417:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10418:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10419:                 unless ($addcheck eq 'ok') {
                   10420:                     push @badclasses, $xl;
                   10421:                 }
                   10422:             }
                   10423:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10424:         }
                   10425:     }
                   10426:     if ($args->{'autoadds'}) {
                   10427:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10428:     }
                   10429:     if ($args->{'autodrops'}) {
                   10430:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10431:     }
                   10432: # check for notification of enrollment changes
                   10433:     my @notified = ();
                   10434:     if ($args->{'notify_owner'}) {
                   10435:         if ($args->{'ccuname'} ne '') {
                   10436:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10437:         }
                   10438:     }
                   10439:     if ($args->{'notify_dc'}) {
                   10440:         if ($uname ne '') { 
1.630     raeburn  10441:             push(@notified,$uname.':'.$udom);
1.444     albertel 10442:         }
                   10443:     }
                   10444:     if (@notified > 0) {
                   10445:         my $notifylist;
                   10446:         if (@notified > 1) {
                   10447:             $notifylist = join(',',@notified);
                   10448:         } else {
                   10449:             $notifylist = $notified[0];
                   10450:         }
                   10451:         $cenv{'internal.notifylist'} = $notifylist;
                   10452:     }
                   10453:     if (@badclasses > 0) {
                   10454:         my %lt=&Apache::lonlocal::texthash(
                   10455:                 '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',
                   10456:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10457:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10458:         );
1.541     raeburn  10459:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10460:                            ' ('.$lt{'adby'}.')';
                   10461:         if ($context eq 'auto') {
                   10462:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10463:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10464:             foreach my $item (@badclasses) {
                   10465:                 if ($context eq 'auto') {
                   10466:                     $outcome .= " - $item\n";
                   10467:                 } else {
                   10468:                     $outcome .= "<li>$item</li>\n";
                   10469:                 }
                   10470:             }
                   10471:             if ($context eq 'auto') {
                   10472:                 $outcome .= $linefeed;
                   10473:             } else {
1.566     albertel 10474:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10475:             }
                   10476:         } 
1.444     albertel 10477:     }
                   10478:     if ($args->{'no_end_date'}) {
                   10479:         $args->{'endaccess'} = 0;
                   10480:     }
                   10481:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10482:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10483:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10484:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10485:     if ($args->{'showphotos'}) {
                   10486:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10487:     }
                   10488:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10489:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10490:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10491:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10492:             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'); 
                   10493:             if ($context eq 'auto') {
                   10494:                 $outcome .= $krb_msg;
                   10495:             } else {
1.566     albertel 10496:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10497:             }
                   10498:             $outcome .= $linefeed;
1.444     albertel 10499:         }
                   10500:     }
                   10501:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10502:        if ($args->{'setpolicy'}) {
                   10503:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10504:        }
                   10505:        if ($args->{'setcontent'}) {
                   10506:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10507:        }
                   10508:     }
                   10509:     if ($args->{'reshome'}) {
                   10510: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10511: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10512:     }
                   10513: #
                   10514: # course has keyed access
                   10515: #
                   10516:     if ($args->{'setkeys'}) {
                   10517:        $cenv{'keyaccess'}='yes';
                   10518:     }
                   10519: # if specified, key authority is not course, but user
                   10520: # only active if keyaccess is yes
                   10521:     if ($args->{'keyauth'}) {
1.487     albertel 10522: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10523: 	$user = &LONCAPA::clean_username($user);
                   10524: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10525: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10526: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10527: 	}
                   10528:     }
                   10529: 
                   10530:     if ($args->{'disresdis'}) {
                   10531:         $cenv{'pch.roles.denied'}='st';
                   10532:     }
                   10533:     if ($args->{'disablechat'}) {
                   10534:         $cenv{'plc.roles.denied'}='st';
                   10535:     }
                   10536: 
                   10537:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10538:     # course
                   10539:     $cenv{'course.helper.not.run'} = 1;
                   10540:     #
                   10541:     # Use new Randomseed
                   10542:     #
                   10543:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10544:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10545:     #
                   10546:     # The encryption code and receipt prefix for this course
                   10547:     #
                   10548:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10549:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10550:     #
                   10551:     # By default, use standard grading
                   10552:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10553: 
1.541     raeburn  10554:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10555:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10556: #
                   10557: # Open all assignments
                   10558: #
                   10559:     if ($args->{'openall'}) {
                   10560:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10561:        my %storecontent = ($storeunder         => time,
                   10562:                            $storeunder.'.type' => 'date_start');
                   10563:        
                   10564:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10565:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10566:    }
                   10567: #
                   10568: # Set first page
                   10569: #
                   10570:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10571: 	    || ($cloneid)) {
1.445     albertel 10572: 	use LONCAPA::map;
1.444     albertel 10573: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10574: 
                   10575: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10576:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10577: 
1.444     albertel 10578:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10579:         my $title; my $url;
                   10580:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10581: 	    $title=&mt('Syllabus');
1.444     albertel 10582:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10583:         } else {
1.690     bisitz   10584:             $title=&mt('Navigate Contents');
1.444     albertel 10585:             $url='/adm/navmaps';
                   10586:         }
1.445     albertel 10587: 
                   10588:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10589: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10590: 
                   10591: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10592:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10593:     }
1.566     albertel 10594: 
1.925.2.12  raeburn  10595:     if ($args->{'cloneroster'}) {
                   10596:         my ($numadded,$clisterror) = &Apache::lonclonecourse::copyroster($cloneid,$$courseid,$args->{'startaccess'},$args->{'endaccess'});
                   10597:         if ($clisterror) {
                   10598:             $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;
                   10599:             if ($numadded) {
                   10600:                 $outcome .= &mt('Although [quant,_1,student] have received roles in the new course the roster does not report this. It is  ').$linefeed;
                   10601:             } 
                   10602:         } else {
                   10603:             if ($numadded) {
                   10604:                 $outcome .= "\0".&mt('[quant,_1,student] copied from roster for old course to roster for new course.',$numadded).$linefeed;
                   10605:             } else {
                   10606:                 $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;
                   10607:             }
                   10608:         }
                   10609:     }
1.566     albertel 10610:     return (1,$outcome);
1.444     albertel 10611: }
                   10612: 
                   10613: ############################################################
                   10614: ############################################################
                   10615: 
1.378     raeburn  10616: sub course_type {
                   10617:     my ($cid) = @_;
                   10618:     if (!defined($cid)) {
                   10619:         $cid = $env{'request.course.id'};
                   10620:     }
1.404     albertel 10621:     if (defined($env{'course.'.$cid.'.type'})) {
                   10622:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10623:     } else {
                   10624:         return 'Course';
1.377     raeburn  10625:     }
                   10626: }
1.156     albertel 10627: 
1.406     raeburn  10628: sub group_term {
                   10629:     my $crstype = &course_type();
                   10630:     my %names = (
                   10631:                   'Course' => 'group',
1.865     raeburn  10632:                   'Community' => 'group',
1.406     raeburn  10633:                 );
                   10634:     return $names{$crstype};
                   10635: }
                   10636: 
1.902     raeburn  10637: sub course_types {
                   10638:     my @types = ('official','unofficial','community');
                   10639:     my %typename = (
                   10640:                          official   => 'Official course',
                   10641:                          unofficial => 'Unofficial course',
                   10642:                          community  => 'Community',
                   10643:                    );
                   10644:     return (\@types,\%typename);
                   10645: }
                   10646: 
1.156     albertel 10647: sub icon {
                   10648:     my ($file)=@_;
1.505     albertel 10649:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10650:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10651:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10652:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10653: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10654: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10655: 	            $curfext.".gif") {
                   10656: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10657: 		$curfext.".gif";
                   10658: 	}
                   10659:     }
1.249     albertel 10660:     return &lonhttpdurl($iconname);
1.154     albertel 10661: } 
1.84      albertel 10662: 
1.575     albertel 10663: sub lonhttpdurl {
1.692     www      10664: #
                   10665: # Had been used for "small fry" static images on separate port 8080.
                   10666: # Modify here if lightweight http functionality desired again.
                   10667: # Currently eliminated due to increasing firewall issues.
                   10668: #
1.575     albertel 10669:     my ($url)=@_;
1.692     www      10670:     return $url;
1.215     albertel 10671: }
                   10672: 
1.213     albertel 10673: sub connection_aborted {
                   10674:     my ($r)=@_;
                   10675:     $r->print(" ");$r->rflush();
                   10676:     my $c = $r->connection;
                   10677:     return $c->aborted();
                   10678: }
                   10679: 
1.221     foxr     10680: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10681: #    strings as 'strings'.
                   10682: sub escape_single {
1.221     foxr     10683:     my ($input) = @_;
1.223     albertel 10684:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10685:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10686:     return $input;
                   10687: }
1.223     albertel 10688: 
1.222     foxr     10689: #  Same as escape_single, but escape's "'s  This 
                   10690: #  can be used for  "strings"
                   10691: sub escape_double {
                   10692:     my ($input) = @_;
                   10693:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10694:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10695:     return $input;
                   10696: }
1.223     albertel 10697:  
1.222     foxr     10698: #   Escapes the last element of a full URL.
                   10699: sub escape_url {
                   10700:     my ($url)   = @_;
1.238     raeburn  10701:     my @urlslices = split(/\//, $url,-1);
1.369     www      10702:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10703:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10704: }
1.462     albertel 10705: 
1.820     raeburn  10706: sub compare_arrays {
                   10707:     my ($arrayref1,$arrayref2) = @_;
                   10708:     my (@difference,%count);
                   10709:     @difference = ();
                   10710:     %count = ();
                   10711:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10712:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10713:         foreach my $element (keys(%count)) {
                   10714:             if ($count{$element} == 1) {
                   10715:                 push(@difference,$element);
                   10716:             }
                   10717:         }
                   10718:     }
                   10719:     return @difference;
                   10720: }
                   10721: 
1.817     bisitz   10722: # -------------------------------------------------------- Initialize user login
1.462     albertel 10723: sub init_user_environment {
1.463     albertel 10724:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10725:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10726: 
                   10727:     my $public=($username eq 'public' && $domain eq 'public');
                   10728: 
                   10729: # See if old ID present, if so, remove
                   10730: 
                   10731:     my ($filename,$cookie,$userroles);
                   10732:     my $now=time;
                   10733: 
                   10734:     if ($public) {
                   10735: 	my $max_public=100;
                   10736: 	my $oldest;
                   10737: 	my $oldest_time=0;
                   10738: 	for(my $next=1;$next<=$max_public;$next++) {
                   10739: 	    if (-e $lonids."/publicuser_$next.id") {
                   10740: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10741: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10742: 		    $oldest_time=$mtime;
                   10743: 		    $oldest=$next;
                   10744: 		}
                   10745: 	    } else {
                   10746: 		$cookie="publicuser_$next";
                   10747: 		last;
                   10748: 	    }
                   10749: 	}
                   10750: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10751:     } else {
1.463     albertel 10752: 	# if this isn't a robot, kill any existing non-robot sessions
                   10753: 	if (!$args->{'robot'}) {
                   10754: 	    opendir(DIR,$lonids);
                   10755: 	    while ($filename=readdir(DIR)) {
                   10756: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10757: 		    unlink($lonids.'/'.$filename);
                   10758: 		}
1.462     albertel 10759: 	    }
1.463     albertel 10760: 	    closedir(DIR);
1.462     albertel 10761: 	}
                   10762: # Give them a new cookie
1.463     albertel 10763: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10764: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10765: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10766:     
                   10767: # Initialize roles
                   10768: 
                   10769: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10770:     }
                   10771: # ------------------------------------ Check browser type and MathML capability
                   10772: 
                   10773:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10774:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10775: 
                   10776: # ------------------------------------------------------------- Get environment
                   10777: 
                   10778:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10779:     my ($tmp) = keys(%userenv);
                   10780:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10781: 	# default remote control to off
                   10782: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10783:     } else {
                   10784: 	undef(%userenv);
                   10785:     }
                   10786:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10787: 	$form->{'interface'}=$userenv{'interface'};
                   10788:     }
                   10789:     $env{'environment.remote'}=$userenv{'remote'};
                   10790:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10791: 
                   10792: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10793:     foreach my $option ('interface','localpath','localres') {
                   10794:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10795:     }
                   10796: # --------------------------------------------------------- Write first profile
                   10797: 
                   10798:     {
                   10799: 	my %initial_env = 
                   10800: 	    ("user.name"          => $username,
                   10801: 	     "user.domain"        => $domain,
                   10802: 	     "user.home"          => $authhost,
                   10803: 	     "browser.type"       => $clientbrowser,
                   10804: 	     "browser.version"    => $clientversion,
                   10805: 	     "browser.mathml"     => $clientmathml,
                   10806: 	     "browser.unicode"    => $clientunicode,
                   10807: 	     "browser.os"         => $clientos,
                   10808: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10809: 	     "request.course.fn"  => '',
                   10810: 	     "request.course.uri" => '',
                   10811: 	     "request.course.sec" => '',
                   10812: 	     "request.role"       => 'cm',
                   10813: 	     "request.role.adv"   => $env{'user.adv'},
                   10814: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10815: 
                   10816:         if ($form->{'localpath'}) {
                   10817: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10818: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10819:         }
                   10820: 	
                   10821: 	if ($public) {
                   10822: 	    $initial_env{"environment.remote"} = "off";
                   10823: 	}
                   10824: 	if ($form->{'interface'}) {
                   10825: 	    $form->{'interface'}=~s/\W//gs;
                   10826: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10827: 	    $env{'browser.interface'}=$form->{'interface'};
                   10828: 	}
                   10829: 
1.724     raeburn  10830:         foreach my $tool ('aboutme','blog','portfolio') {
                   10831:             $userenv{'availabletools.'.$tool} = 
                   10832:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10833:         }
                   10834: 
1.864     raeburn  10835:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10836:             $userenv{'canrequest.'.$crstype} =
                   10837:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10838:                                                   'reload','requestcourses');
                   10839:         }
                   10840: 
1.462     albertel 10841: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10842: 	
                   10843: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10844: 		 &GDBM_WRCREAT(),0640)) {
                   10845: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10846: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10847: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10848: 	    if (ref($args->{'extra_env'})) {
                   10849: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10850: 	    }
1.462     albertel 10851: 	    untie(%disk_env);
                   10852: 	} else {
1.705     tempelho 10853: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10854: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10855: 	    return 'error: '.$!;
                   10856: 	}
                   10857:     }
                   10858:     $env{'request.role'}='cm';
                   10859:     $env{'request.role.adv'}=$env{'user.adv'};
                   10860:     $env{'browser.type'}=$clientbrowser;
                   10861: 
                   10862:     return $cookie;
                   10863: 
                   10864: }
                   10865: 
                   10866: sub _add_to_env {
                   10867:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10868:     if (ref($env_data) eq 'HASH') {
                   10869:         while (my ($key,$value) = each(%$env_data)) {
                   10870: 	    $idf->{$prefix.$key} = $value;
                   10871: 	    $env{$prefix.$key}   = $value;
                   10872:         }
1.462     albertel 10873:     }
                   10874: }
                   10875: 
1.925.2.8  raeburn  10876: sub new_roles_update {
                   10877:     my $rolecount = 0;
                   10878:     foreach my $envkey (keys(%env)) {
                   10879:         next unless ($envkey =~ /^user\.role\./);
                   10880:         $rolecount ++;
                   10881:     }
1.925.2.9  raeburn  10882:     my $newrolecount = 0;
1.925.2.8  raeburn  10883:     if (!$rolecount) {
                   10884:         my %userenv;
                   10885:         foreach my $crstype ('official','unofficial','community') {
                   10886:             $userenv{'canrequest.'.$crstype} =
                   10887:                 &Apache::lonnet::usertools_access($env{'user.name'},
                   10888:                 $env{'user.domain'},$crstype,'reload','requestcourses');
                   10889:         }
                   10890:         my $then=$env{'user.login.time'};
                   10891:         my $refresh=time;
                   10892:         my (%userroles,%allroles,%allgroups,@newroles);
                   10893:         my %roleshash =
                   10894:             &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active','future','previous'],undef,undef,1);
                   10895:         foreach my $item (keys(%roleshash)) {
                   10896:             my ($uname,$udom,$role,$section) = split(':',$item);
                   10897:             my $where = '/'.$udom.'/'.$uname;
                   10898:             my ($tstart,$tend) = split(':',$roleshash{$item});
                   10899:             if ($section ne '') {
                   10900:                 $where .= '/'.$section;
                   10901:             }
                   10902:             my $spec = $role.'.'.$where;
                   10903:             &Apache::lonnet::set_arearole($role,$where,$tstart,$tend,
                   10904:                                           $env{'user.domain'},$env{'user.name'});
                   10905:             $userroles{'user.role.'.$spec} = $tstart.'.'.$tend;
1.925.2.9  raeburn  10906:             $newrolecount ++;
1.925.2.8  raeburn  10907:             unless (grep(/^\Q$role\E$/,@newroles)) {
                   10908:                 push(@newroles,$role);
                   10909:             }
                   10910:             my $status =
                   10911:                 &Apache::lonnet::curr_role_status($tstart,$tend,$refresh,$then);
                   10912:             if ($status eq 'active') {
                   10913:                 &Apache::lonnet::gather_roleprivs(\%allroles,\%allgroups,\%userroles,
                   10914:                                                   $where,$role,$tstart,$tend);
                   10915:             }
                   10916:         }
                   10917:         if (@newroles) {
                   10918:             my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles,
                   10919:                                                                \%allgroups);
1.925.2.10  raeburn  10920:             &Apache::lonnet::appenv(\%userroles,[@newroles,'cm']);
1.925.2.8  raeburn  10921:             $userenv{'user.adv'} = $adv;
                   10922:             $userenv{'user.author'} = $author;
                   10923:             $userenv{'user.refresh.time'} = $refresh;
                   10924:         }
                   10925:         &Apache::lonnet::appenv(\%userenv);
                   10926:     }
1.925.2.9  raeburn  10927:     return $newrolecount;
1.925.2.8  raeburn  10928: }
                   10929: 
1.685     tempelho 10930: # --- Get the symbolic name of a problem and the url
                   10931: sub get_symb {
                   10932:     my ($request,$silent) = @_;
1.726     raeburn  10933:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10934:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10935:     if ($symb eq '') {
                   10936:         if (!$silent) {
                   10937:             $request->print("Unable to handle ambiguous references:$url:.");
                   10938:             return ();
                   10939:         }
                   10940:     }
                   10941:     &Apache::lonenc::check_decrypt(\$symb);
                   10942:     return ($symb);
                   10943: }
                   10944: 
                   10945: # --------------------------------------------------------------Get annotation
                   10946: 
                   10947: sub get_annotation {
                   10948:     my ($symb,$enc) = @_;
                   10949: 
                   10950:     my $key = $symb;
                   10951:     if (!$enc) {
                   10952:         $key =
                   10953:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10954:     }
                   10955:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10956:     return $annotation{$key};
                   10957: }
                   10958: 
                   10959: sub clean_symb {
1.731     raeburn  10960:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10961: 
                   10962:     &Apache::lonenc::check_decrypt(\$symb);
                   10963:     my $enc = $env{'request.enc'};
1.731     raeburn  10964:     if ($delete_enc) {
1.730     raeburn  10965:         delete($env{'request.enc'});
                   10966:     }
1.685     tempelho 10967: 
                   10968:     return ($symb,$enc);
                   10969: }
1.462     albertel 10970: 
1.925.2.1  raeburn  10971: sub needs_gci_custom {
                   10972:     my $custommenu;
                   10973:     my $numdc = &check_for_gci_dc();
                   10974:     unless ($numdc) {
                   10975:         my $then=$env{'user.login.time'};
                   10976:         my $now = time;
                   10977:         my %cnums = (
                   10978:                         review => '9615072b469884921gcil1',
                   10979:                         submit => '1H96711d710194bfegcil1',
                   10980:                     );
                   10981:         if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
                   10982:             my ($start,$end) =
                   10983:                 split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
                   10984:             if (((!$start) || ($start && $start <= $now)) &&
                   10985:                 ((!$end) || ($end > $now))) {
                   10986:                 $custommenu = 1;
                   10987:                 if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
                   10988:                     my ($ccstart,$ccend) =
                   10989:                         split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
                   10990:                     if (((!$start) || ($start && $start <= $now)) &&
                   10991:                             ((!$end) || ($end > $now))) {
                   10992:                         $custommenu = '';
                   10993:                     }
                   10994:                 }
                   10995:             }
                   10996:         }
                   10997:     }
                   10998:     return $custommenu;
                   10999: }
                   11000: 
                   11001: sub check_for_gci_dc {
                   11002:     my $then=$env{'user.login.time'};
                   11003:     my $numdc = 0;
                   11004:     foreach my $dom ('gci','gcitest') {
                   11005:         if ($env{'user.role.dc./'.$dom.'/'}) {
                   11006:             my $livedc = 1;
                   11007:             my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
                   11008:             if ($tstart && $tstart>$then) { $livedc = 0; }
                   11009:             if ($tend   && $tend  <$then) { $livedc = 0; }
                   11010:             if ($livedc) {
                   11011:                 $numdc++;
                   11012:             }
                   11013:         }
                   11014:     }
                   11015:     return $numdc;
                   11016: }
                   11017: 
                   11018: sub existing_gcitest_courses {
1.925.2.6  raeburn  11019:     my ($role) = @_;
1.925.2.1  raeburn  11020:     my %courses;
                   11021:     my $cdom = 'gcitest';
                   11022:     my $now = time;
                   11023:     foreach my $envkey (keys(%env)) {
                   11024:         my $cnum;
                   11025:         if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
                   11026:             $cnum = $1;
                   11027:         } else {
                   11028:             next;
                   11029:         }
1.925.2.7  raeburn  11030:         my ($tstart,$tend) = split('.',$env{$envkey});
1.925.2.1  raeburn  11031:         if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
1.925.2.3  raeburn  11032:             my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
                   11033:             if ($descr ne '') {
                   11034:                 $courses{$cdom.'_'.$cnum}{'description'} = $descr;
1.925.2.1  raeburn  11035:             }
                   11036:         }
                   11037:     }
                   11038:     return %courses;
                   11039: }
                   11040: 
1.925.2.14! raeburn  11041: sub gcitest_switcher {
        !          11042:     my ($role,$formname,%courses) = @_;
        !          11043:     my $output;
        !          11044:     my %Sortby;
        !          11045:     foreach my $course (sort(keys(%courses))) {
        !          11046:         next unless (ref($courses{$course}) eq 'HASH');
        !          11047:         my $clean_title = $courses{$course}{'description'};
        !          11048:         $clean_title =~ s/\W+//g;
        !          11049:         if ($clean_title eq '') {
        !          11050:             $clean_title = $courses{$course}{'description'};
        !          11051:         }
        !          11052:         push(@{$Sortby{$clean_title}},$course);
        !          11053:     }
        !          11054:     my @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby));
        !          11055:     my $default;
        !          11056:     if (@sorted_courses > 1) {
        !          11057:         if (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
        !          11058:             $default = &mt('Switch concept test ...');
        !          11059:         } else {
        !          11060:             $default = &mt('Select a concept test ...');
        !          11061:         }
        !          11062:     } else {
        !          11063:         unless (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
        !          11064:             $default = &mt('Select concept test ...');
        !          11065:         }
        !          11066:     }
        !          11067:     if ($default) {
        !          11068:         $output = '<form name="'.$formname.'" action="/adm/roles" method="post">'.
        !          11069:                   '<select name="newrole" onchange="javascript:courseswitcher();">'.
        !          11070:                   '<option value="" selected="selected">'.$default.'</option>';
        !          11071:         foreach my $item (@sorted_courses) {
        !          11072:             foreach my $course (@{$Sortby{$item}}) {
        !          11073:                 my ($cdom,$cnum) = split('_',$course);
        !          11074:                 $output .= '<option value="'.$role.'./'.$cdom.'/'.$cnum.'">'.$courses{$course}{'description'}.'</option>';
        !          11075:             }
        !          11076:         }
        !          11077:         $output .= '</select><input type="hidden" name="selectrole" value="" /></form>';
        !          11078:     }
        !          11079:     return $output;
        !          11080: }
        !          11081: 
        !          11082: sub gcitest_switcher_js {
        !          11083:     my ($current,$numcourses,$formname) = @_;
        !          11084:     my $output = <<"ENDJS";
        !          11085: 
        !          11086: function courseswitcher(caller) {
        !          11087:     var numcourses = $numcourses;
        !          11088:     var current = '$current';
        !          11089:     var choice = document.$formname.newrole.options[document.$formname.newrole.selectedIndex].value;
        !          11090:     if (choice == '') {
        !          11091:         if (caller == 'icon') {
        !          11092:             alert('No Concept Test selected');
        !          11093:         }
        !          11094:         document.$formname.selectrole.value = '';
        !          11095:         return;
        !          11096:     }
        !          11097:     if (choice == current) {
        !          11098:         if ((caller != 'icon') && (numcourses > 1)) {
        !          11099:             alert('You have selected the current course.\\nPlease select a different Concept Test course');
        !          11100:         }
        !          11101:         document.$formname.newrole.selectedIndex = 0;
        !          11102:         document.$formname.selectrole.value = '';
        !          11103:         return;
        !          11104:     }
        !          11105:     document.$formname.selectrole.value = '1';
        !          11106:     document.$formname.submit();
        !          11107:     return;
        !          11108: }
        !          11109: 
        !          11110: ENDJS
        !          11111:     return $output;
        !          11112: }
        !          11113: 
        !          11114: 
        !          11115: 
1.41      ng       11116: =pod
                   11117: 
                   11118: =back
                   11119: 
1.112     bowersj2 11120: =cut
1.41      ng       11121: 
1.112     bowersj2 11122: 1;
                   11123: __END__;
1.41      ng       11124: 

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