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

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.23! raeburn     4: # $Id: loncommon.pm,v 1.925.2.22 2010/12/05 17:40:24 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') {
1.925.2.21  raeburn  1983:                     if ($dom =~ /^\w+ci$/) {
1.925.2.13  raeburn  1984:                         $domdesc = 'Faculty';
                   1985:                     } else {
                   1986:                         $domdesc = 'Students';
                   1987:                     }
                   1988:                 } else {
                   1989:                     $domdesc = &Apache::lonnet::domain($dom,'description');
                   1990:                 }
1.563     raeburn  1991:                 if ($domdesc ne '') {
                   1992:                     $selectdomain .= ' ('.$domdesc.')';
                   1993:                 }
                   1994:             } 
                   1995:         }
                   1996:         $selectdomain .= "</option>\n";
1.34      matthew  1997:     }
                   1998:     $selectdomain.="</select>";
                   1999:     return $selectdomain;
                   2000: }
                   2001: 
1.35      matthew  2002: #-------------------------------------------
                   2003: 
1.45      matthew  2004: =pod
                   2005: 
1.648     raeburn  2006: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2007: 
1.586     raeburn  2008: input: 4 arguments (two required, two optional) - 
                   2009:     $domain - domain of new user
                   2010:     $name - name of form element
                   2011:     $default - Value of 'default' causes a default item to be first 
                   2012:                             option, and selected by default. 
                   2013:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2014:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2015: output: returns 2 items: 
1.586     raeburn  2016: (a) form element which contains either:
                   2017:    (i) <select name="$name">
                   2018:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2019:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2020:        </select>
                   2021:        form item if there are multiple library servers in $domain, or
                   2022:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2023:        if there is only one library server in $domain.
                   2024: 
                   2025: (b) number of library servers found.
                   2026: 
                   2027: See loncreateuser.pm for example of use.
1.35      matthew  2028: 
                   2029: =cut
                   2030: 
                   2031: #-------------------------------------------
1.586     raeburn  2032: sub home_server_form_item {
                   2033:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2034:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2035:     my $result;
                   2036:     my $numlib = keys(%servers);
                   2037:     if ($numlib > 1) {
                   2038:         $result .= '<select name="'.$name.'" />'."\n";
                   2039:         if ($default) {
1.804     bisitz   2040:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2041:                        '</option>'."\n";
                   2042:         }
                   2043:         foreach my $hostid (sort(keys(%servers))) {
                   2044:             $result.= '<option value="'.$hostid.'">'.
                   2045: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2046:         }
                   2047:         $result .= '</select>'."\n";
                   2048:     } elsif ($numlib == 1) {
                   2049:         my $hostid;
                   2050:         foreach my $item (keys(%servers)) {
                   2051:             $hostid = $item;
                   2052:         }
                   2053:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2054:                    $hostid.'" />';
                   2055:                    if (!$hide) {
                   2056:                        $result .= $hostid.' '.$servers{$hostid};
                   2057:                    }
                   2058:                    $result .= "\n";
                   2059:     } elsif ($default) {
                   2060:         $result .= '<input type="hidden" name="'.$name.
                   2061:                    '" value="default" />';
                   2062:                    if (!$hide) {
                   2063:                        $result .= &mt('default');
                   2064:                    }
                   2065:                    $result .= "\n";
1.33      matthew  2066:     }
1.586     raeburn  2067:     return ($result,$numlib);
1.33      matthew  2068: }
1.112     bowersj2 2069: 
                   2070: =pod
                   2071: 
1.534     albertel 2072: =back 
                   2073: 
1.112     bowersj2 2074: =cut
1.87      matthew  2075: 
                   2076: ###############################################################
1.112     bowersj2 2077: ##                  Decoding User Agent                      ##
1.87      matthew  2078: ###############################################################
                   2079: 
                   2080: =pod
                   2081: 
1.112     bowersj2 2082: =head1 Decoding the User Agent
                   2083: 
                   2084: =over 4
                   2085: 
                   2086: =item * &decode_user_agent()
1.87      matthew  2087: 
                   2088: Inputs: $r
                   2089: 
                   2090: Outputs:
                   2091: 
                   2092: =over 4
                   2093: 
1.112     bowersj2 2094: =item * $httpbrowser
1.87      matthew  2095: 
1.112     bowersj2 2096: =item * $clientbrowser
1.87      matthew  2097: 
1.112     bowersj2 2098: =item * $clientversion
1.87      matthew  2099: 
1.112     bowersj2 2100: =item * $clientmathml
1.87      matthew  2101: 
1.112     bowersj2 2102: =item * $clientunicode
1.87      matthew  2103: 
1.112     bowersj2 2104: =item * $clientos
1.87      matthew  2105: 
                   2106: =back
                   2107: 
1.157     matthew  2108: =back 
                   2109: 
1.87      matthew  2110: =cut
                   2111: 
                   2112: ###############################################################
                   2113: ###############################################################
                   2114: sub decode_user_agent {
1.247     albertel 2115:     my ($r)=@_;
1.87      matthew  2116:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2117:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2118:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2119:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2120:     my $clientbrowser='unknown';
                   2121:     my $clientversion='0';
                   2122:     my $clientmathml='';
                   2123:     my $clientunicode='0';
                   2124:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2125:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2126: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2127: 	    $clientbrowser=$bname;
                   2128:             $httpbrowser=~/$vreg/i;
                   2129: 	    $clientversion=$1;
                   2130:             $clientmathml=($clientversion>=$minv);
                   2131:             $clientunicode=($clientversion>=$univ);
                   2132: 	}
                   2133:     }
                   2134:     my $clientos='unknown';
                   2135:     if (($httpbrowser=~/linux/i) ||
                   2136:         ($httpbrowser=~/unix/i) ||
                   2137:         ($httpbrowser=~/ux/i) ||
                   2138:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2139:     if (($httpbrowser=~/vax/i) ||
                   2140:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2141:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2142:     if (($httpbrowser=~/mac/i) ||
                   2143:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2144:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2145:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2146:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2147:             $clientunicode,$clientos,);
                   2148: }
                   2149: 
1.32      matthew  2150: ###############################################################
                   2151: ##    Authentication changing form generation subroutines    ##
                   2152: ###############################################################
                   2153: ##
                   2154: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2155: ## hash, and have reasonable default values.
                   2156: ##
                   2157: ##    formname = the name given in the <form> tag.
1.35      matthew  2158: #-------------------------------------------
                   2159: 
1.45      matthew  2160: =pod
                   2161: 
1.112     bowersj2 2162: =head1 Authentication Routines
                   2163: 
                   2164: =over 4
                   2165: 
1.648     raeburn  2166: =item * &authform_xxxxxx()
1.35      matthew  2167: 
                   2168: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2169: handle some of the conveniences required for authentication forms.  
                   2170: This is not an optimal method, but it works.  
                   2171: 
                   2172: =over 4
                   2173: 
1.112     bowersj2 2174: =item * authform_header
1.35      matthew  2175: 
1.112     bowersj2 2176: =item * authform_authorwarning
1.35      matthew  2177: 
1.112     bowersj2 2178: =item * authform_nochange
1.35      matthew  2179: 
1.112     bowersj2 2180: =item * authform_kerberos
1.35      matthew  2181: 
1.112     bowersj2 2182: =item * authform_internal
1.35      matthew  2183: 
1.112     bowersj2 2184: =item * authform_filesystem
1.35      matthew  2185: 
                   2186: =back
                   2187: 
1.648     raeburn  2188: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2189: 
1.35      matthew  2190: =cut
                   2191: 
                   2192: #-------------------------------------------
1.32      matthew  2193: sub authform_header{  
                   2194:     my %in = (
                   2195:         formname => 'cu',
1.80      albertel 2196:         kerb_def_dom => '',
1.32      matthew  2197:         @_,
                   2198:     );
                   2199:     $in{'formname'} = 'document.' . $in{'formname'};
                   2200:     my $result='';
1.80      albertel 2201: 
                   2202: #---------------------------------------------- Code for upper case translation
                   2203:     my $Javascript_toUpperCase;
                   2204:     unless ($in{kerb_def_dom}) {
                   2205:         $Javascript_toUpperCase =<<"END";
                   2206:         switch (choice) {
                   2207:            case 'krb': currentform.elements[choicearg].value =
                   2208:                currentform.elements[choicearg].value.toUpperCase();
                   2209:                break;
                   2210:            default:
                   2211:         }
                   2212: END
                   2213:     } else {
                   2214:         $Javascript_toUpperCase = "";
                   2215:     }
                   2216: 
1.165     raeburn  2217:     my $radioval = "'nochange'";
1.591     raeburn  2218:     if (defined($in{'curr_authtype'})) {
                   2219:         if ($in{'curr_authtype'} ne '') {
                   2220:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2221:         }
1.174     matthew  2222:     }
1.165     raeburn  2223:     my $argfield = 'null';
1.591     raeburn  2224:     if (defined($in{'mode'})) {
1.165     raeburn  2225:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2226:             if (defined($in{'curr_autharg'})) {
                   2227:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2228:                     $argfield = "'$in{'curr_autharg'}'";
                   2229:                 }
                   2230:             }
                   2231:         }
                   2232:     }
                   2233: 
1.32      matthew  2234:     $result.=<<"END";
                   2235: var current = new Object();
1.165     raeburn  2236: current.radiovalue = $radioval;
                   2237: current.argfield = $argfield;
1.32      matthew  2238: 
                   2239: function changed_radio(choice,currentform) {
                   2240:     var choicearg = choice + 'arg';
                   2241:     // If a radio button in changed, we need to change the argfield
                   2242:     if (current.radiovalue != choice) {
                   2243:         current.radiovalue = choice;
                   2244:         if (current.argfield != null) {
                   2245:             currentform.elements[current.argfield].value = '';
                   2246:         }
                   2247:         if (choice == 'nochange') {
                   2248:             current.argfield = null;
                   2249:         } else {
                   2250:             current.argfield = choicearg;
                   2251:             switch(choice) {
                   2252:                 case 'krb': 
                   2253:                     currentform.elements[current.argfield].value = 
                   2254:                         "$in{'kerb_def_dom'}";
                   2255:                 break;
                   2256:               default:
                   2257:                 break;
                   2258:             }
                   2259:         }
                   2260:     }
                   2261:     return;
                   2262: }
1.22      www      2263: 
1.32      matthew  2264: function changed_text(choice,currentform) {
                   2265:     var choicearg = choice + 'arg';
                   2266:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2267:         $Javascript_toUpperCase
1.32      matthew  2268:         // clear old field
                   2269:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2270:             currentform.elements[current.argfield].value = '';
                   2271:         }
                   2272:         current.argfield = choicearg;
                   2273:     }
                   2274:     set_auth_radio_buttons(choice,currentform);
                   2275:     return;
1.20      www      2276: }
1.32      matthew  2277: 
                   2278: function set_auth_radio_buttons(newvalue,currentform) {
                   2279:     var i=0;
                   2280:     while (i < currentform.login.length) {
                   2281:         if (currentform.login[i].value == newvalue) { break; }
                   2282:         i++;
                   2283:     }
                   2284:     if (i == currentform.login.length) {
                   2285:         return;
                   2286:     }
                   2287:     current.radiovalue = newvalue;
                   2288:     currentform.login[i].checked = true;
                   2289:     return;
                   2290: }
                   2291: END
                   2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_authorwarning{
                   2296:     my $result='';
1.144     matthew  2297:     $result='<i>'.
                   2298:         &mt('As a general rule, only authors or co-authors should be '.
                   2299:             'filesystem authenticated '.
                   2300:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2301:     return $result;
                   2302: }
                   2303: 
                   2304: sub authform_nochange{  
                   2305:     my %in = (
                   2306:               formname => 'document.cu',
                   2307:               kerb_def_dom => 'MSU.EDU',
                   2308:               @_,
                   2309:           );
1.586     raeburn  2310:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2311:     my $result;
                   2312:     if (keys(%can_assign) == 0) {
                   2313:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2314:     } else {
                   2315:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2316:                   '<input type="radio" name="login" value="nochange" '.
                   2317:                   'checked="checked" onclick="'.
1.281     albertel 2318:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2319: 	    '</label>';
1.586     raeburn  2320:     }
1.32      matthew  2321:     return $result;
                   2322: }
                   2323: 
1.591     raeburn  2324: sub authform_kerberos {
1.32      matthew  2325:     my %in = (
                   2326:               formname => 'document.cu',
                   2327:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2328:               kerb_def_auth => 'krb4',
1.32      matthew  2329:               @_,
                   2330:               );
1.586     raeburn  2331:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2332:         $autharg,$jscall);
                   2333:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2334:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2335:        $check5 = ' checked="checked"';
1.80      albertel 2336:     } else {
1.772     bisitz   2337:        $check4 = ' checked="checked"';
1.80      albertel 2338:     }
1.165     raeburn  2339:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2340:     if (defined($in{'curr_authtype'})) {
                   2341:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2342:             $krbcheck = ' checked="checked"';
1.623     raeburn  2343:             if (defined($in{'mode'})) {
                   2344:                 if ($in{'mode'} eq 'modifyuser') {
                   2345:                     $krbcheck = '';
                   2346:                 }
                   2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_kerb_ver'})) {
                   2349:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2350:                     $check5 = ' checked="checked"';
1.591     raeburn  2351:                     $check4 = '';
                   2352:                 } else {
1.772     bisitz   2353:                     $check4 = ' checked="checked"';
1.591     raeburn  2354:                     $check5 = '';
                   2355:                 }
1.586     raeburn  2356:             }
1.591     raeburn  2357:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2358:                 $krbarg = $in{'curr_autharg'};
                   2359:             }
1.586     raeburn  2360:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2361:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2362:                     $result = 
                   2363:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2364:         $in{'curr_autharg'},$krbver);
                   2365:                 } else {
                   2366:                     $result =
                   2367:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2368:                 }
                   2369:                 return $result; 
                   2370:             }
                   2371:         }
                   2372:     } else {
                   2373:         if ($authnum == 1) {
1.784     bisitz   2374:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2375:         }
                   2376:     }
1.586     raeburn  2377:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2378:         return;
1.587     raeburn  2379:     } elsif ($authtype eq '') {
1.591     raeburn  2380:         if (defined($in{'mode'})) {
1.587     raeburn  2381:             if ($in{'mode'} eq 'modifycourse') {
                   2382:                 if ($authnum == 1) {
1.784     bisitz   2383:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2384:                 }
                   2385:             }
                   2386:         }
1.586     raeburn  2387:     }
                   2388:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2389:     if ($authtype eq '') {
                   2390:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2391:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2392:                     $krbcheck.' />';
                   2393:     }
                   2394:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2395:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2396:          $in{'curr_authtype'} eq 'krb5') ||
                   2397:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2398:          $in{'curr_authtype'} eq 'krb4')) {
                   2399:         $result .= &mt
1.144     matthew  2400:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2401:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2402:          '<label>'.$authtype,
1.281     albertel 2403:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2404:              'value="'.$krbarg.'" '.
1.144     matthew  2405:              'onchange="'.$jscall.'" />',
1.281     albertel 2406:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2407:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2408: 	 '</label>');
1.586     raeburn  2409:     } elsif ($can_assign{'krb4'}) {
                   2410:         $result .= &mt
                   2411:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2412:          '[_3] Version 4 [_4]',
                   2413:          '<label>'.$authtype,
                   2414:          '</label><input type="text" size="10" name="krbarg" '.
                   2415:              'value="'.$krbarg.'" '.
                   2416:              'onchange="'.$jscall.'" />',
                   2417:          '<label><input type="hidden" name="krbver" value="4" />',
                   2418:          '</label>');
                   2419:     } elsif ($can_assign{'krb5'}) {
                   2420:         $result .= &mt
                   2421:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2422:          '[_3] Version 5 [_4]',
                   2423:          '<label>'.$authtype,
                   2424:          '</label><input type="text" size="10" name="krbarg" '.
                   2425:              'value="'.$krbarg.'" '.
                   2426:              'onchange="'.$jscall.'" />',
                   2427:          '<label><input type="hidden" name="krbver" value="5" />',
                   2428:          '</label>');
                   2429:     }
1.32      matthew  2430:     return $result;
                   2431: }
                   2432: 
                   2433: sub authform_internal{  
1.586     raeburn  2434:     my %in = (
1.32      matthew  2435:                 formname => 'document.cu',
                   2436:                 kerb_def_dom => 'MSU.EDU',
                   2437:                 @_,
                   2438:                 );
1.586     raeburn  2439:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2440:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2441:     if (defined($in{'curr_authtype'})) {
                   2442:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2443:             if ($can_assign{'int'}) {
1.772     bisitz   2444:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2445:                 if (defined($in{'mode'})) {
                   2446:                     if ($in{'mode'} eq 'modifyuser') {
                   2447:                         $intcheck = '';
                   2448:                     }
                   2449:                 }
1.591     raeburn  2450:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2451:                     $intarg = $in{'curr_autharg'};
                   2452:                 }
                   2453:             } else {
                   2454:                 $result = &mt('Currently internally authenticated.');
                   2455:                 return $result;
1.165     raeburn  2456:             }
                   2457:         }
1.586     raeburn  2458:     } else {
                   2459:         if ($authnum == 1) {
1.784     bisitz   2460:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2461:         }
                   2462:     }
                   2463:     if (!$can_assign{'int'}) {
                   2464:         return;
1.587     raeburn  2465:     } elsif ($authtype eq '') {
1.591     raeburn  2466:         if (defined($in{'mode'})) {
1.587     raeburn  2467:             if ($in{'mode'} eq 'modifycourse') {
                   2468:                 if ($authnum == 1) {
1.784     bisitz   2469:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2470:                 }
                   2471:             }
                   2472:         }
1.165     raeburn  2473:     }
1.586     raeburn  2474:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2475:     if ($authtype eq '') {
                   2476:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2477:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2478:     }
1.605     bisitz   2479:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2480:                $intarg.'" onchange="'.$jscall.'" />';
1.925.2.13  raeburn  2481:     my $authtext = '[_1] Internally authenticated (with initial password [_2])';
                   2482:     if ($in{'caller'} eq 'requestcrs') {
                   2483:         $authtext = "[_1] Students' password, if none in the uploaded file: [_2]";
                   2484:     }
                   2485:     $result = &mt($authtext,'<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2486:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2487:     return $result;
                   2488: }
                   2489: 
                   2490: sub authform_local{  
                   2491:     my %in = (
                   2492:               formname => 'document.cu',
                   2493:               kerb_def_dom => 'MSU.EDU',
                   2494:               @_,
                   2495:               );
1.586     raeburn  2496:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2497:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2498:     if (defined($in{'curr_authtype'})) {
                   2499:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2500:             if ($can_assign{'loc'}) {
1.772     bisitz   2501:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2502:                 if (defined($in{'mode'})) {
                   2503:                     if ($in{'mode'} eq 'modifyuser') {
                   2504:                         $loccheck = '';
                   2505:                     }
                   2506:                 }
1.591     raeburn  2507:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2508:                     $locarg = $in{'curr_autharg'};
                   2509:                 }
                   2510:             } else {
                   2511:                 $result = &mt('Currently using local (institutional) authentication.');
                   2512:                 return $result;
1.165     raeburn  2513:             }
                   2514:         }
1.586     raeburn  2515:     } else {
                   2516:         if ($authnum == 1) {
1.784     bisitz   2517:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2518:         }
                   2519:     }
                   2520:     if (!$can_assign{'loc'}) {
                   2521:         return;
1.587     raeburn  2522:     } elsif ($authtype eq '') {
1.591     raeburn  2523:         if (defined($in{'mode'})) {
1.587     raeburn  2524:             if ($in{'mode'} eq 'modifycourse') {
                   2525:                 if ($authnum == 1) {
1.784     bisitz   2526:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2527:                 }
                   2528:             }
                   2529:         }
1.165     raeburn  2530:     }
1.586     raeburn  2531:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2532:     if ($authtype eq '') {
                   2533:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2534:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2535:                     $jscall.'" />';
                   2536:     }
                   2537:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2538:                $locarg.'" onchange="'.$jscall.'" />';
                   2539:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2540:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2541:     return $result;
                   2542: }
                   2543: 
                   2544: sub authform_filesystem{  
                   2545:     my %in = (
                   2546:               formname => 'document.cu',
                   2547:               kerb_def_dom => 'MSU.EDU',
                   2548:               @_,
                   2549:               );
1.586     raeburn  2550:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2551:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2552:     if (defined($in{'curr_authtype'})) {
                   2553:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2554:             if ($can_assign{'fsys'}) {
1.772     bisitz   2555:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2556:                 if (defined($in{'mode'})) {
                   2557:                     if ($in{'mode'} eq 'modifyuser') {
                   2558:                         $fsyscheck = '';
                   2559:                     }
                   2560:                 }
1.586     raeburn  2561:             } else {
                   2562:                 $result = &mt('Currently Filesystem Authenticated.');
                   2563:                 return $result;
                   2564:             }           
                   2565:         }
                   2566:     } else {
                   2567:         if ($authnum == 1) {
1.784     bisitz   2568:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2569:         }
                   2570:     }
                   2571:     if (!$can_assign{'fsys'}) {
                   2572:         return;
1.587     raeburn  2573:     } elsif ($authtype eq '') {
1.591     raeburn  2574:         if (defined($in{'mode'})) {
1.587     raeburn  2575:             if ($in{'mode'} eq 'modifycourse') {
                   2576:                 if ($authnum == 1) {
1.784     bisitz   2577:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2578:                 }
                   2579:             }
                   2580:         }
1.586     raeburn  2581:     }
                   2582:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2583:     if ($authtype eq '') {
                   2584:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2585:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2586:                     $jscall.'" />';
                   2587:     }
                   2588:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2589:                ' onchange="'.$jscall.'" />';
                   2590:     $result = &mt
1.144     matthew  2591:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2592:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2593:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2594:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2595:                   'onchange="'.$jscall.'" />');
1.32      matthew  2596:     return $result;
                   2597: }
                   2598: 
1.586     raeburn  2599: sub get_assignable_auth {
                   2600:     my ($dom) = @_;
                   2601:     if ($dom eq '') {
                   2602:         $dom = $env{'request.role.domain'};
                   2603:     }
                   2604:     my %can_assign = (
                   2605:                           krb4 => 1,
                   2606:                           krb5 => 1,
                   2607:                           int  => 1,
                   2608:                           loc  => 1,
                   2609:                      );
                   2610:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2611:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2612:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2613:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2614:             my $context;
                   2615:             if ($env{'request.role'} =~ /^au/) {
                   2616:                 $context = 'author';
                   2617:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2618:                 $context = 'domain';
                   2619:             } elsif ($env{'request.course.id'}) {
                   2620:                 $context = 'course';
                   2621:             }
                   2622:             if ($context) {
                   2623:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2624:                    %can_assign = %{$authhash->{$context}}; 
                   2625:                 }
                   2626:             }
                   2627:         }
                   2628:     }
                   2629:     my $authnum = 0;
                   2630:     foreach my $key (keys(%can_assign)) {
                   2631:         if ($can_assign{$key}) {
                   2632:             $authnum ++;
                   2633:         }
                   2634:     }
                   2635:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2636:         $authnum --;
                   2637:     }
                   2638:     return ($authnum,%can_assign);
                   2639: }
                   2640: 
1.80      albertel 2641: ###############################################################
                   2642: ##    Get Kerberos Defaults for Domain                 ##
                   2643: ###############################################################
                   2644: ##
                   2645: ## Returns default kerberos version and an associated argument
                   2646: ## as listed in file domain.tab. If not listed, provides
                   2647: ## appropriate default domain and kerberos version.
                   2648: ##
                   2649: #-------------------------------------------
                   2650: 
                   2651: =pod
                   2652: 
1.648     raeburn  2653: =item * &get_kerberos_defaults()
1.80      albertel 2654: 
                   2655: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2656: version and domain. If not found, it defaults to version 4 and the 
                   2657: domain of the server.
1.80      albertel 2658: 
1.648     raeburn  2659: =over 4
                   2660: 
1.80      albertel 2661: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2662: 
1.648     raeburn  2663: =back
                   2664: 
                   2665: =back
                   2666: 
1.80      albertel 2667: =cut
                   2668: 
                   2669: #-------------------------------------------
                   2670: sub get_kerberos_defaults {
                   2671:     my $domain=shift;
1.641     raeburn  2672:     my ($krbdef,$krbdefdom);
                   2673:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2674:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2675:         $krbdef = $domdefaults{'auth_def'};
                   2676:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2677:     } else {
1.80      albertel 2678:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2679:         my $krbdefdom=$1;
                   2680:         $krbdefdom=~tr/a-z/A-Z/;
                   2681:         $krbdef = "krb4";
                   2682:     }
                   2683:     return ($krbdef,$krbdefdom);
                   2684: }
1.112     bowersj2 2685: 
1.32      matthew  2686: 
1.46      matthew  2687: ###############################################################
                   2688: ##                Thesaurus Functions                        ##
                   2689: ###############################################################
1.20      www      2690: 
1.46      matthew  2691: =pod
1.20      www      2692: 
1.112     bowersj2 2693: =head1 Thesaurus Functions
                   2694: 
                   2695: =over 4
                   2696: 
1.648     raeburn  2697: =item * &initialize_keywords()
1.46      matthew  2698: 
                   2699: Initializes the package variable %Keywords if it is empty.  Uses the
                   2700: package variable $thesaurus_db_file.
                   2701: 
                   2702: =cut
                   2703: 
                   2704: ###################################################
                   2705: 
                   2706: sub initialize_keywords {
                   2707:     return 1 if (scalar keys(%Keywords));
                   2708:     # If we are here, %Keywords is empty, so fill it up
                   2709:     #   Make sure the file we need exists...
                   2710:     if (! -e $thesaurus_db_file) {
                   2711:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2712:                                  " failed because it does not exist");
                   2713:         return 0;
                   2714:     }
                   2715:     #   Set up the hash as a database
                   2716:     my %thesaurus_db;
                   2717:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2718:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2719:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2720:                                  $thesaurus_db_file);
                   2721:         return 0;
                   2722:     } 
                   2723:     #  Get the average number of appearances of a word.
                   2724:     my $avecount = $thesaurus_db{'average.count'};
                   2725:     #  Put keywords (those that appear > average) into %Keywords
                   2726:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2727:         my ($count,undef) = split /:/,$data;
                   2728:         $Keywords{$word}++ if ($count > $avecount);
                   2729:     }
                   2730:     untie %thesaurus_db;
                   2731:     # Remove special values from %Keywords.
1.356     albertel 2732:     foreach my $value ('total.count','average.count') {
                   2733:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2734:   }
1.46      matthew  2735:     return 1;
                   2736: }
                   2737: 
                   2738: ###################################################
                   2739: 
                   2740: =pod
                   2741: 
1.648     raeburn  2742: =item * &keyword($word)
1.46      matthew  2743: 
                   2744: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2745: than the average number of times in the thesaurus database.  Calls 
                   2746: &initialize_keywords
                   2747: 
                   2748: =cut
                   2749: 
                   2750: ###################################################
1.20      www      2751: 
                   2752: sub keyword {
1.46      matthew  2753:     return if (!&initialize_keywords());
                   2754:     my $word=lc(shift());
                   2755:     $word=~s/\W//g;
                   2756:     return exists($Keywords{$word});
1.20      www      2757: }
1.46      matthew  2758: 
                   2759: ###############################################################
                   2760: 
                   2761: =pod 
1.20      www      2762: 
1.648     raeburn  2763: =item * &get_related_words()
1.46      matthew  2764: 
1.160     matthew  2765: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2766: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2767: will be returned.  The order of the words returned is determined by the
                   2768: database which holds them.
                   2769: 
                   2770: Uses global $thesaurus_db_file.
                   2771: 
                   2772: =cut
                   2773: 
                   2774: ###############################################################
                   2775: sub get_related_words {
                   2776:     my $keyword = shift;
                   2777:     my %thesaurus_db;
                   2778:     if (! -e $thesaurus_db_file) {
                   2779:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2780:                                  "failed because the file does not exist");
                   2781:         return ();
                   2782:     }
                   2783:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2784:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2785:         return ();
                   2786:     } 
                   2787:     my @Words=();
1.429     www      2788:     my $count=0;
1.46      matthew  2789:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2790: 	# The first element is the number of times
                   2791: 	# the word appears.  We do not need it now.
1.429     www      2792: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2793: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2794: 	my $threshold=$mostfrequentcount/10;
                   2795:         foreach my $possibleword (@RelatedWords) {
                   2796:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2797:             if ($wordcount>$threshold) {
                   2798: 		push(@Words,$word);
                   2799:                 $count++;
                   2800:                 if ($count>10) { last; }
                   2801: 	    }
1.20      www      2802:         }
                   2803:     }
1.46      matthew  2804:     untie %thesaurus_db;
                   2805:     return @Words;
1.14      harris41 2806: }
1.46      matthew  2807: 
1.112     bowersj2 2808: =pod
                   2809: 
                   2810: =back
                   2811: 
                   2812: =cut
1.61      www      2813: 
                   2814: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2815: =pod
                   2816: 
1.112     bowersj2 2817: =head1 User Name Functions
                   2818: 
                   2819: =over 4
                   2820: 
1.648     raeburn  2821: =item * &plainname($uname,$udom,$first)
1.81      albertel 2822: 
1.112     bowersj2 2823: Takes a users logon name and returns it as a string in
1.226     albertel 2824: "first middle last generation" form 
                   2825: if $first is set to 'lastname' then it returns it as
                   2826: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2827: 
                   2828: =cut
1.61      www      2829: 
1.295     www      2830: 
1.81      albertel 2831: ###############################################################
1.61      www      2832: sub plainname {
1.226     albertel 2833:     my ($uname,$udom,$first)=@_;
1.537     albertel 2834:     return if (!defined($uname) || !defined($udom));
1.295     www      2835:     my %names=&getnames($uname,$udom);
1.226     albertel 2836:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2837: 					  $names{'middlename'},
                   2838: 					  $names{'lastname'},
                   2839: 					  $names{'generation'},$first);
                   2840:     $name=~s/^\s+//;
1.62      www      2841:     $name=~s/\s+$//;
                   2842:     $name=~s/\s+/ /g;
1.353     albertel 2843:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2844:     return $name;
1.61      www      2845: }
1.66      www      2846: 
                   2847: # -------------------------------------------------------------------- Nickname
1.81      albertel 2848: =pod
                   2849: 
1.648     raeburn  2850: =item * &nickname($uname,$udom)
1.81      albertel 2851: 
                   2852: Gets a users name and returns it as a string as
                   2853: 
                   2854: "&quot;nickname&quot;"
1.66      www      2855: 
1.81      albertel 2856: if the user has a nickname or
                   2857: 
                   2858: "first middle last generation"
                   2859: 
                   2860: if the user does not
                   2861: 
                   2862: =cut
1.66      www      2863: 
                   2864: sub nickname {
                   2865:     my ($uname,$udom)=@_;
1.537     albertel 2866:     return if (!defined($uname) || !defined($udom));
1.295     www      2867:     my %names=&getnames($uname,$udom);
1.68      albertel 2868:     my $name=$names{'nickname'};
1.66      www      2869:     if ($name) {
                   2870:        $name='&quot;'.$name.'&quot;'; 
                   2871:     } else {
                   2872:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2873: 	     $names{'lastname'}.' '.$names{'generation'};
                   2874:        $name=~s/\s+$//;
                   2875:        $name=~s/\s+/ /g;
                   2876:     }
                   2877:     return $name;
                   2878: }
                   2879: 
1.295     www      2880: sub getnames {
                   2881:     my ($uname,$udom)=@_;
1.537     albertel 2882:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2883:     if ($udom eq 'public' && $uname eq 'public') {
                   2884: 	return ('lastname' => &mt('Public'));
                   2885:     }
1.295     www      2886:     my $id=$uname.':'.$udom;
                   2887:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2888:     if ($cached) {
                   2889: 	return %{$names};
                   2890:     } else {
                   2891: 	my %loadnames=&Apache::lonnet::get('environment',
                   2892:                     ['firstname','middlename','lastname','generation','nickname'],
                   2893: 					 $udom,$uname);
                   2894: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2895: 	return %loadnames;
                   2896:     }
                   2897: }
1.61      www      2898: 
1.542     raeburn  2899: # -------------------------------------------------------------------- getemails
1.648     raeburn  2900: 
1.542     raeburn  2901: =pod
                   2902: 
1.648     raeburn  2903: =item * &getemails($uname,$udom)
1.542     raeburn  2904: 
                   2905: Gets a user's email information and returns it as a hash with keys:
                   2906: notification, critnotification, permanentemail
                   2907: 
                   2908: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2909: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2910:  
1.648     raeburn  2911: 
1.542     raeburn  2912: =cut
                   2913: 
1.648     raeburn  2914: 
1.466     albertel 2915: sub getemails {
                   2916:     my ($uname,$udom)=@_;
                   2917:     if ($udom eq 'public' && $uname eq 'public') {
                   2918: 	return;
                   2919:     }
1.467     www      2920:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2921:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2922:     my $id=$uname.':'.$udom;
                   2923:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2924:     if ($cached) {
                   2925: 	return %{$names};
                   2926:     } else {
                   2927: 	my %loadnames=&Apache::lonnet::get('environment',
                   2928:                     			   ['notification','critnotification',
                   2929: 					    'permanentemail'],
                   2930: 					   $udom,$uname);
                   2931: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2932: 	return %loadnames;
                   2933:     }
                   2934: }
                   2935: 
1.551     albertel 2936: sub flush_email_cache {
                   2937:     my ($uname,$udom)=@_;
                   2938:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2939:     if (!$uname) { $uname=$env{'user.name'};   }
                   2940:     return if ($udom eq 'public' && $uname eq 'public');
                   2941:     my $id=$uname.':'.$udom;
                   2942:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2943: }
                   2944: 
1.728     raeburn  2945: # -------------------------------------------------------------------- getlangs
                   2946: 
                   2947: =pod
                   2948: 
                   2949: =item * &getlangs($uname,$udom)
                   2950: 
                   2951: Gets a user's language preference and returns it as a hash with key:
                   2952: language.
                   2953: 
                   2954: =cut
                   2955: 
                   2956: 
                   2957: sub getlangs {
                   2958:     my ($uname,$udom) = @_;
                   2959:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2960:     if (!$uname) { $uname=$env{'user.name'};   }
                   2961:     my $id=$uname.':'.$udom;
                   2962:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2963:     if ($cached) {
                   2964:         return %{$langs};
                   2965:     } else {
                   2966:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2967:                                            $udom,$uname);
                   2968:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2969:         return %loadlangs;
                   2970:     }
                   2971: }
                   2972: 
                   2973: sub flush_langs_cache {
                   2974:     my ($uname,$udom)=@_;
                   2975:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2976:     if (!$uname) { $uname=$env{'user.name'};   }
                   2977:     return if ($udom eq 'public' && $uname eq 'public');
                   2978:     my $id=$uname.':'.$udom;
                   2979:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2980: }
                   2981: 
1.61      www      2982: # ------------------------------------------------------------------ Screenname
1.81      albertel 2983: 
                   2984: =pod
                   2985: 
1.648     raeburn  2986: =item * &screenname($uname,$udom)
1.81      albertel 2987: 
                   2988: Gets a users screenname and returns it as a string
                   2989: 
                   2990: =cut
1.61      www      2991: 
                   2992: sub screenname {
                   2993:     my ($uname,$udom)=@_;
1.258     albertel 2994:     if ($uname eq $env{'user.name'} &&
                   2995: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2996:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2997:     return $names{'screenname'};
1.62      www      2998: }
                   2999: 
1.212     albertel 3000: 
1.802     bisitz   3001: # ------------------------------------------------------------- Confirm Wrapper
                   3002: =pod
                   3003: 
                   3004: =item confirmwrapper
                   3005: 
                   3006: Wrap messages about completion of operation in box
                   3007: 
                   3008: =cut
                   3009: 
                   3010: sub confirmwrapper {
                   3011:     my ($message)=@_;
                   3012:     if ($message) {
                   3013:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3014:                .$message."\n"
                   3015:                .'</div>'."\n";
                   3016:     } else {
                   3017:         return $message;
                   3018:     }
                   3019: }
                   3020: 
1.62      www      3021: # ------------------------------------------------------------- Message Wrapper
                   3022: 
                   3023: sub messagewrapper {
1.369     www      3024:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3025:     return 
1.441     albertel 3026:         '<a href="/adm/email?compose=individual&amp;'.
                   3027:         'recname='.$username.'&amp;recdom='.$domain.
                   3028: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3029:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3030: }
1.802     bisitz   3031: 
1.74      www      3032: # --------------------------------------------------------------- Notes Wrapper
                   3033: 
                   3034: sub noteswrapper {
                   3035:     my ($link,$un,$do)=@_;
                   3036:     return 
1.896     amueller 3037: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3038: }
1.802     bisitz   3039: 
1.62      www      3040: # ------------------------------------------------------------- Aboutme Wrapper
                   3041: 
                   3042: sub aboutmewrapper {
1.166     www      3043:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3044:     if (!defined($username)  && !defined($domain)) {
                   3045:         return;
                   3046:     }
1.892     amueller 3047:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3048: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3049: }
                   3050: 
                   3051: # ------------------------------------------------------------ Syllabus Wrapper
                   3052: 
                   3053: sub syllabuswrapper {
1.707     bisitz   3054:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3055:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3056: }
1.14      harris41 3057: 
1.802     bisitz   3058: # -----------------------------------------------------------------------------
                   3059: 
1.208     matthew  3060: sub track_student_link {
1.887     raeburn  3061:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3062:     my $link ="/adm/trackstudent?";
1.208     matthew  3063:     my $title = 'View recent activity';
                   3064:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3065:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3066:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3067:         $title .= ' of this student';
1.268     albertel 3068:     } 
1.208     matthew  3069:     if (defined($target) && $target !~ /^\s*$/) {
                   3070:         $target = qq{target="$target"};
                   3071:     } else {
                   3072:         $target = '';
                   3073:     }
1.268     albertel 3074:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3075:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3076:     $title = &mt($title);
                   3077:     $linktext = &mt($linktext);
1.448     albertel 3078:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3079: 	&help_open_topic('View_recent_activity');
1.208     matthew  3080: }
                   3081: 
1.781     raeburn  3082: sub slot_reservations_link {
                   3083:     my ($linktext,$sname,$sdom,$target) = @_;
                   3084:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3085:     my $title = 'View slot reservation history';
                   3086:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3087:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3088:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3089:         $title .= ' of this student';
                   3090:     }
                   3091:     if (defined($target) && $target !~ /^\s*$/) {
                   3092:         $target = qq{target="$target"};
                   3093:     } else {
                   3094:         $target = '';
                   3095:     }
                   3096:     $title = &mt($title);
                   3097:     $linktext = &mt($linktext);
                   3098:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3099: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3100: 
                   3101: }
                   3102: 
1.508     www      3103: # ===================================================== Display a student photo
                   3104: 
                   3105: 
1.509     albertel 3106: sub student_image_tag {
1.508     www      3107:     my ($domain,$user)=@_;
                   3108:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3109:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3110: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3111:     } else {
                   3112: 	return '';
                   3113:     }
                   3114: }
                   3115: 
1.112     bowersj2 3116: =pod
                   3117: 
                   3118: =back
                   3119: 
                   3120: =head1 Access .tab File Data
                   3121: 
                   3122: =over 4
                   3123: 
1.648     raeburn  3124: =item * &languageids() 
1.112     bowersj2 3125: 
                   3126: returns list of all language ids
                   3127: 
                   3128: =cut
                   3129: 
1.14      harris41 3130: sub languageids {
1.16      harris41 3131:     return sort(keys(%language));
1.14      harris41 3132: }
                   3133: 
1.112     bowersj2 3134: =pod
                   3135: 
1.648     raeburn  3136: =item * &languagedescription() 
1.112     bowersj2 3137: 
                   3138: returns description of a specified language id
                   3139: 
                   3140: =cut
                   3141: 
1.14      harris41 3142: sub languagedescription {
1.125     www      3143:     my $code=shift;
                   3144:     return  ($supported_language{$code}?'* ':'').
                   3145:             $language{$code}.
1.126     www      3146: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3147: }
                   3148: 
                   3149: sub plainlanguagedescription {
                   3150:     my $code=shift;
                   3151:     return $language{$code};
                   3152: }
                   3153: 
                   3154: sub supportedlanguagecode {
                   3155:     my $code=shift;
                   3156:     return $supported_language{$code};
1.97      www      3157: }
                   3158: 
1.112     bowersj2 3159: =pod
                   3160: 
1.648     raeburn  3161: =item * &copyrightids() 
1.112     bowersj2 3162: 
                   3163: returns list of all copyrights
                   3164: 
                   3165: =cut
                   3166: 
                   3167: sub copyrightids {
                   3168:     return sort(keys(%cprtag));
                   3169: }
                   3170: 
                   3171: =pod
                   3172: 
1.648     raeburn  3173: =item * &copyrightdescription() 
1.112     bowersj2 3174: 
                   3175: returns description of a specified copyright id
                   3176: 
                   3177: =cut
                   3178: 
                   3179: sub copyrightdescription {
1.166     www      3180:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3181: }
1.197     matthew  3182: 
                   3183: =pod
                   3184: 
1.648     raeburn  3185: =item * &source_copyrightids() 
1.192     taceyjo1 3186: 
                   3187: returns list of all source copyrights
                   3188: 
                   3189: =cut
                   3190: 
                   3191: sub source_copyrightids {
                   3192:     return sort(keys(%scprtag));
                   3193: }
                   3194: 
                   3195: =pod
                   3196: 
1.648     raeburn  3197: =item * &source_copyrightdescription() 
1.192     taceyjo1 3198: 
                   3199: returns description of a specified source copyright id
                   3200: 
                   3201: =cut
                   3202: 
                   3203: sub source_copyrightdescription {
                   3204:     return &mt($scprtag{shift(@_)});
                   3205: }
1.112     bowersj2 3206: 
                   3207: =pod
                   3208: 
1.648     raeburn  3209: =item * &filecategories() 
1.112     bowersj2 3210: 
                   3211: returns list of all file categories
                   3212: 
                   3213: =cut
                   3214: 
                   3215: sub filecategories {
                   3216:     return sort(keys(%category_extensions));
                   3217: }
                   3218: 
                   3219: =pod
                   3220: 
1.648     raeburn  3221: =item * &filecategorytypes() 
1.112     bowersj2 3222: 
                   3223: returns list of file types belonging to a given file
                   3224: category
                   3225: 
                   3226: =cut
                   3227: 
                   3228: sub filecategorytypes {
1.356     albertel 3229:     my ($cat) = @_;
                   3230:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3231: }
                   3232: 
                   3233: =pod
                   3234: 
1.648     raeburn  3235: =item * &fileembstyle() 
1.112     bowersj2 3236: 
                   3237: returns embedding style for a specified file type
                   3238: 
                   3239: =cut
                   3240: 
                   3241: sub fileembstyle {
                   3242:     return $fe{lc(shift(@_))};
1.169     www      3243: }
                   3244: 
1.351     www      3245: sub filemimetype {
                   3246:     return $fm{lc(shift(@_))};
                   3247: }
                   3248: 
1.169     www      3249: 
                   3250: sub filecategoryselect {
                   3251:     my ($name,$value)=@_;
1.189     matthew  3252:     return &select_form($value,$name,
1.169     www      3253: 			'' => &mt('Any category'),
                   3254: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3255: }
                   3256: 
                   3257: =pod
                   3258: 
1.648     raeburn  3259: =item * &filedescription() 
1.112     bowersj2 3260: 
                   3261: returns description for a specified file type
                   3262: 
                   3263: =cut
                   3264: 
                   3265: sub filedescription {
1.188     matthew  3266:     my $file_description = $fd{lc(shift())};
                   3267:     $file_description =~ s:([\[\]]):~$1:g;
                   3268:     return &mt($file_description);
1.112     bowersj2 3269: }
                   3270: 
                   3271: =pod
                   3272: 
1.648     raeburn  3273: =item * &filedescriptionex() 
1.112     bowersj2 3274: 
                   3275: returns description for a specified file type with
                   3276: extra formatting
                   3277: 
                   3278: =cut
                   3279: 
                   3280: sub filedescriptionex {
                   3281:     my $ex=shift;
1.188     matthew  3282:     my $file_description = $fd{lc($ex)};
                   3283:     $file_description =~ s:([\[\]]):~$1:g;
                   3284:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3285: }
                   3286: 
                   3287: # End of .tab access
                   3288: =pod
                   3289: 
                   3290: =back
                   3291: 
                   3292: =cut
                   3293: 
                   3294: # ------------------------------------------------------------------ File Types
                   3295: sub fileextensions {
                   3296:     return sort(keys(%fe));
                   3297: }
                   3298: 
1.97      www      3299: # ----------------------------------------------------------- Display Languages
                   3300: # returns a hash with all desired display languages
                   3301: #
                   3302: 
                   3303: sub display_languages {
                   3304:     my %languages=();
1.695     raeburn  3305:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3306: 	$languages{$lang}=1;
1.97      www      3307:     }
                   3308:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3309:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3310: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3311: 	    $languages{$lang}=1;
1.97      www      3312:         }
                   3313:     }
                   3314:     return %languages;
1.14      harris41 3315: }
                   3316: 
1.582     albertel 3317: sub languages {
                   3318:     my ($possible_langs) = @_;
1.695     raeburn  3319:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3320:     if (!ref($possible_langs)) {
                   3321: 	if( wantarray ) {
                   3322: 	    return @preferred_langs;
                   3323: 	} else {
                   3324: 	    return $preferred_langs[0];
                   3325: 	}
                   3326:     }
                   3327:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3328:     my @preferred_possibilities;
                   3329:     foreach my $preferred_lang (@preferred_langs) {
                   3330: 	if (exists($possibilities{$preferred_lang})) {
                   3331: 	    push(@preferred_possibilities, $preferred_lang);
                   3332: 	}
                   3333:     }
                   3334:     if( wantarray ) {
                   3335: 	return @preferred_possibilities;
                   3336:     }
                   3337:     return $preferred_possibilities[0];
                   3338: }
                   3339: 
1.742     raeburn  3340: sub user_lang {
                   3341:     my ($touname,$toudom,$fromcid) = @_;
                   3342:     my @userlangs;
                   3343:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3344:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3345:                     $env{'course.'.$fromcid.'.languages'}));
                   3346:     } else {
                   3347:         my %langhash = &getlangs($touname,$toudom);
                   3348:         if ($langhash{'languages'} ne '') {
                   3349:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3350:         } else {
                   3351:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3352:             if ($domdefs{'lang_def'} ne '') {
                   3353:                 @userlangs = ($domdefs{'lang_def'});
                   3354:             }
                   3355:         }
                   3356:     }
                   3357:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3358:     my $user_lh = Apache::localize->get_handle(@languages);
                   3359:     return $user_lh;
                   3360: }
                   3361: 
                   3362: 
1.112     bowersj2 3363: ###############################################################
                   3364: ##               Student Answer Attempts                     ##
                   3365: ###############################################################
                   3366: 
                   3367: =pod
                   3368: 
                   3369: =head1 Alternate Problem Views
                   3370: 
                   3371: =over 4
                   3372: 
1.648     raeburn  3373: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3374:     $getattempt, $regexp, $gradesub)
                   3375: 
                   3376: Return string with previous attempt on problem. Arguments:
                   3377: 
                   3378: =over 4
                   3379: 
                   3380: =item * $symb: Problem, including path
                   3381: 
                   3382: =item * $username: username of the desired student
                   3383: 
                   3384: =item * $domain: domain of the desired student
1.14      harris41 3385: 
1.112     bowersj2 3386: =item * $course: Course ID
1.14      harris41 3387: 
1.112     bowersj2 3388: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3389:     something
1.14      harris41 3390: 
1.112     bowersj2 3391: =item * $regexp: if string matches this regexp, the string will be
                   3392:     sent to $gradesub
1.14      harris41 3393: 
1.112     bowersj2 3394: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3395: 
1.112     bowersj2 3396: =back
1.14      harris41 3397: 
1.112     bowersj2 3398: The output string is a table containing all desired attempts, if any.
1.16      harris41 3399: 
1.112     bowersj2 3400: =cut
1.1       albertel 3401: 
                   3402: sub get_previous_attempt {
1.43      ng       3403:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3404:   my $prevattempts='';
1.43      ng       3405:   no strict 'refs';
1.1       albertel 3406:   if ($symb) {
1.3       albertel 3407:     my (%returnhash)=
                   3408:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3409:     if ($returnhash{'version'}) {
                   3410:       my %lasthash=();
                   3411:       my $version;
                   3412:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3413:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3414: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3415:         }
1.1       albertel 3416:       }
1.596     albertel 3417:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3418:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3419:       foreach my $key (sort(keys(%lasthash))) {
                   3420: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3421: 	if ($#parts > 0) {
1.31      albertel 3422: 	  my $data=$parts[-1];
                   3423: 	  pop(@parts);
1.596     albertel 3424: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3425: 	} else {
1.41      ng       3426: 	  if ($#parts == 0) {
                   3427: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3428: 	  } else {
                   3429: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3430: 	  }
1.31      albertel 3431: 	}
1.16      harris41 3432:       }
1.596     albertel 3433:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3434:       if ($getattempt eq '') {
                   3435: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3436: 	  $prevattempts.=&start_data_table_row().
                   3437: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3438: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3439: 		my $value = &format_previous_attempt_value($key,
                   3440: 							   $returnhash{$version.':'.$key});
                   3441: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3442: 	    }
1.596     albertel 3443: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3444: 	 }
1.1       albertel 3445:       }
1.596     albertel 3446:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3447:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3448: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3449: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3450: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3451:       }
1.596     albertel 3452:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3453:     } else {
1.596     albertel 3454:       $prevattempts=
                   3455: 	  &start_data_table().&start_data_table_row().
                   3456: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3457: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3458:     }
                   3459:   } else {
1.596     albertel 3460:     $prevattempts=
                   3461: 	  &start_data_table().&start_data_table_row().
                   3462: 	  '<td>'.&mt('No data.').'</td>'.
                   3463: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3464:   }
1.10      albertel 3465: }
                   3466: 
1.581     albertel 3467: sub format_previous_attempt_value {
                   3468:     my ($key,$value) = @_;
                   3469:     if ($key =~ /timestamp/) {
                   3470: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3471:     } elsif (ref($value) eq 'ARRAY') {
                   3472: 	$value = '('.join(', ', @{ $value }).')';
                   3473:     } else {
                   3474: 	$value = &unescape($value);
                   3475:     }
                   3476:     return $value;
                   3477: }
                   3478: 
                   3479: 
1.107     albertel 3480: sub relative_to_absolute {
                   3481:     my ($url,$output)=@_;
                   3482:     my $parser=HTML::TokeParser->new(\$output);
                   3483:     my $token;
                   3484:     my $thisdir=$url;
                   3485:     my @rlinks=();
                   3486:     while ($token=$parser->get_token) {
                   3487: 	if ($token->[0] eq 'S') {
                   3488: 	    if ($token->[1] eq 'a') {
                   3489: 		if ($token->[2]->{'href'}) {
                   3490: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3491: 		}
                   3492: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3493: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3494: 	    } elsif ($token->[1] eq 'base') {
                   3495: 		$thisdir=$token->[2]->{'href'};
                   3496: 	    }
                   3497: 	}
                   3498:     }
                   3499:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3500:     foreach my $link (@rlinks) {
1.726     raeburn  3501: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3502: 		($link=~/^\//) ||
                   3503: 		($link=~/^javascript:/i) ||
                   3504: 		($link=~/^mailto:/i) ||
                   3505: 		($link=~/^\#/)) {
                   3506: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3507: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3508: 	}
                   3509:     }
                   3510: # -------------------------------------------------- Deal with Applet codebases
                   3511:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3512:     return $output;
                   3513: }
                   3514: 
1.112     bowersj2 3515: =pod
                   3516: 
1.648     raeburn  3517: =item * &get_student_view()
1.112     bowersj2 3518: 
                   3519: show a snapshot of what student was looking at
                   3520: 
                   3521: =cut
                   3522: 
1.10      albertel 3523: sub get_student_view {
1.186     albertel 3524:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3525:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3526:   my (%form);
1.10      albertel 3527:   my @elements=('symb','courseid','domain','username');
                   3528:   foreach my $element (@elements) {
1.186     albertel 3529:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3530:   }
1.186     albertel 3531:   if (defined($moreenv)) {
                   3532:       %form=(%form,%{$moreenv});
                   3533:   }
1.236     albertel 3534:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3535:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3536:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3537:   $userview=~s/\<body[^\>]*\>//gi;
                   3538:   $userview=~s/\<\/body\>//gi;
                   3539:   $userview=~s/\<html\>//gi;
                   3540:   $userview=~s/\<\/html\>//gi;
                   3541:   $userview=~s/\<head\>//gi;
                   3542:   $userview=~s/\<\/head\>//gi;
                   3543:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3544:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3545:   if (wantarray) {
                   3546:      return ($userview,$response);
                   3547:   } else {
                   3548:      return $userview;
                   3549:   }
                   3550: }
                   3551: 
                   3552: sub get_student_view_with_retries {
                   3553:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3554: 
                   3555:     my $ok = 0;                 # True if we got a good response.
                   3556:     my $content;
                   3557:     my $response;
                   3558: 
                   3559:     # Try to get the student_view done. within the retries count:
                   3560:     
                   3561:     do {
                   3562:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3563:          $ok      = $response->is_success;
                   3564:          if (!$ok) {
                   3565:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3566:          }
                   3567:          $retries--;
                   3568:     } while (!$ok && ($retries > 0));
                   3569:     
                   3570:     if (!$ok) {
                   3571:        $content = '';          # On error return an empty content.
                   3572:     }
1.651     www      3573:     if (wantarray) {
                   3574:        return ($content, $response);
                   3575:     } else {
                   3576:        return $content;
                   3577:     }
1.11      albertel 3578: }
                   3579: 
1.112     bowersj2 3580: =pod
                   3581: 
1.648     raeburn  3582: =item * &get_student_answers() 
1.112     bowersj2 3583: 
                   3584: show a snapshot of how student was answering problem
                   3585: 
                   3586: =cut
                   3587: 
1.11      albertel 3588: sub get_student_answers {
1.100     sakharuk 3589:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3590:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3591:   my (%moreenv);
1.11      albertel 3592:   my @elements=('symb','courseid','domain','username');
                   3593:   foreach my $element (@elements) {
1.186     albertel 3594:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3595:   }
1.186     albertel 3596:   $moreenv{'grade_target'}='answer';
                   3597:   %moreenv=(%form,%moreenv);
1.497     raeburn  3598:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3599:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3600:   return $userview;
1.1       albertel 3601: }
1.116     albertel 3602: 
                   3603: =pod
                   3604: 
                   3605: =item * &submlink()
                   3606: 
1.242     albertel 3607: Inputs: $text $uname $udom $symb $target
1.116     albertel 3608: 
                   3609: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3610: 
                   3611: =cut
                   3612: 
                   3613: ###############################################
                   3614: sub submlink {
1.242     albertel 3615:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3616:     if (!($uname && $udom)) {
                   3617: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3618: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3619: 	if (!$symb) { $symb=$cursymb; }
                   3620:     }
1.254     matthew  3621:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3622:     $symb=&escape($symb);
1.242     albertel 3623:     if ($target) { $target="target=\"$target\""; }
                   3624:     return '<a href="/adm/grades?&command=submission&'.
                   3625: 	'symb='.$symb.'&student='.$uname.
                   3626: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3627: }
                   3628: ##############################################
                   3629: 
                   3630: =pod
                   3631: 
                   3632: =item * &pgrdlink()
                   3633: 
                   3634: Inputs: $text $uname $udom $symb $target
                   3635: 
                   3636: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3637: 
                   3638: =cut
                   3639: 
                   3640: ###############################################
                   3641: sub pgrdlink {
                   3642:     my $link=&submlink(@_);
                   3643:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3644:     return $link;
                   3645: }
                   3646: ##############################################
                   3647: 
                   3648: =pod
                   3649: 
                   3650: =item * &pprmlink()
                   3651: 
                   3652: Inputs: $text $uname $udom $symb $target
                   3653: 
                   3654: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3655: student and a specific resource
1.242     albertel 3656: 
                   3657: =cut
                   3658: 
                   3659: ###############################################
                   3660: sub pprmlink {
                   3661:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3662:     if (!($uname && $udom)) {
                   3663: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3664: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3665: 	if (!$symb) { $symb=$cursymb; }
                   3666:     }
1.254     matthew  3667:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3668:     $symb=&escape($symb);
1.242     albertel 3669:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3670:     return '<a href="/adm/parmset?command=set&amp;'.
                   3671: 	'symb='.$symb.'&amp;uname='.$uname.
                   3672: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3673: }
                   3674: ##############################################
1.37      matthew  3675: 
1.112     bowersj2 3676: =pod
                   3677: 
                   3678: =back
                   3679: 
                   3680: =cut
                   3681: 
1.37      matthew  3682: ###############################################
1.51      www      3683: 
                   3684: 
                   3685: sub timehash {
1.687     raeburn  3686:     my ($thistime) = @_;
                   3687:     my $timezone = &Apache::lonlocal::gettimezone();
                   3688:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3689:                      ->set_time_zone($timezone);
                   3690:     my $wday = $dt->day_of_week();
                   3691:     if ($wday == 7) { $wday = 0; }
                   3692:     return ( 'second' => $dt->second(),
                   3693:              'minute' => $dt->minute(),
                   3694:              'hour'   => $dt->hour(),
                   3695:              'day'     => $dt->day_of_month(),
                   3696:              'month'   => $dt->month(),
                   3697:              'year'    => $dt->year(),
                   3698:              'weekday' => $wday,
                   3699:              'dayyear' => $dt->day_of_year(),
                   3700:              'dlsav'   => $dt->is_dst() );
1.51      www      3701: }
                   3702: 
1.370     www      3703: sub utc_string {
                   3704:     my ($date)=@_;
1.371     www      3705:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3706: }
                   3707: 
1.51      www      3708: sub maketime {
                   3709:     my %th=@_;
1.687     raeburn  3710:     my ($epoch_time,$timezone,$dt);
                   3711:     $timezone = &Apache::lonlocal::gettimezone();
                   3712:     eval {
                   3713:         $dt = DateTime->new( year   => $th{'year'},
                   3714:                              month  => $th{'month'},
                   3715:                              day    => $th{'day'},
                   3716:                              hour   => $th{'hour'},
                   3717:                              minute => $th{'minute'},
                   3718:                              second => $th{'second'},
                   3719:                              time_zone => $timezone,
                   3720:                          );
                   3721:     };
                   3722:     if (!$@) {
                   3723:         $epoch_time = $dt->epoch;
                   3724:         if ($epoch_time) {
                   3725:             return $epoch_time;
                   3726:         }
                   3727:     }
1.51      www      3728:     return POSIX::mktime(
                   3729:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3730:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3731: }
                   3732: 
                   3733: #########################################
1.51      www      3734: 
                   3735: sub findallcourses {
1.482     raeburn  3736:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3737:     my %roles;
                   3738:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3739:     my %courses;
1.51      www      3740:     my $now=time;
1.482     raeburn  3741:     if (!defined($uname)) {
                   3742:         $uname = $env{'user.name'};
                   3743:     }
                   3744:     if (!defined($udom)) {
                   3745:         $udom = $env{'user.domain'};
                   3746:     }
                   3747:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3748:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3749:         if (!%roles) {
                   3750:             %roles = (
                   3751:                        cc => 1,
1.907     raeburn  3752:                        co => 1,
1.482     raeburn  3753:                        in => 1,
                   3754:                        ep => 1,
                   3755:                        ta => 1,
                   3756:                        cr => 1,
                   3757:                        st => 1,
                   3758:              );
                   3759:         }
                   3760:         foreach my $entry (keys(%roleshash)) {
                   3761:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3762:             if ($trole =~ /^cr/) { 
                   3763:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3764:             } else {
                   3765:                 next if (!exists($roles{$trole}));
                   3766:             }
                   3767:             if ($tend) {
                   3768:                 next if ($tend < $now);
                   3769:             }
                   3770:             if ($tstart) {
                   3771:                 next if ($tstart > $now);
                   3772:             }
                   3773:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3774:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3775:             if ($secpart eq '') {
                   3776:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3777:                 $sec = 'none';
                   3778:                 $realsec = '';
                   3779:             } else {
                   3780:                 $cnum = $cnumpart;
                   3781:                 ($sec,$role) = split(/_/,$secpart);
                   3782:                 $realsec = $sec;
1.490     raeburn  3783:             }
1.482     raeburn  3784:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3785:         }
                   3786:     } else {
                   3787:         foreach my $key (keys(%env)) {
1.483     albertel 3788: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3789:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3790: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3791: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3792: 	        next if (%roles && !exists($roles{$role}));
                   3793: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3794:                 my $active=1;
                   3795:                 if ($starttime) {
                   3796: 		    if ($now<$starttime) { $active=0; }
                   3797:                 }
                   3798:                 if ($endtime) {
                   3799:                     if ($now>$endtime) { $active=0; }
                   3800:                 }
                   3801:                 if ($active) {
                   3802:                     if ($sec eq '') {
                   3803:                         $sec = 'none';
                   3804:                     }
                   3805:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3806:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3807:                 }
                   3808:             }
1.51      www      3809:         }
                   3810:     }
1.474     raeburn  3811:     return %courses;
1.51      www      3812: }
1.37      matthew  3813: 
1.54      www      3814: ###############################################
1.474     raeburn  3815: 
                   3816: sub blockcheck {
1.482     raeburn  3817:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3818: 
                   3819:     if (!defined($udom)) {
                   3820:         $udom = $env{'user.domain'};
                   3821:     }
                   3822:     if (!defined($uname)) {
                   3823:         $uname = $env{'user.name'};
                   3824:     }
                   3825: 
                   3826:     # If uname and udom are for a course, check for blocks in the course.
                   3827: 
                   3828:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3829:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3830:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3831:         return ($startblock,$endblock);
                   3832:     }
1.474     raeburn  3833: 
1.502     raeburn  3834:     my $startblock = 0;
                   3835:     my $endblock = 0;
1.482     raeburn  3836:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3837: 
1.490     raeburn  3838:     # If uname is for a user, and activity is course-specific, i.e.,
                   3839:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3840: 
1.490     raeburn  3841:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3842:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3843:         foreach my $key (keys(%live_courses)) {
                   3844:             if ($key ne $env{'request.course.id'}) {
                   3845:                 delete($live_courses{$key});
                   3846:             }
                   3847:         }
                   3848:     }
                   3849: 
                   3850:     my $otheruser = 0;
                   3851:     my %own_courses;
                   3852:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3853:         # Resource belongs to user other than current user.
                   3854:         $otheruser = 1;
                   3855:         # Gather courses for current user
                   3856:         %own_courses = 
                   3857:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3858:     }
                   3859: 
                   3860:     # Gather active course roles - course coordinator, instructor, 
                   3861:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3862: 
                   3863:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3864:         my ($cdom,$cnum);
                   3865:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3866:             $cdom = $env{'course.'.$course.'.domain'};
                   3867:             $cnum = $env{'course.'.$course.'.num'};
                   3868:         } else {
1.490     raeburn  3869:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3870:         }
                   3871:         my $no_ownblock = 0;
                   3872:         my $no_userblock = 0;
1.533     raeburn  3873:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3874:             # Check if current user has 'evb' priv for this
                   3875:             if (defined($own_courses{$course})) {
                   3876:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3877:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3878:                     if ($sec ne 'none') {
                   3879:                         $checkrole .= '/'.$sec;
                   3880:                     }
                   3881:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3882:                         $no_ownblock = 1;
                   3883:                         last;
                   3884:                     }
                   3885:                 }
                   3886:             }
                   3887:             # if they have 'evb' priv and are currently not playing student
                   3888:             next if (($no_ownblock) &&
                   3889:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3890:         }
1.474     raeburn  3891:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3892:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3893:             if ($sec ne 'none') {
1.482     raeburn  3894:                 $checkrole .= '/'.$sec;
1.474     raeburn  3895:             }
1.490     raeburn  3896:             if ($otheruser) {
                   3897:                 # Resource belongs to user other than current user.
                   3898:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3899:                 my ($trole,$tdom,$tnum,$tsec);
                   3900:                 my $entry = $live_courses{$course}{$sec};
                   3901:                 if ($entry =~ /^cr/) {
                   3902:                     ($trole,$tdom,$tnum,$tsec) = 
                   3903:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3904:                 } else {
                   3905:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3906:                 }
                   3907:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3908:                 $area = '/'.$tdom.'/'.$tnum;
                   3909:                 $trest = $tnum;
                   3910:                 if ($tsec ne '') {
                   3911:                     $area .= '/'.$tsec;
                   3912:                     $trest .= '/'.$tsec;
                   3913:                 }
                   3914:                 $spec = $trole.'.'.$area;
                   3915:                 if ($trole =~ /^cr/) {
                   3916:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3917:                                                       $tdom,$spec,$trest,$area);
                   3918:                 } else {
                   3919:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3920:                                                        $tdom,$spec,$trest,$area);
                   3921:                 }
                   3922:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3923:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3924:                     if ($1) {
                   3925:                         $no_userblock = 1;
                   3926:                         last;
                   3927:                     }
                   3928:                 }
1.490     raeburn  3929:             } else {
                   3930:                 # Resource belongs to current user
                   3931:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3932:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3933:                     $no_ownblock = 1;
                   3934:                     last;
                   3935:                 }
1.474     raeburn  3936:             }
                   3937:         }
                   3938:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3939:         next if (($no_ownblock) &&
1.491     albertel 3940:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3941:         next if ($no_userblock);
1.474     raeburn  3942: 
1.866     kalberla 3943:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3944:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3945:         
                   3946:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3947:         if (($start != 0) && 
                   3948:             (($startblock == 0) || ($startblock > $start))) {
                   3949:             $startblock = $start;
                   3950:         }
                   3951:         if (($end != 0)  &&
                   3952:             (($endblock == 0) || ($endblock < $end))) {
                   3953:             $endblock = $end;
                   3954:         }
1.490     raeburn  3955:     }
                   3956:     return ($startblock,$endblock);
                   3957: }
                   3958: 
                   3959: sub get_blocks {
                   3960:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3961:     my $startblock = 0;
                   3962:     my $endblock = 0;
                   3963:     my $course = $cdom.'_'.$cnum;
                   3964:     $setters->{$course} = {};
                   3965:     $setters->{$course}{'staff'} = [];
                   3966:     $setters->{$course}{'times'} = [];
                   3967:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3968:     foreach my $record (keys(%records)) {
                   3969:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3970:         if ($start <= time && $end >= time) {
                   3971:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3972:                 &parse_block_record($records{$record});
                   3973:             if ($blocks->{$activity} eq 'on') {
                   3974:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3975:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3976:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3977:                     $startblock = $start;
1.490     raeburn  3978:                 }
1.491     albertel 3979:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3980:                     $endblock = $end;
1.474     raeburn  3981:                 }
                   3982:             }
                   3983:         }
                   3984:     }
                   3985:     return ($startblock,$endblock);
                   3986: }
                   3987: 
                   3988: sub parse_block_record {
                   3989:     my ($record) = @_;
                   3990:     my ($setuname,$setudom,$title,$blocks);
                   3991:     if (ref($record) eq 'HASH') {
                   3992:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3993:         $title = &unescape($record->{'event'});
                   3994:         $blocks = $record->{'blocks'};
                   3995:     } else {
                   3996:         my @data = split(/:/,$record,3);
                   3997:         if (scalar(@data) eq 2) {
                   3998:             $title = $data[1];
                   3999:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4000:         } else {
                   4001:             ($setuname,$setudom,$title) = @data;
                   4002:         }
                   4003:         $blocks = { 'com' => 'on' };
                   4004:     }
                   4005:     return ($setuname,$setudom,$title,$blocks);
                   4006: }
                   4007: 
1.854     kalberla 4008: sub blocking_status {
                   4009:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4010:   my %setters;
1.890     droeschl 4011: 
                   4012:   # check for active blocking
1.867     kalberla 4013:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4014: 
1.890     droeschl 4015:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4016: 
                   4017:   # caller just wants to know whether a block is active
                   4018:   if (!wantarray) { return $blocked; }
                   4019: 
                   4020:   # build a link to a popup window containing the details
                   4021:   my $querystring  = "?activity=$activity";
                   4022:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4023:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4024:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4025: 
                   4026:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4027:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4028:         var options = "width=" + w + ",height=" + h + ",";
                   4029:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4030:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4031:         var newWin = window.open(url, wdwName, options);
                   4032:         newWin.focus();
                   4033:     }
1.890     droeschl 4034: END_MYBLOCK
1.854     kalberla 4035: 
1.890     droeschl 4036:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4037:   
1.854     kalberla 4038:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4039:   my $text = mt('Communication Blocked');
                   4040: 
1.867     kalberla 4041:   $output .= <<"END_BLOCK";
                   4042: <div class='LC_comblock'>
1.869     kalberla 4043:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4044:   title='$text'>
                   4045:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4046:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4047:   title='$text'>$text</a>
1.867     kalberla 4048: </div>
                   4049: 
                   4050: END_BLOCK
1.474     raeburn  4051: 
1.854     kalberla 4052:   return ($blocked, $output);
                   4053: }
1.490     raeburn  4054: 
1.60      matthew  4055: ###############################################
                   4056: 
1.682     raeburn  4057: sub check_ip_acc {
                   4058:     my ($acc)=@_;
                   4059:     &Apache::lonxml::debug("acc is $acc");
                   4060:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4061:         return 1;
                   4062:     }
                   4063:     my $allowed=0;
                   4064:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4065: 
                   4066:     my $name;
                   4067:     foreach my $pattern (split(',',$acc)) {
                   4068:         $pattern =~ s/^\s*//;
                   4069:         $pattern =~ s/\s*$//;
                   4070:         if ($pattern =~ /\*$/) {
                   4071:             #35.8.*
                   4072:             $pattern=~s/\*//;
                   4073:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4074:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4075:             #35.8.3.[34-56]
                   4076:             my $low=$2;
                   4077:             my $high=$3;
                   4078:             $pattern=$1;
                   4079:             if ($ip =~ /^\Q$pattern\E/) {
                   4080:                 my $last=(split(/\./,$ip))[3];
                   4081:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4082:             }
                   4083:         } elsif ($pattern =~ /^\*/) {
                   4084:             #*.msu.edu
                   4085:             $pattern=~s/\*//;
                   4086:             if (!defined($name)) {
                   4087:                 use Socket;
                   4088:                 my $netaddr=inet_aton($ip);
                   4089:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4090:             }
                   4091:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4092:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4093:             #127.0.0.1
                   4094:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4095:         } else {
                   4096:             #some.name.com
                   4097:             if (!defined($name)) {
                   4098:                 use Socket;
                   4099:                 my $netaddr=inet_aton($ip);
                   4100:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4101:             }
                   4102:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4103:         }
                   4104:         if ($allowed) { last; }
                   4105:     }
                   4106:     return $allowed;
                   4107: }
                   4108: 
                   4109: ###############################################
                   4110: 
1.60      matthew  4111: =pod
                   4112: 
1.112     bowersj2 4113: =head1 Domain Template Functions
                   4114: 
                   4115: =over 4
                   4116: 
                   4117: =item * &determinedomain()
1.60      matthew  4118: 
                   4119: Inputs: $domain (usually will be undef)
                   4120: 
1.63      www      4121: Returns: Determines which domain should be used for designs
1.60      matthew  4122: 
                   4123: =cut
1.54      www      4124: 
1.60      matthew  4125: ###############################################
1.63      www      4126: sub determinedomain {
                   4127:     my $domain=shift;
1.531     albertel 4128:     if (! $domain) {
1.60      matthew  4129:         # Determine domain if we have not been given one
1.893     raeburn  4130:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4131:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4132:         if ($env{'request.role.domain'}) { 
                   4133:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4134:         }
                   4135:     }
1.63      www      4136:     return $domain;
                   4137: }
                   4138: ###############################################
1.517     raeburn  4139: 
1.518     albertel 4140: sub devalidate_domconfig_cache {
                   4141:     my ($udom)=@_;
                   4142:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4143: }
                   4144: 
                   4145: # ---------------------- Get domain configuration for a domain
                   4146: sub get_domainconf {
                   4147:     my ($udom) = @_;
                   4148:     my $cachetime=1800;
                   4149:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4150:     if (defined($cached)) { return %{$result}; }
                   4151: 
                   4152:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4153: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4154:     my (%designhash,%legacy);
1.518     albertel 4155:     if (keys(%domconfig) > 0) {
                   4156:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4157:             if (keys(%{$domconfig{'login'}})) {
                   4158:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4159:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4160:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4161:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4162:                                 $domconfig{'login'}{$key}{$img};
                   4163:                         }
                   4164:                     } else {
                   4165:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4166:                     }
1.632     raeburn  4167:                 }
                   4168:             } else {
                   4169:                 $legacy{'login'} = 1;
1.518     albertel 4170:             }
1.632     raeburn  4171:         } else {
                   4172:             $legacy{'login'} = 1;
1.518     albertel 4173:         }
                   4174:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4175:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4176:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4177:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4178:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4179:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4180:                         }
1.518     albertel 4181:                     }
                   4182:                 }
1.632     raeburn  4183:             } else {
                   4184:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4185:             }
1.632     raeburn  4186:         } else {
                   4187:             $legacy{'rolecolors'} = 1;
1.518     albertel 4188:         }
1.632     raeburn  4189:         if (keys(%legacy) > 0) {
                   4190:             my %legacyhash = &get_legacy_domconf($udom);
                   4191:             foreach my $item (keys(%legacyhash)) {
                   4192:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4193:                     if ($legacy{'login'}) { 
                   4194:                         $designhash{$item} = $legacyhash{$item};
                   4195:                     }
                   4196:                 } else {
                   4197:                     if ($legacy{'rolecolors'}) {
                   4198:                         $designhash{$item} = $legacyhash{$item};
                   4199:                     }
1.518     albertel 4200:                 }
                   4201:             }
                   4202:         }
1.632     raeburn  4203:     } else {
                   4204:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4205:     }
                   4206:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4207: 				  $cachetime);
                   4208:     return %designhash;
                   4209: }
                   4210: 
1.632     raeburn  4211: sub get_legacy_domconf {
                   4212:     my ($udom) = @_;
                   4213:     my %legacyhash;
                   4214:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4215:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4216:     if (-e $designfile) {
                   4217:         if ( open (my $fh,"<$designfile") ) {
                   4218:             while (my $line = <$fh>) {
                   4219:                 next if ($line =~ /^\#/);
                   4220:                 chomp($line);
                   4221:                 my ($key,$val)=(split(/\=/,$line));
                   4222:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4223:             }
                   4224:             close($fh);
                   4225:         }
                   4226:     }
                   4227:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4228:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4229:     }
                   4230:     return %legacyhash;
                   4231: }
                   4232: 
1.63      www      4233: =pod
                   4234: 
1.112     bowersj2 4235: =item * &domainlogo()
1.63      www      4236: 
                   4237: Inputs: $domain (usually will be undef)
                   4238: 
                   4239: Returns: A link to a domain logo, if the domain logo exists.
                   4240: If the domain logo does not exist, a description of the domain.
                   4241: 
                   4242: =cut
1.112     bowersj2 4243: 
1.63      www      4244: ###############################################
                   4245: sub domainlogo {
1.517     raeburn  4246:     my $domain = &determinedomain(shift);
1.518     albertel 4247:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4248:     # See if there is a logo
                   4249:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4250:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4251:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4252: 	    if ($imgsrc =~ m{^/res/}) {
                   4253: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4254: 		&Apache::lonnet::repcopy($local_name);
                   4255: 	    }
                   4256: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4257:         } 
                   4258:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4259:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4260:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4261:     } else {
1.60      matthew  4262:         return '';
1.59      www      4263:     }
                   4264: }
1.63      www      4265: ##############################################
                   4266: 
                   4267: =pod
                   4268: 
1.112     bowersj2 4269: =item * &designparm()
1.63      www      4270: 
                   4271: Inputs: $which parameter; $domain (usually will be undef)
                   4272: 
                   4273: Returns: value of designparamter $which
                   4274: 
                   4275: =cut
1.112     bowersj2 4276: 
1.397     albertel 4277: 
1.400     albertel 4278: ##############################################
1.397     albertel 4279: sub designparm {
                   4280:     my ($which,$domain)=@_;
                   4281:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4282:         return $env{'environment.color.'.$which};
1.96      www      4283:     }
1.63      www      4284:     $domain=&determinedomain($domain);
1.518     albertel 4285:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4286:     my $output;
1.517     raeburn  4287:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4288:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4289:     } else {
1.520     raeburn  4290:         $output = $defaultdesign{$which};
                   4291:     }
                   4292:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4293:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4294:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4295:             if ($output =~ m{^/res/}) {
                   4296:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4297:                 &Apache::lonnet::repcopy($local_name);
                   4298:             }
1.520     raeburn  4299:             $output = &lonhttpdurl($output);
                   4300:         }
1.63      www      4301:     }
1.520     raeburn  4302:     return $output;
1.63      www      4303: }
1.59      www      4304: 
1.822     bisitz   4305: ##############################################
                   4306: =pod
                   4307: 
1.832     bisitz   4308: =item * &authorspace()
                   4309: 
                   4310: Inputs: ./.
                   4311: 
                   4312: Returns: Path to the Construction Space of the current user's
                   4313:          accessed author space
                   4314:          The author space will be that of the current user
                   4315:          when accessing the own author space
                   4316:          and that of the co-author/assistent co-author
                   4317:          when accessing the co-author's/assistent co-author's
                   4318:          space
                   4319: 
                   4320: =cut
                   4321: 
                   4322: sub authorspace {
                   4323:     my $caname = '';
                   4324:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4325:         (undef,$caname) =
                   4326:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4327:     } else {
                   4328:         $caname = $env{'user.name'};
                   4329:     }
                   4330:     return '/priv/'.$caname.'/';
                   4331: }
                   4332: 
                   4333: ##############################################
                   4334: =pod
                   4335: 
1.822     bisitz   4336: =item * &head_subbox()
                   4337: 
                   4338: Inputs: $content (contains HTML code with page functions, etc.)
                   4339: 
                   4340: Returns: HTML div with $content
                   4341:          To be included in page header
                   4342: 
                   4343: =cut
                   4344: 
                   4345: sub head_subbox {
                   4346:     my ($content)=@_;
                   4347:     my $output =
1.844     bisitz   4348:         '<div id="LC_head_subbox">'
1.822     bisitz   4349:        .$content
                   4350:        .'</div>'
                   4351: }
                   4352: 
                   4353: ##############################################
                   4354: =pod
                   4355: 
                   4356: =item * &CSTR_pageheader()
                   4357: 
                   4358: Inputs: ./.
                   4359: 
                   4360: Returns: HTML div with CSTR path and recent box
                   4361:          To be included on Construction Space pages
                   4362: 
                   4363: =cut
                   4364: 
                   4365: sub CSTR_pageheader {
                   4366:     # this is for resources; directories have customtitle, and crumbs
                   4367:             # and select recent are created in lonpubdir.pm  
                   4368:     my ($uname,$thisdisfn)=
                   4369:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4370:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4371:     $formaction=~s/\/+/\//g;
                   4372: 
                   4373:     my $parentpath = '';
                   4374:     my $lastitem = '';
                   4375:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4376:         $parentpath = $1;
                   4377:         $lastitem = $2;
                   4378:     } else {
                   4379:         $lastitem = $thisdisfn;
                   4380:     }
1.921     bisitz   4381: 
                   4382:     my $output =
1.822     bisitz   4383:          '<div>'
                   4384:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4385:         .'<b>'.&mt('Construction Space:').'</b> '
                   4386:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4387:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
                   4388:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
                   4389: 
                   4390:     if ($lastitem) {
                   4391:         $output .=
                   4392:              '<span class="LC_filename">'
                   4393:             .$lastitem
                   4394:             .'</span>';
                   4395:     }
                   4396:     $output .=
                   4397:          '<br />'
1.822     bisitz   4398:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4399:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4400:         .'</form>'
                   4401:         .&Apache::lonmenu::constspaceform()
                   4402:         .'</div>';
1.921     bisitz   4403: 
                   4404:     return $output;
1.822     bisitz   4405: }
                   4406: 
1.60      matthew  4407: ###############################################
                   4408: ###############################################
                   4409: 
                   4410: =pod
                   4411: 
1.112     bowersj2 4412: =back
                   4413: 
1.549     albertel 4414: =head1 HTML Helpers
1.112     bowersj2 4415: 
                   4416: =over 4
                   4417: 
                   4418: =item * &bodytag()
1.60      matthew  4419: 
                   4420: Returns a uniform header for LON-CAPA web pages.
                   4421: 
                   4422: Inputs: 
                   4423: 
1.112     bowersj2 4424: =over 4
                   4425: 
                   4426: =item * $title, A title to be displayed on the page.
                   4427: 
                   4428: =item * $function, the current role (can be undef).
                   4429: 
                   4430: =item * $addentries, extra parameters for the <body> tag.
                   4431: 
                   4432: =item * $bodyonly, if defined, only return the <body> tag.
                   4433: 
                   4434: =item * $domain, if defined, force a given domain.
                   4435: 
                   4436: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4437:             text interface only)
1.60      matthew  4438: 
1.814     bisitz   4439: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4440:                      navigational links
1.317     albertel 4441: 
1.338     albertel 4442: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4443: 
1.361     albertel 4444: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4445:          'Switch To Inline Menu' link
                   4446: 
1.460     albertel 4447: =item * $args, optional argument valid values are
                   4448:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4449:             inherit_jsmath -> when creating popup window in a page,
                   4450:                               should it have jsmath forced on by the
                   4451:                               current page
1.460     albertel 4452: 
1.112     bowersj2 4453: =back
                   4454: 
1.60      matthew  4455: Returns: A uniform header for LON-CAPA web pages.  
                   4456: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4457: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4458: other decorations will be returned.
                   4459: 
                   4460: =cut
                   4461: 
1.54      www      4462: sub bodytag {
1.831     bisitz   4463:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4464:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4465: 
1.925.2.19  raeburn  4466:     my $public;
                   4467:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4468:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4469:         $public = 1;
                   4470:     }
1.460     albertel 4471:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4472: 
1.183     matthew  4473:     $function = &get_users_function() if (!$function);
1.339     albertel 4474:     my $img =    &designparm($function.'.img',$domain);
                   4475:     my $font =   &designparm($function.'.font',$domain);
                   4476:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4477: 
1.803     bisitz   4478:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4479: 		   'bgcolor' => $pgbg,
1.339     albertel 4480: 		   'text'    => $font,
                   4481:                    'alink'   => &designparm($function.'.alink',$domain),
                   4482: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4483: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4484:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4485: 
1.925.2.4  raeburn  4486:     my $custommenu;
                   4487:     if ($env{'environment.remote'} eq 'off') {
                   4488:         $custommenu = &needs_gci_custom();
                   4489:     }
1.63      www      4490:  # role and realm
1.378     raeburn  4491:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4492:     if ($role  eq 'ca') {
1.479     albertel 4493:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4494:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4495:     } 
1.55      www      4496: # realm
1.258     albertel 4497:     if ($env{'request.course.id'}) {
1.378     raeburn  4498:         if ($env{'request.role'} !~ /^cr/) {
1.925.2.17  raeburn  4499:             if (($custommenu) && (($role eq 'cm') || ($env{'form.context'} eq 'requestcrs'))) {
1.925.2.4  raeburn  4500:                 undef($role);
                   4501:             } else {
                   4502:                 $role = &Apache::lonnet::plaintext($role,&course_type());
                   4503:             }
1.378     raeburn  4504:         }
1.925.2.17  raeburn  4505:         if (defined($role) && $env{'request.course.sec'}) {
1.898     raeburn  4506:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
1.925.2.17  raeburn  4507:         }
                   4508:         if ($env{'form.context'} eq 'requestcrs') {
                   4509:             undef($realm);
                   4510:         } else {
                   4511: 	    $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
                   4512:         }
1.378     raeburn  4513:     } else {
1.925.2.4  raeburn  4514:         if (($custommenu) && ($role eq 'cm')) {
                   4515:             undef($role);
                   4516:         } else {
                   4517:             $role = &Apache::lonnet::plaintext($role);
                   4518:         }
1.54      www      4519:     }
1.433     albertel 4520: 
1.359     albertel 4521:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4522: # Set messages
1.60      matthew  4523:     my $messages=&domainlogo($domain);
1.330     albertel 4524: 
1.438     albertel 4525:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4526: 
1.101     www      4527: # construct main body tag
1.359     albertel 4528:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4529: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4530: 
1.530     albertel 4531:     if ($bodyonly) {
1.60      matthew  4532:         return $bodytag;
1.798     tempelho 4533:     } 
1.359     albertel 4534: 
1.410     albertel 4535:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.925.2.19  raeburn  4536:     if ($public) {
1.433     albertel 4537: 	undef($role);
1.434     albertel 4538:     } else {
                   4539: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4540:     }
1.359     albertel 4541:     
1.762     bisitz   4542:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4543:     #
                   4544:     # Extra info if you are the DC
                   4545:     my $dc_info = '';
                   4546:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4547:                         $env{'course.'.$env{'request.course.id'}.
                   4548:                                  '.domain'}.'/'})) {
                   4549:         my $cid = $env{'request.course.id'};
1.917     raeburn  4550:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4551:         $dc_info =~ s/\s+$//;
1.359     albertel 4552:     }
                   4553: 
1.898     raeburn  4554:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4555:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4556: 
1.925.2.19  raeburn  4557:     if ($env{'environment.remote'} ne 'on') {
1.359     albertel 4558:         # No Remote
1.916     droeschl 4559:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4560:             return $bodytag; 
                   4561:         } 
1.903     droeschl 4562: 
                   4563:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4564: 
                   4565:         #    if ($env{'request.state'} eq 'construct') {
                   4566:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4567:         #    }
                   4568: 
1.925.2.4  raeburn  4569:         my $role_selector;
1.925.2.17  raeburn  4570:         if (($custommenu) && !($env{'form.context'} eq 'requestcrs') && 
                   4571:             ($env{'request.course.id'}) && 
1.925.2.21  raeburn  4572:             ($env{'course.'.$env{'request.course.id'}.'.domain'} =~ /^\w+citest$/)) {
1.925.2.4  raeburn  4573:             $role_selector = &Apache::lonmenu::roles_selector(
                   4574:                         $env{'course.' . $env{'request.course.id'} . '.domain'},
                   4575:                         $env{'course.' . $env{'request.course.id'} . '.num'}  );
                   4576:             if ($role_selector) {
                   4577:                 $role_selector = '<br />'.$role_selector;
                   4578:             }
                   4579:         }
1.925.2.14  raeburn  4580:         my $cid = $env{'request.course.id'};
1.925.2.21  raeburn  4581:         my %cicourses;
                   4582:         my $udom = $env{'user.domain'};
                   4583:         my %allnums = &get_faculty_cnums();
1.925.2.23! raeburn  4584:         if (($udom ne '') && (ref($allnums{$udom}) eq 'HASH')) {
1.925.2.21  raeburn  4585:              foreach my $key (%{$allnums{$udom}}) {
                   4586:                  $cicourses{$udom.'_'.$key} = $allnums{$udom}->{$key};
                   4587:              }
                   4588:         }
                   4589:         if (($custommenu && $cid && !$cicourses{$cid}) && 
1.925.2.17  raeburn  4590:              !($env{'form.context'} eq 'requestcrs') ||
1.925.2.21  raeburn  4591:              ($env{'user.domain'} =~ /^\w+citest$/)) {
1.925.2.14  raeburn  4592:             my $role = 'st';
                   4593:             if ($custommenu) {
                   4594:                 $role = 'cc';
                   4595:             }
                   4596:             my ($switcher_js,$switcher,$formname);
                   4597:             $formname = 'pickrole';
                   4598:             my %courses = &existing_gcitest_courses($role);
                   4599:             my $numcourses = keys(%courses);
                   4600:             my $reqdcount = 0;
                   4601:             if ($cid) {
                   4602:                 if ($courses{$cid}) {
                   4603:                     $reqdcount = 1; 
                   4604:                 }
                   4605:             }
                   4606:             if ($numcourses > $reqdcount) {
                   4607:                 $switcher = &gcitest_switcher($role,$formname,%courses);
                   4608:                 my $current;
                   4609:                 if ($cid) {
                   4610:                     $current = $role.'./'.$env{'course.'.$cid.'.domain'}.
                   4611:                                '/'.$env{'course.'.$cid.'.num'};
                   4612:                 }
1.925.2.21  raeburn  4613:                 $switcher_js = &gcitest_switcher_js($current,$numcourses,$formname);
1.925.2.14  raeburn  4614:                 if ($switcher_js) {  
                   4615:                     $switcher_js= <<"ENDSCRIPT";
                   4616: <script type="text/javascript">
                   4617: // <![CDATA[
                   4618: 
                   4619: $switcher_js
                   4620: 
                   4621: // ]]>
                   4622: </script>
                   4623: ENDSCRIPT
                   4624:                 }
                   4625:             }
                   4626:             if ($switcher) {
                   4627:                 $switcher = $switcher_js.$switcher;
                   4628:                 if ($role_selector) {
                   4629:                     $role_selector .= '&nbsp;&nbsp;&nbsp;'.$switcher;
                   4630:                 } else {
                   4631:                     $role_selector .= '<br />'.$switcher;
                   4632:                 }
                   4633:             }
                   4634:         }
1.359     albertel 4635: 
1.916     droeschl 4636:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4637:              if ($dc_info) {
                   4638:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4639:              }
1.916     droeschl 4640:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4641:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4642:             return $bodytag;
                   4643:         }
1.925.2.17  raeburn  4644:         if ($env{'request.noversionuri'} eq '/adm/navmaps' &&
                   4645:                 $env{'environment.remotenavmap'} eq 'on') {
                   4646:             return $bodytag;
                   4647:         }
1.894     droeschl 4648: 
1.925.2.21  raeburn  4649:         if ($cid && $cicourses{$cid} eq 'tutorial') {
1.925.2.14  raeburn  4650:             $bodytag .= '<div class="LC_page_header">';
1.925.2.17  raeburn  4651:         }
                   4652:  
1.925.2.4  raeburn  4653:         $bodytag .= qq|<div id="LC_nav_bar">$name $role $role_selector</div>|;
1.916     droeschl 4654: 
1.903     droeschl 4655:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.925.2.2  raeburn  4656:             Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
1.816     bisitz   4657: 
1.903     droeschl 4658:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4659: 
1.917     raeburn  4660:         if ($dc_info) {
                   4661:             $dc_info = &dc_courseid_toggle($dc_info);
                   4662:         }
                   4663:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.925.2.21  raeburn  4664:         if ($cid && $cicourses{$cid} eq 'tutorial') {
1.925.2.14  raeburn  4665:             $bodytag .= '</div>';
                   4666:         }
1.916     droeschl 4667: 
1.903     droeschl 4668:         #don't show menus for public users
1.925.2.19  raeburn  4669:         if(!$public){
1.925.2.5  raeburn  4670:             if (($custommenu) && 
1.925.2.21  raeburn  4671:                 ($env{'request.role'} !~ m{^st\./(\w+)citest/$match_courseid})) {
1.925.2.2  raeburn  4672:                 $bodytag .= &Apache::lonmenu::gci_secondary_menu();
1.925.2.16  raeburn  4673:             } elsif ($env{'request.role'} ne 'cm' || &check_for_gci_dc()) {    
1.925.2.2  raeburn  4674:                 $bodytag .= Apache::lonmenu::secondary_menu();
                   4675:             }
1.903     droeschl 4676:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4677:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4678:             if ($env{'request.state'} eq 'construct') {
                   4679:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
                   4680:                                 $args->{'bread_crumbs'});
                   4681:             } elsif ($forcereg) { 
                   4682:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
1.925.2.14  raeburn  4683:             } elsif ($custommenu && $env{'request.course.id'} && 
                   4684:                      &Apache::lonnet::allowed('mdc', $env{'request.course.id'})) {
1.925.2.17  raeburn  4685:                 if ((($env{'request.noversionuri'} eq '/adm/navmaps') && 
                   4686:                     ($env{'request.noversionuri'} ne 'on')) ||
                   4687:                     (($env{'request.noversionuri'} eq '/adm/coursedocs') &&
                   4688:                      (!($env{'form.context'} eq 'requestcrs'))) ||
                   4689:                     (($env{'request.noversionuri'} eq '/adm/createuser') &&
                   4690:                      (!($env{'form.context'} eq 'requestcrs'))) ||
1.925.2.16  raeburn  4691:                     ($env{'request.noversionuri'} eq '/adm/whatsnew') ||
                   4692:                     ($env{'request.noversionuri'} eq '/cgi-bin/printout.pl') ||
                   4693:                     ($env{'request.noversionuri'} eq '/adm/printout') ||
                   4694:                     ($env{'request.noversionuri'} eq '/adm/statistics')) {
                   4695: 
1.925.2.14  raeburn  4696:                     my @advtools = &concept_test_manager();
1.925.2.16  raeburn  4697:                     &Apache::lonhtmlcommon::clear_breadcrumbs();
1.925.2.14  raeburn  4698:                     &Apache::lonhtmlcommon::add_breadcrumb_tool(
                   4699:                                       'advtools',@advtools);
                   4700:                     my $advlinks;
                   4701:                     my $legendtext = '<a class="LC_menubuttons_link" href="/adm/menu">'.&mt('Management').'</a>';
                   4702:                     &Apache::lonhtmlcommon::render_advtools(\$advlinks,$legendtext);
                   4703:                     $bodytag .= $advlinks;
                   4704:                 }
1.920     raeburn  4705:             }
1.903     droeschl 4706:         }else{
                   4707:             # this is to seperate menu from content when there's no secondary
                   4708:             # menu. Especially needed for public accessible ressources.
                   4709:             $bodytag .= '<hr style="clear:both" />';
                   4710:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4711:         }
1.903     droeschl 4712: 
1.235     raeburn  4713:         return $bodytag;
1.94      www      4714:     }
1.95      www      4715: 
1.93      www      4716: #
1.95      www      4717: # Top frame rendering, Remote is up
1.93      www      4718: #
1.359     albertel 4719: 
1.517     raeburn  4720:     my $imgsrc = $img;
                   4721:     if ($img =~ /^\/adm/) {
1.575     albertel 4722:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4723:     }
                   4724:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4725: 
1.305     www      4726:     # Explicit link to get inline menu
1.361     albertel 4727:     my $menu= ($no_inline_link?''
1.883     droeschl 4728: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917     raeburn  4729: 
                   4730:     if ($dc_info) {
                   4731:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   4732:     }
                   4733: 
1.916     droeschl 4734:     $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897     wenzelju 4735:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4736:                 <li>$menu</li>
1.917     raeburn  4737:             </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94      www      4738:     return(<<ENDBODY);
1.60      matthew  4739: $bodytag
1.359     albertel 4740: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4741: <tr><td>$upperleft</td>
                   4742:     <td>$messages&nbsp;</td>
1.54      www      4743: </tr>
1.359     albertel 4744: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4745: </tr>
1.356     albertel 4746: </table>
1.54      www      4747: ENDBODY
1.182     matthew  4748: }
                   4749: 
1.925.2.14  raeburn  4750: sub concept_test_manager {
                   4751:     my @advtools;
                   4752:     my  %items = (
                   4753:                    docs => { 
                   4754:                               desc    => 'Edit Test',
                   4755:                               action  => "go('/adm/coursedocs')",
                   4756:                               tooltip => 'Assemble or modify Concept Test'
                   4757:                            },
                   4758:                    cprv => {
                   4759:                               desc => 'Enrollment/Activity',
                   4760:                               action => "go('/adm/createuser')",
                   4761:                               tooltip => 'Enrollment and student activity',
                   4762:                            },
                   4763:                    new => { 
                   4764:                               desc   => "What's New?",
                   4765:                               action => "go('/adm/whatsnew')",
                   4766:                               tooltip => 'Recent events/action items in Concept Test' ,
                   4767:                            },
                   4768:                    prnt => {
                   4769:                               desc => 'Print Test',
                   4770:                               action => "go('/adm/printout');",
                   4771:                               tooltip => 'Prepare printable Concept Test',
                   4772:                            },
                   4773:                    chrt => { 
                   4774:                               desc   => 'Test Statistics',
                   4775:                               action => "go('/adm/statistics');",
                   4776:                               tooltip => 'Concept Test Statistics',
                   4777:                            },
                   4778:                    rcrs => {
                   4779:                               desc   => 'Create New Test',
                   4780:                               action  => "switchpage('createtest');",
                   4781:                               tooltip => 'Create new Concept Test',
                   4782:                            },
                   4783:                  );
                   4784:     my @ordered = ('docs','cprv','new','prnt','chrt','rcrs');
                   4785:     foreach my $item (@ordered) {
                   4786:          push(@advtools,
                   4787:                   '<a title="'.$items{$item}{tooltip}.'" class="LC_menubuttons_link" href="javascript:'.
                   4788:                   $items{$item}{action}.';">'.
                   4789:                   '<img src="'.'/res/adm/pages/'.$item.'22.png" alt="'.$items{$item}{tooltip}.
                   4790:                   '" border="0" class="LC_icon" />'.
                   4791:                   '<span class="LC_menubuttons_inline_text">'.$items{$item}{desc}.'</span></a>');
                   4792:     }
                   4793:     return @advtools;
                   4794: }
                   4795: 
1.917     raeburn  4796: sub dc_courseid_toggle {
                   4797:     my ($dc_info) = @_;
                   4798:     return ' <span id="dccidtext" class="LC_cusr_subheading">'.
                   4799:            '<a href="javascript:showCourseID();">'.
                   4800:            &mt('(More ...)').'</a></span>'.
                   4801:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4802: }
                   4803: 
1.330     albertel 4804: sub make_attr_string {
                   4805:     my ($register,$attr_ref) = @_;
                   4806: 
                   4807:     if ($attr_ref && !ref($attr_ref)) {
                   4808: 	die("addentries Must be a hash ref ".
                   4809: 	    join(':',caller(1))." ".
                   4810: 	    join(':',caller(0))." ");
                   4811:     }
                   4812: 
                   4813:     if ($register) {
1.339     albertel 4814: 	my ($on_load,$on_unload);
                   4815: 	foreach my $key (keys(%{$attr_ref})) {
                   4816: 	    if      (lc($key) eq 'onload') {
                   4817: 		$on_load.=$attr_ref->{$key}.';';
                   4818: 		delete($attr_ref->{$key});
                   4819: 
                   4820: 	    } elsif (lc($key) eq 'onunload') {
                   4821: 		$on_unload.=$attr_ref->{$key}.';';
                   4822: 		delete($attr_ref->{$key});
                   4823: 	    }
                   4824: 	}
                   4825: 	$attr_ref->{'onload'}  =
                   4826: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4827: 	$attr_ref->{'onunload'}=
                   4828: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4829:     }
                   4830: 
                   4831: # Accessibility font enhance
                   4832:     if ($env{'browser.fontenhance'} eq 'on') {
                   4833: 	my $style;
                   4834: 	foreach my $key (keys(%{$attr_ref})) {
                   4835: 	    if (lc($key) eq 'style') {
                   4836: 		$style.=$attr_ref->{$key}.';';
                   4837: 		delete($attr_ref->{$key});
                   4838: 	    }
                   4839: 	}
                   4840: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4841:     }
1.339     albertel 4842: 
1.330     albertel 4843:     my $attr_string;
                   4844:     foreach my $attr (keys(%$attr_ref)) {
                   4845: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4846:     }
                   4847:     return $attr_string;
                   4848: }
                   4849: 
                   4850: 
1.182     matthew  4851: ###############################################
1.251     albertel 4852: ###############################################
                   4853: 
                   4854: =pod
                   4855: 
                   4856: =item * &endbodytag()
                   4857: 
                   4858: Returns a uniform footer for LON-CAPA web pages.
                   4859: 
1.635     raeburn  4860: Inputs: 1 - optional reference to an args hash
                   4861: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4862: a 'Continue' link is not displayed if the page contains an
                   4863: internal redirect in the <head></head> section,
                   4864: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4865: 
                   4866: =cut
                   4867: 
                   4868: sub endbodytag {
1.635     raeburn  4869:     my ($args) = @_;
1.251     albertel 4870:     my $endbodytag='</body>';
1.269     albertel 4871:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4872:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4873:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4874: 	    $endbodytag=
                   4875: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4876: 	        &mt('Continue').'</a>'.
                   4877: 	        $endbodytag;
                   4878:         }
1.315     albertel 4879:     }
1.251     albertel 4880:     return $endbodytag;
                   4881: }
                   4882: 
1.352     albertel 4883: =pod
                   4884: 
                   4885: =item * &standard_css()
                   4886: 
                   4887: Returns a style sheet
                   4888: 
                   4889: Inputs: (all optional)
                   4890:             domain         -> force to color decorate a page for a specific
                   4891:                                domain
                   4892:             function       -> force usage of a specific rolish color scheme
                   4893:             bgcolor        -> override the default page bgcolor
                   4894: 
                   4895: =cut
                   4896: 
1.343     albertel 4897: sub standard_css {
1.345     albertel 4898:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4899:     $function  = &get_users_function() if (!$function);
                   4900:     my $img    = &designparm($function.'.img',   $domain);
                   4901:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4902:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4903:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4904: #second colour for later usage
1.345     albertel 4905:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4906:     my $pgbg_or_bgcolor =
                   4907: 	         $bgcolor ||
1.352     albertel 4908: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4909:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4910:     my $alink  = &designparm($function.'.alink', $domain);
                   4911:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4912:     my $link   = &designparm($function.'.link',  $domain);
                   4913: 
1.704     muellerd 4914:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4915:     my $bgcol = &designparm('login.bgcol',$domain);
                   4916:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4917: 
1.602     albertel 4918:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4919:     my $mono                 = 'monospace';
1.850     bisitz   4920:     my $data_table_head      = $sidebg;
                   4921:     my $data_table_light     = '#FAFAFA';
                   4922:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4923:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4924:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4925:     my $mail_new             = '#FFBB77';
                   4926:     my $mail_new_hover       = '#DD9955';
                   4927:     my $mail_read            = '#BBBB77';
                   4928:     my $mail_read_hover      = '#999944';
                   4929:     my $mail_replied         = '#AAAA88';
                   4930:     my $mail_replied_hover   = '#888855';
                   4931:     my $mail_other           = '#99BBBB';
                   4932:     my $mail_other_hover     = '#669999';
1.391     albertel 4933:     my $table_header         = '#DDDDDD';
1.489     raeburn  4934:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4935:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4936: 
1.608     albertel 4937:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4938:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4939:                                              : '0 3px 0 4px';
1.448     albertel 4940: 
1.523     albertel 4941: 
1.343     albertel 4942:     return <<END;
1.795     www      4943: body {
1.911     bisitz   4944:   font-family: $sans;
                   4945:   line-height:130%;
                   4946:   font-size:0.83em;
                   4947:   color:$font;
1.795     www      4948: }
                   4949: 
1.911     bisitz   4950: a:focus {
1.795     www      4951:   color: red;
1.911     bisitz   4952:   background: yellow;
1.795     www      4953: }
1.698     harmsja  4954: 
1.911     bisitz   4955: form, .inline {
                   4956:   display: inline;
1.795     www      4957: }
1.721     harmsja  4958: 
1.795     www      4959: .LC_right {
1.911     bisitz   4960:   text-align:right;
1.795     www      4961: }
                   4962: 
                   4963: .LC_middle {
1.911     bisitz   4964:   vertical-align:middle;
1.795     www      4965: }
1.721     harmsja  4966: 
                   4967: /* just for tests */
1.911     bisitz   4968: .LC_400Box {
                   4969:   width:400px;
                   4970: }
1.721     harmsja  4971: /* end */
                   4972: 
1.778     bisitz   4973: .LC_filename {
                   4974:   font-family: $mono;
                   4975:   white-space:pre;
1.921     bisitz   4976:   font-size: 120%;
1.778     bisitz   4977: }
                   4978: 
                   4979: .LC_fileicon {
                   4980:   border: none;
                   4981:   height: 1.3em;
                   4982:   vertical-align: text-bottom;
                   4983:   margin-right: 0.3em;
                   4984:   text-decoration:none;
                   4985: }
                   4986: 
1.350     albertel 4987: .LC_error {
                   4988:   color: red;
                   4989:   font-size: larger;
                   4990: }
1.795     www      4991: 
1.457     albertel 4992: .LC_warning,
                   4993: .LC_diff_removed {
1.733     bisitz   4994:   color: red;
1.394     albertel 4995: }
1.532     albertel 4996: 
                   4997: .LC_info,
1.457     albertel 4998: .LC_success,
                   4999: .LC_diff_added {
1.350     albertel 5000:   color: green;
                   5001: }
1.795     www      5002: 
1.802     bisitz   5003: div.LC_confirm_box {
                   5004:   background-color: #FAFAFA;
                   5005:   border: 1px solid $lg_border_color;
                   5006:   margin-right: 0;
                   5007:   padding: 5px;
                   5008: }
                   5009: 
                   5010: div.LC_confirm_box .LC_error img,
                   5011: div.LC_confirm_box .LC_success img {
                   5012:   vertical-align: middle;
                   5013: }
                   5014: 
1.440     albertel 5015: .LC_icon {
1.771     droeschl 5016:   border: none;
1.790     droeschl 5017:   vertical-align: middle;
1.771     droeschl 5018: }
                   5019: 
1.543     albertel 5020: .LC_docs_spacer {
                   5021:   width: 25px;
                   5022:   height: 1px;
1.771     droeschl 5023:   border: none;
1.543     albertel 5024: }
1.346     albertel 5025: 
1.532     albertel 5026: .LC_internal_info {
1.735     bisitz   5027:   color: #999999;
1.532     albertel 5028: }
                   5029: 
1.794     www      5030: .LC_discussion {
1.911     bisitz   5031:   background: $tabbg;
                   5032:   border: 1px solid black;
                   5033:   margin: 2px;
1.794     www      5034: }
                   5035: 
                   5036: .LC_disc_action_links_bar {
1.911     bisitz   5037:   background: $tabbg;
                   5038:   border: none;
                   5039:   margin: 4px;
1.794     www      5040: }
                   5041: 
                   5042: .LC_disc_action_left {
1.911     bisitz   5043:   text-align: left;
1.794     www      5044: }
                   5045: 
                   5046: .LC_disc_action_right {
1.911     bisitz   5047:   text-align: right;
1.794     www      5048: }
                   5049: 
                   5050: .LC_disc_new_item {
1.911     bisitz   5051:   background: white;
                   5052:   border: 2px solid red;
                   5053:   margin: 2px;
1.794     www      5054: }
                   5055: 
                   5056: .LC_disc_old_item {
1.911     bisitz   5057:   background: white;
                   5058:   border: 1px solid black;
                   5059:   margin: 2px;
1.794     www      5060: }
                   5061: 
1.458     albertel 5062: table.LC_pastsubmission {
                   5063:   border: 1px solid black;
                   5064:   margin: 2px;
                   5065: }
                   5066: 
1.924     bisitz   5067: table#LC_menubuttons {
1.345     albertel 5068:   width: 100%;
                   5069:   background: $pgbg;
1.392     albertel 5070:   border: 2px;
1.402     albertel 5071:   border-collapse: separate;
1.803     bisitz   5072:   padding: 0;
1.345     albertel 5073: }
1.392     albertel 5074: 
1.801     tempelho 5075: table#LC_title_bar a {
                   5076:   color: $fontmenu;
                   5077: }
1.836     bisitz   5078: 
1.807     droeschl 5079: table#LC_title_bar {
1.819     tempelho 5080:   clear: both;
1.836     bisitz   5081:   display: none;
1.807     droeschl 5082: }
                   5083: 
1.795     www      5084: table#LC_title_bar,
                   5085: table.LC_breadcrumbs,
1.393     albertel 5086: table#LC_title_bar.LC_with_remote {
1.359     albertel 5087:   width: 100%;
1.392     albertel 5088:   border-color: $pgbg;
                   5089:   border-style: solid;
                   5090:   border-width: $border;
1.379     albertel 5091:   background: $pgbg;
1.801     tempelho 5092:   color: $fontmenu;
1.392     albertel 5093:   border-collapse: collapse;
1.803     bisitz   5094:   padding: 0;
1.819     tempelho 5095:   margin: 0;
1.359     albertel 5096: }
1.795     www      5097: 
1.925.2.14  raeburn  5098: ul.LC_breadcrumb_tools_outerlist {
                   5099:     margin: 0;
                   5100:     padding: 0;
                   5101:     position: relative;
                   5102:     list-style: none;
                   5103: }
                   5104: ul.LC_breadcrumb_tools_outerlist li {
                   5105:     display: inline;
                   5106: }
                   5107: 
                   5108: .LC_breadcrumb_tools_navigation {
                   5109:     padding: 0;
                   5110:     margin: 0;
                   5111:     float: left;
                   5112: }
                   5113: .LC_breadcrumb_tools_tools {
                   5114:     padding: 0;
                   5115:     margin: 0;
                   5116:     float: right;
                   5117: }
                   5118: 
                   5119: div.LC_GCI_Menu {
                   5120:     width:900px;
                   5121: }
                   5122: 
                   5123: div.LC_GCI_Menu:after {
                   5124:     content:'';
                   5125:     display:block;
                   5126:     clear:both;
                   5127: }
                   5128: 
                   5129: div.LC_GCI_Menu_left {
                   5130:     float:left;
                   5131:     width:400px;
                   5132: }
                   5133: 
                   5134: div.LC_GCI_Menu_right {
                   5135:     float:left;
                   5136:     width:400px;;
                   5137: }
                   5138: 
1.925.2.13  raeburn  5139: dl.LC_GCI_Menu {
                   5140:     width:300px;
                   5141:     float:left;
                   5142:     margin-right:2em;
                   5143: }
                   5144: 
                   5145: dl.LC_GCI_Menu dt {
                   5146:     font-weight: bold;
                   5147:     font-size:0.9em;
                   5148:     margin-bottom:0.7em;
                   5149: }
                   5150: 
1.925.2.14  raeburn  5151: dl.LC_GCI_Menu dt a {
                   5152:     color: $font;
                   5153: }
                   5154: 
1.925.2.13  raeburn  5155: dl.LC_GCI_Menu dd {
                   5156:     font-size:0.8em;
                   5157:     margin:0 0 2em 0;
                   5158:     padding-left:4.5em;
                   5159:     line-height:1.5em;
                   5160:     background:none no-repeat left top;
                   5161: }
                   5162: 
1.359     albertel 5163: table#LC_title_bar td {
                   5164:   background: $tabbg;
                   5165: }
1.795     www      5166: 
1.911     bisitz   5167: table#LC_menubuttons img {
1.803     bisitz   5168:   border: none;
1.346     albertel 5169: }
1.795     www      5170: 
1.842     droeschl 5171: .LC_breadcrumbs_component {
1.911     bisitz   5172:   float: right;
1.925.2.14  raeburn  5173:   margin: 0.25em 1em;
1.357     albertel 5174: }
1.842     droeschl 5175: .LC_breadcrumbs_component img {
1.911     bisitz   5176:   vertical-align: middle;
1.777     tempelho 5177: }
1.795     www      5178: 
1.383     albertel 5179: td.LC_table_cell_checkbox {
                   5180:   text-align: center;
                   5181: }
1.795     www      5182: 
                   5183: .LC_fontsize_small {
1.911     bisitz   5184:   font-size: 70%;
1.705     tempelho 5185: }
                   5186: 
1.844     bisitz   5187: #LC_breadcrumbs {
1.911     bisitz   5188:   clear:both;
                   5189:   background: $sidebg;
                   5190:   border-bottom: 1px solid $lg_border_color;
                   5191:   line-height: 2.5em;
1.925.2.14  raeburn  5192:   overflow: hidden;
1.911     bisitz   5193:   margin: 0;
                   5194:   padding: 0;
1.925.2.14  raeburn  5195:   text-align: left;
1.819     tempelho 5196: }
1.862     bisitz   5197: 
1.839     droeschl 5198: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5199: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5200:   display:none;
1.839     droeschl 5201: }
1.819     tempelho 5202: 
1.844     bisitz   5203: #LC_head_subbox {
1.911     bisitz   5204:   clear:both;
                   5205:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5206:   border: 1px solid $sidebg;
1.925.2.14  raeburn  5207:   margin: 0 0 0 0;      
1.822     bisitz   5208: }
                   5209: 
1.795     www      5210: .LC_fontsize_medium {
1.911     bisitz   5211:   font-size: 85%;
1.705     tempelho 5212: }
                   5213: 
1.795     www      5214: .LC_fontsize_large {
1.911     bisitz   5215:   font-size: 120%;
1.705     tempelho 5216: }
                   5217: 
1.346     albertel 5218: .LC_menubuttons_inline_text {
                   5219:   color: $font;
1.698     harmsja  5220:   font-size: 90%;
1.701     harmsja  5221:   padding-left:3px;
1.346     albertel 5222: }
                   5223: 
1.526     www      5224: .LC_menubuttons_link {
                   5225:   text-decoration: none;
                   5226: }
1.795     www      5227: 
1.522     albertel 5228: .LC_menubuttons_category {
1.521     www      5229:   color: $font;
1.526     www      5230:   background: $pgbg;
1.521     www      5231:   font-size: larger;
                   5232:   font-weight: bold;
                   5233: }
                   5234: 
1.346     albertel 5235: td.LC_menubuttons_text {
1.911     bisitz   5236:   color: $font;
1.346     albertel 5237: }
1.706     harmsja  5238: 
1.346     albertel 5239: .LC_current_location {
                   5240:   background: $tabbg;
                   5241: }
1.795     www      5242: 
                   5243: table.LC_data_table,
                   5244: table.LC_mail_list {
1.347     albertel 5245:   border: 1px solid #000000;
1.402     albertel 5246:   border-collapse: separate;
1.426     albertel 5247:   border-spacing: 1px;
1.610     albertel 5248:   background: $pgbg;
1.347     albertel 5249: }
1.795     www      5250: 
1.422     albertel 5251: .LC_data_table_dense {
                   5252:   font-size: small;
                   5253: }
1.795     www      5254: 
1.507     raeburn  5255: table.LC_nested_outer {
                   5256:   border: 1px solid #000000;
1.589     raeburn  5257:   border-collapse: collapse;
1.803     bisitz   5258:   border-spacing: 0;
1.507     raeburn  5259:   width: 100%;
                   5260: }
1.795     www      5261: 
1.879     raeburn  5262: table.LC_innerpickbox,
1.507     raeburn  5263: table.LC_nested {
1.803     bisitz   5264:   border: none;
1.589     raeburn  5265:   border-collapse: collapse;
1.803     bisitz   5266:   border-spacing: 0;
1.507     raeburn  5267:   width: 100%;
                   5268: }
1.795     www      5269: 
1.911     bisitz   5270: table.LC_data_table tr th,
                   5271: table.LC_calendar tr th,
1.795     www      5272: table.LC_mail_list tr th,
1.879     raeburn  5273: table.LC_prior_tries tr th,
                   5274: table.LC_innerpickbox tr th {
1.349     albertel 5275:   font-weight: bold;
                   5276:   background-color: $data_table_head;
1.801     tempelho 5277:   color:$fontmenu;
1.701     harmsja  5278:   font-size:90%;
1.347     albertel 5279: }
1.795     www      5280: 
1.879     raeburn  5281: table.LC_innerpickbox tr th,
                   5282: table.LC_innerpickbox tr td {
                   5283:   vertical-align: top;
                   5284: }
                   5285: 
1.711     raeburn  5286: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5287:   background-color: #CCCCCC;
1.711     raeburn  5288:   font-weight: bold;
                   5289:   text-align: left;
                   5290: }
1.795     www      5291: 
1.912     bisitz   5292: table.LC_data_table tr.LC_odd_row > td {
                   5293:   background-color: $data_table_light;
                   5294:   padding: 2px;
                   5295:   vertical-align: top;
                   5296: }
                   5297: 
1.809     bisitz   5298: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5299:   background-color: $data_table_light;
1.912     bisitz   5300:   vertical-align: top;
                   5301: }
                   5302: 
                   5303: table.LC_data_table tr.LC_even_row > td {
                   5304:   background-color: $data_table_dark;
1.425     albertel 5305:   padding: 2px;
1.900     bisitz   5306:   vertical-align: top;
1.347     albertel 5307: }
1.795     www      5308: 
1.809     bisitz   5309: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5310:   background-color: $data_table_dark;
1.900     bisitz   5311:   vertical-align: top;
1.347     albertel 5312: }
1.795     www      5313: 
1.425     albertel 5314: table.LC_data_table tr.LC_data_table_highlight td {
                   5315:   background-color: $data_table_darker;
                   5316: }
1.795     www      5317: 
1.639     raeburn  5318: table.LC_data_table tr td.LC_leftcol_header {
                   5319:   background-color: $data_table_head;
                   5320:   font-weight: bold;
                   5321: }
1.795     www      5322: 
1.451     albertel 5323: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5324: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5325:   background-color: #FFFFFF;
1.421     albertel 5326:   font-weight: bold;
                   5327:   font-style: italic;
                   5328:   text-align: center;
                   5329:   padding: 8px;
1.347     albertel 5330: }
1.795     www      5331: 
1.890     droeschl 5332: table.LC_caption {
                   5333: }
                   5334: 
1.507     raeburn  5335: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5336:   padding: 4ex
                   5337: }
1.795     www      5338: 
1.507     raeburn  5339: table.LC_nested_outer tr th {
                   5340:   font-weight: bold;
1.801     tempelho 5341:   color:$fontmenu;
1.507     raeburn  5342:   background-color: $data_table_head;
1.701     harmsja  5343:   font-size: small;
1.507     raeburn  5344:   border-bottom: 1px solid #000000;
                   5345: }
1.795     www      5346: 
1.507     raeburn  5347: table.LC_nested_outer tr td.LC_subheader {
                   5348:   background-color: $data_table_head;
                   5349:   font-weight: bold;
                   5350:   font-size: small;
                   5351:   border-bottom: 1px solid #000000;
                   5352:   text-align: right;
1.451     albertel 5353: }
1.795     www      5354: 
1.507     raeburn  5355: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5356:   background-color: #CCCCCC;
1.451     albertel 5357:   font-weight: bold;
                   5358:   font-size: small;
1.507     raeburn  5359:   text-align: center;
                   5360: }
1.795     www      5361: 
1.589     raeburn  5362: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5363: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5364:   text-align: left;
1.451     albertel 5365: }
1.795     www      5366: 
1.507     raeburn  5367: table.LC_nested td {
1.735     bisitz   5368:   background-color: #FFFFFF;
1.451     albertel 5369:   font-size: small;
1.507     raeburn  5370: }
1.795     www      5371: 
1.507     raeburn  5372: table.LC_nested_outer tr th.LC_right_item,
                   5373: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5374: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5375: table.LC_nested tr td.LC_right_item {
1.451     albertel 5376:   text-align: right;
                   5377: }
                   5378: 
1.507     raeburn  5379: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5380:   background-color: #EEEEEE;
1.451     albertel 5381: }
                   5382: 
1.473     raeburn  5383: table.LC_createuser {
                   5384: }
                   5385: 
                   5386: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5387:   font-size: small;
1.473     raeburn  5388: }
                   5389: 
                   5390: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5391:   background-color: #CCCCCC;
1.473     raeburn  5392:   font-weight: bold;
                   5393:   text-align: center;
                   5394: }
                   5395: 
1.349     albertel 5396: table.LC_calendar {
                   5397:   border: 1px solid #000000;
                   5398:   border-collapse: collapse;
1.917     raeburn  5399:   width: 98%;
1.349     albertel 5400: }
1.795     www      5401: 
1.349     albertel 5402: table.LC_calendar_pickdate {
                   5403:   font-size: xx-small;
                   5404: }
1.795     www      5405: 
1.349     albertel 5406: table.LC_calendar tr td {
                   5407:   border: 1px solid #000000;
                   5408:   vertical-align: top;
1.917     raeburn  5409:   width: 14%;
1.349     albertel 5410: }
1.795     www      5411: 
1.349     albertel 5412: table.LC_calendar tr td.LC_calendar_day_empty {
                   5413:   background-color: $data_table_dark;
                   5414: }
1.795     www      5415: 
1.779     bisitz   5416: table.LC_calendar tr td.LC_calendar_day_current {
                   5417:   background-color: $data_table_highlight;
1.777     tempelho 5418: }
1.795     www      5419: 
1.349     albertel 5420: table.LC_mail_list tr.LC_mail_new {
                   5421:   background-color: $mail_new;
                   5422: }
1.795     www      5423: 
1.349     albertel 5424: table.LC_mail_list tr.LC_mail_new:hover {
                   5425:   background-color: $mail_new_hover;
                   5426: }
1.795     www      5427: 
1.349     albertel 5428: table.LC_mail_list tr.LC_mail_read {
                   5429:   background-color: $mail_read;
                   5430: }
1.795     www      5431: 
1.349     albertel 5432: table.LC_mail_list tr.LC_mail_read:hover {
                   5433:   background-color: $mail_read_hover;
                   5434: }
1.795     www      5435: 
1.349     albertel 5436: table.LC_mail_list tr.LC_mail_replied {
                   5437:   background-color: $mail_replied;
                   5438: }
1.795     www      5439: 
1.349     albertel 5440: table.LC_mail_list tr.LC_mail_replied:hover {
                   5441:   background-color: $mail_replied_hover;
                   5442: }
1.795     www      5443: 
1.349     albertel 5444: table.LC_mail_list tr.LC_mail_other {
                   5445:   background-color: $mail_other;
                   5446: }
1.795     www      5447: 
1.349     albertel 5448: table.LC_mail_list tr.LC_mail_other:hover {
                   5449:   background-color: $mail_other_hover;
                   5450: }
1.494     raeburn  5451: 
1.777     tempelho 5452: table.LC_data_table tr > td.LC_browser_file,
                   5453: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5454:   background: #AAEE77;
1.389     albertel 5455: }
1.795     www      5456: 
1.777     tempelho 5457: table.LC_data_table tr > td.LC_browser_file_locked,
                   5458: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5459:   background: #FFAA99;
1.387     albertel 5460: }
1.795     www      5461: 
1.777     tempelho 5462: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5463:   background: #888888;
1.779     bisitz   5464: }
1.795     www      5465: 
1.777     tempelho 5466: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5467: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5468:   background: #F8F866;
1.777     tempelho 5469: }
1.795     www      5470: 
1.696     bisitz   5471: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5472:   background: #E0E8FF;
1.387     albertel 5473: }
1.696     bisitz   5474: 
1.707     bisitz   5475: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5476:   /* background: #77FF77; */
1.707     bisitz   5477: }
1.795     www      5478: 
1.707     bisitz   5479: table.LC_data_table tr > td.LC_roles_future {
                   5480:   background: #FFFF77;
                   5481: }
1.795     www      5482: 
1.707     bisitz   5483: table.LC_data_table tr > td.LC_roles_will {
                   5484:   background: #FFAA77;
                   5485: }
1.795     www      5486: 
1.707     bisitz   5487: table.LC_data_table tr > td.LC_roles_expired {
                   5488:   background: #FF7777;
                   5489: }
1.795     www      5490: 
1.707     bisitz   5491: table.LC_data_table tr > td.LC_roles_will_not {
                   5492:   background: #AAFF77;
                   5493: }
1.795     www      5494: 
1.707     bisitz   5495: table.LC_data_table tr > td.LC_roles_selected {
                   5496:   background: #11CC55;
                   5497: }
                   5498: 
1.388     albertel 5499: span.LC_current_location {
1.701     harmsja  5500:   font-size:larger;
1.388     albertel 5501:   background: $pgbg;
                   5502: }
1.387     albertel 5503: 
1.395     albertel 5504: span.LC_parm_menu_item {
                   5505:   font-size: larger;
                   5506: }
1.795     www      5507: 
1.395     albertel 5508: span.LC_parm_scope_all {
                   5509:   color: red;
                   5510: }
1.795     www      5511: 
1.395     albertel 5512: span.LC_parm_scope_folder {
                   5513:   color: green;
                   5514: }
1.795     www      5515: 
1.395     albertel 5516: span.LC_parm_scope_resource {
                   5517:   color: orange;
                   5518: }
1.795     www      5519: 
1.395     albertel 5520: span.LC_parm_part {
                   5521:   color: blue;
                   5522: }
1.795     www      5523: 
1.911     bisitz   5524: span.LC_parm_folder,
                   5525: span.LC_parm_symb {
1.395     albertel 5526:   font-size: x-small;
                   5527:   font-family: $mono;
                   5528:   color: #AAAAAA;
                   5529: }
                   5530: 
1.795     www      5531: td.LC_parm_overview_level_menu,
                   5532: td.LC_parm_overview_map_menu,
                   5533: td.LC_parm_overview_parm_selectors,
                   5534: td.LC_parm_overview_restrictions  {
1.396     albertel 5535:   border: 1px solid black;
                   5536:   border-collapse: collapse;
                   5537: }
1.795     www      5538: 
1.396     albertel 5539: table.LC_parm_overview_restrictions td {
                   5540:   border-width: 1px 4px 1px 4px;
                   5541:   border-style: solid;
                   5542:   border-color: $pgbg;
                   5543:   text-align: center;
                   5544: }
1.795     www      5545: 
1.396     albertel 5546: table.LC_parm_overview_restrictions th {
                   5547:   background: $tabbg;
                   5548:   border-width: 1px 4px 1px 4px;
                   5549:   border-style: solid;
                   5550:   border-color: $pgbg;
                   5551: }
1.795     www      5552: 
1.398     albertel 5553: table#LC_helpmenu {
1.803     bisitz   5554:   border: none;
1.398     albertel 5555:   height: 55px;
1.803     bisitz   5556:   border-spacing: 0;
1.398     albertel 5557: }
                   5558: 
                   5559: table#LC_helpmenu fieldset legend {
                   5560:   font-size: larger;
                   5561: }
1.795     www      5562: 
1.397     albertel 5563: table#LC_helpmenu_links {
                   5564:   width: 100%;
                   5565:   border: 1px solid black;
                   5566:   background: $pgbg;
1.803     bisitz   5567:   padding: 0;
1.397     albertel 5568:   border-spacing: 1px;
                   5569: }
1.795     www      5570: 
1.397     albertel 5571: table#LC_helpmenu_links tr td {
                   5572:   padding: 1px;
                   5573:   background: $tabbg;
1.399     albertel 5574:   text-align: center;
                   5575:   font-weight: bold;
1.397     albertel 5576: }
1.396     albertel 5577: 
1.795     www      5578: table#LC_helpmenu_links a:link,
                   5579: table#LC_helpmenu_links a:visited,
1.397     albertel 5580: table#LC_helpmenu_links a:active {
                   5581:   text-decoration: none;
                   5582:   color: $font;
                   5583: }
1.795     www      5584: 
1.397     albertel 5585: table#LC_helpmenu_links a:hover {
                   5586:   text-decoration: underline;
                   5587:   color: $vlink;
                   5588: }
1.396     albertel 5589: 
1.417     albertel 5590: .LC_chrt_popup_exists {
                   5591:   border: 1px solid #339933;
                   5592:   margin: -1px;
                   5593: }
1.795     www      5594: 
1.417     albertel 5595: .LC_chrt_popup_up {
                   5596:   border: 1px solid yellow;
                   5597:   margin: -1px;
                   5598: }
1.795     www      5599: 
1.417     albertel 5600: .LC_chrt_popup {
                   5601:   border: 1px solid #8888FF;
                   5602:   background: #CCCCFF;
                   5603: }
1.795     www      5604: 
1.421     albertel 5605: table.LC_pick_box {
                   5606:   border-collapse: separate;
                   5607:   background: white;
                   5608:   border: 1px solid black;
                   5609:   border-spacing: 1px;
                   5610: }
1.795     www      5611: 
1.421     albertel 5612: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5613:   background: $sidebg;
1.421     albertel 5614:   font-weight: bold;
1.900     bisitz   5615:   text-align: left;
1.740     bisitz   5616:   vertical-align: top;
1.421     albertel 5617:   width: 184px;
                   5618:   padding: 8px;
                   5619: }
1.795     www      5620: 
1.579     raeburn  5621: table.LC_pick_box td.LC_pick_box_value {
                   5622:   text-align: left;
                   5623:   padding: 8px;
                   5624: }
1.795     www      5625: 
1.579     raeburn  5626: table.LC_pick_box td.LC_pick_box_select {
                   5627:   text-align: left;
                   5628:   padding: 8px;
                   5629: }
1.795     www      5630: 
1.424     albertel 5631: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5632:   padding: 0;
1.421     albertel 5633:   height: 1px;
                   5634:   background: black;
                   5635: }
1.795     www      5636: 
1.421     albertel 5637: table.LC_pick_box td.LC_pick_box_submit {
                   5638:   text-align: right;
                   5639: }
1.795     www      5640: 
1.579     raeburn  5641: table.LC_pick_box td.LC_evenrow_value {
                   5642:   text-align: left;
                   5643:   padding: 8px;
                   5644:   background-color: $data_table_light;
                   5645: }
1.795     www      5646: 
1.579     raeburn  5647: table.LC_pick_box td.LC_oddrow_value {
                   5648:   text-align: left;
                   5649:   padding: 8px;
                   5650:   background-color: $data_table_light;
                   5651: }
1.795     www      5652: 
1.579     raeburn  5653: span.LC_helpform_receipt_cat {
                   5654:   font-weight: bold;
                   5655: }
1.795     www      5656: 
1.424     albertel 5657: table.LC_group_priv_box {
                   5658:   background: white;
                   5659:   border: 1px solid black;
                   5660:   border-spacing: 1px;
                   5661: }
1.795     www      5662: 
1.424     albertel 5663: table.LC_group_priv_box td.LC_pick_box_title {
                   5664:   background: $tabbg;
                   5665:   font-weight: bold;
                   5666:   text-align: right;
                   5667:   width: 184px;
                   5668: }
1.795     www      5669: 
1.424     albertel 5670: table.LC_group_priv_box td.LC_groups_fixed {
                   5671:   background: $data_table_light;
                   5672:   text-align: center;
                   5673: }
1.795     www      5674: 
1.424     albertel 5675: table.LC_group_priv_box td.LC_groups_optional {
                   5676:   background: $data_table_dark;
                   5677:   text-align: center;
                   5678: }
1.795     www      5679: 
1.424     albertel 5680: table.LC_group_priv_box td.LC_groups_functionality {
                   5681:   background: $data_table_darker;
                   5682:   text-align: center;
                   5683:   font-weight: bold;
                   5684: }
1.795     www      5685: 
1.424     albertel 5686: table.LC_group_priv td {
                   5687:   text-align: left;
1.803     bisitz   5688:   padding: 0;
1.424     albertel 5689: }
                   5690: 
1.421     albertel 5691: table.LC_notify_front_page {
                   5692:   background: white;
                   5693:   border: 1px solid black;
                   5694:   padding: 8px;
                   5695: }
1.795     www      5696: 
1.421     albertel 5697: table.LC_notify_front_page td {
                   5698:   padding: 8px;
                   5699: }
1.795     www      5700: 
1.424     albertel 5701: .LC_navbuttons {
                   5702:   margin: 2ex 0ex 2ex 0ex;
                   5703: }
1.795     www      5704: 
1.423     albertel 5705: .LC_topic_bar {
                   5706:   font-weight: bold;
                   5707:   background: $tabbg;
1.918     wenzelju 5708:   margin: 1em 0em 1em 2em;
1.805     bisitz   5709:   padding: 3px;
1.918     wenzelju 5710:   font-size: 1.2em;
1.423     albertel 5711: }
1.795     www      5712: 
1.423     albertel 5713: .LC_topic_bar span {
1.918     wenzelju 5714:   left: 0.5em;
                   5715:   position: absolute;
1.423     albertel 5716:   vertical-align: middle;
1.918     wenzelju 5717:   font-size: 1.2em;
1.423     albertel 5718: }
1.795     www      5719: 
1.423     albertel 5720: .LC_topic_bar img {
                   5721:   vertical-align: bottom;
                   5722: }
1.795     www      5723: 
1.423     albertel 5724: table.LC_course_group_status {
                   5725:   margin: 20px;
                   5726: }
1.795     www      5727: 
1.423     albertel 5728: table.LC_status_selector td {
                   5729:   vertical-align: top;
                   5730:   text-align: center;
1.424     albertel 5731:   padding: 4px;
                   5732: }
1.795     www      5733: 
1.599     albertel 5734: div.LC_feedback_link {
1.616     albertel 5735:   clear: both;
1.829     kalberla 5736:   background: $sidebg;
1.779     bisitz   5737:   width: 100%;
1.829     kalberla 5738:   padding-bottom: 10px;
                   5739:   border: 1px $tabbg solid;
1.833     kalberla 5740:   height: 22px;
                   5741:   line-height: 22px;
                   5742:   padding-top: 5px;
                   5743: }
                   5744: 
                   5745: div.LC_feedback_link img {
                   5746:   height: 22px;
1.867     kalberla 5747:   vertical-align:middle;
1.829     kalberla 5748: }
                   5749: 
1.911     bisitz   5750: div.LC_feedback_link a {
1.829     kalberla 5751:   text-decoration: none;
1.489     raeburn  5752: }
1.795     www      5753: 
1.867     kalberla 5754: div.LC_comblock {
1.911     bisitz   5755:   display:inline;
1.867     kalberla 5756:   color:$font;
                   5757:   font-size:90%;
                   5758: }
                   5759: 
                   5760: div.LC_feedback_link div.LC_comblock {
                   5761:   padding-left:5px;
                   5762: }
                   5763: 
                   5764: div.LC_feedback_link div.LC_comblock a {
                   5765:   color:$font;
                   5766: }
                   5767: 
1.489     raeburn  5768: span.LC_feedback_link {
1.858     bisitz   5769:   /* background: $feedback_link_bg; */
1.599     albertel 5770:   font-size: larger;
                   5771: }
1.795     www      5772: 
1.599     albertel 5773: span.LC_message_link {
1.858     bisitz   5774:   /* background: $feedback_link_bg; */
1.599     albertel 5775:   font-size: larger;
                   5776:   position: absolute;
                   5777:   right: 1em;
1.489     raeburn  5778: }
1.421     albertel 5779: 
1.515     albertel 5780: table.LC_prior_tries {
1.524     albertel 5781:   border: 1px solid #000000;
                   5782:   border-collapse: separate;
                   5783:   border-spacing: 1px;
1.515     albertel 5784: }
1.523     albertel 5785: 
1.515     albertel 5786: table.LC_prior_tries td {
1.524     albertel 5787:   padding: 2px;
1.515     albertel 5788: }
1.523     albertel 5789: 
                   5790: .LC_answer_correct {
1.795     www      5791:   background: lightgreen;
                   5792:   color: darkgreen;
                   5793:   padding: 6px;
1.523     albertel 5794: }
1.795     www      5795: 
1.523     albertel 5796: .LC_answer_charged_try {
1.797     www      5797:   background: #FFAAAA;
1.795     www      5798:   color: darkred;
                   5799:   padding: 6px;
1.523     albertel 5800: }
1.795     www      5801: 
1.779     bisitz   5802: .LC_answer_not_charged_try,
1.523     albertel 5803: .LC_answer_no_grade,
                   5804: .LC_answer_late {
1.795     www      5805:   background: lightyellow;
1.523     albertel 5806:   color: black;
1.795     www      5807:   padding: 6px;
1.523     albertel 5808: }
1.795     www      5809: 
1.523     albertel 5810: .LC_answer_previous {
1.795     www      5811:   background: lightblue;
                   5812:   color: darkblue;
                   5813:   padding: 6px;
1.523     albertel 5814: }
1.795     www      5815: 
1.779     bisitz   5816: .LC_answer_no_message {
1.777     tempelho 5817:   background: #FFFFFF;
                   5818:   color: black;
1.795     www      5819:   padding: 6px;
1.779     bisitz   5820: }
1.795     www      5821: 
1.779     bisitz   5822: .LC_answer_unknown {
                   5823:   background: orange;
                   5824:   color: black;
1.795     www      5825:   padding: 6px;
1.777     tempelho 5826: }
1.795     www      5827: 
1.529     albertel 5828: span.LC_prior_numerical,
                   5829: span.LC_prior_string,
                   5830: span.LC_prior_custom,
                   5831: span.LC_prior_reaction,
                   5832: span.LC_prior_math {
1.925     bisitz   5833:   font-family: $mono;
1.523     albertel 5834:   white-space: pre;
                   5835: }
                   5836: 
1.525     albertel 5837: span.LC_prior_string {
1.925     bisitz   5838:   font-family: $mono;
1.525     albertel 5839:   white-space: pre;
                   5840: }
                   5841: 
1.523     albertel 5842: table.LC_prior_option {
                   5843:   width: 100%;
                   5844:   border-collapse: collapse;
                   5845: }
1.795     www      5846: 
1.911     bisitz   5847: table.LC_prior_rank,
1.795     www      5848: table.LC_prior_match {
1.528     albertel 5849:   border-collapse: collapse;
                   5850: }
1.795     www      5851: 
1.528     albertel 5852: table.LC_prior_option tr td,
                   5853: table.LC_prior_rank tr td,
                   5854: table.LC_prior_match tr td {
1.524     albertel 5855:   border: 1px solid #000000;
1.515     albertel 5856: }
                   5857: 
1.855     bisitz   5858: .LC_nobreak {
1.544     albertel 5859:   white-space: nowrap;
1.519     raeburn  5860: }
                   5861: 
1.576     raeburn  5862: span.LC_cusr_emph {
                   5863:   font-style: italic;
                   5864: }
                   5865: 
1.633     raeburn  5866: span.LC_cusr_subheading {
                   5867:   font-weight: normal;
                   5868:   font-size: 85%;
                   5869: }
                   5870: 
1.861     bisitz   5871: div.LC_docs_entry_move {
1.859     bisitz   5872:   border: 1px solid #BBBBBB;
1.545     albertel 5873:   background: #DDDDDD;
1.861     bisitz   5874:   width: 22px;
1.859     bisitz   5875:   padding: 1px;
                   5876:   margin: 0;
1.545     albertel 5877: }
                   5878: 
1.861     bisitz   5879: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5880: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5881:   background: #DDDDDD;
                   5882:   font-size: x-small;
                   5883: }
1.795     www      5884: 
1.861     bisitz   5885: .LC_docs_entry_parameter {
                   5886:   white-space: nowrap;
                   5887: }
                   5888: 
1.544     albertel 5889: .LC_docs_copy {
1.545     albertel 5890:   color: #000099;
1.544     albertel 5891: }
1.795     www      5892: 
1.544     albertel 5893: .LC_docs_cut {
1.545     albertel 5894:   color: #550044;
1.544     albertel 5895: }
1.795     www      5896: 
1.544     albertel 5897: .LC_docs_rename {
1.545     albertel 5898:   color: #009900;
1.544     albertel 5899: }
1.795     www      5900: 
1.544     albertel 5901: .LC_docs_remove {
1.545     albertel 5902:   color: #990000;
                   5903: }
                   5904: 
1.547     albertel 5905: .LC_docs_reinit_warn,
                   5906: .LC_docs_ext_edit {
                   5907:   font-size: x-small;
                   5908: }
                   5909: 
1.545     albertel 5910: table.LC_docs_adddocs td,
                   5911: table.LC_docs_adddocs th {
                   5912:   border: 1px solid #BBBBBB;
                   5913:   padding: 4px;
                   5914:   background: #DDDDDD;
1.543     albertel 5915: }
                   5916: 
1.584     albertel 5917: table.LC_sty_begin {
                   5918:   background: #BBFFBB;
                   5919: }
1.795     www      5920: 
1.584     albertel 5921: table.LC_sty_end {
                   5922:   background: #FFBBBB;
                   5923: }
                   5924: 
1.589     raeburn  5925: table.LC_double_column {
1.803     bisitz   5926:   border-width: 0;
1.589     raeburn  5927:   border-collapse: collapse;
                   5928:   width: 100%;
                   5929:   padding: 2px;
                   5930: }
                   5931: 
                   5932: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5933:   top: 2px;
1.589     raeburn  5934:   left: 2px;
                   5935:   width: 47%;
                   5936:   vertical-align: top;
                   5937: }
                   5938: 
                   5939: table.LC_double_column tr td.LC_right_col {
                   5940:   top: 2px;
1.779     bisitz   5941:   right: 2px;
1.589     raeburn  5942:   width: 47%;
                   5943:   vertical-align: top;
                   5944: }
                   5945: 
1.591     raeburn  5946: div.LC_left_float {
                   5947:   float: left;
                   5948:   padding-right: 5%;
1.597     albertel 5949:   padding-bottom: 4px;
1.591     raeburn  5950: }
                   5951: 
                   5952: div.LC_clear_float_header {
1.597     albertel 5953:   padding-bottom: 2px;
1.591     raeburn  5954: }
                   5955: 
                   5956: div.LC_clear_float_footer {
1.597     albertel 5957:   padding-top: 10px;
1.591     raeburn  5958:   clear: both;
                   5959: }
                   5960: 
1.597     albertel 5961: div.LC_grade_show_user {
                   5962:   margin-top: 20px;
                   5963:   border: 1px solid black;
                   5964: }
1.795     www      5965: 
1.597     albertel 5966: div.LC_grade_user_name {
                   5967:   background: #DDDDEE;
                   5968:   border-bottom: 1px solid black;
1.705     tempelho 5969:   font-weight: bold;
                   5970:   font-size: large;
1.597     albertel 5971: }
1.795     www      5972: 
1.597     albertel 5973: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5974:   background: #DDEEDD;
                   5975: }
                   5976: 
                   5977: div.LC_grade_show_problem,
                   5978: div.LC_grade_submissions,
                   5979: div.LC_grade_message_center,
                   5980: div.LC_grade_info_links,
                   5981: div.LC_grade_assign {
                   5982:   margin: 5px;
                   5983:   width: 99%;
                   5984:   background: #FFFFFF;
                   5985: }
1.795     www      5986: 
1.597     albertel 5987: div.LC_grade_show_problem_header,
                   5988: div.LC_grade_submissions_header,
                   5989: div.LC_grade_message_center_header,
                   5990: div.LC_grade_assign_header {
1.705     tempelho 5991:   font-weight: bold;
                   5992:   font-size: large;
1.597     albertel 5993: }
1.795     www      5994: 
1.597     albertel 5995: div.LC_grade_show_problem_problem,
                   5996: div.LC_grade_submissions_body,
                   5997: div.LC_grade_message_center_body,
                   5998: div.LC_grade_assign_body {
                   5999:   border: 1px solid black;
                   6000:   width: 99%;
                   6001:   background: #FFFFFF;
                   6002: }
1.795     www      6003: 
1.598     albertel 6004: span.LC_grade_check_note {
1.705     tempelho 6005:   font-weight: normal;
                   6006:   font-size: medium;
1.598     albertel 6007:   display: inline;
                   6008:   position: absolute;
                   6009:   right: 1em;
                   6010: }
1.597     albertel 6011: 
1.613     albertel 6012: table.LC_scantron_action {
                   6013:   width: 100%;
                   6014: }
1.795     www      6015: 
1.613     albertel 6016: table.LC_scantron_action tr th {
1.698     harmsja  6017:   font-weight:bold;
                   6018:   font-style:normal;
1.613     albertel 6019: }
1.795     www      6020: 
1.779     bisitz   6021: .LC_edit_problem_header,
1.614     albertel 6022: div.LC_edit_problem_footer {
1.705     tempelho 6023:   font-weight: normal;
                   6024:   font-size:  medium;
1.602     albertel 6025:   margin: 2px;
1.600     albertel 6026: }
1.795     www      6027: 
1.600     albertel 6028: div.LC_edit_problem_header,
1.602     albertel 6029: div.LC_edit_problem_header div,
1.614     albertel 6030: div.LC_edit_problem_footer,
                   6031: div.LC_edit_problem_footer div,
1.602     albertel 6032: div.LC_edit_problem_editxml_header,
                   6033: div.LC_edit_problem_editxml_header div {
1.600     albertel 6034:   margin-top: 5px;
                   6035: }
1.795     www      6036: 
1.600     albertel 6037: div.LC_edit_problem_header_title {
1.705     tempelho 6038:   font-weight: bold;
                   6039:   font-size: larger;
1.602     albertel 6040:   background: $tabbg;
                   6041:   padding: 3px;
                   6042: }
1.795     www      6043: 
1.602     albertel 6044: table.LC_edit_problem_header_title {
1.705     tempelho 6045:   font-size: larger;
                   6046:   font-weight:  bold;
1.602     albertel 6047:   width: 100%;
                   6048:   border-color: $pgbg;
                   6049:   border-style: solid;
                   6050:   border-width: $border;
1.600     albertel 6051:   background: $tabbg;
1.602     albertel 6052:   border-collapse: collapse;
1.803     bisitz   6053:   padding: 0;
1.602     albertel 6054: }
                   6055: 
                   6056: div.LC_edit_problem_discards {
                   6057:   float: left;
                   6058:   padding-bottom: 5px;
                   6059: }
1.795     www      6060: 
1.602     albertel 6061: div.LC_edit_problem_saves {
                   6062:   float: right;
                   6063:   padding-bottom: 5px;
1.600     albertel 6064: }
1.795     www      6065: 
1.911     bisitz   6066: img.stift {
1.803     bisitz   6067:   border-width: 0;
                   6068:   vertical-align: middle;
1.677     riegler  6069: }
1.680     riegler  6070: 
1.923     bisitz   6071: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6072:   vertical-align: top;
1.777     tempelho 6073: }
1.795     www      6074: 
1.716     raeburn  6075: div.LC_createcourse {
1.911     bisitz   6076:   margin: 10px 10px 10px 10px;
1.716     raeburn  6077: }
                   6078: 
1.917     raeburn  6079: .LC_dccid {
                   6080:   margin: 0.2em 0 0 0;
                   6081:   padding: 0;
                   6082:   font-size: 90%;
                   6083:   display:none;
                   6084: }
                   6085: 
1.693     droeschl 6086: /* ---- Remove when done ----
                   6087: # The following styles is part of the redesign of LON-CAPA and are
                   6088: # subject to change during this project.
                   6089: # Don't rely on their current functionality as they might be 
                   6090: # changed or removed.
                   6091: # --------------------------*/
                   6092: 
1.698     harmsja  6093: a:hover,
1.897     wenzelju 6094: ol.LC_primary_menu a:hover,
1.721     harmsja  6095: ol#LC_MenuBreadcrumbs a:hover,
                   6096: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6097: ul#LC_secondary_menu a:hover,
1.721     harmsja  6098: .LC_FormSectionClearButton input:hover
1.795     www      6099: ul.LC_TabContent   li:hover a {
1.911     bisitz   6100:   color:#BF2317;
                   6101:   text-decoration:none;
1.693     droeschl 6102: }
                   6103: 
1.779     bisitz   6104: h1 {
1.911     bisitz   6105:   padding: 0;
                   6106:   line-height:130%;
1.693     droeschl 6107: }
1.698     harmsja  6108: 
1.911     bisitz   6109: h2,
                   6110: h3,
                   6111: h4,
                   6112: h5,
                   6113: h6 {
                   6114:   margin: 5px 0 5px 0;
                   6115:   padding: 0;
                   6116:   line-height:130%;
1.693     droeschl 6117: }
1.795     www      6118: 
                   6119: .LC_hcell {
1.911     bisitz   6120:   padding:3px 15px 3px 15px;
                   6121:   margin: 0;
                   6122:   background-color:$tabbg;
                   6123:   color:$fontmenu;
                   6124:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6125: }
1.795     www      6126: 
1.840     bisitz   6127: .LC_Box > .LC_hcell {
1.911     bisitz   6128:   margin: 0 -10px 10px -10px;
1.835     bisitz   6129: }
                   6130: 
1.721     harmsja  6131: .LC_noBorder {
1.911     bisitz   6132:   border: 0;
1.698     harmsja  6133: }
1.693     droeschl 6134: 
1.721     harmsja  6135: .LC_FormSectionClearButton input {
1.911     bisitz   6136:   background-color:transparent;
                   6137:   border: none;
                   6138:   cursor:pointer;
                   6139:   text-decoration:underline;
1.693     droeschl 6140: }
1.763     bisitz   6141: 
                   6142: .LC_help_open_topic {
1.911     bisitz   6143:   color: #FFFFFF;
                   6144:   background-color: #EEEEFF;
                   6145:   margin: 1px;
                   6146:   padding: 4px;
                   6147:   border: 1px solid #000033;
                   6148:   white-space: nowrap;
                   6149:   /* vertical-align: middle; */
1.759     neumanie 6150: }
1.693     droeschl 6151: 
1.911     bisitz   6152: dl,
                   6153: ul,
                   6154: div,
                   6155: fieldset {
                   6156:   margin: 10px 10px 10px 0;
                   6157:   /* overflow: hidden; */
1.693     droeschl 6158: }
1.795     www      6159: 
1.838     bisitz   6160: fieldset > legend {
1.911     bisitz   6161:   font-weight: bold;
                   6162:   padding: 0 5px 0 5px;
1.838     bisitz   6163: }
                   6164: 
1.925.2.14  raeburn  6165: div.LC_page_header {
                   6166:   background-color: $pgbg_or_bgcolor;
                   6167:   margin: 0 0 1.0em 0;
                   6168: }
                   6169: 
1.813     bisitz   6170: #LC_nav_bar {
1.911     bisitz   6171:   float: left;
                   6172:   margin: 0.2em 0 0 0;
1.807     droeschl 6173: }
                   6174: 
1.916     droeschl 6175: #LC_realm {
                   6176:   margin: 0.2em 0 0 0;
                   6177:   padding: 0;
                   6178:   font-weight: bold;
                   6179:   text-align: center;
                   6180: }
                   6181: 
1.911     bisitz   6182: #LC_nav_bar em {
                   6183:   font-weight: bold;
                   6184:   font-style: normal;
1.807     droeschl 6185: }
                   6186: 
1.897     wenzelju 6187: ol.LC_primary_menu {
1.911     bisitz   6188:   float: right;
                   6189:   margin: 0.2em 0 0 0;
1.807     droeschl 6190: }
                   6191: 
1.852     droeschl 6192: ol#LC_PathBreadcrumbs {
1.911     bisitz   6193:   margin: 0;
1.693     droeschl 6194: }
                   6195: 
1.897     wenzelju 6196: ol.LC_primary_menu li {
1.911     bisitz   6197:   display: inline;
                   6198:   padding: 5px 5px 0 10px;
                   6199:   vertical-align: top;
1.693     droeschl 6200: }
                   6201: 
1.897     wenzelju 6202: ol.LC_primary_menu li img {
1.911     bisitz   6203:   vertical-align: bottom;
1.693     droeschl 6204: }
                   6205: 
1.897     wenzelju 6206: ol.LC_primary_menu a {
1.911     bisitz   6207:   font-size: 90%;
                   6208:   color: RGB(80, 80, 80);
                   6209:   text-decoration: none;
1.693     droeschl 6210: }
1.795     www      6211: 
1.925.2.20  raeburn  6212: ol.LC_primary_menu a.LC_new_message {
                   6213:   font-weight:bold;
                   6214:   color: darkred;
                   6215: }
                   6216: 
1.897     wenzelju 6217: ul#LC_secondary_menu {
1.911     bisitz   6218:   clear: both;
                   6219:   color: $fontmenu;
                   6220:   background: $tabbg;
                   6221:   list-style: none;
                   6222:   padding: 0;
                   6223:   margin: 0;
                   6224:   width: 100%;
1.808     droeschl 6225: }
                   6226: 
1.897     wenzelju 6227: ul#LC_secondary_menu li {
1.911     bisitz   6228:   font-weight: bold;
                   6229:   line-height: 1.8em;
                   6230:   padding: 0 0.8em;
                   6231:   border-right: 1px solid black;
                   6232:   display: inline;
                   6233:   vertical-align: middle;
1.807     droeschl 6234: }
                   6235: 
1.847     tempelho 6236: ul.LC_TabContent {
1.911     bisitz   6237:   display:block;
                   6238:   background: $sidebg;
                   6239:   border-bottom: solid 1px $lg_border_color;
                   6240:   list-style:none;
                   6241:   margin: 0 -10px;
                   6242:   padding: 0;
1.693     droeschl 6243: }
                   6244: 
1.795     www      6245: ul.LC_TabContent li,
                   6246: ul.LC_TabContentBigger li {
1.911     bisitz   6247:   float:left;
1.741     harmsja  6248: }
1.795     www      6249: 
1.897     wenzelju 6250: ul#LC_secondary_menu li a {
1.911     bisitz   6251:   color: $fontmenu;
                   6252:   text-decoration: none;
1.693     droeschl 6253: }
1.795     www      6254: 
1.721     harmsja  6255: ul.LC_TabContent {
1.911     bisitz   6256:   min-height:1.5em;
1.721     harmsja  6257: }
1.795     www      6258: 
                   6259: ul.LC_TabContent li {
1.911     bisitz   6260:   vertical-align:middle;
                   6261:   padding: 0 10px 0 10px;
                   6262:   background-color:$tabbg;
                   6263:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6264: }
1.795     www      6265: 
1.847     tempelho 6266: ul.LC_TabContent .right {
1.911     bisitz   6267:   float:right;
1.847     tempelho 6268: }
                   6269: 
1.911     bisitz   6270: ul.LC_TabContent li a,
                   6271: ul.LC_TabContent li {
                   6272:   color:rgb(47,47,47);
                   6273:   text-decoration:none;
                   6274:   font-size:95%;
                   6275:   font-weight:bold;
                   6276:   padding-right: 16px;
1.721     harmsja  6277: }
1.795     www      6278: 
1.911     bisitz   6279: ul.LC_TabContent li:hover,
                   6280: ul.LC_TabContent li.active {
                   6281:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6282:   border-bottom:solid 2px #FFFFFF;
                   6283:   padding-right: 16px;
1.744     ehlerst  6284: }
1.795     www      6285: 
1.870     tempelho 6286: #maincoursedoc {
1.911     bisitz   6287:   clear:both;
1.870     tempelho 6288: }
                   6289: 
                   6290: ul.LC_TabContentBigger {
1.911     bisitz   6291:   display:block;
                   6292:   list-style:none;
                   6293:   padding: 0;
1.870     tempelho 6294: }
                   6295: 
1.795     www      6296: ul.LC_TabContentBigger li {
1.911     bisitz   6297:   vertical-align:bottom;
                   6298:   height: 30px;
                   6299:   font-size:110%;
                   6300:   font-weight:bold;
                   6301:   color: #737373;
1.841     tempelho 6302: }
                   6303: 
1.870     tempelho 6304: 
                   6305: ul.LC_TabContentBigger li a {
1.911     bisitz   6306:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6307:   height: 30px;
                   6308:   line-height: 30px;
                   6309:   text-align: center;
                   6310:   display: block;
                   6311:   text-decoration: none;
1.741     harmsja  6312: }
1.795     www      6313: 
1.911     bisitz   6314: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6315: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6316:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6317:   color:$font;
                   6318:   text-decoration: underline;
1.744     ehlerst  6319: }
1.795     www      6320: 
1.870     tempelho 6321: 
                   6322: ul.LC_TabContentBigger li b {
1.911     bisitz   6323:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6324:   display: block;
                   6325:   float: left;
                   6326:   padding: 0 30px;
1.870     tempelho 6327: }
                   6328: 
                   6329: ul.LC_TabContentBigger li:hover b,
                   6330: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6331:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6332:   color:$font;
                   6333:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6334: }
1.693     droeschl 6335: 
1.870     tempelho 6336: 
1.862     bisitz   6337: ul.LC_CourseBreadcrumbs {
                   6338:   background: $sidebg;
                   6339:   line-height: 32px;
                   6340:   padding-left: 10px;
                   6341:   margin: 0 0 10px 0;
                   6342:   list-style-position: inside;
                   6343: 
                   6344: }
                   6345: 
1.911     bisitz   6346: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6347: ol#LC_PathBreadcrumbs {
1.911     bisitz   6348:   padding-left: 10px;
                   6349:   margin: 0;
1.925.2.14  raeburn  6350:   margin: 0;
                   6351:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6352: }
                   6353: 
1.911     bisitz   6354: ol#LC_MenuBreadcrumbs li,
                   6355: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6356: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6357:   display: inline;
1.925.2.14  raeburn  6358:   white-space: normal;
1.693     droeschl 6359: }
                   6360: 
1.823     bisitz   6361: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6362: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6363:   text-decoration: none;
                   6364:   font-size:90%;
1.693     droeschl 6365: }
1.795     www      6366: 
1.925.2.14  raeburn  6367: ol#LC_MenuBreadcrumbs h1 {
                   6368:   display: inline;
                   6369:   font-size: 90%;
                   6370:   line-height: 2.5em;
                   6371:   margin: 0;
                   6372:   padding: 0;
                   6373: }
                   6374: 
1.795     www      6375: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6376:   text-decoration:none;
                   6377:   font-size:100%;
                   6378:   font-weight:bold;
1.693     droeschl 6379: }
1.795     www      6380: 
1.840     bisitz   6381: .LC_Box {
1.911     bisitz   6382:   border: solid 1px $lg_border_color;
                   6383:   padding: 0 10px 10px 10px;
1.746     neumanie 6384: }
1.795     www      6385: 
                   6386: .LC_AboutMe_Image {
1.911     bisitz   6387:   float:left;
                   6388:   margin-right:10px;
1.747     neumanie 6389: }
1.795     www      6390: 
                   6391: .LC_Clear_AboutMe_Image {
1.911     bisitz   6392:   clear:left;
1.747     neumanie 6393: }
1.795     www      6394: 
1.721     harmsja  6395: dl.LC_ListStyleClean dt {
1.911     bisitz   6396:   padding-right: 5px;
                   6397:   display: table-header-group;
1.693     droeschl 6398: }
                   6399: 
1.721     harmsja  6400: dl.LC_ListStyleClean dd {
1.911     bisitz   6401:   display: table-row;
1.693     droeschl 6402: }
                   6403: 
1.721     harmsja  6404: .LC_ListStyleClean,
                   6405: .LC_ListStyleSimple,
                   6406: .LC_ListStyleNormal,
1.795     www      6407: .LC_ListStyleSpecial {
1.911     bisitz   6408:   /* display:block; */
                   6409:   list-style-position: inside;
                   6410:   list-style-type: none;
                   6411:   overflow: hidden;
                   6412:   padding: 0;
1.693     droeschl 6413: }
                   6414: 
1.721     harmsja  6415: .LC_ListStyleSimple li,
                   6416: .LC_ListStyleSimple dd,
                   6417: .LC_ListStyleNormal li,
                   6418: .LC_ListStyleNormal dd,
                   6419: .LC_ListStyleSpecial li,
1.795     www      6420: .LC_ListStyleSpecial dd {
1.911     bisitz   6421:   margin: 0;
                   6422:   padding: 5px 5px 5px 10px;
                   6423:   clear: both;
1.693     droeschl 6424: }
                   6425: 
1.721     harmsja  6426: .LC_ListStyleClean li,
                   6427: .LC_ListStyleClean dd {
1.911     bisitz   6428:   padding-top: 0;
                   6429:   padding-bottom: 0;
1.693     droeschl 6430: }
                   6431: 
1.721     harmsja  6432: .LC_ListStyleSimple dd,
1.795     www      6433: .LC_ListStyleSimple li {
1.911     bisitz   6434:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6435: }
                   6436: 
1.721     harmsja  6437: .LC_ListStyleSpecial li,
                   6438: .LC_ListStyleSpecial dd {
1.911     bisitz   6439:   list-style-type: none;
                   6440:   background-color: RGB(220, 220, 220);
                   6441:   margin-bottom: 4px;
1.693     droeschl 6442: }
                   6443: 
1.721     harmsja  6444: table.LC_SimpleTable {
1.911     bisitz   6445:   margin:5px;
                   6446:   border:solid 1px $lg_border_color;
1.795     www      6447: }
1.693     droeschl 6448: 
1.721     harmsja  6449: table.LC_SimpleTable tr {
1.911     bisitz   6450:   padding: 0;
                   6451:   border:solid 1px $lg_border_color;
1.693     droeschl 6452: }
1.795     www      6453: 
                   6454: table.LC_SimpleTable thead {
1.911     bisitz   6455:   background:rgb(220,220,220);
1.693     droeschl 6456: }
                   6457: 
1.721     harmsja  6458: div.LC_columnSection {
1.911     bisitz   6459:   display: block;
                   6460:   clear: both;
                   6461:   overflow: hidden;
                   6462:   margin: 0;
1.693     droeschl 6463: }
                   6464: 
1.721     harmsja  6465: div.LC_columnSection>* {
1.911     bisitz   6466:   float: left;
                   6467:   margin: 10px 20px 10px 0;
                   6468:   overflow:hidden;
1.693     droeschl 6469: }
1.721     harmsja  6470: 
1.694     tempelho 6471: .LC_loginpage_container {
1.911     bisitz   6472:   text-align:left;
                   6473:   margin : 0 auto;
                   6474:   width:90%;
                   6475:   padding: 10px;
                   6476:   height: auto;
                   6477:   background-color:#FFFFFF;
                   6478:   border:1px solid #CCCCCC;
1.694     tempelho 6479: }
                   6480: 
                   6481: 
                   6482: .LC_loginpage_loginContainer {
1.911     bisitz   6483:   float:left;
                   6484:   width: 182px;
                   6485:   padding: 2px;
                   6486:   border:1px solid #CCCCCC;
                   6487:   background-color:$loginbg;
1.694     tempelho 6488: }
                   6489: 
1.795     www      6490: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6491:   margin-top: 0;
                   6492:   display:block;
                   6493:   background:$bgcol;
                   6494:   color:$textcol;
                   6495:   padding-left:5px;
1.712     muellerd 6496: }
1.785     tempelho 6497: 
1.694     tempelho 6498: .LC_loginpage_loginInfo {
1.911     bisitz   6499:   float:left;
                   6500:   width:182px;
                   6501:   border:1px solid #CCCCCC;
                   6502:   padding:2px;
1.712     muellerd 6503: }
                   6504: 
1.694     tempelho 6505: .LC_loginpage_space {
1.911     bisitz   6506:   clear: both;
                   6507:   margin-bottom: 20px;
                   6508:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6509: }
                   6510: 
1.785     tempelho 6511: .LC_loginpage_floatLeft {
1.911     bisitz   6512:   float: left;
                   6513:   width: 200px;
                   6514:   margin: 0;
1.785     tempelho 6515: }
                   6516: 
1.795     www      6517: table em {
1.911     bisitz   6518:   font-weight: bold;
                   6519:   font-style: normal;
1.748     schulted 6520: }
1.795     www      6521: 
1.779     bisitz   6522: table.LC_tableBrowseRes,
1.795     www      6523: table.LC_tableOfContent {
1.911     bisitz   6524:   border:none;
                   6525:   border-spacing: 1px;
                   6526:   padding: 3px;
                   6527:   background-color: #FFFFFF;
                   6528:   font-size: 90%;
1.753     droeschl 6529: }
1.789     droeschl 6530: 
1.911     bisitz   6531: table.LC_tableOfContent {
                   6532:   border-collapse: collapse;
1.789     droeschl 6533: }
                   6534: 
1.771     droeschl 6535: table.LC_tableBrowseRes a,
1.768     schulted 6536: table.LC_tableOfContent a {
1.911     bisitz   6537:   background-color: transparent;
                   6538:   text-decoration: none;
1.753     droeschl 6539: }
                   6540: 
1.795     www      6541: table.LC_tableOfContent img {
1.911     bisitz   6542:   border: none;
                   6543:   height: 1.3em;
                   6544:   vertical-align: text-bottom;
                   6545:   margin-right: 0.3em;
1.753     droeschl 6546: }
1.757     schulted 6547: 
1.795     www      6548: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6549:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6550: }
                   6551: 
1.795     www      6552: a#LC_content_toolbar_launchnav {
1.911     bisitz   6553:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6554: }
                   6555: 
1.795     www      6556: a#LC_content_toolbar_closenav {
1.911     bisitz   6557:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6558: }
                   6559: 
1.795     www      6560: a#LC_content_toolbar_everything {
1.911     bisitz   6561:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6562: }
                   6563: 
1.795     www      6564: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6565:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6566: }
                   6567: 
1.795     www      6568: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6569:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6570: }
                   6571: 
1.795     www      6572: a#LC_content_toolbar_changefolder {
1.911     bisitz   6573:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6574: }
                   6575: 
1.795     www      6576: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6577:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6578: }
                   6579: 
1.925.2.17  raeburn  6580: a#LC_content_toolbar_management {
1.925.2.18  raeburn  6581:   background-image:url(/res/adm/pages/navtomenu.png);
1.925.2.17  raeburn  6582: }
                   6583: 
1.795     www      6584: ul#LC_toolbar li a:hover {
1.911     bisitz   6585:   background-position: bottom center;
1.757     schulted 6586: }
                   6587: 
1.795     www      6588: ul#LC_toolbar {
1.911     bisitz   6589:   padding: 0;
                   6590:   margin: 2px;
                   6591:   list-style:none;
                   6592:   position:relative;
                   6593:   background-color:white;
1.757     schulted 6594: }
                   6595: 
1.795     www      6596: ul#LC_toolbar li {
1.911     bisitz   6597:   border:1px solid white;
                   6598:   padding: 0;
                   6599:   margin: 0;
                   6600:   float: left;
                   6601:   display:inline;
                   6602:   vertical-align:middle;
                   6603: }
1.757     schulted 6604: 
1.783     amueller 6605: 
1.795     www      6606: a.LC_toolbarItem {
1.911     bisitz   6607:   display:block;
                   6608:   padding: 0;
                   6609:   margin: 0;
                   6610:   height: 32px;
                   6611:   width: 32px;
                   6612:   color:white;
                   6613:   border: none;
                   6614:   background-repeat:no-repeat;
                   6615:   background-color:transparent;
1.757     schulted 6616: }
                   6617: 
1.915     droeschl 6618: ul.LC_funclist {
                   6619:     margin: 0;
                   6620:     padding: 0.5em 1em 0.5em 0;
                   6621: }
                   6622: 
1.925.2.14  raeburn  6623: ul.LC_funclist > li:first-child {
                   6624:     font-weight:bold;
                   6625:     margin-left:0.8em;
                   6626: }
                   6627: 
1.915     droeschl 6628: ul.LC_funclist + ul.LC_funclist {
                   6629:     /* 
                   6630:        left border as a seperator if we have more than
                   6631:        one list 
                   6632:     */
                   6633:     border-left: 1px solid $sidebg;
                   6634:     /* 
                   6635:        this hides the left border behind the border of the 
                   6636:        outer box if element is wrapped to the next 'line' 
                   6637:     */
                   6638:     margin-left: -1px;
                   6639: }
                   6640: 
1.843     bisitz   6641: ul.LC_funclist li {
1.915     droeschl 6642:   display: inline;
1.782     bisitz   6643:   white-space: nowrap;
1.915     droeschl 6644:   margin: 0 0 0 25px;
                   6645:   line-height: 150%;
1.782     bisitz   6646: }
                   6647: 
1.925.2.1  raeburn  6648: #gciheader {
                   6649:   float:left;
                   6650:   width:100%;
                   6651:   background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
                   6652:   font-size:93%;
                   6653:   line-height:normal;
1.925.2.14  raeburn  6654:   margin: 0.5em 0 0.5em 0;
1.925.2.1  raeburn  6655: }
                   6656: #gciheader ul {
                   6657:   margin:0;
1.925.2.16  raeburn  6658:   padding:10px 10px 0;
1.925.2.1  raeburn  6659:   list-style:none;
                   6660: }
                   6661: #gciheader li {
                   6662:   float:left;
                   6663:   background:url("/gcimenu_left.gif") no-repeat left top;
                   6664:   margin:0;
                   6665:   padding:0 0 0 9px;
                   6666: }
                   6667: #gciheader a {
                   6668:   display:block;
                   6669:   background:url("/gcimenu_right.gif") no-repeat right top;
                   6670:   padding:5px 15px 4px 6px;
                   6671: }
                   6672: #gciheader #current {
                   6673:   background-image:url("/gcimenu_left_on.gif");
                   6674: }
                   6675: #gciheader #current a {
                   6676:   background-image:url("/gcimenu_right_on.gif");
                   6677:   padding-bottom:5px;
                   6678: }
1.757     schulted 6679: 
1.343     albertel 6680: END
                   6681: }
                   6682: 
1.306     albertel 6683: =pod
                   6684: 
                   6685: =item * &headtag()
                   6686: 
                   6687: Returns a uniform footer for LON-CAPA web pages.
                   6688: 
1.307     albertel 6689: Inputs: $title - optional title for the head
                   6690:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6691:         $args - optional arguments
1.319     albertel 6692:             force_register - if is true call registerurl so the remote is 
                   6693:                              informed
1.415     albertel 6694:             redirect       -> array ref of
                   6695:                                    1- seconds before redirect occurs
                   6696:                                    2- url to redirect to
                   6697:                                    3- whether the side effect should occur
1.315     albertel 6698:                            (side effect of setting 
                   6699:                                $env{'internal.head.redirect'} to the url 
                   6700:                                redirected too)
1.352     albertel 6701:             domain         -> force to color decorate a page for a specific
                   6702:                                domain
                   6703:             function       -> force usage of a specific rolish color scheme
                   6704:             bgcolor        -> override the default page bgcolor
1.460     albertel 6705:             no_auto_mt_title
                   6706:                            -> prevent &mt()ing the title arg
1.464     albertel 6707: 
1.306     albertel 6708: =cut
                   6709: 
                   6710: sub headtag {
1.313     albertel 6711:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6712:     
1.363     albertel 6713:     my $function = $args->{'function'} || &get_users_function();
                   6714:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6715:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6716:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6717: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6718: 		   #time(),
1.418     albertel 6719: 		   $env{'environment.color.timestamp'},
1.363     albertel 6720: 		   $function,$domain,$bgcolor);
                   6721: 
1.369     www      6722:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6723: 
1.308     albertel 6724:     my $result =
                   6725: 	'<head>'.
1.461     albertel 6726: 	&font_settings();
1.319     albertel 6727: 
1.461     albertel 6728:     if (!$args->{'frameset'}) {
                   6729: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6730:     }
1.319     albertel 6731:     if ($args->{'force_register'}) {
                   6732: 	$result .= &Apache::lonmenu::registerurl(1);
                   6733:     }
1.436     albertel 6734:     if (!$args->{'no_nav_bar'} 
                   6735: 	&& !$args->{'only_body'}
                   6736: 	&& !$args->{'frameset'}) {
                   6737: 	$result .= &help_menu_js();
                   6738:     }
1.319     albertel 6739: 
1.314     albertel 6740:     if (ref($args->{'redirect'})) {
1.414     albertel 6741: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6742: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6743: 	if (!$inhibit_continue) {
                   6744: 	    $env{'internal.head.redirect'} = $url;
                   6745: 	}
1.313     albertel 6746: 	$result.=<<ADDMETA
                   6747: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6748: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6749: ADDMETA
                   6750:     }
1.306     albertel 6751:     if (!defined($title)) {
                   6752: 	$title = 'The LearningOnline Network with CAPA';
                   6753:     }
1.460     albertel 6754:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6755:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6756: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6757: 	.$head_extra;
1.306     albertel 6758:     return $result;
                   6759: }
                   6760: 
                   6761: =pod
                   6762: 
1.340     albertel 6763: =item * &font_settings()
                   6764: 
                   6765: Returns neccessary <meta> to set the proper encoding
                   6766: 
                   6767: Inputs: none
                   6768: 
                   6769: =cut
                   6770: 
                   6771: sub font_settings {
                   6772:     my $headerstring='';
1.647     www      6773:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6774: 	$headerstring.=
                   6775: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6776:     }
                   6777:     return $headerstring;
                   6778: }
                   6779: 
1.341     albertel 6780: =pod
                   6781: 
                   6782: =item * &xml_begin()
                   6783: 
                   6784: Returns the needed doctype and <html>
                   6785: 
                   6786: Inputs: none
                   6787: 
                   6788: =cut
                   6789: 
                   6790: sub xml_begin {
                   6791:     my $output='';
                   6792: 
1.592     albertel 6793:     if ($env{'internal.start_page'}==1) {
                   6794: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6795:     }
1.342     albertel 6796: 
1.341     albertel 6797:     if ($env{'browser.mathml'}) {
                   6798: 	$output='<?xml version="1.0"?>'
                   6799:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6800: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6801:             
                   6802: #	    .'<!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">] >'
                   6803: 	    .'<!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">'
                   6804:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6805: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6806:     } else {
1.849     bisitz   6807: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6808:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6809:     }
                   6810:     return $output;
                   6811: }
1.340     albertel 6812: 
                   6813: =pod
                   6814: 
1.306     albertel 6815: =item * &endheadtag()
                   6816: 
                   6817: Returns a uniform </head> for LON-CAPA web pages.
                   6818: 
                   6819: Inputs: none
                   6820: 
                   6821: =cut
                   6822: 
                   6823: sub endheadtag {
                   6824:     return '</head>';
                   6825: }
                   6826: 
                   6827: =pod
                   6828: 
                   6829: =item * &head()
                   6830: 
                   6831: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6832: 
1.648     raeburn  6833: Inputs:
                   6834: 
                   6835: =over 4
                   6836: 
                   6837: $title - optional title for the page
                   6838: 
                   6839: $head_extra - optional extra HTML to put inside the <head>
                   6840: 
                   6841: =back
1.405     albertel 6842: 
1.306     albertel 6843: =cut
                   6844: 
                   6845: sub head {
1.325     albertel 6846:     my ($title,$head_extra,$args) = @_;
                   6847:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6848: }
                   6849: 
                   6850: =pod
                   6851: 
                   6852: =item * &start_page()
                   6853: 
                   6854: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6855: 
1.648     raeburn  6856: Inputs:
                   6857: 
                   6858: =over 4
                   6859: 
                   6860: $title - optional title for the page
                   6861: 
                   6862: $head_extra - optional extra HTML to incude inside the <head>
                   6863: 
                   6864: $args - additional optional args supported are:
                   6865: 
                   6866: =over 8
                   6867: 
                   6868:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6869:                                     arg on
1.814     bisitz   6870:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6871:              add_entries    -> additional attributes to add to the  <body>
                   6872:              domain         -> force to color decorate a page for a 
1.317     albertel 6873:                                     specific domain
1.648     raeburn  6874:              function       -> force usage of a specific rolish color
1.317     albertel 6875:                                     scheme
1.648     raeburn  6876:              redirect       -> see &headtag()
                   6877:              bgcolor        -> override the default page bg color
                   6878:              js_ready       -> return a string ready for being used in 
1.317     albertel 6879:                                     a javascript writeln
1.648     raeburn  6880:              html_encode    -> return a string ready for being used in 
1.320     albertel 6881:                                     a html attribute
1.648     raeburn  6882:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6883:                                     $forcereg arg
1.648     raeburn  6884:              frameset       -> if true will start with a <frameset>
1.330     albertel 6885:                                     rather than <body>
1.648     raeburn  6886:              skip_phases    -> hash ref of 
1.338     albertel 6887:                                     head -> skip the <html><head> generation
                   6888:                                     body -> skip all <body> generation
1.648     raeburn  6889:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6890:                                     'Switch To Inline Menu' link
1.648     raeburn  6891:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6892:              inherit_jsmath -> when creating popup window in a page,
                   6893:                                     should it have jsmath forced on by the
                   6894:                                     current page
1.867     kalberla 6895:              bread_crumbs ->             Array containing breadcrumbs
                   6896:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6897: 
1.648     raeburn  6898: =back
1.460     albertel 6899: 
1.648     raeburn  6900: =back
1.562     albertel 6901: 
1.306     albertel 6902: =cut
                   6903: 
                   6904: sub start_page {
1.309     albertel 6905:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6906:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6907:     my %head_args;
1.352     albertel 6908:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6909: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6910: 		     'no_auto_mt_title') {
1.319     albertel 6911: 	if (defined($args->{$arg})) {
1.324     raeburn  6912: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6913: 	}
1.313     albertel 6914:     }
1.319     albertel 6915: 
1.315     albertel 6916:     $env{'internal.start_page'}++;
1.338     albertel 6917:     my $result;
                   6918:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6919: 	$result.=
1.341     albertel 6920: 	    &xml_begin().
1.338     albertel 6921: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6922:     }
                   6923:     
                   6924:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6925: 	if ($args->{'frameset'}) {
                   6926: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6927: 						$args->{'add_entries'});
                   6928: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6929:         } else {
                   6930:             $result .=
                   6931:                 &bodytag($title, 
                   6932:                          $args->{'function'},       $args->{'add_entries'},
                   6933:                          $args->{'only_body'},      $args->{'domain'},
                   6934:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6935:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6936:                          $args);
                   6937:         }
1.330     albertel 6938:     }
1.338     albertel 6939: 
1.315     albertel 6940:     if ($args->{'js_ready'}) {
1.713     kaisler  6941: 		$result = &js_ready($result);
1.315     albertel 6942:     }
1.320     albertel 6943:     if ($args->{'html_encode'}) {
1.713     kaisler  6944: 		$result = &html_encode($result);
                   6945:     }
                   6946: 
1.813     bisitz   6947:     # Preparation for new and consistent functionlist at top of screen
                   6948:     # if ($args->{'functionlist'}) {
                   6949:     #            $result .= &build_functionlist();
                   6950:     #}
                   6951: 
                   6952:     # Don't add anything more if only_body wanted
                   6953:     return $result if $args->{'only_body'};
                   6954: 
1.920     raeburn  6955:     #Breadcrumbs for Construction Space provided by &bodytag. 
                   6956:     if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
                   6957:         return $result;
                   6958:     }
                   6959:  
1.813     bisitz   6960:     #Breadcrumbs
1.758     kaisler  6961:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6962: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6963: 		#if any br links exists, add them to the breadcrumbs
                   6964: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6965: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6966: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6967: 			}
                   6968: 		}
                   6969: 
                   6970: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6971: 		if(exists($args->{'bread_crumbs_component'})){
                   6972: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
1.925.2.16  raeburn  6973: 		} elsif (exists($args->{'bread_crumbs_menulink'})) {
1.925.2.17  raeburn  6974: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$args->{'bread_crumbs_menulink'});
1.925.2.16  raeburn  6975:                 } else {
1.925.2.17  raeburn  6976: 			$result .= &Apache::lonhtmlcommon::breadcrumbs(); 
1.758     kaisler  6977: 		}
1.320     albertel 6978:     }
1.315     albertel 6979:     return $result;
1.306     albertel 6980: }
                   6981: 
1.330     albertel 6982: 
1.306     albertel 6983: =pod
                   6984: 
                   6985: =item * &head()
                   6986: 
                   6987: Returns a complete </body></html> section for LON-CAPA web pages.
                   6988: 
1.315     albertel 6989: Inputs:         $args - additional optional args supported are:
                   6990:                  js_ready     -> return a string ready for being used in 
                   6991:                                  a javascript writeln
1.320     albertel 6992:                  html_encode  -> return a string ready for being used in 
                   6993:                                  a html attribute
1.330     albertel 6994:                  frameset     -> if true will start with a <frameset>
                   6995:                                  rather than <body>
1.493     albertel 6996:                  dicsussion   -> if true will get discussion from
                   6997:                                   lonxml::xmlend
                   6998:                                  (you can pass the target and parser arguments
                   6999:                                   through optional 'target' and 'parser' args
                   7000:                                   to this routine)
1.306     albertel 7001: 
                   7002: =cut
                   7003: 
                   7004: sub end_page {
1.315     albertel 7005:     my ($args) = @_;
                   7006:     $env{'internal.end_page'}++;
1.330     albertel 7007:     my $result;
1.335     albertel 7008:     if ($args->{'discussion'}) {
                   7009: 	my ($target,$parser);
                   7010: 	if (ref($args->{'discussion'})) {
                   7011: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7012: 				$args->{'discussion'}{'parser'});
                   7013: 	}
                   7014: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7015:     }
                   7016: 
1.330     albertel 7017:     if ($args->{'frameset'}) {
                   7018: 	$result .= '</frameset>';
                   7019:     } else {
1.635     raeburn  7020: 	$result .= &endbodytag($args);
1.330     albertel 7021:     }
                   7022:     $result .= "\n</html>";
                   7023: 
1.315     albertel 7024:     if ($args->{'js_ready'}) {
1.317     albertel 7025: 	$result = &js_ready($result);
1.315     albertel 7026:     }
1.335     albertel 7027: 
1.320     albertel 7028:     if ($args->{'html_encode'}) {
                   7029: 	$result = &html_encode($result);
                   7030:     }
1.335     albertel 7031: 
1.315     albertel 7032:     return $result;
                   7033: }
                   7034: 
1.320     albertel 7035: sub html_encode {
                   7036:     my ($result) = @_;
                   7037: 
1.322     albertel 7038:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7039:     
                   7040:     return $result;
                   7041: }
1.317     albertel 7042: sub js_ready {
                   7043:     my ($result) = @_;
                   7044: 
1.323     albertel 7045:     $result =~ s/[\n\r]/ /xmsg;
                   7046:     $result =~ s/\\/\\\\/xmsg;
                   7047:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7048:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7049:     
                   7050:     return $result;
                   7051: }
                   7052: 
1.315     albertel 7053: sub validate_page {
                   7054:     if (  exists($env{'internal.start_page'})
1.316     albertel 7055: 	  &&     $env{'internal.start_page'} > 1) {
                   7056: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7057: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7058: 				 $ENV{'request.filename'});
1.315     albertel 7059:     }
                   7060:     if (  exists($env{'internal.end_page'})
1.316     albertel 7061: 	  &&     $env{'internal.end_page'} > 1) {
                   7062: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7063: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7064: 				 $env{'request.filename'});
1.315     albertel 7065:     }
                   7066:     if (     exists($env{'internal.start_page'})
                   7067: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7068: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7069: 				 $env{'request.filename'});
1.315     albertel 7070:     }
                   7071:     if (   ! exists($env{'internal.start_page'})
                   7072: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7073: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7074: 				 $env{'request.filename'});
1.315     albertel 7075:     }
1.306     albertel 7076: }
1.315     albertel 7077: 
1.318     albertel 7078: sub simple_error_page {
                   7079:     my ($r,$title,$msg) = @_;
                   7080:     my $page =
                   7081: 	&Apache::loncommon::start_page($title).
                   7082: 	&mt($msg).
                   7083: 	&Apache::loncommon::end_page();
                   7084:     if (ref($r)) {
                   7085: 	$r->print($page);
1.327     albertel 7086: 	return;
1.318     albertel 7087:     }
                   7088:     return $page;
                   7089: }
1.347     albertel 7090: 
                   7091: {
1.610     albertel 7092:     my @row_count;
1.347     albertel 7093:     sub start_data_table {
1.422     albertel 7094: 	my ($add_class) = @_;
                   7095: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 7096: 	unshift(@row_count,0);
1.422     albertel 7097: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 7098:     }
                   7099: 
                   7100:     sub end_data_table {
1.610     albertel 7101: 	shift(@row_count);
1.389     albertel 7102: 	return '</table>'."\n";;
1.347     albertel 7103:     }
                   7104: 
                   7105:     sub start_data_table_row {
1.422     albertel 7106: 	my ($add_class) = @_;
1.610     albertel 7107: 	$row_count[0]++;
                   7108: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7109: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 7110: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 7111:     }
1.471     banghart 7112:     
                   7113:     sub continue_data_table_row {
                   7114: 	my ($add_class) = @_;
1.610     albertel 7115: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7116: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 7117: 	return  '<tr class="'.$css_class.'">'."\n";;
                   7118:     }
1.347     albertel 7119: 
                   7120:     sub end_data_table_row {
1.389     albertel 7121: 	return '</tr>'."\n";;
1.347     albertel 7122:     }
1.367     www      7123: 
1.421     albertel 7124:     sub start_data_table_empty_row {
1.707     bisitz   7125: #	$row_count[0]++;
1.421     albertel 7126: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7127:     }
                   7128: 
                   7129:     sub end_data_table_empty_row {
                   7130: 	return '</tr>'."\n";;
                   7131:     }
                   7132: 
1.367     www      7133:     sub start_data_table_header_row {
1.389     albertel 7134: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7135:     }
                   7136: 
                   7137:     sub end_data_table_header_row {
1.389     albertel 7138: 	return '</tr>'."\n";;
1.367     www      7139:     }
1.890     droeschl 7140: 
                   7141:     sub data_table_caption {
                   7142:         my $caption = shift;
                   7143:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7144:     }
1.347     albertel 7145: }
                   7146: 
1.548     albertel 7147: =pod
                   7148: 
                   7149: =item * &inhibit_menu_check($arg)
                   7150: 
                   7151: Checks for a inhibitmenu state and generates output to preserve it
                   7152: 
                   7153: Inputs:         $arg - can be any of
                   7154:                      - undef - in which case the return value is a string 
                   7155:                                to add  into arguments list of a uri
                   7156:                      - 'input' - in which case the return value is a HTML
                   7157:                                  <form> <input> field of type hidden to
                   7158:                                  preserve the value
                   7159:                      - a url - in which case the return value is the url with
                   7160:                                the neccesary cgi args added to preserve the
                   7161:                                inhibitmenu state
                   7162:                      - a ref to a url - no return value, but the string is
                   7163:                                         updated to include the neccessary cgi
                   7164:                                         args to preserve the inhibitmenu state
                   7165: 
                   7166: =cut
                   7167: 
                   7168: sub inhibit_menu_check {
                   7169:     my ($arg) = @_;
                   7170:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7171:     if ($arg eq 'input') {
                   7172: 	if ($env{'form.inhibitmenu'}) {
                   7173: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7174: 	} else {
                   7175: 	    return
                   7176: 	}
                   7177:     }
                   7178:     if ($env{'form.inhibitmenu'}) {
                   7179: 	if (ref($arg)) {
                   7180: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7181: 	} elsif ($arg eq '') {
                   7182: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7183: 	} else {
                   7184: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7185: 	}
                   7186:     }
                   7187:     if (!ref($arg)) {
                   7188: 	return $arg;
                   7189:     }
                   7190: }
                   7191: 
1.251     albertel 7192: ###############################################
1.182     matthew  7193: 
                   7194: =pod
                   7195: 
1.549     albertel 7196: =back
                   7197: 
                   7198: =head1 User Information Routines
                   7199: 
                   7200: =over 4
                   7201: 
1.405     albertel 7202: =item * &get_users_function()
1.182     matthew  7203: 
                   7204: Used by &bodytag to determine the current users primary role.
                   7205: Returns either 'student','coordinator','admin', or 'author'.
                   7206: 
                   7207: =cut
                   7208: 
                   7209: ###############################################
                   7210: sub get_users_function {
1.815     tempelho 7211:     my $function = 'norole';
1.818     tempelho 7212:     if ($env{'request.role'}=~/^(st)/) {
                   7213:         $function='student';
                   7214:     }
1.907     raeburn  7215:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7216:         $function='coordinator';
                   7217:     }
1.258     albertel 7218:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7219:         $function='admin';
                   7220:     }
1.826     bisitz   7221:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7222:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7223:         $function='author';
                   7224:     }
                   7225:     return $function;
1.54      www      7226: }
1.99      www      7227: 
                   7228: ###############################################
                   7229: 
1.233     raeburn  7230: =pod
                   7231: 
1.821     raeburn  7232: =item * &show_course()
                   7233: 
                   7234: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7235: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7236: 
                   7237: Inputs:
                   7238: None
                   7239: 
                   7240: Outputs:
                   7241: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7242: 
                   7243: =cut
                   7244: 
                   7245: ###############################################
                   7246: sub show_course {
                   7247:     my $course = !$env{'user.adv'};
                   7248:     if (!$env{'user.adv'}) {
                   7249:         foreach my $env (keys(%env)) {
                   7250:             next if ($env !~ m/^user\.priv\./);
                   7251:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7252:                 $course = 0;
                   7253:                 last;
                   7254:             }
                   7255:         }
                   7256:     }
                   7257:     return $course;
                   7258: }
                   7259: 
                   7260: ###############################################
                   7261: 
                   7262: =pod
                   7263: 
1.542     raeburn  7264: =item * &check_user_status()
1.274     raeburn  7265: 
                   7266: Determines current status of supplied role for a
                   7267: specific user. Roles can be active, previous or future.
                   7268: 
                   7269: Inputs: 
                   7270: user's domain, user's username, course's domain,
1.375     raeburn  7271: course's number, optional section ID.
1.274     raeburn  7272: 
                   7273: Outputs:
                   7274: role status: active, previous or future. 
                   7275: 
                   7276: =cut
                   7277: 
                   7278: sub check_user_status {
1.412     raeburn  7279:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7280:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7281:     my @uroles = keys %userinfo;
                   7282:     my $srchstr;
                   7283:     my $active_chk = 'none';
1.412     raeburn  7284:     my $now = time;
1.274     raeburn  7285:     if (@uroles > 0) {
1.908     raeburn  7286:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7287:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7288:         } else {
1.412     raeburn  7289:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7290:         }
                   7291:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7292:             my $role_end = 0;
                   7293:             my $role_start = 0;
                   7294:             $active_chk = 'active';
1.412     raeburn  7295:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7296:                 $role_end = $1;
                   7297:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7298:                     $role_start = $1;
1.274     raeburn  7299:                 }
                   7300:             }
                   7301:             if ($role_start > 0) {
1.412     raeburn  7302:                 if ($now < $role_start) {
1.274     raeburn  7303:                     $active_chk = 'future';
                   7304:                 }
                   7305:             }
                   7306:             if ($role_end > 0) {
1.412     raeburn  7307:                 if ($now > $role_end) {
1.274     raeburn  7308:                     $active_chk = 'previous';
                   7309:                 }
                   7310:             }
                   7311:         }
                   7312:     }
                   7313:     return $active_chk;
                   7314: }
                   7315: 
                   7316: ###############################################
                   7317: 
                   7318: =pod
                   7319: 
1.405     albertel 7320: =item * &get_sections()
1.233     raeburn  7321: 
                   7322: Determines all the sections for a course including
                   7323: sections with students and sections containing other roles.
1.419     raeburn  7324: Incoming parameters: 
                   7325: 
                   7326: 1. domain
                   7327: 2. course number 
                   7328: 3. reference to array containing roles for which sections should 
                   7329: be gathered (optional).
                   7330: 4. reference to array containing status types for which sections 
                   7331: should be gathered (optional).
                   7332: 
                   7333: If the third argument is undefined, sections are gathered for any role. 
                   7334: If the fourth argument is undefined, sections are gathered for any status.
                   7335: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7336:  
1.374     raeburn  7337: Returns section hash (keys are section IDs, values are
                   7338: number of users in each section), subject to the
1.419     raeburn  7339: optional roles filter, optional status filter 
1.233     raeburn  7340: 
                   7341: =cut
                   7342: 
                   7343: ###############################################
                   7344: sub get_sections {
1.419     raeburn  7345:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7346:     if (!defined($cdom) || !defined($cnum)) {
                   7347:         my $cid =  $env{'request.course.id'};
                   7348: 
                   7349: 	return if (!defined($cid));
                   7350: 
                   7351:         $cdom = $env{'course.'.$cid.'.domain'};
                   7352:         $cnum = $env{'course.'.$cid.'.num'};
                   7353:     }
                   7354: 
                   7355:     my %sectioncount;
1.419     raeburn  7356:     my $now = time;
1.240     albertel 7357: 
1.366     albertel 7358:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7359: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7360: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7361: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7362:         my $start_index = &Apache::loncoursedata::CL_START();
                   7363:         my $end_index = &Apache::loncoursedata::CL_END();
                   7364:         my $status;
1.366     albertel 7365: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7366: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7367: 				                     $data->[$status_index],
                   7368:                                                      $data->[$start_index],
                   7369:                                                      $data->[$end_index]);
                   7370:             if ($stu_status eq 'Active') {
                   7371:                 $status = 'active';
                   7372:             } elsif ($end < $now) {
                   7373:                 $status = 'previous';
                   7374:             } elsif ($start > $now) {
                   7375:                 $status = 'future';
                   7376:             } 
                   7377: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7378:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7379:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7380: 		    $sectioncount{$section}++;
                   7381:                 }
1.240     albertel 7382: 	    }
                   7383: 	}
                   7384:     }
                   7385:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7386:     foreach my $user (sort(keys(%courseroles))) {
                   7387: 	if ($user !~ /^(\w{2})/) { next; }
                   7388: 	my ($role) = ($user =~ /^(\w{2})/);
                   7389: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7390: 	my ($section,$status);
1.240     albertel 7391: 	if ($role eq 'cr' &&
                   7392: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7393: 	    $section=$1;
                   7394: 	}
                   7395: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7396: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7397:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7398:         if ($end == -1 && $start == -1) {
                   7399:             next; #deleted role
                   7400:         }
                   7401:         if (!defined($possible_status)) { 
                   7402:             $sectioncount{$section}++;
                   7403:         } else {
                   7404:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7405:                 $status = 'active';
                   7406:             } elsif ($end < $now) {
                   7407:                 $status = 'future';
                   7408:             } elsif ($start > $now) {
                   7409:                 $status = 'previous';
                   7410:             }
                   7411:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7412:                 $sectioncount{$section}++;
                   7413:             }
                   7414:         }
1.233     raeburn  7415:     }
1.366     albertel 7416:     return %sectioncount;
1.233     raeburn  7417: }
                   7418: 
1.274     raeburn  7419: ###############################################
1.294     raeburn  7420: 
                   7421: =pod
1.405     albertel 7422: 
                   7423: =item * &get_course_users()
                   7424: 
1.275     raeburn  7425: Retrieves usernames:domains for users in the specified course
                   7426: with specific role(s), and access status. 
                   7427: 
                   7428: Incoming parameters:
1.277     albertel 7429: 1. course domain
                   7430: 2. course number
                   7431: 3. access status: users must have - either active, 
1.275     raeburn  7432: previous, future, or all.
1.277     albertel 7433: 4. reference to array of permissible roles
1.288     raeburn  7434: 5. reference to array of section restrictions (optional)
                   7435: 6. reference to results object (hash of hashes).
                   7436: 7. reference to optional userdata hash
1.609     raeburn  7437: 8. reference to optional statushash
1.630     raeburn  7438: 9. flag if privileged users (except those set to unhide in
                   7439:    course settings) should be excluded    
1.609     raeburn  7440: Keys of top level results hash are roles.
1.275     raeburn  7441: Keys of inner hashes are username:domain, with 
                   7442: values set to access type.
1.288     raeburn  7443: Optional userdata hash returns an array with arguments in the 
                   7444: same order as loncoursedata::get_classlist() for student data.
                   7445: 
1.609     raeburn  7446: Optional statushash returns
                   7447: 
1.288     raeburn  7448: Entries for end, start, section and status are blank because
                   7449: of the possibility of multiple values for non-student roles.
                   7450: 
1.275     raeburn  7451: =cut
1.405     albertel 7452: 
1.275     raeburn  7453: ###############################################
1.405     albertel 7454: 
1.275     raeburn  7455: sub get_course_users {
1.630     raeburn  7456:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7457:     my %idx = ();
1.419     raeburn  7458:     my %seclists;
1.288     raeburn  7459: 
                   7460:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7461:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7462:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7463:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7464:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7465:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7466:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7467:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7468: 
1.290     albertel 7469:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7470:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7471:         my $now = time;
1.277     albertel 7472:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7473:             my $match = 0;
1.412     raeburn  7474:             my $secmatch = 0;
1.419     raeburn  7475:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7476:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7477:             if ($section eq '') {
                   7478:                 $section = 'none';
                   7479:             }
1.291     albertel 7480:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7481:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7482:                     $secmatch = 1;
                   7483:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7484:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7485:                         $secmatch = 1;
                   7486:                     }
                   7487:                 } else {  
1.419     raeburn  7488: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7489: 		        $secmatch = 1;
                   7490:                     }
1.290     albertel 7491: 		}
1.412     raeburn  7492:                 if (!$secmatch) {
                   7493:                     next;
                   7494:                 }
1.419     raeburn  7495:             }
1.275     raeburn  7496:             if (defined($$types{'active'})) {
1.288     raeburn  7497:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7498:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7499:                     $match = 1;
1.275     raeburn  7500:                 }
                   7501:             }
                   7502:             if (defined($$types{'previous'})) {
1.609     raeburn  7503:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7504:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7505:                     $match = 1;
1.275     raeburn  7506:                 }
                   7507:             }
                   7508:             if (defined($$types{'future'})) {
1.609     raeburn  7509:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7510:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7511:                     $match = 1;
1.275     raeburn  7512:                 }
                   7513:             }
1.609     raeburn  7514:             if ($match) {
                   7515:                 push(@{$seclists{$student}},$section);
                   7516:                 if (ref($userdata) eq 'HASH') {
                   7517:                     $$userdata{$student} = $$classlist{$student};
                   7518:                 }
                   7519:                 if (ref($statushash) eq 'HASH') {
                   7520:                     $statushash->{$student}{'st'}{$section} = $status;
                   7521:                 }
1.288     raeburn  7522:             }
1.275     raeburn  7523:         }
                   7524:     }
1.412     raeburn  7525:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7526:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7527:         my $now = time;
1.609     raeburn  7528:         my %displaystatus = ( previous => 'Expired',
                   7529:                               active   => 'Active',
                   7530:                               future   => 'Future',
                   7531:                             );
1.630     raeburn  7532:         my %nothide;
                   7533:         if ($hidepriv) {
                   7534:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7535:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7536:                 if ($user !~ /:/) {
                   7537:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7538:                 } else {
                   7539:                     $nothide{$user} = 1;
                   7540:                 }
                   7541:             }
                   7542:         }
1.439     raeburn  7543:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7544:             my $match = 0;
1.412     raeburn  7545:             my $secmatch = 0;
1.439     raeburn  7546:             my $status;
1.412     raeburn  7547:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7548:             $user =~ s/:$//;
1.439     raeburn  7549:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7550:             if ($end == -1 || $start == -1) {
                   7551:                 next;
                   7552:             }
                   7553:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7554:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7555:                 my ($uname,$udom) = split(/:/,$user);
                   7556:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7557:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7558:                         $secmatch = 1;
                   7559:                     } elsif ($usec eq '') {
1.420     albertel 7560:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7561:                             $secmatch = 1;
                   7562:                         }
                   7563:                     } else {
                   7564:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7565:                             $secmatch = 1;
                   7566:                         }
                   7567:                     }
                   7568:                     if (!$secmatch) {
                   7569:                         next;
                   7570:                     }
1.288     raeburn  7571:                 }
1.419     raeburn  7572:                 if ($usec eq '') {
                   7573:                     $usec = 'none';
                   7574:                 }
1.275     raeburn  7575:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7576:                     if ($hidepriv) {
                   7577:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7578:                             (!$nothide{$uname.':'.$udom})) {
                   7579:                             next;
                   7580:                         }
                   7581:                     }
1.503     raeburn  7582:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7583:                         $status = 'previous';
                   7584:                     } elsif ($start > $now) {
                   7585:                         $status = 'future';
                   7586:                     } else {
                   7587:                         $status = 'active';
                   7588:                     }
1.277     albertel 7589:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7590:                         if ($status eq $type) {
1.420     albertel 7591:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7592:                                 push(@{$$users{$role}{$user}},$type);
                   7593:                             }
1.288     raeburn  7594:                             $match = 1;
                   7595:                         }
                   7596:                     }
1.419     raeburn  7597:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7598:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7599: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7600:                         }
1.420     albertel 7601:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7602:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7603:                         }
1.609     raeburn  7604:                         if (ref($statushash) eq 'HASH') {
                   7605:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7606:                         }
1.275     raeburn  7607:                     }
                   7608:                 }
                   7609:             }
                   7610:         }
1.290     albertel 7611:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7612:             if ((defined($cdom)) && (defined($cnum))) {
                   7613:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7614:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7615:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7616:                     next if ($owner eq '');
                   7617:                     my ($ownername,$ownerdom);
                   7618:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7619:                         $ownername = $1;
                   7620:                         $ownerdom = $2;
                   7621:                     } else {
                   7622:                         $ownername = $owner;
                   7623:                         $ownerdom = $cdom;
                   7624:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7625:                     }
                   7626:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7627:                     if (defined($userdata) && 
1.609     raeburn  7628: 			!exists($$userdata{$owner})) {
                   7629: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7630:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7631:                             push(@{$seclists{$owner}},'none');
                   7632:                         }
                   7633:                         if (ref($statushash) eq 'HASH') {
                   7634:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7635:                         }
1.290     albertel 7636: 		    }
1.279     raeburn  7637:                 }
                   7638:             }
                   7639:         }
1.419     raeburn  7640:         foreach my $user (keys(%seclists)) {
                   7641:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7642:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7643:         }
1.275     raeburn  7644:     }
                   7645:     return;
                   7646: }
                   7647: 
1.288     raeburn  7648: sub get_user_info {
                   7649:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7650:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7651: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7652:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7653:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7654:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7655:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7656:     return;
                   7657: }
1.275     raeburn  7658: 
1.472     raeburn  7659: ###############################################
                   7660: 
                   7661: =pod
                   7662: 
                   7663: =item * &get_user_quota()
                   7664: 
                   7665: Retrieves quota assigned for storage of portfolio files for a user  
                   7666: 
                   7667: Incoming parameters:
                   7668: 1. user's username
                   7669: 2. user's domain
                   7670: 
                   7671: Returns:
1.536     raeburn  7672: 1. Disk quota (in Mb) assigned to student.
                   7673: 2. (Optional) Type of setting: custom or default
                   7674:    (individually assigned or default for user's 
                   7675:    institutional status).
                   7676: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7677:    or student - types as defined in localenroll::inst_usertypes 
                   7678:    for user's domain, which determines default quota for user.
                   7679: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7680: 
                   7681: If a value has been stored in the user's environment, 
1.536     raeburn  7682: it will return that, otherwise it returns the maximal default
                   7683: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7684: 
                   7685: =cut
                   7686: 
                   7687: ###############################################
                   7688: 
                   7689: 
                   7690: sub get_user_quota {
                   7691:     my ($uname,$udom) = @_;
1.536     raeburn  7692:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7693:     if (!defined($udom)) {
                   7694:         $udom = $env{'user.domain'};
                   7695:     }
                   7696:     if (!defined($uname)) {
                   7697:         $uname = $env{'user.name'};
                   7698:     }
                   7699:     if (($udom eq '' || $uname eq '') ||
                   7700:         ($udom eq 'public') && ($uname eq 'public')) {
                   7701:         $quota = 0;
1.536     raeburn  7702:         $quotatype = 'default';
                   7703:         $defquota = 0; 
1.472     raeburn  7704:     } else {
1.536     raeburn  7705:         my $inststatus;
1.472     raeburn  7706:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7707:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7708:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7709:         } else {
1.536     raeburn  7710:             my %userenv = 
                   7711:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7712:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7713:             my ($tmp) = keys(%userenv);
                   7714:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7715:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7716:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7717:             } else {
                   7718:                 undef(%userenv);
                   7719:             }
                   7720:         }
1.536     raeburn  7721:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7722:         if ($quota eq '') {
1.536     raeburn  7723:             $quota = $defquota;
                   7724:             $quotatype = 'default';
                   7725:         } else {
                   7726:             $quotatype = 'custom';
1.472     raeburn  7727:         }
                   7728:     }
1.536     raeburn  7729:     if (wantarray) {
                   7730:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7731:     } else {
                   7732:         return $quota;
                   7733:     }
1.472     raeburn  7734: }
                   7735: 
                   7736: ###############################################
                   7737: 
                   7738: =pod
                   7739: 
                   7740: =item * &default_quota()
                   7741: 
1.536     raeburn  7742: Retrieves default quota assigned for storage of user portfolio files,
                   7743: given an (optional) user's institutional status.
1.472     raeburn  7744: 
                   7745: Incoming parameters:
                   7746: 1. domain
1.536     raeburn  7747: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7748:    status types (e.g., faculty, staff, student etc.)
                   7749:    which apply to the user for whom the default is being retrieved.
                   7750:    If the institutional status string in undefined, the domain
                   7751:    default quota will be returned. 
1.472     raeburn  7752: 
                   7753: Returns:
                   7754: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7755: 2. (Optional) institutional type which determined the value of the
                   7756:    default quota.
1.472     raeburn  7757: 
                   7758: If a value has been stored in the domain's configuration db,
                   7759: it will return that, otherwise it returns 20 (for backwards 
                   7760: compatibility with domains which have not set up a configuration
                   7761: db file; the original statically defined portfolio quota was 20 Mb). 
                   7762: 
1.536     raeburn  7763: If the user's status includes multiple types (e.g., staff and student),
                   7764: the largest default quota which applies to the user determines the
                   7765: default quota returned.
                   7766: 
1.780     raeburn  7767: =back
                   7768: 
1.472     raeburn  7769: =cut
                   7770: 
                   7771: ###############################################
                   7772: 
                   7773: 
                   7774: sub default_quota {
1.536     raeburn  7775:     my ($udom,$inststatus) = @_;
                   7776:     my ($defquota,$settingstatus);
                   7777:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7778:                                             ['quotas'],$udom);
                   7779:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7780:         if ($inststatus ne '') {
1.765     raeburn  7781:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7782:             foreach my $item (@statuses) {
1.711     raeburn  7783:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7784:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7785:                         if ($defquota eq '') {
                   7786:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7787:                             $settingstatus = $item;
                   7788:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7789:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7790:                             $settingstatus = $item;
                   7791:                         }
                   7792:                     }
                   7793:                 } else {
                   7794:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7795:                         if ($defquota eq '') {
                   7796:                             $defquota = $quotahash{'quotas'}{$item};
                   7797:                             $settingstatus = $item;
                   7798:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7799:                             $defquota = $quotahash{'quotas'}{$item};
                   7800:                             $settingstatus = $item;
                   7801:                         }
1.536     raeburn  7802:                     }
                   7803:                 }
                   7804:             }
                   7805:         }
                   7806:         if ($defquota eq '') {
1.711     raeburn  7807:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7808:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7809:             } else {
                   7810:                 $defquota = $quotahash{'quotas'}{'default'};
                   7811:             }
1.536     raeburn  7812:             $settingstatus = 'default';
                   7813:         }
                   7814:     } else {
                   7815:         $settingstatus = 'default';
                   7816:         $defquota = 20;
                   7817:     }
                   7818:     if (wantarray) {
                   7819:         return ($defquota,$settingstatus);
1.472     raeburn  7820:     } else {
1.536     raeburn  7821:         return $defquota;
1.472     raeburn  7822:     }
                   7823: }
                   7824: 
1.384     raeburn  7825: sub get_secgrprole_info {
                   7826:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7827:     my %sections_count = &get_sections($cdom,$cnum);
                   7828:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7829:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7830:     my @groups = sort(keys(%curr_groups));
                   7831:     my $allroles = [];
                   7832:     my $rolehash;
                   7833:     my $accesshash = {
                   7834:                      active => 'Currently has access',
                   7835:                      future => 'Will have future access',
                   7836:                      previous => 'Previously had access',
                   7837:                   };
                   7838:     if ($needroles) {
                   7839:         $rolehash = {'all' => 'all'};
1.385     albertel 7840:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7841: 	if (&Apache::lonnet::error(%user_roles)) {
                   7842: 	    undef(%user_roles);
                   7843: 	}
                   7844:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7845:             my ($role)=split(/\:/,$item,2);
                   7846:             if ($role eq 'cr') { next; }
                   7847:             if ($role =~ /^cr/) {
                   7848:                 $$rolehash{$role} = (split('/',$role))[3];
                   7849:             } else {
                   7850:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7851:             }
                   7852:         }
                   7853:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7854:             push(@{$allroles},$key);
                   7855:         }
                   7856:         push (@{$allroles},'st');
                   7857:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7858:     }
                   7859:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7860: }
                   7861: 
1.555     raeburn  7862: sub user_picker {
1.627     raeburn  7863:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7864:     my $currdom = $dom;
                   7865:     my %curr_selected = (
                   7866:                         srchin => 'dom',
1.580     raeburn  7867:                         srchby => 'lastname',
1.555     raeburn  7868:                       );
                   7869:     my $srchterm;
1.625     raeburn  7870:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7871:         if ($srch->{'srchby'} ne '') {
                   7872:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7873:         }
                   7874:         if ($srch->{'srchin'} ne '') {
                   7875:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7876:         }
                   7877:         if ($srch->{'srchtype'} ne '') {
                   7878:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7879:         }
                   7880:         if ($srch->{'srchdomain'} ne '') {
                   7881:             $currdom = $srch->{'srchdomain'};
                   7882:         }
                   7883:         $srchterm = $srch->{'srchterm'};
                   7884:     }
                   7885:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7886:                     'usr'       => 'Search criteria',
1.563     raeburn  7887:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7888:                     'uname'     => 'username',
                   7889:                     'lastname'  => 'last name',
1.555     raeburn  7890:                     'lastfirst' => 'last name, first name',
1.558     albertel 7891:                     'crs'       => 'in this course',
1.576     raeburn  7892:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7893:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7894:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7895:                     'exact'     => 'is',
                   7896:                     'contains'  => 'contains',
1.569     raeburn  7897:                     'begins'    => 'begins with',
1.571     raeburn  7898:                     'youm'      => "You must include some text to search for.",
                   7899:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7900:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7901:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7902:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7903:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7904:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7905:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7906:                                        );
1.925.2.13  raeburn  7907:     my $domform = &select_dom_form($currdom,'srchdomain',undef,1);
1.563     raeburn  7908:     my $srchinsel = ' <select name="srchin">';
1.925.2.13  raeburn  7909:      
1.555     raeburn  7910:     my @srchins = ('crs','dom','alc','instd');
                   7911: 
                   7912:     foreach my $option (@srchins) {
                   7913:         # FIXME 'alc' option unavailable until 
                   7914:         #       loncreateuser::print_user_query_page()
                   7915:         #       has been completed.
                   7916:         next if ($option eq 'alc');
1.880     raeburn  7917:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7918:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.925.2.13  raeburn  7919:         next if ($option eq 'instd');
1.563     raeburn  7920:         if ($curr_selected{'srchin'} eq $option) {
                   7921:             $srchinsel .= ' 
1.925.2.13  raeburn  7922:        <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
1.563     raeburn  7923:         } else {
                   7924:             $srchinsel .= '
1.925.2.13  raeburn  7925:     <option value="'.$option.'">'.$lt{$option}.'</option>';
1.563     raeburn  7926:         }
1.555     raeburn  7927:     }
1.563     raeburn  7928:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7929: 
                   7930:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7931:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7932:         if ($curr_selected{'srchby'} eq $option) {
                   7933:             $srchbysel .= '
                   7934:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7935:         } else {
                   7936:             $srchbysel .= '
                   7937:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7938:          }
                   7939:     }
                   7940:     $srchbysel .= "\n  </select>\n";
                   7941: 
                   7942:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7943:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7944:         if ($curr_selected{'srchtype'} eq $option) {
                   7945:             $srchtypesel .= '
                   7946:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7947:         } else {
                   7948:             $srchtypesel .= '
                   7949:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7950:         }
                   7951:     }
                   7952:     $srchtypesel .= "\n  </select>\n";
                   7953: 
1.558     albertel 7954:     my ($newuserscript,$new_user_create);
1.556     raeburn  7955: 
                   7956:     if ($forcenewuser) {
1.576     raeburn  7957:         if (ref($srch) eq 'HASH') {
                   7958:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7959:                 if ($cancreate) {
                   7960:                     $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>';
                   7961:                 } else {
1.799     bisitz   7962:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7963:                     my %usertypetext = (
                   7964:                         official   => 'institutional',
                   7965:                         unofficial => 'non-institutional',
                   7966:                     );
1.799     bisitz   7967:                     $new_user_create = '<p class="LC_warning">'
                   7968:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
1.925.2.13  raeburn  7969:                                       .'<br />'
                   7970:                                       .&mt('Enter a valid e-mail address as the username for the new user.').' '.&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7971:                                       ,'<a href="'.$helplink.'">','</a>')
1.799     bisitz   7972:                                       .'</p><br />';
1.627     raeburn  7973:                 }
1.576     raeburn  7974:             }
                   7975:         }
                   7976: 
1.556     raeburn  7977:         $newuserscript = <<"ENDSCRIPT";
                   7978: 
1.570     raeburn  7979: function setSearch(createnew,callingForm) {
1.556     raeburn  7980:     if (createnew == 1) {
1.570     raeburn  7981:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7982:             if (callingForm.srchby.options[i].value == 'uname') {
                   7983:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7984:             }
                   7985:         }
1.570     raeburn  7986:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7987:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7988: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7989:             }
                   7990:         }
1.570     raeburn  7991:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7992:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7993:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7994:             }
                   7995:         }
1.570     raeburn  7996:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7997:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7998:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7999:             }
                   8000:         }
                   8001:     }
                   8002: }
                   8003: ENDSCRIPT
1.558     albertel 8004: 
1.556     raeburn  8005:     }
                   8006: 
1.555     raeburn  8007:     my $output = <<"END_BLOCK";
1.556     raeburn  8008: <script type="text/javascript">
1.824     bisitz   8009: // <![CDATA[
1.570     raeburn  8010: function validateEntry(callingForm) {
1.558     albertel 8011: 
1.556     raeburn  8012:     var checkok = 1;
1.558     albertel 8013:     var srchin;
1.570     raeburn  8014:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8015: 	if ( callingForm.srchin[i].checked ) {
                   8016: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8017: 	}
                   8018:     }
                   8019: 
1.570     raeburn  8020:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8021:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8022:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8023:     var srchterm =  callingForm.srchterm.value;
                   8024:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8025:     var msg = "";
                   8026: 
                   8027:     if (srchterm == "") {
                   8028:         checkok = 0;
1.571     raeburn  8029:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8030:     }
                   8031: 
1.569     raeburn  8032:     if (srchtype== 'begins') {
                   8033:         if (srchterm.length < 2) {
                   8034:             checkok = 0;
1.571     raeburn  8035:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8036:         }
                   8037:     }
                   8038: 
1.556     raeburn  8039:     if (srchtype== 'contains') {
                   8040:         if (srchterm.length < 3) {
                   8041:             checkok = 0;
1.571     raeburn  8042:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8043:         }
                   8044:     }
                   8045:     if (srchin == 'instd') {
                   8046:         if (srchdomain == '') {
                   8047:             checkok = 0;
1.571     raeburn  8048:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8049:         }
                   8050:     }
                   8051:     if (srchin == 'dom') {
                   8052:         if (srchdomain == '') {
                   8053:             checkok = 0;
1.571     raeburn  8054:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8055:         }
                   8056:     }
                   8057:     if (srchby == 'lastfirst') {
                   8058:         if (srchterm.indexOf(",") == -1) {
                   8059:             checkok = 0;
1.571     raeburn  8060:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8061:         }
                   8062:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8063:             checkok = 0;
1.571     raeburn  8064:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8065:         }
                   8066:     }
                   8067:     if (checkok == 0) {
1.571     raeburn  8068:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8069:         return;
                   8070:     }
                   8071:     if (checkok == 1) {
1.570     raeburn  8072:         callingForm.submit();
1.556     raeburn  8073:     }
                   8074: }
                   8075: 
                   8076: $newuserscript
                   8077: 
1.824     bisitz   8078: // ]]>
1.556     raeburn  8079: </script>
1.558     albertel 8080: 
                   8081: $new_user_create
                   8082: 
1.555     raeburn  8083: END_BLOCK
1.558     albertel 8084: 
1.876     raeburn  8085:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8086:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8087:                $domform.
                   8088:                &Apache::lonhtmlcommon::row_closure().
                   8089:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8090:                $srchbysel.
                   8091:                $srchtypesel. 
                   8092:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8093:                $srchinsel.
                   8094:                &Apache::lonhtmlcommon::row_closure(1). 
                   8095:                &Apache::lonhtmlcommon::end_pick_box().
                   8096:                '<br />';
1.555     raeburn  8097:     return $output;
                   8098: }
                   8099: 
1.612     raeburn  8100: sub user_rule_check {
1.615     raeburn  8101:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8102:     my $response;
                   8103:     if (ref($usershash) eq 'HASH') {
                   8104:         foreach my $user (keys(%{$usershash})) {
                   8105:             my ($uname,$udom) = split(/:/,$user);
                   8106:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8107:             my ($id,$newuser);
1.612     raeburn  8108:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8109:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8110:                 $id = $usershash->{$user}->{'id'};
                   8111:             }
                   8112:             my $inst_response;
                   8113:             if (ref($checks) eq 'HASH') {
                   8114:                 if (defined($checks->{'username'})) {
1.615     raeburn  8115:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8116:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8117:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8118:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8119:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8120:                 }
1.615     raeburn  8121:             } else {
                   8122:                 ($inst_response,%{$inst_results->{$user}}) =
                   8123:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8124:                 return;
1.612     raeburn  8125:             }
1.615     raeburn  8126:             if (!$got_rules->{$udom}) {
1.612     raeburn  8127:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8128:                                                   ['usercreation'],$udom);
                   8129:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8130:                     foreach my $item ('username','id') {
1.612     raeburn  8131:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8132:                             $$curr_rules{$udom}{$item} = 
                   8133:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8134:                         }
                   8135:                     }
                   8136:                 }
1.615     raeburn  8137:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8138:             }
1.612     raeburn  8139:             foreach my $item (keys(%{$checks})) {
                   8140:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8141:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8142:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8143:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8144:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8145:                                 if ($rule_check{$rule}) {
                   8146:                                     $$rulematch{$user}{$item} = $rule;
                   8147:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8148:                                         if (ref($inst_results) eq 'HASH') {
                   8149:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8150:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8151:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8152:                                                 }
1.612     raeburn  8153:                                             }
                   8154:                                         }
1.615     raeburn  8155:                                     }
                   8156:                                     last;
1.585     raeburn  8157:                                 }
                   8158:                             }
                   8159:                         }
                   8160:                     }
                   8161:                 }
                   8162:             }
                   8163:         }
                   8164:     }
1.612     raeburn  8165:     return;
                   8166: }
                   8167: 
                   8168: sub user_rule_formats {
                   8169:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8170:     my %text = ( 
                   8171:                  'username' => 'Usernames',
                   8172:                  'id'       => 'IDs',
                   8173:                );
                   8174:     my $output;
                   8175:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8176:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8177:         if (@{$ruleorder} > 0) {
                   8178:             $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>';
                   8179:             foreach my $rule (@{$ruleorder}) {
                   8180:                 if (ref($curr_rules) eq 'ARRAY') {
                   8181:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8182:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8183:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8184:                                         $rules->{$rule}{'desc'}.'</li>';
                   8185:                         }
                   8186:                     }
                   8187:                 }
                   8188:             }
                   8189:             $output .= '</ul>';
                   8190:         }
                   8191:     }
                   8192:     return $output;
                   8193: }
                   8194: 
                   8195: sub instrule_disallow_msg {
1.615     raeburn  8196:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8197:     my $response;
                   8198:     my %text = (
                   8199:                   item   => 'username',
                   8200:                   items  => 'usernames',
                   8201:                   match  => 'matches',
                   8202:                   do     => 'does',
                   8203:                   action => 'a username',
                   8204:                   one    => 'one',
                   8205:                );
                   8206:     if ($count > 1) {
                   8207:         $text{'item'} = 'usernames';
                   8208:         $text{'match'} ='match';
                   8209:         $text{'do'} = 'do';
                   8210:         $text{'action'} = 'usernames',
                   8211:         $text{'one'} = 'ones';
                   8212:     }
                   8213:     if ($checkitem eq 'id') {
                   8214:         $text{'items'} = 'IDs';
                   8215:         $text{'item'} = 'ID';
                   8216:         $text{'action'} = 'an ID';
1.615     raeburn  8217:         if ($count > 1) {
                   8218:             $text{'item'} = 'IDs';
                   8219:             $text{'action'} = 'IDs';
                   8220:         }
1.612     raeburn  8221:     }
1.674     bisitz   8222:     $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  8223:     if ($mode eq 'upload') {
                   8224:         if ($checkitem eq 'username') {
                   8225:             $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'}.");
                   8226:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8227:             $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  8228:         }
1.669     raeburn  8229:     } elsif ($mode eq 'selfcreate') {
                   8230:         if ($checkitem eq 'id') {
                   8231:             $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.");
                   8232:         }
1.615     raeburn  8233:     } else {
                   8234:         if ($checkitem eq 'username') {
                   8235:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8236:         } elsif ($checkitem eq 'id') {
                   8237:             $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.");
                   8238:         }
1.612     raeburn  8239:     }
                   8240:     return $response;
1.585     raeburn  8241: }
                   8242: 
1.624     raeburn  8243: sub personal_data_fieldtitles {
                   8244:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8245:                         id => 'Student/Employee ID',
                   8246:                         permanentemail => 'E-mail address',
                   8247:                         lastname => 'Last Name',
                   8248:                         firstname => 'First Name',
                   8249:                         middlename => 'Middle Name',
                   8250:                         generation => 'Generation',
                   8251:                         gen => 'Generation',
1.765     raeburn  8252:                         inststatus => 'Affiliation',
1.624     raeburn  8253:                    );
                   8254:     return %fieldtitles;
                   8255: }
                   8256: 
1.642     raeburn  8257: sub sorted_inst_types {
                   8258:     my ($dom) = @_;
                   8259:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8260:     my $othertitle = &mt('All users');
                   8261:     if ($env{'request.course.id'}) {
1.668     raeburn  8262:         $othertitle  = &mt('Any users');
1.642     raeburn  8263:     }
                   8264:     my @types;
                   8265:     if (ref($order) eq 'ARRAY') {
                   8266:         @types = @{$order};
                   8267:     }
                   8268:     if (@types == 0) {
                   8269:         if (ref($usertypes) eq 'HASH') {
                   8270:             @types = sort(keys(%{$usertypes}));
                   8271:         }
                   8272:     }
                   8273:     if (keys(%{$usertypes}) > 0) {
                   8274:         $othertitle = &mt('Other users');
                   8275:     }
                   8276:     return ($othertitle,$usertypes,\@types);
                   8277: }
                   8278: 
1.645     raeburn  8279: sub get_institutional_codes {
                   8280:     my ($settings,$allcourses,$LC_code) = @_;
                   8281: # Get complete list of course sections to update
                   8282:     my @currsections = ();
                   8283:     my @currxlists = ();
                   8284:     my $coursecode = $$settings{'internal.coursecode'};
                   8285: 
                   8286:     if ($$settings{'internal.sectionnums'} ne '') {
                   8287:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8288:     }
                   8289: 
                   8290:     if ($$settings{'internal.crosslistings'} ne '') {
                   8291:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8292:     }
                   8293: 
                   8294:     if (@currxlists > 0) {
                   8295:         foreach (@currxlists) {
                   8296:             if (m/^([^:]+):(\w*)$/) {
                   8297:                 unless (grep/^$1$/,@{$allcourses}) {
                   8298:                     push @{$allcourses},$1;
                   8299:                     $$LC_code{$1} = $2;
                   8300:                 }
                   8301:             }
                   8302:         }
                   8303:     }
                   8304:  
                   8305:     if (@currsections > 0) {
                   8306:         foreach (@currsections) {
                   8307:             if (m/^(\w+):(\w*)$/) {
                   8308:                 my $sec = $coursecode.$1;
                   8309:                 my $lc_sec = $2;
                   8310:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8311:                     push @{$allcourses},$sec;
                   8312:                     $$LC_code{$sec} = $lc_sec;
                   8313:                 }
                   8314:             }
                   8315:         }
                   8316:     }
                   8317:     return;
                   8318: }
                   8319: 
1.112     bowersj2 8320: =pod
                   8321: 
1.780     raeburn  8322: =head1 Slot Helpers
                   8323: 
                   8324: =over 4
                   8325: 
                   8326: =item * sorted_slots()
                   8327: 
                   8328: Sorts an array of slot names in order of slot start time (earliest first). 
                   8329: 
                   8330: Inputs:
                   8331: 
                   8332: =over 4
                   8333: 
                   8334: slotsarr  - Reference to array of unsorted slot names.
                   8335: 
                   8336: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8337: 
1.549     albertel 8338: =back
                   8339: 
1.780     raeburn  8340: Returns:
                   8341: 
                   8342: =over 4
                   8343: 
                   8344: sorted   - An array of slot names sorted by the start time of the slot.
                   8345: 
                   8346: =back
                   8347: 
                   8348: =back
                   8349: 
                   8350: =cut
                   8351: 
                   8352: 
                   8353: sub sorted_slots {
                   8354:     my ($slotsarr,$slots) = @_;
                   8355:     my @sorted;
                   8356:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8357:         @sorted =
                   8358:             sort {
                   8359:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8360:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8361:                      }
                   8362:                      if (ref($slots->{$a})) { return -1;}
                   8363:                      if (ref($slots->{$b})) { return 1;}
                   8364:                      return 0;
                   8365:                  } @{$slotsarr};
                   8366:     }
                   8367:     return @sorted;
                   8368: }
                   8369: 
                   8370: 
                   8371: =pod
                   8372: 
1.549     albertel 8373: =head1 HTTP Helpers
                   8374: 
                   8375: =over 4
                   8376: 
1.648     raeburn  8377: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8378: 
1.258     albertel 8379: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8380: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8381: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8382: 
                   8383: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8384: $possible_names is an ref to an array of form element names.  As an example:
                   8385: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8386: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8387: 
                   8388: =cut
1.1       albertel 8389: 
1.6       albertel 8390: sub get_unprocessed_cgi {
1.25      albertel 8391:   my ($query,$possible_names)= @_;
1.26      matthew  8392:   # $Apache::lonxml::debug=1;
1.356     albertel 8393:   foreach my $pair (split(/&/,$query)) {
                   8394:     my ($name, $value) = split(/=/,$pair);
1.369     www      8395:     $name = &unescape($name);
1.25      albertel 8396:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8397:       $value =~ tr/+/ /;
                   8398:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8399:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8400:     }
1.16      harris41 8401:   }
1.6       albertel 8402: }
                   8403: 
1.112     bowersj2 8404: =pod
                   8405: 
1.648     raeburn  8406: =item * &cacheheader() 
1.112     bowersj2 8407: 
                   8408: returns cache-controlling header code
                   8409: 
                   8410: =cut
                   8411: 
1.7       albertel 8412: sub cacheheader {
1.258     albertel 8413:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8414:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8415:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8416:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8417:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8418:     return $output;
1.7       albertel 8419: }
                   8420: 
1.112     bowersj2 8421: =pod
                   8422: 
1.648     raeburn  8423: =item * &no_cache($r) 
1.112     bowersj2 8424: 
                   8425: specifies header code to not have cache
                   8426: 
                   8427: =cut
                   8428: 
1.9       albertel 8429: sub no_cache {
1.216     albertel 8430:     my ($r) = @_;
                   8431:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8432: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8433:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8434:     $r->no_cache(1);
                   8435:     $r->header_out("Expires" => $date);
                   8436:     $r->header_out("Pragma" => "no-cache");
1.123     www      8437: }
                   8438: 
                   8439: sub content_type {
1.181     albertel 8440:     my ($r,$type,$charset) = @_;
1.299     foxr     8441:     if ($r) {
                   8442: 	#  Note that printout.pl calls this with undef for $r.
                   8443: 	&no_cache($r);
                   8444:     }
1.258     albertel 8445:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8446:     unless ($charset) {
                   8447: 	$charset=&Apache::lonlocal::current_encoding;
                   8448:     }
                   8449:     if ($charset) { $type.='; charset='.$charset; }
                   8450:     if ($r) {
                   8451: 	$r->content_type($type);
                   8452:     } else {
                   8453: 	print("Content-type: $type\n\n");
                   8454:     }
1.9       albertel 8455: }
1.25      albertel 8456: 
1.112     bowersj2 8457: =pod
                   8458: 
1.648     raeburn  8459: =item * &add_to_env($name,$value) 
1.112     bowersj2 8460: 
1.258     albertel 8461: adds $name to the %env hash with value
1.112     bowersj2 8462: $value, if $name already exists, the entry is converted to an array
                   8463: reference and $value is added to the array.
                   8464: 
                   8465: =cut
                   8466: 
1.25      albertel 8467: sub add_to_env {
                   8468:   my ($name,$value)=@_;
1.258     albertel 8469:   if (defined($env{$name})) {
                   8470:     if (ref($env{$name})) {
1.25      albertel 8471:       #already have multiple values
1.258     albertel 8472:       push(@{ $env{$name} },$value);
1.25      albertel 8473:     } else {
                   8474:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8475:       my $first=$env{$name};
                   8476:       undef($env{$name});
                   8477:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8478:     }
                   8479:   } else {
1.258     albertel 8480:     $env{$name}=$value;
1.25      albertel 8481:   }
1.31      albertel 8482: }
1.149     albertel 8483: 
                   8484: =pod
                   8485: 
1.648     raeburn  8486: =item * &get_env_multiple($name) 
1.149     albertel 8487: 
1.258     albertel 8488: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8489: values may be defined and end up as an array ref.
                   8490: 
                   8491: returns an array of values
                   8492: 
                   8493: =cut
                   8494: 
                   8495: sub get_env_multiple {
                   8496:     my ($name) = @_;
                   8497:     my @values;
1.258     albertel 8498:     if (defined($env{$name})) {
1.149     albertel 8499:         # exists is it an array
1.258     albertel 8500:         if (ref($env{$name})) {
                   8501:             @values=@{ $env{$name} };
1.149     albertel 8502:         } else {
1.258     albertel 8503:             $values[0]=$env{$name};
1.149     albertel 8504:         }
                   8505:     }
                   8506:     return(@values);
                   8507: }
                   8508: 
1.660     raeburn  8509: sub ask_for_embedded_content {
                   8510:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8511:     my $upload_output = '
                   8512:    <form name="upload_embedded" action="'.$actionurl.'"
                   8513:                   method="post" enctype="multipart/form-data">';
                   8514:     $upload_output .= $state;
1.661     raeburn  8515:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8516: 
                   8517:     my $num = 0;
                   8518:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8519:         $upload_output .= &start_data_table_row().
                   8520:             '<td>'.$embed_file.'</td><td>';
                   8521:         if ($args->{'ignore_remote_references'}
                   8522:             && $embed_file =~ m{^\w+://}) {
                   8523:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8524:         } elsif ($args->{'error_on_invalid_names'}
                   8525:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8526: 
                   8527:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8528: 
                   8529:         } else {
                   8530:             $upload_output .='
1.661     raeburn  8531:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8532:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8533:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8534:             $upload_output .=
                   8535:                 "\n\t\t".
                   8536:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8537:                 $attrib.'" />';
                   8538:             if (exists($$codebase{$embed_file})) {
                   8539:                 $upload_output .=
                   8540:                     "\n\t\t".
                   8541:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8542:                     &escape($$codebase{$embed_file}).'" />';
                   8543:             }
                   8544:         }
                   8545:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8546:         $num++;
                   8547:     }
                   8548:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8549:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8550:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8551:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8552:    </form>';
                   8553:     return $upload_output;
                   8554: }
                   8555: 
1.661     raeburn  8556: sub upload_embedded {
                   8557:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8558:         $current_disk_usage) = @_;
                   8559:     my $output;
                   8560:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8561:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8562:         my $orig_uploaded_filename =
                   8563:             $env{'form.embedded_item_'.$i.'.filename'};
                   8564: 
                   8565:         $env{'form.embedded_orig_'.$i} =
                   8566:             &unescape($env{'form.embedded_orig_'.$i});
                   8567:         my ($path,$fname) =
                   8568:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8569:         # no path, whole string is fname
                   8570:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8571: 
                   8572:         $path = $env{'form.currentpath'}.$path;
                   8573:         $fname = &Apache::lonnet::clean_filename($fname);
                   8574:         # See if there is anything left
                   8575:         next if ($fname eq '');
                   8576: 
                   8577:         # Check if file already exists as a file or directory.
                   8578:         my ($state,$msg);
                   8579:         if ($context eq 'portfolio') {
                   8580:             my $port_path = $dirpath;
                   8581:             if ($group ne '') {
                   8582:                 $port_path = "groups/$group/$port_path";
                   8583:             }
                   8584:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8585:                                               $dir_root,$port_path,$disk_quota,
                   8586:                                               $current_disk_usage,$uname,$udom);
                   8587:             if ($state eq 'will_exceed_quota'
                   8588:                 || $state eq 'file_locked'
                   8589:                 || $state eq 'file_exists' ) {
                   8590:                 $output .= $msg;
                   8591:                 next;
                   8592:             }
                   8593:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8594:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8595:             if ($state eq 'exists') {
                   8596:                 $output .= $msg;
                   8597:                 next;
                   8598:             }
                   8599:         }
                   8600:         # Check if extension is valid
                   8601:         if (($fname =~ /\.(\w+)$/) &&
                   8602:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8603:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8604:             next;
                   8605:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8606:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8607:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8608:             next;
                   8609:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8610:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8611:             next;
                   8612:         }
                   8613: 
                   8614:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8615:         if ($context eq 'portfolio') {
                   8616:             my $result=
                   8617:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8618:                                                 $dirpath.$path);
                   8619:             if ($result !~ m|^/uploaded/|) {
                   8620:                 $output .= '<span class="LC_error">'
                   8621:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8622:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8623:                       .'</span><br />';
                   8624:                 next;
                   8625:             } else {
                   8626:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8627:                            $path.$fname.'</span>').'</p>';     
                   8628:             }
                   8629:         } else {
                   8630: # Save the file
                   8631:             my $target = $env{'form.embedded_item_'.$i};
                   8632:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8633:             my $dest = $fullpath.$fname;
                   8634:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8635:             my @parts=split(/\//,$fullpath);
                   8636:             my $count;
                   8637:             my $filepath = $dir_root;
                   8638:             for ($count=4;$count<=$#parts;$count++) {
                   8639:                 $filepath .= "/$parts[$count]";
                   8640:                 if ((-e $filepath)!=1) {
                   8641:                     mkdir($filepath,0770);
                   8642:                 }
                   8643:             }
                   8644:             my $fh;
                   8645:             if (!open($fh,'>'.$dest)) {
                   8646:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8647:                 $output .= '<span class="LC_error">'.
                   8648:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8649:                            '</span><br />';
                   8650:             } else {
                   8651:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8652:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8653:                     $output .= '<span class="LC_error">'.
                   8654:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8655:                               '</span><br />';
                   8656:                 } else {
                   8657:                     if ($context eq 'testbank') {
                   8658:                         $output .= &mt('Embedded file uploaded successfully:').
                   8659:                                    '&nbsp;<a href="'.$url.'">'.
                   8660:                                    $orig_uploaded_filename.'</a><br />';
                   8661:                     } else {
1.705     tempelho 8662:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8663:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8664:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8665:                     }
                   8666:                 }
                   8667:                 close($fh);
                   8668:             }
                   8669:         }
                   8670:     }
                   8671:     return $output;
                   8672: }
                   8673: 
                   8674: sub check_for_existing {
                   8675:     my ($path,$fname,$element) = @_;
                   8676:     my ($state,$msg);
                   8677:     if (-d $path.'/'.$fname) {
                   8678:         $state = 'exists';
                   8679:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8680:     } elsif (-e $path.'/'.$fname) {
                   8681:         $state = 'exists';
                   8682:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8683:     }
                   8684:     if ($state eq 'exists') {
                   8685:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8686:     }
                   8687:     return ($state,$msg);
                   8688: }
                   8689: 
                   8690: sub check_for_upload {
                   8691:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8692:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8693:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8694:     my $getpropath = 1;
                   8695:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8696:                                             $getpropath);
                   8697:     my $found_file = 0;
                   8698:     my $locked_file = 0;
                   8699:     foreach my $line (@dir_list) {
                   8700:         my ($file_name)=split(/\&/,$line,2);
                   8701:         if ($file_name eq $fname){
                   8702:             $file_name = $path.$file_name;
                   8703:             if ($group ne '') {
                   8704:                 $file_name = $group.$file_name;
                   8705:             }
                   8706:             $found_file = 1;
                   8707:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8708:                 $locked_file = 1;
                   8709:             }
                   8710:         }
                   8711:     }
                   8712:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8713:         my $msg = '<span class="LC_error">'.
                   8714:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8715:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8716:         return ('will_exceed_quota',$msg);
                   8717:     } elsif ($found_file) {
                   8718:         if ($locked_file) {
                   8719:             my $msg = '<span class="LC_error">';
                   8720:             $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>');
                   8721:             $msg .= '</span><br />';
                   8722:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8723:             return ('file_locked',$msg);
                   8724:         } else {
                   8725:             my $msg = '<span class="LC_error">';
                   8726:             $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'});
                   8727:             $msg .= '</span>';
                   8728:             $msg .= '<br />';
                   8729:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8730:             return ('file_exists',$msg);
                   8731:         }
                   8732:     }
                   8733: }
                   8734: 
1.31      albertel 8735: 
1.41      ng       8736: =pod
1.45      matthew  8737: 
1.464     albertel 8738: =back
1.41      ng       8739: 
1.112     bowersj2 8740: =head1 CSV Upload/Handling functions
1.38      albertel 8741: 
1.41      ng       8742: =over 4
                   8743: 
1.648     raeburn  8744: =item * &upfile_store($r)
1.41      ng       8745: 
                   8746: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8747: needs $env{'form.upfile'}
1.41      ng       8748: returns $datatoken to be put into hidden field
                   8749: 
                   8750: =cut
1.31      albertel 8751: 
                   8752: sub upfile_store {
                   8753:     my $r=shift;
1.258     albertel 8754:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8755:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8756:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8757:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8758: 
1.258     albertel 8759:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8760: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8761:     {
1.158     raeburn  8762:         my $datafile = $r->dir_config('lonDaemons').
                   8763:                            '/tmp/'.$datatoken.'.tmp';
                   8764:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8765:             print $fh $env{'form.upfile'};
1.158     raeburn  8766:             close($fh);
                   8767:         }
1.31      albertel 8768:     }
                   8769:     return $datatoken;
                   8770: }
                   8771: 
1.56      matthew  8772: =pod
                   8773: 
1.648     raeburn  8774: =item * &load_tmp_file($r)
1.41      ng       8775: 
                   8776: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8777: needs $env{'form.datatoken'},
                   8778: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8779: 
                   8780: =cut
1.31      albertel 8781: 
                   8782: sub load_tmp_file {
                   8783:     my $r=shift;
                   8784:     my @studentdata=();
                   8785:     {
1.158     raeburn  8786:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8787:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8788:         if ( open(my $fh,"<$studentfile") ) {
                   8789:             @studentdata=<$fh>;
                   8790:             close($fh);
                   8791:         }
1.31      albertel 8792:     }
1.258     albertel 8793:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8794: }
                   8795: 
1.56      matthew  8796: =pod
                   8797: 
1.648     raeburn  8798: =item * &upfile_record_sep()
1.41      ng       8799: 
                   8800: Separate uploaded file into records
                   8801: returns array of records,
1.258     albertel 8802: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8803: 
                   8804: =cut
1.31      albertel 8805: 
                   8806: sub upfile_record_sep {
1.258     albertel 8807:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8808:     } else {
1.248     albertel 8809: 	my @records;
1.258     albertel 8810: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8811: 	    if ($line=~/^\s*$/) { next; }
                   8812: 	    push(@records,$line);
                   8813: 	}
                   8814: 	return @records;
1.31      albertel 8815:     }
                   8816: }
                   8817: 
1.56      matthew  8818: =pod
                   8819: 
1.648     raeburn  8820: =item * &record_sep($record)
1.41      ng       8821: 
1.258     albertel 8822: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8823: 
                   8824: =cut
                   8825: 
1.263     www      8826: sub takeleft {
                   8827:     my $index=shift;
                   8828:     return substr('0000'.$index,-4,4);
                   8829: }
                   8830: 
1.31      albertel 8831: sub record_sep {
                   8832:     my $record=shift;
                   8833:     my %components=();
1.258     albertel 8834:     if ($env{'form.upfiletype'} eq 'xml') {
                   8835:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8836:         my $i=0;
1.356     albertel 8837:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8838:             $field=~s/^(\"|\')//;
                   8839:             $field=~s/(\"|\')$//;
1.263     www      8840:             $components{&takeleft($i)}=$field;
1.31      albertel 8841:             $i++;
                   8842:         }
1.258     albertel 8843:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8844:         my $i=0;
1.356     albertel 8845:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8846:             $field=~s/^(\"|\')//;
                   8847:             $field=~s/(\"|\')$//;
1.263     www      8848:             $components{&takeleft($i)}=$field;
1.31      albertel 8849:             $i++;
                   8850:         }
                   8851:     } else {
1.561     www      8852:         my $separator=',';
1.480     banghart 8853:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8854:             $separator=';';
1.480     banghart 8855:         }
1.31      albertel 8856:         my $i=0;
1.561     www      8857: # the character we are looking for to indicate the end of a quote or a record 
                   8858:         my $looking_for=$separator;
                   8859: # do not add the characters to the fields
                   8860:         my $ignore=0;
                   8861: # we just encountered a separator (or the beginning of the record)
                   8862:         my $just_found_separator=1;
                   8863: # store the field we are working on here
                   8864:         my $field='';
                   8865: # work our way through all characters in record
                   8866:         foreach my $character ($record=~/(.)/g) {
                   8867:             if ($character eq $looking_for) {
                   8868:                if ($character ne $separator) {
                   8869: # Found the end of a quote, again looking for separator
                   8870:                   $looking_for=$separator;
                   8871:                   $ignore=1;
                   8872:                } else {
                   8873: # Found a separator, store away what we got
                   8874:                   $components{&takeleft($i)}=$field;
                   8875: 	          $i++;
                   8876:                   $just_found_separator=1;
                   8877:                   $ignore=0;
                   8878:                   $field='';
                   8879:                }
                   8880:                next;
                   8881:             }
                   8882: # single or double quotation marks after a separator indicate beginning of a quote
                   8883: # we are now looking for the end of the quote and need to ignore separators
                   8884:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8885:                $looking_for=$character;
                   8886:                next;
                   8887:             }
                   8888: # ignore would be true after we reached the end of a quote
                   8889:             if ($ignore) { next; }
                   8890:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8891:             $field.=$character;
                   8892:             $just_found_separator=0; 
1.31      albertel 8893:         }
1.561     www      8894: # catch the very last entry, since we never encountered the separator
                   8895:         $components{&takeleft($i)}=$field;
1.31      albertel 8896:     }
                   8897:     return %components;
                   8898: }
                   8899: 
1.144     matthew  8900: ######################################################
                   8901: ######################################################
                   8902: 
1.56      matthew  8903: =pod
                   8904: 
1.648     raeburn  8905: =item * &upfile_select_html()
1.41      ng       8906: 
1.144     matthew  8907: Return HTML code to select a file from the users machine and specify 
                   8908: the file type.
1.41      ng       8909: 
                   8910: =cut
                   8911: 
1.144     matthew  8912: ######################################################
                   8913: ######################################################
1.31      albertel 8914: sub upfile_select_html {
1.144     matthew  8915:     my %Types = (
                   8916:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8917:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8918:                  space => &mt('Space separated'),
                   8919:                  tab   => &mt('Tabulator separated'),
                   8920: #                 xml   => &mt('HTML/XML'),
                   8921:                  );
                   8922:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8923:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8924:     foreach my $type (sort(keys(%Types))) {
                   8925:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8926:     }
                   8927:     $Str .= "</select>\n";
                   8928:     return $Str;
1.31      albertel 8929: }
                   8930: 
1.301     albertel 8931: sub get_samples {
                   8932:     my ($records,$toget) = @_;
                   8933:     my @samples=({});
                   8934:     my $got=0;
                   8935:     foreach my $rec (@$records) {
                   8936: 	my %temp = &record_sep($rec);
                   8937: 	if (! grep(/\S/, values(%temp))) { next; }
                   8938: 	if (%temp) {
                   8939: 	    $samples[$got]=\%temp;
                   8940: 	    $got++;
                   8941: 	    if ($got == $toget) { last; }
                   8942: 	}
                   8943:     }
                   8944:     return \@samples;
                   8945: }
                   8946: 
1.144     matthew  8947: ######################################################
                   8948: ######################################################
                   8949: 
1.56      matthew  8950: =pod
                   8951: 
1.648     raeburn  8952: =item * &csv_print_samples($r,$records)
1.41      ng       8953: 
                   8954: Prints a table of sample values from each column uploaded $r is an
                   8955: Apache Request ref, $records is an arrayref from
                   8956: &Apache::loncommon::upfile_record_sep
                   8957: 
                   8958: =cut
                   8959: 
1.144     matthew  8960: ######################################################
                   8961: ######################################################
1.31      albertel 8962: sub csv_print_samples {
                   8963:     my ($r,$records) = @_;
1.662     bisitz   8964:     my $samples = &get_samples($records,5);
1.301     albertel 8965: 
1.594     raeburn  8966:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8967:               &start_data_table_header_row());
1.356     albertel 8968:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8969:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8970:     $r->print(&end_data_table_header_row());
1.301     albertel 8971:     foreach my $hash (@$samples) {
1.594     raeburn  8972: 	$r->print(&start_data_table_row());
1.356     albertel 8973: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8974: 	    $r->print('<td>');
1.356     albertel 8975: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8976: 	    $r->print('</td>');
                   8977: 	}
1.594     raeburn  8978: 	$r->print(&end_data_table_row());
1.31      albertel 8979:     }
1.594     raeburn  8980:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8981: }
                   8982: 
1.144     matthew  8983: ######################################################
                   8984: ######################################################
                   8985: 
1.56      matthew  8986: =pod
                   8987: 
1.648     raeburn  8988: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8989: 
                   8990: Prints a table to create associations between values and table columns.
1.144     matthew  8991: 
1.41      ng       8992: $r is an Apache Request ref,
                   8993: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8994: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8995: 
                   8996: =cut
                   8997: 
1.144     matthew  8998: ######################################################
                   8999: ######################################################
1.31      albertel 9000: sub csv_print_select_table {
                   9001:     my ($r,$records,$d) = @_;
1.301     albertel 9002:     my $i=0;
                   9003:     my $samples = &get_samples($records,1);
1.144     matthew  9004:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  9005: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  9006:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  9007:               '<th>'.&mt('Column').'</th>'.
                   9008:               &end_data_table_header_row()."\n");
1.356     albertel 9009:     foreach my $array_ref (@$d) {
                   9010: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  9011: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 9012: 
1.875     bisitz   9013: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  9014: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 9015: 	$r->print('<option value="none"></option>');
1.356     albertel 9016: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   9017: 	    $r->print('<option value="'.$sample.'"'.
                   9018:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   9019:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 9020: 	}
1.594     raeburn  9021: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 9022: 	$i++;
                   9023:     }
1.594     raeburn  9024:     $r->print(&end_data_table());
1.31      albertel 9025:     $i--;
                   9026:     return $i;
                   9027: }
1.56      matthew  9028: 
1.144     matthew  9029: ######################################################
                   9030: ######################################################
                   9031: 
1.56      matthew  9032: =pod
1.31      albertel 9033: 
1.648     raeburn  9034: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       9035: 
                   9036: Prints a table of sample values from the upload and can make associate samples to internal names.
                   9037: 
                   9038: $r is an Apache Request ref,
                   9039: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   9040: $d is an array of 2 element arrays (internal name, displayed name)
                   9041: 
                   9042: =cut
                   9043: 
1.144     matthew  9044: ######################################################
                   9045: ######################################################
1.31      albertel 9046: sub csv_samples_select_table {
                   9047:     my ($r,$records,$d) = @_;
                   9048:     my $i=0;
1.144     matthew  9049:     #
1.662     bisitz   9050:     my $max_samples = 5;
                   9051:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  9052:     $r->print(&start_data_table().
                   9053:               &start_data_table_header_row().'<th>'.
                   9054:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   9055:               &end_data_table_header_row());
1.301     albertel 9056: 
                   9057:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  9058: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  9059: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 9060: 	foreach my $option (@$d) {
                   9061: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  9062: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 9063:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  9064:                       $display.'</option>');
1.31      albertel 9065: 	}
                   9066: 	$r->print('</select></td><td>');
1.662     bisitz   9067: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 9068: 	    if (defined($samples->[$line]{$key})) { 
                   9069: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   9070: 	    }
                   9071: 	}
1.594     raeburn  9072: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 9073: 	$i++;
                   9074:     }
1.594     raeburn  9075:     $r->print(&end_data_table());
1.31      albertel 9076:     $i--;
                   9077:     return($i);
1.115     matthew  9078: }
                   9079: 
1.144     matthew  9080: ######################################################
                   9081: ######################################################
                   9082: 
1.115     matthew  9083: =pod
                   9084: 
1.648     raeburn  9085: =item * &clean_excel_name($name)
1.115     matthew  9086: 
                   9087: Returns a replacement for $name which does not contain any illegal characters.
                   9088: 
                   9089: =cut
                   9090: 
1.144     matthew  9091: ######################################################
                   9092: ######################################################
1.115     matthew  9093: sub clean_excel_name {
                   9094:     my ($name) = @_;
                   9095:     $name =~ s/[:\*\?\/\\]//g;
                   9096:     if (length($name) > 31) {
                   9097:         $name = substr($name,0,31);
                   9098:     }
                   9099:     return $name;
1.25      albertel 9100: }
1.84      albertel 9101: 
1.85      albertel 9102: =pod
                   9103: 
1.648     raeburn  9104: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 9105: 
                   9106: Returns either 1 or undef
                   9107: 
                   9108: 1 if the part is to be hidden, undef if it is to be shown
                   9109: 
                   9110: Arguments are:
                   9111: 
                   9112: $id the id of the part to be checked
                   9113: $symb, optional the symb of the resource to check
                   9114: $udom, optional the domain of the user to check for
                   9115: $uname, optional the username of the user to check for
                   9116: 
                   9117: =cut
1.84      albertel 9118: 
                   9119: sub check_if_partid_hidden {
                   9120:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 9121:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 9122: 					 $symb,$udom,$uname);
1.141     albertel 9123:     my $truth=1;
                   9124:     #if the string starts with !, then the list is the list to show not hide
                   9125:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 9126:     my @hiddenlist=split(/,/,$hiddenparts);
                   9127:     foreach my $checkid (@hiddenlist) {
1.141     albertel 9128: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 9129:     }
1.141     albertel 9130:     return !$truth;
1.84      albertel 9131: }
1.127     matthew  9132: 
1.138     matthew  9133: 
                   9134: ############################################################
                   9135: ############################################################
                   9136: 
                   9137: =pod
                   9138: 
1.157     matthew  9139: =back 
                   9140: 
1.138     matthew  9141: =head1 cgi-bin script and graphing routines
                   9142: 
1.157     matthew  9143: =over 4
                   9144: 
1.648     raeburn  9145: =item * &get_cgi_id()
1.138     matthew  9146: 
                   9147: Inputs: none
                   9148: 
                   9149: Returns an id which can be used to pass environment variables
                   9150: to various cgi-bin scripts.  These environment variables will
                   9151: be removed from the users environment after a given time by
                   9152: the routine &Apache::lonnet::transfer_profile_to_env.
                   9153: 
                   9154: =cut
                   9155: 
                   9156: ############################################################
                   9157: ############################################################
1.152     albertel 9158: my $uniq=0;
1.136     matthew  9159: sub get_cgi_id {
1.154     albertel 9160:     $uniq=($uniq+1)%100000;
1.280     albertel 9161:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  9162: }
                   9163: 
1.127     matthew  9164: ############################################################
                   9165: ############################################################
                   9166: 
                   9167: =pod
                   9168: 
1.648     raeburn  9169: =item * &DrawBarGraph()
1.127     matthew  9170: 
1.138     matthew  9171: Facilitates the plotting of data in a (stacked) bar graph.
                   9172: Puts plot definition data into the users environment in order for 
                   9173: graph.png to plot it.  Returns an <img> tag for the plot.
                   9174: The bars on the plot are labeled '1','2',...,'n'.
                   9175: 
                   9176: Inputs:
                   9177: 
                   9178: =over 4
                   9179: 
                   9180: =item $Title: string, the title of the plot
                   9181: 
                   9182: =item $xlabel: string, text describing the X-axis of the plot
                   9183: 
                   9184: =item $ylabel: string, text describing the Y-axis of the plot
                   9185: 
                   9186: =item $Max: scalar, the maximum Y value to use in the plot
                   9187: If $Max is < any data point, the graph will not be rendered.
                   9188: 
1.140     matthew  9189: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  9190: they are plotted.  If undefined, default values will be used.
                   9191: 
1.178     matthew  9192: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   9193: 
1.138     matthew  9194: =item @Values: An array of array references.  Each array reference holds data
                   9195: to be plotted in a stacked bar chart.
                   9196: 
1.239     matthew  9197: =item If the final element of @Values is a hash reference the key/value
                   9198: pairs will be added to the graph definition.
                   9199: 
1.138     matthew  9200: =back
                   9201: 
                   9202: Returns:
                   9203: 
                   9204: An <img> tag which references graph.png and the appropriate identifying
                   9205: information for the plot.
                   9206: 
1.127     matthew  9207: =cut
                   9208: 
                   9209: ############################################################
                   9210: ############################################################
1.134     matthew  9211: sub DrawBarGraph {
1.178     matthew  9212:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  9213:     #
                   9214:     if (! defined($colors)) {
                   9215:         $colors = ['#33ff00', 
                   9216:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9217:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9218:                   ]; 
                   9219:     }
1.228     matthew  9220:     my $extra_settings = {};
                   9221:     if (ref($Values[-1]) eq 'HASH') {
                   9222:         $extra_settings = pop(@Values);
                   9223:     }
1.127     matthew  9224:     #
1.136     matthew  9225:     my $identifier = &get_cgi_id();
                   9226:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9227:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9228:         return '';
                   9229:     }
1.225     matthew  9230:     #
                   9231:     my @Labels;
                   9232:     if (defined($labels)) {
                   9233:         @Labels = @$labels;
                   9234:     } else {
                   9235:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9236:             push (@Labels,$i+1);
                   9237:         }
                   9238:     }
                   9239:     #
1.129     matthew  9240:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9241:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9242:     my %ValuesHash;
                   9243:     my $NumSets=1;
                   9244:     foreach my $array (@Values) {
                   9245:         next if (! ref($array));
1.136     matthew  9246:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9247:             join(',',@$array);
1.129     matthew  9248:     }
1.127     matthew  9249:     #
1.136     matthew  9250:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9251:     if ($NumBars < 3) {
                   9252:         $width = 120+$NumBars*32;
1.220     matthew  9253:         $xskip = 1;
1.225     matthew  9254:         $bar_width = 30;
                   9255:     } elsif ($NumBars < 5) {
                   9256:         $width = 120+$NumBars*20;
                   9257:         $xskip = 1;
                   9258:         $bar_width = 20;
1.220     matthew  9259:     } elsif ($NumBars < 10) {
1.136     matthew  9260:         $width = 120+$NumBars*15;
                   9261:         $xskip = 1;
                   9262:         $bar_width = 15;
                   9263:     } elsif ($NumBars <= 25) {
                   9264:         $width = 120+$NumBars*11;
                   9265:         $xskip = 5;
                   9266:         $bar_width = 8;
                   9267:     } elsif ($NumBars <= 50) {
                   9268:         $width = 120+$NumBars*8;
                   9269:         $xskip = 5;
                   9270:         $bar_width = 4;
                   9271:     } else {
                   9272:         $width = 120+$NumBars*8;
                   9273:         $xskip = 5;
                   9274:         $bar_width = 4;
                   9275:     }
                   9276:     #
1.137     matthew  9277:     $Max = 1 if ($Max < 1);
                   9278:     if ( int($Max) < $Max ) {
                   9279:         $Max++;
                   9280:         $Max = int($Max);
                   9281:     }
1.127     matthew  9282:     $Title  = '' if (! defined($Title));
                   9283:     $xlabel = '' if (! defined($xlabel));
                   9284:     $ylabel = '' if (! defined($ylabel));
1.369     www      9285:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9286:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9287:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9288:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9289:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9290:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9291:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9292:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9293:     $ValuesHash{$id.'.height'}   = $height;
                   9294:     $ValuesHash{$id.'.width'}    = $width;
                   9295:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9296:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9297:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9298:     #
1.228     matthew  9299:     # Deal with other parameters
                   9300:     while (my ($key,$value) = each(%$extra_settings)) {
                   9301:         $ValuesHash{$id.'.'.$key} = $value;
                   9302:     }
                   9303:     #
1.646     raeburn  9304:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9305:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9306: }
                   9307: 
                   9308: ############################################################
                   9309: ############################################################
                   9310: 
                   9311: =pod
                   9312: 
1.648     raeburn  9313: =item * &DrawXYGraph()
1.137     matthew  9314: 
1.138     matthew  9315: Facilitates the plotting of data in an XY graph.
                   9316: Puts plot definition data into the users environment in order for 
                   9317: graph.png to plot it.  Returns an <img> tag for the plot.
                   9318: 
                   9319: Inputs:
                   9320: 
                   9321: =over 4
                   9322: 
                   9323: =item $Title: string, the title of the plot
                   9324: 
                   9325: =item $xlabel: string, text describing the X-axis of the plot
                   9326: 
                   9327: =item $ylabel: string, text describing the Y-axis of the plot
                   9328: 
                   9329: =item $Max: scalar, the maximum Y value to use in the plot
                   9330: If $Max is < any data point, the graph will not be rendered.
                   9331: 
                   9332: =item $colors: Array ref containing the hex color codes for the data to be 
                   9333: plotted in.  If undefined, default values will be used.
                   9334: 
                   9335: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9336: 
                   9337: =item $Ydata: Array ref containing Array refs.  
1.185     www      9338: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9339: 
                   9340: =item %Values: hash indicating or overriding any default values which are 
                   9341: passed to graph.png.  
                   9342: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9343: 
                   9344: =back
                   9345: 
                   9346: Returns:
                   9347: 
                   9348: An <img> tag which references graph.png and the appropriate identifying
                   9349: information for the plot.
                   9350: 
1.137     matthew  9351: =cut
                   9352: 
                   9353: ############################################################
                   9354: ############################################################
                   9355: sub DrawXYGraph {
                   9356:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9357:     #
                   9358:     # Create the identifier for the graph
                   9359:     my $identifier = &get_cgi_id();
                   9360:     my $id = 'cgi.'.$identifier;
                   9361:     #
                   9362:     $Title  = '' if (! defined($Title));
                   9363:     $xlabel = '' if (! defined($xlabel));
                   9364:     $ylabel = '' if (! defined($ylabel));
                   9365:     my %ValuesHash = 
                   9366:         (
1.369     www      9367:          $id.'.title'  => &escape($Title),
                   9368:          $id.'.xlabel' => &escape($xlabel),
                   9369:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9370:          $id.'.y_max_value'=> $Max,
                   9371:          $id.'.labels'     => join(',',@$Xlabels),
                   9372:          $id.'.PlotType'   => 'XY',
                   9373:          );
                   9374:     #
                   9375:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9376:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9377:     }
                   9378:     #
                   9379:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9380:         return '';
                   9381:     }
                   9382:     my $NumSets=1;
1.138     matthew  9383:     foreach my $array (@{$Ydata}){
1.137     matthew  9384:         next if (! ref($array));
                   9385:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9386:     }
1.138     matthew  9387:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9388:     #
                   9389:     # Deal with other parameters
                   9390:     while (my ($key,$value) = each(%Values)) {
                   9391:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9392:     }
                   9393:     #
1.646     raeburn  9394:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9395:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9396: }
                   9397: 
                   9398: ############################################################
                   9399: ############################################################
                   9400: 
                   9401: =pod
                   9402: 
1.648     raeburn  9403: =item * &DrawXYYGraph()
1.138     matthew  9404: 
                   9405: Facilitates the plotting of data in an XY graph with two Y axes.
                   9406: Puts plot definition data into the users environment in order for 
                   9407: graph.png to plot it.  Returns an <img> tag for the plot.
                   9408: 
                   9409: Inputs:
                   9410: 
                   9411: =over 4
                   9412: 
                   9413: =item $Title: string, the title of the plot
                   9414: 
                   9415: =item $xlabel: string, text describing the X-axis of the plot
                   9416: 
                   9417: =item $ylabel: string, text describing the Y-axis of the plot
                   9418: 
                   9419: =item $colors: Array ref containing the hex color codes for the data to be 
                   9420: plotted in.  If undefined, default values will be used.
                   9421: 
                   9422: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9423: 
                   9424: =item $Ydata1: The first data set
                   9425: 
                   9426: =item $Min1: The minimum value of the left Y-axis
                   9427: 
                   9428: =item $Max1: The maximum value of the left Y-axis
                   9429: 
                   9430: =item $Ydata2: The second data set
                   9431: 
                   9432: =item $Min2: The minimum value of the right Y-axis
                   9433: 
                   9434: =item $Max2: The maximum value of the left Y-axis
                   9435: 
                   9436: =item %Values: hash indicating or overriding any default values which are 
                   9437: passed to graph.png.  
                   9438: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9439: 
                   9440: =back
                   9441: 
                   9442: Returns:
                   9443: 
                   9444: An <img> tag which references graph.png and the appropriate identifying
                   9445: information for the plot.
1.136     matthew  9446: 
                   9447: =cut
                   9448: 
                   9449: ############################################################
                   9450: ############################################################
1.137     matthew  9451: sub DrawXYYGraph {
                   9452:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9453:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9454:     #
                   9455:     # Create the identifier for the graph
                   9456:     my $identifier = &get_cgi_id();
                   9457:     my $id = 'cgi.'.$identifier;
                   9458:     #
                   9459:     $Title  = '' if (! defined($Title));
                   9460:     $xlabel = '' if (! defined($xlabel));
                   9461:     $ylabel = '' if (! defined($ylabel));
                   9462:     my %ValuesHash = 
                   9463:         (
1.369     www      9464:          $id.'.title'  => &escape($Title),
                   9465:          $id.'.xlabel' => &escape($xlabel),
                   9466:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9467:          $id.'.labels' => join(',',@$Xlabels),
                   9468:          $id.'.PlotType' => 'XY',
                   9469:          $id.'.NumSets' => 2,
1.137     matthew  9470:          $id.'.two_axes' => 1,
                   9471:          $id.'.y1_max_value' => $Max1,
                   9472:          $id.'.y1_min_value' => $Min1,
                   9473:          $id.'.y2_max_value' => $Max2,
                   9474:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9475:          );
                   9476:     #
1.137     matthew  9477:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9478:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9479:     }
                   9480:     #
                   9481:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9482:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9483:         return '';
                   9484:     }
                   9485:     my $NumSets=1;
1.137     matthew  9486:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9487:         next if (! ref($array));
                   9488:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9489:     }
                   9490:     #
                   9491:     # Deal with other parameters
                   9492:     while (my ($key,$value) = each(%Values)) {
                   9493:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9494:     }
                   9495:     #
1.646     raeburn  9496:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9497:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9498: }
                   9499: 
                   9500: ############################################################
                   9501: ############################################################
                   9502: 
                   9503: =pod
                   9504: 
1.157     matthew  9505: =back 
                   9506: 
1.139     matthew  9507: =head1 Statistics helper routines?  
                   9508: 
                   9509: Bad place for them but what the hell.
                   9510: 
1.157     matthew  9511: =over 4
                   9512: 
1.648     raeburn  9513: =item * &chartlink()
1.139     matthew  9514: 
                   9515: Returns a link to the chart for a specific student.  
                   9516: 
                   9517: Inputs:
                   9518: 
                   9519: =over 4
                   9520: 
                   9521: =item $linktext: The text of the link
                   9522: 
                   9523: =item $sname: The students username
                   9524: 
                   9525: =item $sdomain: The students domain
                   9526: 
                   9527: =back
                   9528: 
1.157     matthew  9529: =back
                   9530: 
1.139     matthew  9531: =cut
                   9532: 
                   9533: ############################################################
                   9534: ############################################################
                   9535: sub chartlink {
                   9536:     my ($linktext, $sname, $sdomain) = @_;
                   9537:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9538:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9539:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9540:        '">'.$linktext.'</a>';
1.153     matthew  9541: }
                   9542: 
                   9543: #######################################################
                   9544: #######################################################
                   9545: 
                   9546: =pod
                   9547: 
                   9548: =head1 Course Environment Routines
1.157     matthew  9549: 
                   9550: =over 4
1.153     matthew  9551: 
1.648     raeburn  9552: =item * &restore_course_settings()
1.153     matthew  9553: 
1.648     raeburn  9554: =item * &store_course_settings()
1.153     matthew  9555: 
                   9556: Restores/Store indicated form parameters from the course environment.
                   9557: Will not overwrite existing values of the form parameters.
                   9558: 
                   9559: Inputs: 
                   9560: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9561: 
                   9562: a hash ref describing the data to be stored.  For example:
                   9563:    
                   9564: %Save_Parameters = ('Status' => 'scalar',
                   9565:     'chartoutputmode' => 'scalar',
                   9566:     'chartoutputdata' => 'scalar',
                   9567:     'Section' => 'array',
1.373     raeburn  9568:     'Group' => 'array',
1.153     matthew  9569:     'StudentData' => 'array',
                   9570:     'Maps' => 'array');
                   9571: 
                   9572: Returns: both routines return nothing
                   9573: 
1.631     raeburn  9574: =back
                   9575: 
1.153     matthew  9576: =cut
                   9577: 
                   9578: #######################################################
                   9579: #######################################################
                   9580: sub store_course_settings {
1.496     albertel 9581:     return &store_settings($env{'request.course.id'},@_);
                   9582: }
                   9583: 
                   9584: sub store_settings {
1.153     matthew  9585:     # save to the environment
                   9586:     # appenv the same items, just to be safe
1.300     albertel 9587:     my $udom  = $env{'user.domain'};
                   9588:     my $uname = $env{'user.name'};
1.496     albertel 9589:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9590:     my %SaveHash;
                   9591:     my %AppHash;
                   9592:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9593:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9594:         my $envname = 'environment.'.$basename;
1.258     albertel 9595:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9596:             # Save this value away
                   9597:             if ($type eq 'scalar' &&
1.258     albertel 9598:                 (! exists($env{$envname}) || 
                   9599:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9600:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9601:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9602:             } elsif ($type eq 'array') {
                   9603:                 my $stored_form;
1.258     albertel 9604:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9605:                     $stored_form = join(',',
                   9606:                                         map {
1.369     www      9607:                                             &escape($_);
1.258     albertel 9608:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9609:                 } else {
                   9610:                     $stored_form = 
1.369     www      9611:                         &escape($env{'form.'.$setting});
1.153     matthew  9612:                 }
                   9613:                 # Determine if the array contents are the same.
1.258     albertel 9614:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9615:                     $SaveHash{$basename} = $stored_form;
                   9616:                     $AppHash{$envname}   = $stored_form;
                   9617:                 }
                   9618:             }
                   9619:         }
                   9620:     }
                   9621:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9622:                                           $udom,$uname);
1.153     matthew  9623:     if ($put_result !~ /^(ok|delayed)/) {
                   9624:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9625:                                  'got error:'.$put_result);
                   9626:     }
                   9627:     # Make sure these settings stick around in this session, too
1.646     raeburn  9628:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9629:     return;
                   9630: }
                   9631: 
                   9632: sub restore_course_settings {
1.499     albertel 9633:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9634: }
                   9635: 
                   9636: sub restore_settings {
                   9637:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9638:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9639:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9640:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9641:             '.'.$setting;
1.258     albertel 9642:         if (exists($env{$envname})) {
1.153     matthew  9643:             if ($type eq 'scalar') {
1.258     albertel 9644:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9645:             } elsif ($type eq 'array') {
1.258     albertel 9646:                 $env{'form.'.$setting} = [ 
1.153     matthew  9647:                                            map { 
1.369     www      9648:                                                &unescape($_); 
1.258     albertel 9649:                                            } split(',',$env{$envname})
1.153     matthew  9650:                                            ];
                   9651:             }
                   9652:         }
                   9653:     }
1.127     matthew  9654: }
                   9655: 
1.618     raeburn  9656: #######################################################
                   9657: #######################################################
                   9658: 
                   9659: =pod
                   9660: 
                   9661: =head1 Domain E-mail Routines  
                   9662: 
                   9663: =over 4
                   9664: 
1.648     raeburn  9665: =item * &build_recipient_list()
1.618     raeburn  9666: 
1.884     raeburn  9667: Build recipient lists for five types of e-mail:
1.766     raeburn  9668: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9669: (d) Help requests, (e) Course requests needing approval,  generated by
                   9670: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9671: loncoursequeueadmin.pm respectively.
1.618     raeburn  9672: 
                   9673: Inputs:
1.619     raeburn  9674: defmail (scalar - email address of default recipient), 
1.618     raeburn  9675: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9676: defdom (domain for which to retrieve configuration settings),
                   9677: origmail (scalar - email address of recipient from loncapa.conf, 
                   9678: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9679: 
1.655     raeburn  9680: Returns: comma separated list of addresses to which to send e-mail.
                   9681: 
                   9682: =back
1.618     raeburn  9683: 
                   9684: =cut
                   9685: 
                   9686: ############################################################
                   9687: ############################################################
                   9688: sub build_recipient_list {
1.619     raeburn  9689:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9690:     my @recipients;
                   9691:     my $otheremails;
                   9692:     my %domconfig =
                   9693:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9694:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9695:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9696:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9697:                 my @contacts = ('adminemail','supportemail');
                   9698:                 foreach my $item (@contacts) {
                   9699:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9700:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9701:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9702:                             push(@recipients,$addr);
                   9703:                         }
1.619     raeburn  9704:                     }
1.766     raeburn  9705:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9706:                 }
                   9707:             }
1.766     raeburn  9708:         } elsif ($origmail ne '') {
                   9709:             push(@recipients,$origmail);
1.618     raeburn  9710:         }
1.619     raeburn  9711:     } elsif ($origmail ne '') {
                   9712:         push(@recipients,$origmail);
1.618     raeburn  9713:     }
1.688     raeburn  9714:     if (defined($defmail)) {
                   9715:         if ($defmail ne '') {
                   9716:             push(@recipients,$defmail);
                   9717:         }
1.618     raeburn  9718:     }
                   9719:     if ($otheremails) {
1.619     raeburn  9720:         my @others;
                   9721:         if ($otheremails =~ /,/) {
                   9722:             @others = split(/,/,$otheremails);
1.618     raeburn  9723:         } else {
1.619     raeburn  9724:             push(@others,$otheremails);
                   9725:         }
                   9726:         foreach my $addr (@others) {
                   9727:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9728:                 push(@recipients,$addr);
                   9729:             }
1.618     raeburn  9730:         }
                   9731:     }
1.619     raeburn  9732:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9733:     return $recipientlist;
                   9734: }
                   9735: 
1.127     matthew  9736: ############################################################
                   9737: ############################################################
1.154     albertel 9738: 
1.655     raeburn  9739: =pod
                   9740: 
                   9741: =head1 Course Catalog Routines
                   9742: 
                   9743: =over 4
                   9744: 
                   9745: =item * &gather_categories()
                   9746: 
                   9747: Converts category definitions - keys of categories hash stored in  
                   9748: coursecategories in configuration.db on the primary library server in a 
                   9749: domain - to an array.  Also generates javascript and idx hash used to 
                   9750: generate Domain Coordinator interface for editing Course Categories.
                   9751: 
                   9752: Inputs:
1.663     raeburn  9753: 
1.655     raeburn  9754: categories (reference to hash of category definitions).
1.663     raeburn  9755: 
1.655     raeburn  9756: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9757:       categories and subcategories).
1.663     raeburn  9758: 
1.655     raeburn  9759: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9760:       editing Course Categories).
1.663     raeburn  9761: 
1.655     raeburn  9762: jsarray (reference to array of categories used to create Javascript arrays for
                   9763:          Domain Coordinator interface for editing Course Categories).
                   9764: 
                   9765: Returns: nothing
                   9766: 
                   9767: Side effects: populates cats, idx and jsarray. 
                   9768: 
                   9769: =cut
                   9770: 
                   9771: sub gather_categories {
                   9772:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9773:     my %counters;
                   9774:     my $num = 0;
                   9775:     foreach my $item (keys(%{$categories})) {
                   9776:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9777:         if ($container eq '' && $depth == 0) {
                   9778:             $cats->[$depth][$categories->{$item}] = $cat;
                   9779:         } else {
                   9780:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9781:         }
                   9782:         my ($escitem,$tail) = split(/:/,$item,2);
                   9783:         if ($counters{$tail} eq '') {
                   9784:             $counters{$tail} = $num;
                   9785:             $num ++;
                   9786:         }
                   9787:         if (ref($idx) eq 'HASH') {
                   9788:             $idx->{$item} = $counters{$tail};
                   9789:         }
                   9790:         if (ref($jsarray) eq 'ARRAY') {
                   9791:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9792:         }
                   9793:     }
                   9794:     return;
                   9795: }
                   9796: 
                   9797: =pod
                   9798: 
                   9799: =item * &extract_categories()
                   9800: 
                   9801: Used to generate breadcrumb trails for course categories.
                   9802: 
                   9803: Inputs:
1.663     raeburn  9804: 
1.655     raeburn  9805: categories (reference to hash of category definitions).
1.663     raeburn  9806: 
1.655     raeburn  9807: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9808:       categories and subcategories).
1.663     raeburn  9809: 
1.655     raeburn  9810: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9811: 
1.655     raeburn  9812: allitems (reference to hash - key is category key 
                   9813:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9814: 
1.655     raeburn  9815: idx (reference to hash of counters used in Domain Coordinator interface for
                   9816:       editing Course Categories).
1.663     raeburn  9817: 
1.655     raeburn  9818: jsarray (reference to array of categories used to create Javascript arrays for
                   9819:          Domain Coordinator interface for editing Course Categories).
                   9820: 
1.665     raeburn  9821: subcats (reference to hash of arrays containing all subcategories within each 
                   9822:          category, -recursive)
                   9823: 
1.655     raeburn  9824: Returns: nothing
                   9825: 
                   9826: Side effects: populates trails and allitems hash references.
                   9827: 
                   9828: =cut
                   9829: 
                   9830: sub extract_categories {
1.665     raeburn  9831:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9832:     if (ref($categories) eq 'HASH') {
                   9833:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9834:         if (ref($cats->[0]) eq 'ARRAY') {
                   9835:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9836:                 my $name = $cats->[0][$i];
                   9837:                 my $item = &escape($name).'::0';
                   9838:                 my $trailstr;
                   9839:                 if ($name eq 'instcode') {
                   9840:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9841:                 } elsif ($name eq 'communities') {
                   9842:                     $trailstr = &mt('Communities');
1.655     raeburn  9843:                 } else {
                   9844:                     $trailstr = $name;
                   9845:                 }
                   9846:                 if ($allitems->{$item} eq '') {
                   9847:                     push(@{$trails},$trailstr);
                   9848:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9849:                 }
                   9850:                 my @parents = ($name);
                   9851:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9852:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9853:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9854:                         if (ref($subcats) eq 'HASH') {
                   9855:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9856:                         }
                   9857:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9858:                     }
                   9859:                 } else {
                   9860:                     if (ref($subcats) eq 'HASH') {
                   9861:                         $subcats->{$item} = [];
1.655     raeburn  9862:                     }
                   9863:                 }
                   9864:             }
                   9865:         }
                   9866:     }
                   9867:     return;
                   9868: }
                   9869: 
                   9870: =pod
                   9871: 
                   9872: =item *&recurse_categories()
                   9873: 
                   9874: Recursively used to generate breadcrumb trails for course categories.
                   9875: 
                   9876: Inputs:
1.663     raeburn  9877: 
1.655     raeburn  9878: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9879:       categories and subcategories).
1.663     raeburn  9880: 
1.655     raeburn  9881: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9882: 
                   9883: category (current course category, for which breadcrumb trail is being generated).
                   9884: 
                   9885: trails (reference to array of breadcrumb trails for each category).
                   9886: 
1.655     raeburn  9887: allitems (reference to hash - key is category key
                   9888:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9889: 
1.655     raeburn  9890: parents (array containing containers directories for current category, 
                   9891:          back to top level). 
                   9892: 
                   9893: Returns: nothing
                   9894: 
                   9895: Side effects: populates trails and allitems hash references
                   9896: 
                   9897: =cut
                   9898: 
                   9899: sub recurse_categories {
1.665     raeburn  9900:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9901:     my $shallower = $depth - 1;
                   9902:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9903:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9904:             my $name = $cats->[$depth]{$category}[$k];
                   9905:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9906:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9907:             if ($allitems->{$item} eq '') {
                   9908:                 push(@{$trails},$trailstr);
                   9909:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9910:             }
                   9911:             my $deeper = $depth+1;
                   9912:             push(@{$parents},$category);
1.665     raeburn  9913:             if (ref($subcats) eq 'HASH') {
                   9914:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9915:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9916:                     my $higher;
                   9917:                     if ($j > 0) {
                   9918:                         $higher = &escape($parents->[$j]).':'.
                   9919:                                   &escape($parents->[$j-1]).':'.$j;
                   9920:                     } else {
                   9921:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9922:                     }
                   9923:                     push(@{$subcats->{$higher}},$subcat);
                   9924:                 }
                   9925:             }
                   9926:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9927:                                 $subcats);
1.655     raeburn  9928:             pop(@{$parents});
                   9929:         }
                   9930:     } else {
                   9931:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9932:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9933:         if ($allitems->{$item} eq '') {
                   9934:             push(@{$trails},$trailstr);
                   9935:             $allitems->{$item} = scalar(@{$trails})-1;
                   9936:         }
                   9937:     }
                   9938:     return;
                   9939: }
                   9940: 
1.663     raeburn  9941: =pod
                   9942: 
                   9943: =item *&assign_categories_table()
                   9944: 
                   9945: Create a datatable for display of hierarchical categories in a domain,
                   9946: with checkboxes to allow a course to be categorized. 
                   9947: 
                   9948: Inputs:
                   9949: 
                   9950: cathash - reference to hash of categories defined for the domain (from
                   9951:           configuration.db)
                   9952: 
                   9953: currcat - scalar with an & separated list of categories assigned to a course. 
                   9954: 
1.919     raeburn  9955: type    - scalar contains course type (Course or Community).
                   9956: 
1.663     raeburn  9957: Returns: $output (markup to be displayed) 
                   9958: 
                   9959: =cut
                   9960: 
                   9961: sub assign_categories_table {
1.919     raeburn  9962:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9963:     my $output;
                   9964:     if (ref($cathash) eq 'HASH') {
                   9965:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9966:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9967:         $maxdepth = scalar(@cats);
                   9968:         if (@cats > 0) {
                   9969:             my $itemcount = 0;
                   9970:             if (ref($cats[0]) eq 'ARRAY') {
                   9971:                 my @currcategories;
                   9972:                 if ($currcat ne '') {
                   9973:                     @currcategories = split('&',$currcat);
                   9974:                 }
1.919     raeburn  9975:                 my $table;
1.663     raeburn  9976:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9977:                     my $parent = $cats[0][$i];
1.919     raeburn  9978:                     next if ($parent eq 'instcode');
                   9979:                     if ($type eq 'Community') {
                   9980:                         next unless ($parent eq 'communities');
                   9981:                     } else {
                   9982:                         next if ($parent eq 'communities');
                   9983:                     }
1.663     raeburn  9984:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9985:                     my $item = &escape($parent).'::0';
                   9986:                     my $checked = '';
                   9987:                     if (@currcategories > 0) {
                   9988:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9989:                             $checked = ' checked="checked"';
1.663     raeburn  9990:                         }
                   9991:                     }
1.919     raeburn  9992:                     my $parent_title = $parent;
                   9993:                     if ($parent eq 'communities') {
                   9994:                         $parent_title = &mt('Communities');
                   9995:                     }
                   9996:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9997:                               '<input type="checkbox" name="usecategory" value="'.
                   9998:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9999:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  10000:                     my $depth = 1;
                   10001:                     push(@path,$parent);
1.919     raeburn  10002:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  10003:                     pop(@path);
1.919     raeburn  10004:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  10005:                     $itemcount ++;
                   10006:                 }
1.919     raeburn  10007:                 if ($itemcount) {
                   10008:                     $output = &Apache::loncommon::start_data_table().
                   10009:                               $table.
                   10010:                               &Apache::loncommon::end_data_table();
                   10011:                 }
1.663     raeburn  10012:             }
                   10013:         }
                   10014:     }
                   10015:     return $output;
                   10016: }
                   10017: 
                   10018: =pod
                   10019: 
                   10020: =item *&assign_category_rows()
                   10021: 
                   10022: Create a datatable row for display of nested categories in a domain,
                   10023: with checkboxes to allow a course to be categorized,called recursively.
                   10024: 
                   10025: Inputs:
                   10026: 
                   10027: itemcount - track row number for alternating colors
                   10028: 
                   10029: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   10030:       categories and subcategories.
                   10031: 
                   10032: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   10033: 
                   10034: parent - parent of current category item
                   10035: 
                   10036: path - Array containing all categories back up through the hierarchy from the
                   10037:        current category to the top level.
                   10038: 
                   10039: currcategories - reference to array of current categories assigned to the course
                   10040: 
                   10041: Returns: $output (markup to be displayed).
                   10042: 
                   10043: =cut
                   10044: 
                   10045: sub assign_category_rows {
                   10046:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   10047:     my ($text,$name,$item,$chgstr);
                   10048:     if (ref($cats) eq 'ARRAY') {
                   10049:         my $maxdepth = scalar(@{$cats});
                   10050:         if (ref($cats->[$depth]) eq 'HASH') {
                   10051:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   10052:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   10053:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   10054:                 $text .= '<td><table class="LC_datatable">';
                   10055:                 for (my $j=0; $j<$numchildren; $j++) {
                   10056:                     $name = $cats->[$depth]{$parent}[$j];
                   10057:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   10058:                     my $deeper = $depth+1;
                   10059:                     my $checked = '';
                   10060:                     if (ref($currcategories) eq 'ARRAY') {
                   10061:                         if (@{$currcategories} > 0) {
                   10062:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   10063:                                 $checked = ' checked="checked"';
1.663     raeburn  10064:                             }
                   10065:                         }
                   10066:                     }
1.664     raeburn  10067:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   10068:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  10069:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   10070:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   10071:                              '</td><td>';
1.663     raeburn  10072:                     if (ref($path) eq 'ARRAY') {
                   10073:                         push(@{$path},$name);
                   10074:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   10075:                         pop(@{$path});
                   10076:                     }
                   10077:                     $text .= '</td></tr>';
                   10078:                 }
                   10079:                 $text .= '</table></td>';
                   10080:             }
                   10081:         }
                   10082:     }
                   10083:     return $text;
                   10084: }
                   10085: 
1.655     raeburn  10086: ############################################################
                   10087: ############################################################
                   10088: 
                   10089: 
1.443     albertel 10090: sub commit_customrole {
1.664     raeburn  10091:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  10092:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 10093:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   10094:                          ($end?', ending '.localtime($end):'').': <b>'.
                   10095:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  10096:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 10097:                  '</b><br />';
                   10098:     return $output;
                   10099: }
                   10100: 
                   10101: sub commit_standardrole {
1.541     raeburn  10102:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   10103:     my ($output,$logmsg,$linefeed);
                   10104:     if ($context eq 'auto') {
                   10105:         $linefeed = "\n";
                   10106:     } else {
                   10107:         $linefeed = "<br />\n";
                   10108:     }  
1.443     albertel 10109:     if ($three eq 'st') {
1.541     raeburn  10110:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   10111:                                          $one,$two,$sec,$context);
                   10112:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  10113:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   10114:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 10115:         } else {
1.541     raeburn  10116:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 10117:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10118:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   10119:             if ($context eq 'auto') {
                   10120:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   10121:             } else {
                   10122:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   10123:                &mt('Add to classlist').': <b>ok</b>';
                   10124:             }
                   10125:             $output .= $linefeed;
1.443     albertel 10126:         }
                   10127:     } else {
                   10128:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   10129:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10130:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  10131:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  10132:         if ($context eq 'auto') {
                   10133:             $output .= $result.$linefeed;
                   10134:         } else {
                   10135:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   10136:         }
1.443     albertel 10137:     }
                   10138:     return $output;
                   10139: }
                   10140: 
                   10141: sub commit_studentrole {
1.541     raeburn  10142:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  10143:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  10144:     if ($context eq 'auto') {
                   10145:         $linefeed = "\n";
                   10146:     } else {
                   10147:         $linefeed = '<br />'."\n";
                   10148:     }
1.443     albertel 10149:     if (defined($one) && defined($two)) {
                   10150:         my $cid=$one.'_'.$two;
                   10151:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   10152:         my $secchange = 0;
                   10153:         my $expire_role_result;
                   10154:         my $modify_section_result;
1.628     raeburn  10155:         if ($oldsec ne '-1') { 
                   10156:             if ($oldsec ne $sec) {
1.443     albertel 10157:                 $secchange = 1;
1.628     raeburn  10158:                 my $now = time;
1.443     albertel 10159:                 my $uurl='/'.$cid;
                   10160:                 $uurl=~s/\_/\//g;
                   10161:                 if ($oldsec) {
                   10162:                     $uurl.='/'.$oldsec;
                   10163:                 }
1.626     raeburn  10164:                 $oldsecurl = $uurl;
1.628     raeburn  10165:                 $expire_role_result = 
1.652     raeburn  10166:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  10167:                 if ($env{'request.course.sec'} ne '') { 
                   10168:                     if ($expire_role_result eq 'refused') {
                   10169:                         my @roles = ('st');
                   10170:                         my @statuses = ('previous');
                   10171:                         my @roledoms = ($one);
                   10172:                         my $withsec = 1;
                   10173:                         my %roleshash = 
                   10174:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   10175:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   10176:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   10177:                             my ($oldstart,$oldend) = 
                   10178:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   10179:                             if ($oldend > 0 && $oldend <= $now) {
                   10180:                                 $expire_role_result = 'ok';
                   10181:                             }
                   10182:                         }
                   10183:                     }
                   10184:                 }
1.443     albertel 10185:                 $result = $expire_role_result;
                   10186:             }
                   10187:         }
                   10188:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  10189:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 10190:             if ($modify_section_result =~ /^ok/) {
                   10191:                 if ($secchange == 1) {
1.628     raeburn  10192:                     if ($sec eq '') {
                   10193:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   10194:                     } else {
                   10195:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   10196:                     }
1.443     albertel 10197:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  10198:                     if ($sec eq '') {
                   10199:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   10200:                     } else {
                   10201:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10202:                     }
1.443     albertel 10203:                 } else {
1.628     raeburn  10204:                     if ($sec eq '') {
                   10205:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   10206:                     } else {
                   10207:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10208:                     }
1.443     albertel 10209:                 }
                   10210:             } else {
1.628     raeburn  10211:                 if ($secchange) {       
                   10212:                     $$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;
                   10213:                 } else {
                   10214:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10215:                 }
1.443     albertel 10216:             }
                   10217:             $result = $modify_section_result;
                   10218:         } elsif ($secchange == 1) {
1.628     raeburn  10219:             if ($oldsec eq '') {
                   10220:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10221:             } else {
                   10222:                 $$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;
                   10223:             }
1.626     raeburn  10224:             if ($expire_role_result eq 'refused') {
                   10225:                 my $newsecurl = '/'.$cid;
                   10226:                 $newsecurl =~ s/\_/\//g;
                   10227:                 if ($sec ne '') {
                   10228:                     $newsecurl.='/'.$sec;
                   10229:                 }
                   10230:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10231:                     if ($sec eq '') {
                   10232:                         $$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;
                   10233:                     } else {
                   10234:                         $$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;
                   10235:                     }
                   10236:                 }
                   10237:             }
1.443     albertel 10238:         }
                   10239:     } else {
1.626     raeburn  10240:         $$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 10241:         $result = "error: incomplete course id\n";
                   10242:     }
                   10243:     return $result;
                   10244: }
                   10245: 
                   10246: ############################################################
                   10247: ############################################################
                   10248: 
1.566     albertel 10249: sub check_clone {
1.578     raeburn  10250:     my ($args,$linefeed) = @_;
1.566     albertel 10251:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10252:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10253:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10254:     my $clonemsg;
                   10255:     my $can_clone = 0;
1.925.2.11  raeburn  10256:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10257:     if ($lctype ne 'community') {
                   10258:         $lctype = 'course';
                   10259:     }
1.566     albertel 10260:     if ($clonehome eq 'no_host') {
1.925.2.11  raeburn  10261:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10262:             $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'});
                   10263:         } else {
                   10264:             $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'});
                   10265:         }     
1.566     albertel 10266:     } else {
                   10267: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.925.2.11  raeburn  10268:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10269:             if ($clonedesc{'type'} ne 'Community') {
                   10270:                  $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'});
                   10271:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10272:             }
                   10273:         }
1.882     raeburn  10274: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10275:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10276: 	    $can_clone = 1;
                   10277: 	} else {
                   10278: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10279: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10280: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10281:             if (grep(/^\*$/,@cloners)) {
                   10282:                 $can_clone = 1;
                   10283:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10284:                 $can_clone = 1;
                   10285:             } else {
1.908     raeburn  10286:                 my $ccrole = 'cc';
1.925.2.11  raeburn  10287:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10288:                     $ccrole = 'co';
                   10289:                 }
1.578     raeburn  10290: 	        my %roleshash =
                   10291: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10292: 					 $args->{'ccdomain'},
1.908     raeburn  10293:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10294: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10295: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10296: 		    $can_clone = 1;
                   10297: 	        } else {
1.925.2.11  raeburn  10298:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10299:                         $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'});
                   10300:                     } else {
                   10301:                         $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'});
                   10302:                     }
1.578     raeburn  10303: 	        }
1.566     albertel 10304: 	    }
1.578     raeburn  10305:         }
1.566     albertel 10306:     }
                   10307:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10308: }
                   10309: 
1.444     albertel 10310: sub construct_course {
1.885     raeburn  10311:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10312:     my $outcome;
1.541     raeburn  10313:     my $linefeed =  '<br />'."\n";
                   10314:     if ($context eq 'auto') {
                   10315:         $linefeed = "\n";
                   10316:     }
1.566     albertel 10317: 
                   10318: #
                   10319: # Are we cloning?
                   10320: #
                   10321:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10322:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10323: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10324: 	if ($context ne 'auto') {
1.578     raeburn  10325:             if ($clonemsg ne '') {
                   10326: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10327:             }
1.566     albertel 10328: 	}
                   10329: 	$outcome .= $clonemsg.$linefeed;
                   10330: 
                   10331:         if (!$can_clone) {
                   10332: 	    return (0,$outcome);
                   10333: 	}
                   10334:     }
                   10335: 
1.444     albertel 10336: #
                   10337: # Open course
                   10338: #
                   10339:     my $crstype = lc($args->{'crstype'});
                   10340:     my %cenv=();
                   10341:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10342:                                              $args->{'cdescr'},
                   10343:                                              $args->{'curl'},
                   10344:                                              $args->{'course_home'},
                   10345:                                              $args->{'nonstandard'},
                   10346:                                              $args->{'crscode'},
                   10347:                                              $args->{'ccuname'}.':'.
                   10348:                                              $args->{'ccdomain'},
1.882     raeburn  10349:                                              $args->{'crstype'},
1.885     raeburn  10350:                                              $cnum,$context,$category);
1.444     albertel 10351: 
                   10352:     # Note: The testing routines depend on this being output; see 
                   10353:     # Utils::Course. This needs to at least be output as a comment
                   10354:     # if anyone ever decides to not show this, and Utils::Course::new
                   10355:     # will need to be suitably modified.
1.541     raeburn  10356:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10357: #
                   10358: # Check if created correctly
                   10359: #
1.479     albertel 10360:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10361:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10362:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10363: 
1.444     albertel 10364: #
1.566     albertel 10365: # Do the cloning
                   10366: #   
                   10367:     if ($can_clone && $cloneid) {
                   10368: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10369: 	if ($context ne 'auto') {
                   10370: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10371: 	}
                   10372: 	$outcome .= $clonemsg.$linefeed;
                   10373: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10374: # Copy all files
1.637     www      10375: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10376: # Restore URL
1.566     albertel 10377: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10378: # Restore title
1.566     albertel 10379: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10380: # Mark as cloned
1.566     albertel 10381: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10382: # Need to clone grading mode
                   10383:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10384:         $cenv{'grading'}=$newenv{'grading'};
                   10385: # Do not clone these environment entries
                   10386:         &Apache::lonnet::del('environment',
                   10387:                   ['default_enrollment_start_date',
                   10388:                    'default_enrollment_end_date',
                   10389:                    'question.email',
                   10390:                    'policy.email',
                   10391:                    'comment.email',
                   10392:                    'pch.users.denied',
1.725     raeburn  10393:                    'plc.users.denied',
                   10394:                    'hidefromcat',
                   10395:                    'categories'],
1.638     www      10396:                    $$crsudom,$$crsunum);
1.444     albertel 10397:     }
1.566     albertel 10398: 
1.444     albertel 10399: #
                   10400: # Set environment (will override cloned, if existing)
                   10401: #
                   10402:     my @sections = ();
                   10403:     my @xlists = ();
                   10404:     if ($args->{'crstype'}) {
                   10405:         $cenv{'type'}=$args->{'crstype'};
                   10406:     }
                   10407:     if ($args->{'crsid'}) {
                   10408:         $cenv{'courseid'}=$args->{'crsid'};
                   10409:     }
                   10410:     if ($args->{'crscode'}) {
                   10411:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10412:     }
                   10413:     if ($args->{'crsquota'} ne '') {
                   10414:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10415:     } else {
                   10416:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10417:     }
                   10418:     if ($args->{'ccuname'}) {
                   10419:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10420:                                         ':'.$args->{'ccdomain'};
                   10421:     } else {
                   10422:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10423:     }
                   10424:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10425:     if ($args->{'crssections'}) {
                   10426:         $cenv{'internal.sectionnums'} = '';
                   10427:         if ($args->{'crssections'} =~ m/,/) {
                   10428:             @sections = split/,/,$args->{'crssections'};
                   10429:         } else {
                   10430:             $sections[0] = $args->{'crssections'};
                   10431:         }
                   10432:         if (@sections > 0) {
                   10433:             foreach my $item (@sections) {
                   10434:                 my ($sec,$gp) = split/:/,$item;
                   10435:                 my $class = $args->{'crscode'}.$sec;
                   10436:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10437:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10438:                 unless ($addcheck eq 'ok') {
                   10439:                     push @badclasses, $class;
                   10440:                 }
                   10441:             }
                   10442:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10443:         }
                   10444:     }
                   10445: # do not hide course coordinator from staff listing, 
                   10446: # even if privileged
                   10447:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10448: # add crosslistings
                   10449:     if ($args->{'crsxlist'}) {
                   10450:         $cenv{'internal.crosslistings'}='';
                   10451:         if ($args->{'crsxlist'} =~ m/,/) {
                   10452:             @xlists = split/,/,$args->{'crsxlist'};
                   10453:         } else {
                   10454:             $xlists[0] = $args->{'crsxlist'};
                   10455:         }
                   10456:         if (@xlists > 0) {
                   10457:             foreach my $item (@xlists) {
                   10458:                 my ($xl,$gp) = split/:/,$item;
                   10459:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10460:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10461:                 unless ($addcheck eq 'ok') {
                   10462:                     push @badclasses, $xl;
                   10463:                 }
                   10464:             }
                   10465:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10466:         }
                   10467:     }
                   10468:     if ($args->{'autoadds'}) {
                   10469:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10470:     }
                   10471:     if ($args->{'autodrops'}) {
                   10472:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10473:     }
                   10474: # check for notification of enrollment changes
                   10475:     my @notified = ();
                   10476:     if ($args->{'notify_owner'}) {
                   10477:         if ($args->{'ccuname'} ne '') {
                   10478:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10479:         }
                   10480:     }
                   10481:     if ($args->{'notify_dc'}) {
                   10482:         if ($uname ne '') { 
1.630     raeburn  10483:             push(@notified,$uname.':'.$udom);
1.444     albertel 10484:         }
                   10485:     }
                   10486:     if (@notified > 0) {
                   10487:         my $notifylist;
                   10488:         if (@notified > 1) {
                   10489:             $notifylist = join(',',@notified);
                   10490:         } else {
                   10491:             $notifylist = $notified[0];
                   10492:         }
                   10493:         $cenv{'internal.notifylist'} = $notifylist;
                   10494:     }
                   10495:     if (@badclasses > 0) {
                   10496:         my %lt=&Apache::lonlocal::texthash(
                   10497:                 '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',
                   10498:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10499:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10500:         );
1.541     raeburn  10501:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10502:                            ' ('.$lt{'adby'}.')';
                   10503:         if ($context eq 'auto') {
                   10504:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10505:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10506:             foreach my $item (@badclasses) {
                   10507:                 if ($context eq 'auto') {
                   10508:                     $outcome .= " - $item\n";
                   10509:                 } else {
                   10510:                     $outcome .= "<li>$item</li>\n";
                   10511:                 }
                   10512:             }
                   10513:             if ($context eq 'auto') {
                   10514:                 $outcome .= $linefeed;
                   10515:             } else {
1.566     albertel 10516:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10517:             }
                   10518:         } 
1.444     albertel 10519:     }
                   10520:     if ($args->{'no_end_date'}) {
                   10521:         $args->{'endaccess'} = 0;
                   10522:     }
                   10523:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10524:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10525:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10526:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10527:     if ($args->{'showphotos'}) {
                   10528:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10529:     }
                   10530:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10531:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10532:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10533:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10534:             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'); 
                   10535:             if ($context eq 'auto') {
                   10536:                 $outcome .= $krb_msg;
                   10537:             } else {
1.566     albertel 10538:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10539:             }
                   10540:             $outcome .= $linefeed;
1.444     albertel 10541:         }
                   10542:     }
                   10543:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10544:        if ($args->{'setpolicy'}) {
                   10545:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10546:        }
                   10547:        if ($args->{'setcontent'}) {
                   10548:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10549:        }
                   10550:     }
                   10551:     if ($args->{'reshome'}) {
                   10552: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10553: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10554:     }
                   10555: #
                   10556: # course has keyed access
                   10557: #
                   10558:     if ($args->{'setkeys'}) {
                   10559:        $cenv{'keyaccess'}='yes';
                   10560:     }
                   10561: # if specified, key authority is not course, but user
                   10562: # only active if keyaccess is yes
                   10563:     if ($args->{'keyauth'}) {
1.487     albertel 10564: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10565: 	$user = &LONCAPA::clean_username($user);
                   10566: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10567: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10568: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10569: 	}
                   10570:     }
                   10571: 
                   10572:     if ($args->{'disresdis'}) {
                   10573:         $cenv{'pch.roles.denied'}='st';
                   10574:     }
                   10575:     if ($args->{'disablechat'}) {
                   10576:         $cenv{'plc.roles.denied'}='st';
                   10577:     }
                   10578: 
                   10579:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10580:     # course
                   10581:     $cenv{'course.helper.not.run'} = 1;
                   10582:     #
                   10583:     # Use new Randomseed
                   10584:     #
                   10585:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10586:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10587:     #
                   10588:     # The encryption code and receipt prefix for this course
                   10589:     #
                   10590:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10591:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10592:     #
                   10593:     # By default, use standard grading
                   10594:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10595: 
1.541     raeburn  10596:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10597:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10598: #
                   10599: # Open all assignments
                   10600: #
                   10601:     if ($args->{'openall'}) {
                   10602:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10603:        my %storecontent = ($storeunder         => time,
                   10604:                            $storeunder.'.type' => 'date_start');
                   10605:        
                   10606:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10607:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10608:    }
                   10609: #
                   10610: # Set first page
                   10611: #
                   10612:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10613: 	    || ($cloneid)) {
1.445     albertel 10614: 	use LONCAPA::map;
1.444     albertel 10615: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10616: 
                   10617: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10618:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10619: 
1.444     albertel 10620:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10621:         my $title; my $url;
                   10622:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10623: 	    $title=&mt('Syllabus');
1.444     albertel 10624:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10625:         } else {
1.690     bisitz   10626:             $title=&mt('Navigate Contents');
1.444     albertel 10627:             $url='/adm/navmaps';
                   10628:         }
1.445     albertel 10629: 
                   10630:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10631: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10632: 
                   10633: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10634:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10635:     }
1.566     albertel 10636: 
1.925.2.12  raeburn  10637:     if ($args->{'cloneroster'}) {
                   10638:         my ($numadded,$clisterror) = &Apache::lonclonecourse::copyroster($cloneid,$$courseid,$args->{'startaccess'},$args->{'endaccess'});
                   10639:         if ($clisterror) {
                   10640:             $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;
                   10641:             if ($numadded) {
                   10642:                 $outcome .= &mt('Although [quant,_1,student] have received roles in the new course the roster does not report this. It is  ').$linefeed;
                   10643:             } 
                   10644:         } else {
                   10645:             if ($numadded) {
                   10646:                 $outcome .= "\0".&mt('[quant,_1,student] copied from roster for old course to roster for new course.',$numadded).$linefeed;
                   10647:             } else {
                   10648:                 $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;
                   10649:             }
                   10650:         }
                   10651:     }
1.566     albertel 10652:     return (1,$outcome);
1.444     albertel 10653: }
                   10654: 
                   10655: ############################################################
                   10656: ############################################################
                   10657: 
1.378     raeburn  10658: sub course_type {
                   10659:     my ($cid) = @_;
                   10660:     if (!defined($cid)) {
                   10661:         $cid = $env{'request.course.id'};
                   10662:     }
1.404     albertel 10663:     if (defined($env{'course.'.$cid.'.type'})) {
                   10664:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10665:     } else {
                   10666:         return 'Course';
1.377     raeburn  10667:     }
                   10668: }
1.156     albertel 10669: 
1.406     raeburn  10670: sub group_term {
                   10671:     my $crstype = &course_type();
                   10672:     my %names = (
                   10673:                   'Course' => 'group',
1.865     raeburn  10674:                   'Community' => 'group',
1.406     raeburn  10675:                 );
                   10676:     return $names{$crstype};
                   10677: }
                   10678: 
1.902     raeburn  10679: sub course_types {
                   10680:     my @types = ('official','unofficial','community');
                   10681:     my %typename = (
                   10682:                          official   => 'Official course',
                   10683:                          unofficial => 'Unofficial course',
                   10684:                          community  => 'Community',
                   10685:                    );
                   10686:     return (\@types,\%typename);
                   10687: }
                   10688: 
1.156     albertel 10689: sub icon {
                   10690:     my ($file)=@_;
1.505     albertel 10691:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10692:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10693:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10694:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10695: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10696: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10697: 	            $curfext.".gif") {
                   10698: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10699: 		$curfext.".gif";
                   10700: 	}
                   10701:     }
1.249     albertel 10702:     return &lonhttpdurl($iconname);
1.154     albertel 10703: } 
1.84      albertel 10704: 
1.575     albertel 10705: sub lonhttpdurl {
1.692     www      10706: #
                   10707: # Had been used for "small fry" static images on separate port 8080.
                   10708: # Modify here if lightweight http functionality desired again.
                   10709: # Currently eliminated due to increasing firewall issues.
                   10710: #
1.575     albertel 10711:     my ($url)=@_;
1.692     www      10712:     return $url;
1.215     albertel 10713: }
                   10714: 
1.213     albertel 10715: sub connection_aborted {
                   10716:     my ($r)=@_;
                   10717:     $r->print(" ");$r->rflush();
                   10718:     my $c = $r->connection;
                   10719:     return $c->aborted();
                   10720: }
                   10721: 
1.221     foxr     10722: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10723: #    strings as 'strings'.
                   10724: sub escape_single {
1.221     foxr     10725:     my ($input) = @_;
1.223     albertel 10726:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10727:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10728:     return $input;
                   10729: }
1.223     albertel 10730: 
1.222     foxr     10731: #  Same as escape_single, but escape's "'s  This 
                   10732: #  can be used for  "strings"
                   10733: sub escape_double {
                   10734:     my ($input) = @_;
                   10735:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10736:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10737:     return $input;
                   10738: }
1.223     albertel 10739:  
1.222     foxr     10740: #   Escapes the last element of a full URL.
                   10741: sub escape_url {
                   10742:     my ($url)   = @_;
1.238     raeburn  10743:     my @urlslices = split(/\//, $url,-1);
1.369     www      10744:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10745:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10746: }
1.462     albertel 10747: 
1.820     raeburn  10748: sub compare_arrays {
                   10749:     my ($arrayref1,$arrayref2) = @_;
                   10750:     my (@difference,%count);
                   10751:     @difference = ();
                   10752:     %count = ();
                   10753:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10754:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10755:         foreach my $element (keys(%count)) {
                   10756:             if ($count{$element} == 1) {
                   10757:                 push(@difference,$element);
                   10758:             }
                   10759:         }
                   10760:     }
                   10761:     return @difference;
                   10762: }
                   10763: 
1.817     bisitz   10764: # -------------------------------------------------------- Initialize user login
1.462     albertel 10765: sub init_user_environment {
1.463     albertel 10766:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10767:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10768: 
                   10769:     my $public=($username eq 'public' && $domain eq 'public');
                   10770: 
                   10771: # See if old ID present, if so, remove
                   10772: 
                   10773:     my ($filename,$cookie,$userroles);
                   10774:     my $now=time;
                   10775: 
                   10776:     if ($public) {
                   10777: 	my $max_public=100;
                   10778: 	my $oldest;
                   10779: 	my $oldest_time=0;
                   10780: 	for(my $next=1;$next<=$max_public;$next++) {
                   10781: 	    if (-e $lonids."/publicuser_$next.id") {
                   10782: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10783: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10784: 		    $oldest_time=$mtime;
                   10785: 		    $oldest=$next;
                   10786: 		}
                   10787: 	    } else {
                   10788: 		$cookie="publicuser_$next";
                   10789: 		last;
                   10790: 	    }
                   10791: 	}
                   10792: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10793:     } else {
1.463     albertel 10794: 	# if this isn't a robot, kill any existing non-robot sessions
                   10795: 	if (!$args->{'robot'}) {
                   10796: 	    opendir(DIR,$lonids);
                   10797: 	    while ($filename=readdir(DIR)) {
                   10798: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10799: 		    unlink($lonids.'/'.$filename);
                   10800: 		}
1.462     albertel 10801: 	    }
1.463     albertel 10802: 	    closedir(DIR);
1.462     albertel 10803: 	}
                   10804: # Give them a new cookie
1.463     albertel 10805: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10806: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10807: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10808:     
                   10809: # Initialize roles
                   10810: 
                   10811: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10812:     }
                   10813: # ------------------------------------ Check browser type and MathML capability
                   10814: 
                   10815:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10816:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10817: 
                   10818: # ------------------------------------------------------------- Get environment
                   10819: 
                   10820:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10821:     my ($tmp) = keys(%userenv);
                   10822:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10823: 	# default remote control to off
                   10824: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10825:     } else {
                   10826: 	undef(%userenv);
                   10827:     }
                   10828:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10829: 	$form->{'interface'}=$userenv{'interface'};
                   10830:     }
                   10831:     $env{'environment.remote'}=$userenv{'remote'};
                   10832:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10833: 
                   10834: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10835:     foreach my $option ('interface','localpath','localres') {
                   10836:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10837:     }
                   10838: # --------------------------------------------------------- Write first profile
                   10839: 
                   10840:     {
                   10841: 	my %initial_env = 
                   10842: 	    ("user.name"          => $username,
                   10843: 	     "user.domain"        => $domain,
                   10844: 	     "user.home"          => $authhost,
                   10845: 	     "browser.type"       => $clientbrowser,
                   10846: 	     "browser.version"    => $clientversion,
                   10847: 	     "browser.mathml"     => $clientmathml,
                   10848: 	     "browser.unicode"    => $clientunicode,
                   10849: 	     "browser.os"         => $clientos,
                   10850: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10851: 	     "request.course.fn"  => '',
                   10852: 	     "request.course.uri" => '',
                   10853: 	     "request.course.sec" => '',
                   10854: 	     "request.role"       => 'cm',
                   10855: 	     "request.role.adv"   => $env{'user.adv'},
                   10856: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10857: 
                   10858:         if ($form->{'localpath'}) {
                   10859: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10860: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10861:         }
                   10862: 	
                   10863: 	if ($public) {
                   10864: 	    $initial_env{"environment.remote"} = "off";
                   10865: 	}
                   10866: 	if ($form->{'interface'}) {
                   10867: 	    $form->{'interface'}=~s/\W//gs;
                   10868: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10869: 	    $env{'browser.interface'}=$form->{'interface'};
                   10870: 	}
                   10871: 
1.724     raeburn  10872:         foreach my $tool ('aboutme','blog','portfolio') {
                   10873:             $userenv{'availabletools.'.$tool} = 
                   10874:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10875:         }
                   10876: 
1.864     raeburn  10877:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10878:             $userenv{'canrequest.'.$crstype} =
                   10879:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10880:                                                   'reload','requestcourses');
                   10881:         }
                   10882: 
1.462     albertel 10883: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10884: 	
                   10885: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10886: 		 &GDBM_WRCREAT(),0640)) {
                   10887: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10888: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10889: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10890: 	    if (ref($args->{'extra_env'})) {
                   10891: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10892: 	    }
1.462     albertel 10893: 	    untie(%disk_env);
                   10894: 	} else {
1.705     tempelho 10895: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10896: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10897: 	    return 'error: '.$!;
                   10898: 	}
                   10899:     }
                   10900:     $env{'request.role'}='cm';
                   10901:     $env{'request.role.adv'}=$env{'user.adv'};
                   10902:     $env{'browser.type'}=$clientbrowser;
                   10903: 
                   10904:     return $cookie;
                   10905: 
                   10906: }
                   10907: 
                   10908: sub _add_to_env {
                   10909:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10910:     if (ref($env_data) eq 'HASH') {
                   10911:         while (my ($key,$value) = each(%$env_data)) {
                   10912: 	    $idf->{$prefix.$key} = $value;
                   10913: 	    $env{$prefix.$key}   = $value;
                   10914:         }
1.462     albertel 10915:     }
                   10916: }
                   10917: 
1.925.2.8  raeburn  10918: sub new_roles_update {
                   10919:     my $rolecount = 0;
                   10920:     foreach my $envkey (keys(%env)) {
                   10921:         next unless ($envkey =~ /^user\.role\./);
                   10922:         $rolecount ++;
                   10923:     }
1.925.2.9  raeburn  10924:     my $newrolecount = 0;
1.925.2.8  raeburn  10925:     if (!$rolecount) {
                   10926:         my %userenv;
                   10927:         foreach my $crstype ('official','unofficial','community') {
                   10928:             $userenv{'canrequest.'.$crstype} =
                   10929:                 &Apache::lonnet::usertools_access($env{'user.name'},
                   10930:                 $env{'user.domain'},$crstype,'reload','requestcourses');
                   10931:         }
                   10932:         my $then=$env{'user.login.time'};
                   10933:         my $refresh=time;
                   10934:         my (%userroles,%allroles,%allgroups,@newroles);
                   10935:         my %roleshash =
                   10936:             &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active','future','previous'],undef,undef,1);
                   10937:         foreach my $item (keys(%roleshash)) {
                   10938:             my ($uname,$udom,$role,$section) = split(':',$item);
                   10939:             my $where = '/'.$udom.'/'.$uname;
                   10940:             my ($tstart,$tend) = split(':',$roleshash{$item});
                   10941:             if ($section ne '') {
                   10942:                 $where .= '/'.$section;
                   10943:             }
                   10944:             my $spec = $role.'.'.$where;
                   10945:             &Apache::lonnet::set_arearole($role,$where,$tstart,$tend,
                   10946:                                           $env{'user.domain'},$env{'user.name'});
                   10947:             $userroles{'user.role.'.$spec} = $tstart.'.'.$tend;
1.925.2.9  raeburn  10948:             $newrolecount ++;
1.925.2.8  raeburn  10949:             unless (grep(/^\Q$role\E$/,@newroles)) {
                   10950:                 push(@newroles,$role);
                   10951:             }
                   10952:             my $status =
                   10953:                 &Apache::lonnet::curr_role_status($tstart,$tend,$refresh,$then);
                   10954:             if ($status eq 'active') {
                   10955:                 &Apache::lonnet::gather_roleprivs(\%allroles,\%allgroups,\%userroles,
                   10956:                                                   $where,$role,$tstart,$tend);
                   10957:             }
                   10958:         }
                   10959:         if (@newroles) {
                   10960:             my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles,
                   10961:                                                                \%allgroups);
1.925.2.10  raeburn  10962:             &Apache::lonnet::appenv(\%userroles,[@newroles,'cm']);
1.925.2.8  raeburn  10963:             $userenv{'user.adv'} = $adv;
                   10964:             $userenv{'user.author'} = $author;
                   10965:             $userenv{'user.refresh.time'} = $refresh;
                   10966:         }
                   10967:         &Apache::lonnet::appenv(\%userenv);
                   10968:     }
1.925.2.9  raeburn  10969:     return $newrolecount;
1.925.2.8  raeburn  10970: }
                   10971: 
1.685     tempelho 10972: # --- Get the symbolic name of a problem and the url
                   10973: sub get_symb {
                   10974:     my ($request,$silent) = @_;
1.726     raeburn  10975:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10976:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10977:     if ($symb eq '') {
                   10978:         if (!$silent) {
                   10979:             $request->print("Unable to handle ambiguous references:$url:.");
                   10980:             return ();
                   10981:         }
                   10982:     }
                   10983:     &Apache::lonenc::check_decrypt(\$symb);
                   10984:     return ($symb);
                   10985: }
                   10986: 
                   10987: # --------------------------------------------------------------Get annotation
                   10988: 
                   10989: sub get_annotation {
                   10990:     my ($symb,$enc) = @_;
                   10991: 
                   10992:     my $key = $symb;
                   10993:     if (!$enc) {
                   10994:         $key =
                   10995:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10996:     }
                   10997:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10998:     return $annotation{$key};
                   10999: }
                   11000: 
                   11001: sub clean_symb {
1.731     raeburn  11002:     my ($symb,$delete_enc) = @_;
1.685     tempelho 11003: 
                   11004:     &Apache::lonenc::check_decrypt(\$symb);
                   11005:     my $enc = $env{'request.enc'};
1.731     raeburn  11006:     if ($delete_enc) {
1.730     raeburn  11007:         delete($env{'request.enc'});
                   11008:     }
1.685     tempelho 11009: 
                   11010:     return ($symb,$enc);
                   11011: }
1.462     albertel 11012: 
1.925.2.1  raeburn  11013: sub needs_gci_custom {
                   11014:     my $custommenu;
                   11015:     my $numdc = &check_for_gci_dc();
1.925.2.21  raeburn  11016:     my $udom = $env{'user.domain'};
                   11017:     return if ($udom eq '');
1.925.2.1  raeburn  11018:     unless ($numdc) {
                   11019:         my $then=$env{'user.login.time'};
                   11020:         my $now = time;
1.925.2.21  raeburn  11021:         my %allnums = &get_faculty_cnums();
                   11022:         my $cnums = $allnums{$udom};
                   11023:         return unless (ref($cnums) eq 'HASH');
                   11024:         if ($env{'user.role.st./\Q$udom\E/'.$cnums->{'review'}}) {
1.925.2.1  raeburn  11025:             my ($start,$end) =
1.925.2.21  raeburn  11026:                 split('.',$env{'user.role.st./\Q$udom\E/'.$cnums->{'review'}});
1.925.2.1  raeburn  11027:             if (((!$start) || ($start && $start <= $now)) &&
                   11028:                 ((!$end) || ($end > $now))) {
                   11029:                 $custommenu = 1;
1.925.2.21  raeburn  11030:                 if ($env{'user.role.cc./\Q$udom\E/'.$cnums->{'review'}}) {
1.925.2.1  raeburn  11031:                     my ($ccstart,$ccend) =
1.925.2.21  raeburn  11032:                         split('.',$env{'user.role.cc./\Q$udom\E/'.$cnums->{'review'}});
1.925.2.1  raeburn  11033:                     if (((!$start) || ($start && $start <= $now)) &&
                   11034:                             ((!$end) || ($end > $now))) {
                   11035:                         $custommenu = '';
                   11036:                     }
                   11037:                 }
                   11038:             }
                   11039:         }
                   11040:     }
                   11041:     return $custommenu;
                   11042: }
                   11043: 
1.925.2.22  raeburn  11044: sub ci_tabs {
                   11045:     my ($domain) = @_;
                   11046:     my %tabs = (
                   11047:                  gci  => ['review','submit','managetest','tutorial'],
                   11048:                  slci => ['review'],
1.925.2.23! raeburn  11049:                );
1.925.2.22  raeburn  11050:     return $tabs{$domain};
                   11051: }
                   11052: 
1.925.2.1  raeburn  11053: sub check_for_gci_dc {
                   11054:     my $then=$env{'user.login.time'};
                   11055:     my $numdc = 0;
1.925.2.21  raeburn  11056:     my @doms = &Apache::lonnet::current_machine_domains();
                   11057:     foreach my $dom (@doms) {
1.925.2.1  raeburn  11058:         if ($env{'user.role.dc./'.$dom.'/'}) {
                   11059:             my $livedc = 1;
                   11060:             my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
                   11061:             if ($tstart && $tstart>$then) { $livedc = 0; }
                   11062:             if ($tend   && $tend  <$then) { $livedc = 0; }
                   11063:             if ($livedc) {
                   11064:                 $numdc++;
                   11065:             }
                   11066:         }
                   11067:     }
                   11068:     return $numdc;
                   11069: }
                   11070: 
1.925.2.21  raeburn  11071: sub get_faculty_cnums {
                   11072:     my %cnums = (
                   11073:          gci => { 
                   11074:                     review => '9615072b469884921gcil1',
                   11075:                     submit => '1H96711d710194bfegcil1',
1.925.2.23! raeburn  11076:                     tutorial => '5422913620b814c90gcil1',
1.925.2.21  raeburn  11077:                 },
                   11078:          slci => {
                   11079:                     review => '',
                   11080:                  }
                   11081:     );
                   11082:     return %cnums;
                   11083: }
                   11084: 
1.925.2.1  raeburn  11085: sub existing_gcitest_courses {
1.925.2.6  raeburn  11086:     my ($role) = @_;
1.925.2.1  raeburn  11087:     my %courses;
1.925.2.21  raeburn  11088:     my $cdom = $env{'user.domain'}.'test';
1.925.2.1  raeburn  11089:     my $now = time;
                   11090:     foreach my $envkey (keys(%env)) {
                   11091:         my $cnum;
                   11092:         if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
                   11093:             $cnum = $1;
                   11094:         } else {
                   11095:             next;
                   11096:         }
1.925.2.16  raeburn  11097:         my ($tstart,$tend) = split(/\./,$env{$envkey});
1.925.2.1  raeburn  11098:         if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
1.925.2.3  raeburn  11099:             my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
                   11100:             if ($descr ne '') {
                   11101:                 $courses{$cdom.'_'.$cnum}{'description'} = $descr;
1.925.2.1  raeburn  11102:             }
                   11103:         }
                   11104:     }
                   11105:     return %courses;
                   11106: }
                   11107: 
1.925.2.14  raeburn  11108: sub gcitest_switcher {
                   11109:     my ($role,$formname,%courses) = @_;
                   11110:     my $output;
                   11111:     my %Sortby;
                   11112:     foreach my $course (sort(keys(%courses))) {
                   11113:         next unless (ref($courses{$course}) eq 'HASH');
                   11114:         my $clean_title = $courses{$course}{'description'};
                   11115:         $clean_title =~ s/\W+//g;
                   11116:         if ($clean_title eq '') {
                   11117:             $clean_title = $courses{$course}{'description'};
                   11118:         }
                   11119:         push(@{$Sortby{$clean_title}},$course);
                   11120:     }
                   11121:     my @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby));
                   11122:     my $default;
                   11123:     if (@sorted_courses > 1) {
                   11124:         if (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11125:             $default = &mt('Switch concept test ...');
                   11126:         } else {
                   11127:             $default = &mt('Select a concept test ...');
                   11128:         }
                   11129:     } else {
                   11130:         unless (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11131:             $default = &mt('Select concept test ...');
                   11132:         }
                   11133:     }
                   11134:     if ($default) {
                   11135:         $output = '<form name="'.$formname.'" action="/adm/roles" method="post">'.
                   11136:                   '<select name="newrole" onchange="javascript:courseswitcher();">'.
                   11137:                   '<option value="" selected="selected">'.$default.'</option>';
                   11138:         foreach my $item (@sorted_courses) {
                   11139:             foreach my $course (@{$Sortby{$item}}) {
                   11140:                 my ($cdom,$cnum) = split('_',$course);
                   11141:                 $output .= '<option value="'.$role.'./'.$cdom.'/'.$cnum.'">'.$courses{$course}{'description'}.'</option>';
                   11142:             }
                   11143:         }
                   11144:         $output .= '</select><input type="hidden" name="selectrole" value="" /></form>';
                   11145:     }
                   11146:     return $output;
                   11147: }
                   11148: 
                   11149: sub gcitest_switcher_js {
                   11150:     my ($current,$numcourses,$formname) = @_;
                   11151:     my $output = <<"ENDJS";
                   11152: 
                   11153: function courseswitcher(caller) {
                   11154:     var numcourses = $numcourses;
                   11155:     var current = '$current';
                   11156:     var choice = document.$formname.newrole.options[document.$formname.newrole.selectedIndex].value;
                   11157:     if (choice == '') {
                   11158:         if (caller == 'icon') {
                   11159:             alert('No Concept Test selected');
                   11160:         }
                   11161:         document.$formname.selectrole.value = '';
                   11162:         return;
                   11163:     }
                   11164:     if (choice == current) {
                   11165:         if ((caller != 'icon') && (numcourses > 1)) {
                   11166:             alert('You have selected the current course.\\nPlease select a different Concept Test course');
                   11167:         }
                   11168:         document.$formname.newrole.selectedIndex = 0;
                   11169:         document.$formname.selectrole.value = '';
                   11170:         return;
                   11171:     }
                   11172:     document.$formname.selectrole.value = '1';
                   11173:     document.$formname.submit();
                   11174:     return;
                   11175: }
                   11176: 
                   11177: ENDJS
                   11178:     return $output;
                   11179: }
                   11180: 
1.925.2.21  raeburn  11181: sub get_citest_map {
                   11182:     my ($cdom) = @_;
                   11183:     my %questionnaires = (
                   11184:                            gcitest  => 'default_1261144274.sequence',
                   11185:                            slcitest => 'default_1261144274.sequence',
                   11186:                          );
                   11187:     return $questionnaires{$cdom};
                   11188: }
1.925.2.14  raeburn  11189: 
1.41      ng       11190: =pod
                   11191: 
                   11192: =back
                   11193: 
1.112     bowersj2 11194: =cut
1.41      ng       11195: 
1.112     bowersj2 11196: 1;
                   11197: __END__;
1.41      ng       11198: 

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