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

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.16! raeburn     4: # $Id: loncommon.pm,v 1.925.2.15 2010/10/04 22:30:42 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
                    486:     my $wintitle = &mt('Course Browser');
                    487:     if ($crstype ne '') {
                    488:         $wintitle = &mt($crstype);
                    489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
                    903:     return &select_form($selected,$name,%langchoices);
                    904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.648     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
                   1093: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1094: 
                   1095: =cut
                   1096: 
                   1097: sub help_open_topic {
1.48      bowersj2 1098:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1099:     $text = "" if (not defined $text);
1.44      bowersj2 1100:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1101:     $width = 350 if (not defined $width);
                   1102:     $height = 400 if (not defined $height);
                   1103:     my $filename = $topic;
                   1104:     $filename =~ s/ /_/g;
                   1105: 
1.48      bowersj2 1106:     my $template = "";
                   1107:     my $link;
1.572     banghart 1108:     
1.159     www      1109:     $topic=~s/\W/\_/g;
1.44      bowersj2 1110: 
1.572     banghart 1111:     if (!$stayOnPage) {
1.72      bowersj2 1112: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1113:     } else {
1.48      bowersj2 1114: 	$link = "/adm/help/${filename}.hlp";
                   1115:     }
                   1116: 
                   1117:     # Add the text
1.755     neumanie 1118:     if ($text ne "") {	
1.763     bisitz   1119: 	$template.='<span class="LC_help_open_topic">'
                   1120:                   .'<a target="_top" href="'.$link.'">'
                   1121:                   .$text.'</a>';
1.48      bowersj2 1122:     }
                   1123: 
1.763     bisitz   1124:     # (Always) Add the graphic
1.179     matthew  1125:     my $title = &mt('Online Help');
1.667     raeburn  1126:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1127:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1128:               .'<img src="'.$helpicon.'" border="0"'
                   1129:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1130:               .' title="'.$title.'"' 
1.763     bisitz   1131:               .' /></a>';
                   1132:     if ($text ne "") {	
                   1133:         $template.='</span>';
                   1134:     }
1.44      bowersj2 1135:     return $template;
                   1136: 
1.106     bowersj2 1137: }
                   1138: 
                   1139: # This is a quicky function for Latex cheatsheet editing, since it 
                   1140: # appears in at least four places
                   1141: sub helpLatexCheatsheet {
1.732     raeburn  1142:     my ($topic,$text,$not_author) = @_;
                   1143:     my $out;
1.106     bowersj2 1144:     my $addOther = '';
1.732     raeburn  1145:     if ($topic) {
1.763     bisitz   1146: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1147: 							       undef, undef, 600).
                   1148: 								   '</span> ';
                   1149:     }
                   1150:     $out = '<span>' # Start cheatsheet
                   1151: 	  .$addOther
                   1152:           .'<span>'
                   1153: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1154: 					       undef,undef,600)
                   1155: 	  .'</span> <span>'
                   1156: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1157: 					       undef,undef,600)
                   1158: 	  .'</span>';
1.732     raeburn  1159:     unless ($not_author) {
1.763     bisitz   1160:         $out .= ' <span>'
                   1161: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1162: 	                                            undef,undef,600)
                   1163: 	       .'</span>';
1.732     raeburn  1164:     }
1.763     bisitz   1165:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1166:     return $out;
1.172     www      1167: }
                   1168: 
1.430     albertel 1169: sub general_help {
                   1170:     my $helptopic='Student_Intro';
                   1171:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1172: 	$helptopic='Authoring_Intro';
1.907     raeburn  1173:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1174: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1175:     } elsif ($env{'request.role'}=~/^dc/) {
                   1176:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1177:     }
                   1178:     return $helptopic;
                   1179: }
                   1180: 
                   1181: sub update_help_link {
                   1182:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1183:     my $origurl = $ENV{'REQUEST_URI'};
                   1184:     $origurl=~s|^/~|/priv/|;
                   1185:     my $timestamp = time;
                   1186:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1187:         $$datum = &escape($$datum);
                   1188:     }
                   1189: 
                   1190:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1191:     my $output .= <<"ENDOUTPUT";
                   1192: <script type="text/javascript">
1.824     bisitz   1193: // <![CDATA[
1.430     albertel 1194: banner_link = '$banner_link';
1.824     bisitz   1195: // ]]>
1.430     albertel 1196: </script>
                   1197: ENDOUTPUT
                   1198:     return $output;
                   1199: }
                   1200: 
                   1201: # now just updates the help link and generates a blue icon
1.193     raeburn  1202: sub help_open_menu {
1.430     albertel 1203:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1204: 	= @_;    
1.430     albertel 1205:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1206:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1207:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1208:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1209:         $stayOnPage=1;
1.430     albertel 1210:     }
                   1211:     my $output;
                   1212:     if ($component_help) {
                   1213: 	if (!$text) {
                   1214: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1215: 				       $width,$height);
                   1216: 	} else {
                   1217: 	    my $help_text;
                   1218: 	    $help_text=&unescape($topic);
                   1219: 	    $output='<table><tr><td>'.
                   1220: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1221: 				 $width,$height).'</td></tr></table>';
                   1222: 	}
                   1223:     }
                   1224:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1225:     return $output.$banner_link;
                   1226: }
                   1227: 
                   1228: sub top_nav_help {
                   1229:     my ($text) = @_;
1.436     albertel 1230:     $text = &mt($text);
1.572     banghart 1231:     my $stay_on_page = 
1.798     tempelho 1232: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1233:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1234: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1235:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1236: 
1.201     raeburn  1237:     my $title = &mt('Get help');
1.436     albertel 1238: 
                   1239:     return <<"END";
                   1240: $banner_link
                   1241:  <a href="$link" title="$title">$text</a>
                   1242: END
                   1243: }
                   1244: 
                   1245: sub help_menu_js {
                   1246:     my ($text) = @_;
                   1247: 
                   1248:     my $stayOnPage = 
1.798     tempelho 1249: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1250: 
                   1251:     my $width = 620;
                   1252:     my $height = 600;
1.430     albertel 1253:     my $helptopic=&general_help();
                   1254:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1255:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1256:     my $start_page =
                   1257:         &Apache::loncommon::start_page('Help Menu', undef,
                   1258: 				       {'frameset'    => 1,
                   1259: 					'js_ready'    => 1,
                   1260: 					'add_entries' => {
                   1261: 					    'border' => '0',
1.579     raeburn  1262: 					    'rows'   => "110,*",},});
1.331     albertel 1263:     my $end_page =
                   1264:         &Apache::loncommon::end_page({'frameset' => 1,
                   1265: 				      'js_ready' => 1,});
                   1266: 
1.436     albertel 1267:     my $template .= <<"ENDTEMPLATE";
                   1268: <script type="text/javascript">
1.877     bisitz   1269: // <![CDATA[
1.253     albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1271: var banner_link = '';
1.243     raeburn  1272: function helpMenu(target) {
                   1273:     var caller = this;
                   1274:     if (target == 'open') {
                   1275:         var newWindow = null;
                   1276:         try {
1.262     albertel 1277:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1278:         }
                   1279:         catch(error) {
                   1280:             writeHelp(caller);
                   1281:             return;
                   1282:         }
                   1283:         if (newWindow) {
                   1284:             caller = newWindow;
                   1285:         }
1.193     raeburn  1286:     }
1.243     raeburn  1287:     writeHelp(caller);
                   1288:     return;
                   1289: }
                   1290: function writeHelp(caller) {
1.430     albertel 1291:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1292:     caller.document.close()
                   1293:     caller.focus()
1.193     raeburn  1294: }
1.877     bisitz   1295: // END LON-CAPA Internal -->
1.253     albertel 1296: // ]]>
1.436     albertel 1297: </script>
1.193     raeburn  1298: ENDTEMPLATE
                   1299:     return $template;
                   1300: }
                   1301: 
1.172     www      1302: sub help_open_bug {
                   1303:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1304:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1305:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1306:     $text = "" if (not defined $text);
                   1307:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1308:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1309: 	$stayOnPage=1;
                   1310:     }
1.184     albertel 1311:     $width = 600 if (not defined $width);
                   1312:     $height = 600 if (not defined $height);
1.172     www      1313: 
                   1314:     $topic=~s/\W+/\+/g;
                   1315:     my $link='';
                   1316:     my $template='';
1.379     albertel 1317:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1318: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1319:     if (!$stayOnPage)
                   1320:     {
                   1321: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1322:     }
                   1323:     else
                   1324:     {
                   1325: 	$link = $url;
                   1326:     }
                   1327:     # Add the text
                   1328:     if ($text ne "")
                   1329:     {
                   1330: 	$template .= 
                   1331:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1332:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1333:     }
                   1334: 
                   1335:     # Add the graphic
1.179     matthew  1336:     my $title = &mt('Report a Bug');
1.215     albertel 1337:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1338:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1339:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1340: ENDTEMPLATE
                   1341:     if ($text ne '') { $template.='</td></tr></table>' };
                   1342:     return $template;
                   1343: 
                   1344: }
                   1345: 
                   1346: sub help_open_faq {
                   1347:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1348:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1349:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1350:     $text = "" if (not defined $text);
                   1351:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1352:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1353: 	$stayOnPage=1;
                   1354:     }
                   1355:     $width = 350 if (not defined $width);
                   1356:     $height = 400 if (not defined $height);
                   1357: 
                   1358:     $topic=~s/\W+/\+/g;
                   1359:     my $link='';
                   1360:     my $template='';
                   1361:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1362:     if (!$stayOnPage)
                   1363:     {
                   1364: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1365:     }
                   1366:     else
                   1367:     {
                   1368: 	$link = $url;
                   1369:     }
                   1370: 
                   1371:     # Add the text
                   1372:     if ($text ne "")
                   1373:     {
                   1374: 	$template .= 
1.173     www      1375:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1376:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1377:     }
                   1378: 
                   1379:     # Add the graphic
1.179     matthew  1380:     my $title = &mt('View the FAQ');
1.215     albertel 1381:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1382:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1383:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1384: ENDTEMPLATE
                   1385:     if ($text ne '') { $template.='</td></tr></table>' };
                   1386:     return $template;
                   1387: 
1.44      bowersj2 1388: }
1.37      matthew  1389: 
1.180     matthew  1390: ###############################################################
                   1391: ###############################################################
                   1392: 
1.45      matthew  1393: =pod
                   1394: 
1.648     raeburn  1395: =item * &change_content_javascript():
1.256     matthew  1396: 
                   1397: This and the next function allow you to create small sections of an
                   1398: otherwise static HTML page that you can update on the fly with
                   1399: Javascript, even in Netscape 4.
                   1400: 
                   1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1402: must be written to the HTML page once. It will prove the Javascript
                   1403: function "change(name, content)". Calling the change function with the
                   1404: name of the section 
                   1405: you want to update, matching the name passed to C<changable_area>, and
                   1406: the new content you want to put in there, will put the content into
                   1407: that area.
                   1408: 
                   1409: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1410: to contain room for the original contents. You need to "make space"
                   1411: for whatever changes you wish to make, and be B<sure> to check your
                   1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1413: it's adequate for updating a one-line status display, but little more.
                   1414: This script will set the space to 100% width, so you only need to
                   1415: worry about height in Netscape 4.
                   1416: 
                   1417: Modern browsers are much less limiting, and if you can commit to the
                   1418: user not using Netscape 4, this feature may be used freely with
                   1419: pretty much any HTML.
                   1420: 
                   1421: =cut
                   1422: 
                   1423: sub change_content_javascript {
                   1424:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1425:     if ($env{'browser.type'} eq 'netscape' &&
                   1426: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1427: 	return (<<NETSCAPE4);
                   1428: 	function change(name, content) {
                   1429: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1430: 	    doc.open();
                   1431: 	    doc.write(content);
                   1432: 	    doc.close();
                   1433: 	}
                   1434: NETSCAPE4
                   1435:     } else {
                   1436: 	# Otherwise, we need to use semi-standards-compliant code
                   1437: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1438: 	# is really scary, and every useful browser supports it
                   1439: 	return (<<DOMBASED);
                   1440: 	function change(name, content) {
                   1441: 	    element = document.getElementById(name);
                   1442: 	    element.innerHTML = content;
                   1443: 	}
                   1444: DOMBASED
                   1445:     }
                   1446: }
                   1447: 
                   1448: =pod
                   1449: 
1.648     raeburn  1450: =item * &changable_area($name,$origContent):
1.256     matthew  1451: 
                   1452: This provides a "changable area" that can be modified on the fly via
                   1453: the Javascript code provided in C<change_content_javascript>. $name is
                   1454: the name you will use to reference the area later; do not repeat the
                   1455: same name on a given HTML page more then once. $origContent is what
                   1456: the area will originally contain, which can be left blank.
                   1457: 
                   1458: =cut
                   1459: 
                   1460: sub changable_area {
                   1461:     my ($name, $origContent) = @_;
                   1462: 
1.258     albertel 1463:     if ($env{'browser.type'} eq 'netscape' &&
                   1464: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1465: 	# If this is netscape 4, we need to use the Layer tag
                   1466: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1467:     } else {
                   1468: 	return "<span id='$name'>$origContent</span>";
                   1469:     }
                   1470: }
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &viewport_geometry_js 
1.590     raeburn  1475: 
                   1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1477: 
                   1478: =cut
                   1479: 
                   1480: 
                   1481: sub viewport_geometry_js { 
                   1482:     return <<"GEOMETRY";
                   1483: var Geometry = {};
                   1484: function init_geometry() {
                   1485:     if (Geometry.init) { return };
                   1486:     Geometry.init=1;
                   1487:     if (window.innerHeight) {
                   1488:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1489:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1490:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1491:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1492:     }
                   1493:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1494:         Geometry.getViewportHeight =
                   1495:             function() { return document.documentElement.clientHeight; };
                   1496:         Geometry.getViewportWidth =
                   1497:             function() { return document.documentElement.clientWidth; };
                   1498: 
                   1499:         Geometry.getHorizontalScroll =
                   1500:             function() { return document.documentElement.scrollLeft; };
                   1501:         Geometry.getVerticalScroll =
                   1502:             function() { return document.documentElement.scrollTop; };
                   1503:     }
                   1504:     else if (document.body.clientHeight) {
                   1505:         Geometry.getViewportHeight =
                   1506:             function() { return document.body.clientHeight; };
                   1507:         Geometry.getViewportWidth =
                   1508:             function() { return document.body.clientWidth; };
                   1509:         Geometry.getHorizontalScroll =
                   1510:             function() { return document.body.scrollLeft; };
                   1511:         Geometry.getVerticalScroll =
                   1512:             function() { return document.body.scrollTop; };
                   1513:     }
                   1514: }
                   1515: 
                   1516: GEOMETRY
                   1517: }
                   1518: 
                   1519: =pod
                   1520: 
1.648     raeburn  1521: =item * &viewport_size_js()
1.590     raeburn  1522: 
                   1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1524: 
                   1525: =cut
                   1526: 
                   1527: sub viewport_size_js {
                   1528:     my $geometry = &viewport_geometry_js();
                   1529:     return <<"DIMS";
                   1530: 
                   1531: $geometry
                   1532: 
                   1533: function getViewportDims(width,height) {
                   1534:     init_geometry();
                   1535:     width.value = Geometry.getViewportWidth();
                   1536:     height.value = Geometry.getViewportHeight();
                   1537:     return;
                   1538: }
                   1539: 
                   1540: DIMS
                   1541: }
                   1542: 
                   1543: =pod
                   1544: 
1.648     raeburn  1545: =item * &resize_textarea_js()
1.565     albertel 1546: 
                   1547: emits the needed javascript to resize a textarea to be as big as possible
                   1548: 
                   1549: creates a function resize_textrea that takes two IDs first should be
                   1550: the id of the element to resize, second should be the id of a div that
                   1551: surrounds everything that comes after the textarea, this routine needs
                   1552: to be attached to the <body> for the onload and onresize events.
                   1553: 
1.648     raeburn  1554: =back
1.565     albertel 1555: 
                   1556: =cut
                   1557: 
                   1558: sub resize_textarea_js {
1.590     raeburn  1559:     my $geometry = &viewport_geometry_js();
1.565     albertel 1560:     return <<"RESIZE";
                   1561:     <script type="text/javascript">
1.824     bisitz   1562: // <![CDATA[
1.590     raeburn  1563: $geometry
1.565     albertel 1564: 
1.588     albertel 1565: function getX(element) {
                   1566:     var x = 0;
                   1567:     while (element) {
                   1568: 	x += element.offsetLeft;
                   1569: 	element = element.offsetParent;
                   1570:     }
                   1571:     return x;
                   1572: }
                   1573: function getY(element) {
                   1574:     var y = 0;
                   1575:     while (element) {
                   1576: 	y += element.offsetTop;
                   1577: 	element = element.offsetParent;
                   1578:     }
                   1579:     return y;
                   1580: }
                   1581: 
                   1582: 
1.565     albertel 1583: function resize_textarea(textarea_id,bottom_id) {
                   1584:     init_geometry();
                   1585:     var textarea        = document.getElementById(textarea_id);
                   1586:     //alert(textarea);
                   1587: 
1.588     albertel 1588:     var textarea_top    = getY(textarea);
1.565     albertel 1589:     var textarea_height = textarea.offsetHeight;
                   1590:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1591:     var bottom_top      = getY(bottom);
1.565     albertel 1592:     var bottom_height   = bottom.offsetHeight;
                   1593:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1594:     var fudge           = 23;
1.565     albertel 1595:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1596:     if (new_height < 300) {
                   1597: 	new_height = 300;
                   1598:     }
                   1599:     textarea.style.height=new_height+'px';
                   1600: }
1.824     bisitz   1601: // ]]>
1.565     albertel 1602: </script>
                   1603: RESIZE
                   1604: 
                   1605: }
                   1606: 
                   1607: =pod
                   1608: 
1.256     matthew  1609: =head1 Excel and CSV file utility routines
                   1610: 
                   1611: =over 4
                   1612: 
                   1613: =cut
                   1614: 
                   1615: ###############################################################
                   1616: ###############################################################
                   1617: 
                   1618: =pod
                   1619: 
1.648     raeburn  1620: =item * &csv_translate($text) 
1.37      matthew  1621: 
1.185     www      1622: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1623: format.
                   1624: 
                   1625: =cut
                   1626: 
1.180     matthew  1627: ###############################################################
                   1628: ###############################################################
1.37      matthew  1629: sub csv_translate {
                   1630:     my $text = shift;
                   1631:     $text =~ s/\"/\"\"/g;
1.209     albertel 1632:     $text =~ s/\n/ /g;
1.37      matthew  1633:     return $text;
                   1634: }
1.180     matthew  1635: 
                   1636: ###############################################################
                   1637: ###############################################################
                   1638: 
                   1639: =pod
                   1640: 
1.648     raeburn  1641: =item * &define_excel_formats()
1.180     matthew  1642: 
                   1643: Define some commonly used Excel cell formats.
                   1644: 
                   1645: Currently supported formats:
                   1646: 
                   1647: =over 4
                   1648: 
                   1649: =item header
                   1650: 
                   1651: =item bold
                   1652: 
                   1653: =item h1
                   1654: 
                   1655: =item h2
                   1656: 
                   1657: =item h3
                   1658: 
1.256     matthew  1659: =item h4
                   1660: 
                   1661: =item i
                   1662: 
1.180     matthew  1663: =item date
                   1664: 
                   1665: =back
                   1666: 
                   1667: Inputs: $workbook
                   1668: 
                   1669: Returns: $format, a hash reference.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: sub define_excel_formats {
                   1676:     my ($workbook) = @_;
                   1677:     my $format;
                   1678:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1679:                                                 bottom    => 1,
                   1680:                                                 align     => 'center');
                   1681:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1682:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1683:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1684:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1685:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1686:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1687:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1688:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1689:     return $format;
                   1690: }
                   1691: 
                   1692: ###############################################################
                   1693: ###############################################################
1.113     bowersj2 1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &create_workbook()
1.255     matthew  1698: 
                   1699: Create an Excel worksheet.  If it fails, output message on the
                   1700: request object and return undefs.
                   1701: 
                   1702: Inputs: Apache request object
                   1703: 
                   1704: Returns (undef) on failure, 
                   1705:     Excel worksheet object, scalar with filename, and formats 
                   1706:     from &Apache::loncommon::define_excel_formats on success
                   1707: 
                   1708: =cut
                   1709: 
                   1710: ###############################################################
                   1711: ###############################################################
                   1712: sub create_workbook {
                   1713:     my ($r) = @_;
                   1714:         #
                   1715:     # Create the excel spreadsheet
                   1716:     my $filename = '/prtspool/'.
1.258     albertel 1717:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1718:         time.'_'.rand(1000000000).'.xls';
                   1719:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1720:     if (! defined($workbook)) {
                   1721:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1722:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1723:                             "This error has been logged.  ".
                   1724:                             "Please alert your LON-CAPA administrator").
                   1725:                   '</p>');
                   1726:         return (undef);
                   1727:     }
                   1728:     #
                   1729:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1730:     #
                   1731:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1732:     return ($workbook,$filename,$format);
                   1733: }
                   1734: 
                   1735: ###############################################################
                   1736: ###############################################################
                   1737: 
                   1738: =pod
                   1739: 
1.648     raeburn  1740: =item * &create_text_file()
1.113     bowersj2 1741: 
1.542     raeburn  1742: Create a file to write to and eventually make available to the user.
1.256     matthew  1743: If file creation fails, outputs an error message on the request object and 
                   1744: return undefs.
1.113     bowersj2 1745: 
1.256     matthew  1746: Inputs: Apache request object, and file suffix
1.113     bowersj2 1747: 
1.256     matthew  1748: Returns (undef) on failure, 
                   1749:     Filehandle and filename on success.
1.113     bowersj2 1750: 
                   1751: =cut
                   1752: 
1.256     matthew  1753: ###############################################################
                   1754: ###############################################################
                   1755: sub create_text_file {
                   1756:     my ($r,$suffix) = @_;
                   1757:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1758:     my $fh;
                   1759:     my $filename = '/prtspool/'.
1.258     albertel 1760:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1761:         time.'_'.rand(1000000000).'.'.$suffix;
                   1762:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1763:     if (! defined($fh)) {
                   1764:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1765:         $r->print(&mt('Problems occurred in creating the output file. '
                   1766:                      .'This error has been logged. '
                   1767:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1796: 	return &select_form($name,$value,%domains);
                   1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.648     raeburn  1858: =item * &select_form($defdom,$name,%hash)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
                   1861: allow a user to select options from a hash option_name => displayed text.  
                   1862: See lonrights.pm for an example invocation and use.
                   1863: 
                   1864: =cut
                   1865: 
                   1866: #-------------------------------------------
                   1867: sub select_form {
                   1868:     my ($def,$name,%hash) = @_;
                   1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1870:     my @keys;
                   1871:     if (exists($hash{'select_form_order'})) {
                   1872: 	@keys=@{$hash{'select_form_order'}};
                   1873:     } else {
                   1874: 	@keys=sort(keys(%hash));
                   1875:     }
1.356     albertel 1876:     foreach my $key (@keys) {
                   1877:         $selectform.=
                   1878: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1879:             ($key eq $def ? 'selected="selected" ' : '').
1.922     bisitz   1880:                 ">".$hash{$key}."</option>\n";
1.88      www      1881:     }
                   1882:     $selectform.="</select>";
                   1883:     return $selectform;
                   1884: }
                   1885: 
1.475     www      1886: # For display filters
                   1887: 
                   1888: sub display_filter {
                   1889:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1890:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1891:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1892: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1893: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1894: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1895:            &mt('Filter [_1]',
1.477     www      1896: 	   &select_form($env{'form.displayfilter'},
                   1897: 			'displayfilter',
                   1898: 			('currentfolder' => 'Current folder/page',
                   1899: 			 'containing' => 'Containing phrase',
                   1900: 			 'none' => 'None'))).
1.714     bisitz   1901: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1902: }
                   1903: 
1.167     www      1904: sub gradeleveldescription {
                   1905:     my $gradelevel=shift;
                   1906:     my %gradelevels=(0 => 'Not specified',
                   1907: 		     1 => 'Grade 1',
                   1908: 		     2 => 'Grade 2',
                   1909: 		     3 => 'Grade 3',
                   1910: 		     4 => 'Grade 4',
                   1911: 		     5 => 'Grade 5',
                   1912: 		     6 => 'Grade 6',
                   1913: 		     7 => 'Grade 7',
                   1914: 		     8 => 'Grade 8',
                   1915: 		     9 => 'Grade 9',
                   1916: 		     10 => 'Grade 10',
                   1917: 		     11 => 'Grade 11',
                   1918: 		     12 => 'Grade 12',
                   1919: 		     13 => 'Grade 13',
                   1920: 		     14 => '100 Level',
                   1921: 		     15 => '200 Level',
                   1922: 		     16 => '300 Level',
                   1923: 		     17 => '400 Level',
                   1924: 		     18 => 'Graduate Level');
                   1925:     return &mt($gradelevels{$gradelevel});
                   1926: }
                   1927: 
1.163     www      1928: sub select_level_form {
                   1929:     my ($deflevel,$name)=@_;
                   1930:     unless ($deflevel) { $deflevel=0; }
1.167     www      1931:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1932:     for (my $i=0; $i<=18; $i++) {
                   1933:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1934:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1935:                 ">".&gradeleveldescription($i)."</option>\n";
                   1936:     }
                   1937:     $selectform.="</select>";
                   1938:     return $selectform;
1.163     www      1939: }
1.167     www      1940: 
1.35      matthew  1941: #-------------------------------------------
                   1942: 
1.45      matthew  1943: =pod
                   1944: 
1.910     raeburn  1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1946: 
                   1947: Returns a string containing a <select name='$name' size='1'> form to 
                   1948: allow a user to select the domain to preform an operation in.  
                   1949: See loncreateuser.pm for an example invocation and use.
                   1950: 
1.90      www      1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1952: selected");
                   1953: 
1.743     raeburn  1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1955: 
1.910     raeburn  1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   1957: 
                   1958: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1959: 
1.35      matthew  1960: =cut
                   1961: 
                   1962: #-------------------------------------------
1.34      matthew  1963: sub select_dom_form {
1.910     raeburn  1964:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1965:     if ($onchange) {
1.874     raeburn  1966:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1967:     }
1.910     raeburn  1968:     my @domains;
                   1969:     if (ref($incdoms) eq 'ARRAY') {
                   1970:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   1971:     } else {
                   1972:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   1973:     }
1.90      www      1974:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1975:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1976:     foreach my $dom (@domains) {
                   1977:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1978:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1979:         if ($showdomdesc) {
                   1980:             if ($dom ne '') {
1.925.2.13  raeburn  1981:                 my $domdesc;
                   1982:                 if ($name eq 'srchdomain') {
                   1983:                     if ($dom eq 'gci') {
                   1984:                         $domdesc = 'Faculty';
                   1985:                     } else {
                   1986:                         $domdesc = 'Students';
                   1987:                     }
                   1988:                 } else {
                   1989:                     $domdesc = &Apache::lonnet::domain($dom,'description');
                   1990:                 }
1.563     raeburn  1991:                 if ($domdesc ne '') {
                   1992:                     $selectdomain .= ' ('.$domdesc.')';
                   1993:                 }
                   1994:             } 
                   1995:         }
                   1996:         $selectdomain .= "</option>\n";
1.34      matthew  1997:     }
                   1998:     $selectdomain.="</select>";
                   1999:     return $selectdomain;
                   2000: }
                   2001: 
1.35      matthew  2002: #-------------------------------------------
                   2003: 
1.45      matthew  2004: =pod
                   2005: 
1.648     raeburn  2006: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2007: 
1.586     raeburn  2008: input: 4 arguments (two required, two optional) - 
                   2009:     $domain - domain of new user
                   2010:     $name - name of form element
                   2011:     $default - Value of 'default' causes a default item to be first 
                   2012:                             option, and selected by default. 
                   2013:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2014:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2015: output: returns 2 items: 
1.586     raeburn  2016: (a) form element which contains either:
                   2017:    (i) <select name="$name">
                   2018:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2019:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2020:        </select>
                   2021:        form item if there are multiple library servers in $domain, or
                   2022:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2023:        if there is only one library server in $domain.
                   2024: 
                   2025: (b) number of library servers found.
                   2026: 
                   2027: See loncreateuser.pm for example of use.
1.35      matthew  2028: 
                   2029: =cut
                   2030: 
                   2031: #-------------------------------------------
1.586     raeburn  2032: sub home_server_form_item {
                   2033:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2034:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2035:     my $result;
                   2036:     my $numlib = keys(%servers);
                   2037:     if ($numlib > 1) {
                   2038:         $result .= '<select name="'.$name.'" />'."\n";
                   2039:         if ($default) {
1.804     bisitz   2040:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2041:                        '</option>'."\n";
                   2042:         }
                   2043:         foreach my $hostid (sort(keys(%servers))) {
                   2044:             $result.= '<option value="'.$hostid.'">'.
                   2045: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2046:         }
                   2047:         $result .= '</select>'."\n";
                   2048:     } elsif ($numlib == 1) {
                   2049:         my $hostid;
                   2050:         foreach my $item (keys(%servers)) {
                   2051:             $hostid = $item;
                   2052:         }
                   2053:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2054:                    $hostid.'" />';
                   2055:                    if (!$hide) {
                   2056:                        $result .= $hostid.' '.$servers{$hostid};
                   2057:                    }
                   2058:                    $result .= "\n";
                   2059:     } elsif ($default) {
                   2060:         $result .= '<input type="hidden" name="'.$name.
                   2061:                    '" value="default" />';
                   2062:                    if (!$hide) {
                   2063:                        $result .= &mt('default');
                   2064:                    }
                   2065:                    $result .= "\n";
1.33      matthew  2066:     }
1.586     raeburn  2067:     return ($result,$numlib);
1.33      matthew  2068: }
1.112     bowersj2 2069: 
                   2070: =pod
                   2071: 
1.534     albertel 2072: =back 
                   2073: 
1.112     bowersj2 2074: =cut
1.87      matthew  2075: 
                   2076: ###############################################################
1.112     bowersj2 2077: ##                  Decoding User Agent                      ##
1.87      matthew  2078: ###############################################################
                   2079: 
                   2080: =pod
                   2081: 
1.112     bowersj2 2082: =head1 Decoding the User Agent
                   2083: 
                   2084: =over 4
                   2085: 
                   2086: =item * &decode_user_agent()
1.87      matthew  2087: 
                   2088: Inputs: $r
                   2089: 
                   2090: Outputs:
                   2091: 
                   2092: =over 4
                   2093: 
1.112     bowersj2 2094: =item * $httpbrowser
1.87      matthew  2095: 
1.112     bowersj2 2096: =item * $clientbrowser
1.87      matthew  2097: 
1.112     bowersj2 2098: =item * $clientversion
1.87      matthew  2099: 
1.112     bowersj2 2100: =item * $clientmathml
1.87      matthew  2101: 
1.112     bowersj2 2102: =item * $clientunicode
1.87      matthew  2103: 
1.112     bowersj2 2104: =item * $clientos
1.87      matthew  2105: 
                   2106: =back
                   2107: 
1.157     matthew  2108: =back 
                   2109: 
1.87      matthew  2110: =cut
                   2111: 
                   2112: ###############################################################
                   2113: ###############################################################
                   2114: sub decode_user_agent {
1.247     albertel 2115:     my ($r)=@_;
1.87      matthew  2116:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2117:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2118:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2119:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2120:     my $clientbrowser='unknown';
                   2121:     my $clientversion='0';
                   2122:     my $clientmathml='';
                   2123:     my $clientunicode='0';
                   2124:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2125:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2126: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2127: 	    $clientbrowser=$bname;
                   2128:             $httpbrowser=~/$vreg/i;
                   2129: 	    $clientversion=$1;
                   2130:             $clientmathml=($clientversion>=$minv);
                   2131:             $clientunicode=($clientversion>=$univ);
                   2132: 	}
                   2133:     }
                   2134:     my $clientos='unknown';
                   2135:     if (($httpbrowser=~/linux/i) ||
                   2136:         ($httpbrowser=~/unix/i) ||
                   2137:         ($httpbrowser=~/ux/i) ||
                   2138:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2139:     if (($httpbrowser=~/vax/i) ||
                   2140:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2141:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2142:     if (($httpbrowser=~/mac/i) ||
                   2143:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2144:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2145:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2146:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2147:             $clientunicode,$clientos,);
                   2148: }
                   2149: 
1.32      matthew  2150: ###############################################################
                   2151: ##    Authentication changing form generation subroutines    ##
                   2152: ###############################################################
                   2153: ##
                   2154: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2155: ## hash, and have reasonable default values.
                   2156: ##
                   2157: ##    formname = the name given in the <form> tag.
1.35      matthew  2158: #-------------------------------------------
                   2159: 
1.45      matthew  2160: =pod
                   2161: 
1.112     bowersj2 2162: =head1 Authentication Routines
                   2163: 
                   2164: =over 4
                   2165: 
1.648     raeburn  2166: =item * &authform_xxxxxx()
1.35      matthew  2167: 
                   2168: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2169: handle some of the conveniences required for authentication forms.  
                   2170: This is not an optimal method, but it works.  
                   2171: 
                   2172: =over 4
                   2173: 
1.112     bowersj2 2174: =item * authform_header
1.35      matthew  2175: 
1.112     bowersj2 2176: =item * authform_authorwarning
1.35      matthew  2177: 
1.112     bowersj2 2178: =item * authform_nochange
1.35      matthew  2179: 
1.112     bowersj2 2180: =item * authform_kerberos
1.35      matthew  2181: 
1.112     bowersj2 2182: =item * authform_internal
1.35      matthew  2183: 
1.112     bowersj2 2184: =item * authform_filesystem
1.35      matthew  2185: 
                   2186: =back
                   2187: 
1.648     raeburn  2188: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2189: 
1.35      matthew  2190: =cut
                   2191: 
                   2192: #-------------------------------------------
1.32      matthew  2193: sub authform_header{  
                   2194:     my %in = (
                   2195:         formname => 'cu',
1.80      albertel 2196:         kerb_def_dom => '',
1.32      matthew  2197:         @_,
                   2198:     );
                   2199:     $in{'formname'} = 'document.' . $in{'formname'};
                   2200:     my $result='';
1.80      albertel 2201: 
                   2202: #---------------------------------------------- Code for upper case translation
                   2203:     my $Javascript_toUpperCase;
                   2204:     unless ($in{kerb_def_dom}) {
                   2205:         $Javascript_toUpperCase =<<"END";
                   2206:         switch (choice) {
                   2207:            case 'krb': currentform.elements[choicearg].value =
                   2208:                currentform.elements[choicearg].value.toUpperCase();
                   2209:                break;
                   2210:            default:
                   2211:         }
                   2212: END
                   2213:     } else {
                   2214:         $Javascript_toUpperCase = "";
                   2215:     }
                   2216: 
1.165     raeburn  2217:     my $radioval = "'nochange'";
1.591     raeburn  2218:     if (defined($in{'curr_authtype'})) {
                   2219:         if ($in{'curr_authtype'} ne '') {
                   2220:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2221:         }
1.174     matthew  2222:     }
1.165     raeburn  2223:     my $argfield = 'null';
1.591     raeburn  2224:     if (defined($in{'mode'})) {
1.165     raeburn  2225:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2226:             if (defined($in{'curr_autharg'})) {
                   2227:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2228:                     $argfield = "'$in{'curr_autharg'}'";
                   2229:                 }
                   2230:             }
                   2231:         }
                   2232:     }
                   2233: 
1.32      matthew  2234:     $result.=<<"END";
                   2235: var current = new Object();
1.165     raeburn  2236: current.radiovalue = $radioval;
                   2237: current.argfield = $argfield;
1.32      matthew  2238: 
                   2239: function changed_radio(choice,currentform) {
                   2240:     var choicearg = choice + 'arg';
                   2241:     // If a radio button in changed, we need to change the argfield
                   2242:     if (current.radiovalue != choice) {
                   2243:         current.radiovalue = choice;
                   2244:         if (current.argfield != null) {
                   2245:             currentform.elements[current.argfield].value = '';
                   2246:         }
                   2247:         if (choice == 'nochange') {
                   2248:             current.argfield = null;
                   2249:         } else {
                   2250:             current.argfield = choicearg;
                   2251:             switch(choice) {
                   2252:                 case 'krb': 
                   2253:                     currentform.elements[current.argfield].value = 
                   2254:                         "$in{'kerb_def_dom'}";
                   2255:                 break;
                   2256:               default:
                   2257:                 break;
                   2258:             }
                   2259:         }
                   2260:     }
                   2261:     return;
                   2262: }
1.22      www      2263: 
1.32      matthew  2264: function changed_text(choice,currentform) {
                   2265:     var choicearg = choice + 'arg';
                   2266:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2267:         $Javascript_toUpperCase
1.32      matthew  2268:         // clear old field
                   2269:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2270:             currentform.elements[current.argfield].value = '';
                   2271:         }
                   2272:         current.argfield = choicearg;
                   2273:     }
                   2274:     set_auth_radio_buttons(choice,currentform);
                   2275:     return;
1.20      www      2276: }
1.32      matthew  2277: 
                   2278: function set_auth_radio_buttons(newvalue,currentform) {
                   2279:     var i=0;
                   2280:     while (i < currentform.login.length) {
                   2281:         if (currentform.login[i].value == newvalue) { break; }
                   2282:         i++;
                   2283:     }
                   2284:     if (i == currentform.login.length) {
                   2285:         return;
                   2286:     }
                   2287:     current.radiovalue = newvalue;
                   2288:     currentform.login[i].checked = true;
                   2289:     return;
                   2290: }
                   2291: END
                   2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_authorwarning{
                   2296:     my $result='';
1.144     matthew  2297:     $result='<i>'.
                   2298:         &mt('As a general rule, only authors or co-authors should be '.
                   2299:             'filesystem authenticated '.
                   2300:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2301:     return $result;
                   2302: }
                   2303: 
                   2304: sub authform_nochange{  
                   2305:     my %in = (
                   2306:               formname => 'document.cu',
                   2307:               kerb_def_dom => 'MSU.EDU',
                   2308:               @_,
                   2309:           );
1.586     raeburn  2310:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2311:     my $result;
                   2312:     if (keys(%can_assign) == 0) {
                   2313:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2314:     } else {
                   2315:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2316:                   '<input type="radio" name="login" value="nochange" '.
                   2317:                   'checked="checked" onclick="'.
1.281     albertel 2318:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2319: 	    '</label>';
1.586     raeburn  2320:     }
1.32      matthew  2321:     return $result;
                   2322: }
                   2323: 
1.591     raeburn  2324: sub authform_kerberos {
1.32      matthew  2325:     my %in = (
                   2326:               formname => 'document.cu',
                   2327:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2328:               kerb_def_auth => 'krb4',
1.32      matthew  2329:               @_,
                   2330:               );
1.586     raeburn  2331:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2332:         $autharg,$jscall);
                   2333:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2334:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2335:        $check5 = ' checked="checked"';
1.80      albertel 2336:     } else {
1.772     bisitz   2337:        $check4 = ' checked="checked"';
1.80      albertel 2338:     }
1.165     raeburn  2339:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2340:     if (defined($in{'curr_authtype'})) {
                   2341:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2342:             $krbcheck = ' checked="checked"';
1.623     raeburn  2343:             if (defined($in{'mode'})) {
                   2344:                 if ($in{'mode'} eq 'modifyuser') {
                   2345:                     $krbcheck = '';
                   2346:                 }
                   2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_kerb_ver'})) {
                   2349:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2350:                     $check5 = ' checked="checked"';
1.591     raeburn  2351:                     $check4 = '';
                   2352:                 } else {
1.772     bisitz   2353:                     $check4 = ' checked="checked"';
1.591     raeburn  2354:                     $check5 = '';
                   2355:                 }
1.586     raeburn  2356:             }
1.591     raeburn  2357:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2358:                 $krbarg = $in{'curr_autharg'};
                   2359:             }
1.586     raeburn  2360:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2361:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2362:                     $result = 
                   2363:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2364:         $in{'curr_autharg'},$krbver);
                   2365:                 } else {
                   2366:                     $result =
                   2367:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2368:                 }
                   2369:                 return $result; 
                   2370:             }
                   2371:         }
                   2372:     } else {
                   2373:         if ($authnum == 1) {
1.784     bisitz   2374:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2375:         }
                   2376:     }
1.586     raeburn  2377:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2378:         return;
1.587     raeburn  2379:     } elsif ($authtype eq '') {
1.591     raeburn  2380:         if (defined($in{'mode'})) {
1.587     raeburn  2381:             if ($in{'mode'} eq 'modifycourse') {
                   2382:                 if ($authnum == 1) {
1.784     bisitz   2383:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2384:                 }
                   2385:             }
                   2386:         }
1.586     raeburn  2387:     }
                   2388:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2389:     if ($authtype eq '') {
                   2390:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2391:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2392:                     $krbcheck.' />';
                   2393:     }
                   2394:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2395:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2396:          $in{'curr_authtype'} eq 'krb5') ||
                   2397:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2398:          $in{'curr_authtype'} eq 'krb4')) {
                   2399:         $result .= &mt
1.144     matthew  2400:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2401:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2402:          '<label>'.$authtype,
1.281     albertel 2403:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2404:              'value="'.$krbarg.'" '.
1.144     matthew  2405:              'onchange="'.$jscall.'" />',
1.281     albertel 2406:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2407:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2408: 	 '</label>');
1.586     raeburn  2409:     } elsif ($can_assign{'krb4'}) {
                   2410:         $result .= &mt
                   2411:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2412:          '[_3] Version 4 [_4]',
                   2413:          '<label>'.$authtype,
                   2414:          '</label><input type="text" size="10" name="krbarg" '.
                   2415:              'value="'.$krbarg.'" '.
                   2416:              'onchange="'.$jscall.'" />',
                   2417:          '<label><input type="hidden" name="krbver" value="4" />',
                   2418:          '</label>');
                   2419:     } elsif ($can_assign{'krb5'}) {
                   2420:         $result .= &mt
                   2421:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2422:          '[_3] Version 5 [_4]',
                   2423:          '<label>'.$authtype,
                   2424:          '</label><input type="text" size="10" name="krbarg" '.
                   2425:              'value="'.$krbarg.'" '.
                   2426:              'onchange="'.$jscall.'" />',
                   2427:          '<label><input type="hidden" name="krbver" value="5" />',
                   2428:          '</label>');
                   2429:     }
1.32      matthew  2430:     return $result;
                   2431: }
                   2432: 
                   2433: sub authform_internal{  
1.586     raeburn  2434:     my %in = (
1.32      matthew  2435:                 formname => 'document.cu',
                   2436:                 kerb_def_dom => 'MSU.EDU',
                   2437:                 @_,
                   2438:                 );
1.586     raeburn  2439:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2440:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2441:     if (defined($in{'curr_authtype'})) {
                   2442:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2443:             if ($can_assign{'int'}) {
1.772     bisitz   2444:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2445:                 if (defined($in{'mode'})) {
                   2446:                     if ($in{'mode'} eq 'modifyuser') {
                   2447:                         $intcheck = '';
                   2448:                     }
                   2449:                 }
1.591     raeburn  2450:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2451:                     $intarg = $in{'curr_autharg'};
                   2452:                 }
                   2453:             } else {
                   2454:                 $result = &mt('Currently internally authenticated.');
                   2455:                 return $result;
1.165     raeburn  2456:             }
                   2457:         }
1.586     raeburn  2458:     } else {
                   2459:         if ($authnum == 1) {
1.784     bisitz   2460:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2461:         }
                   2462:     }
                   2463:     if (!$can_assign{'int'}) {
                   2464:         return;
1.587     raeburn  2465:     } elsif ($authtype eq '') {
1.591     raeburn  2466:         if (defined($in{'mode'})) {
1.587     raeburn  2467:             if ($in{'mode'} eq 'modifycourse') {
                   2468:                 if ($authnum == 1) {
1.784     bisitz   2469:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2470:                 }
                   2471:             }
                   2472:         }
1.165     raeburn  2473:     }
1.586     raeburn  2474:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2475:     if ($authtype eq '') {
                   2476:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2477:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2478:     }
1.605     bisitz   2479:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2480:                $intarg.'" onchange="'.$jscall.'" />';
1.925.2.13  raeburn  2481:     my $authtext = '[_1] Internally authenticated (with initial password [_2])';
                   2482:     if ($in{'caller'} eq 'requestcrs') {
                   2483:         $authtext = "[_1] Students' password, if none in the uploaded file: [_2]";
                   2484:     }
                   2485:     $result = &mt($authtext,'<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2486:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2487:     return $result;
                   2488: }
                   2489: 
                   2490: sub authform_local{  
                   2491:     my %in = (
                   2492:               formname => 'document.cu',
                   2493:               kerb_def_dom => 'MSU.EDU',
                   2494:               @_,
                   2495:               );
1.586     raeburn  2496:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2497:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2498:     if (defined($in{'curr_authtype'})) {
                   2499:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2500:             if ($can_assign{'loc'}) {
1.772     bisitz   2501:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2502:                 if (defined($in{'mode'})) {
                   2503:                     if ($in{'mode'} eq 'modifyuser') {
                   2504:                         $loccheck = '';
                   2505:                     }
                   2506:                 }
1.591     raeburn  2507:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2508:                     $locarg = $in{'curr_autharg'};
                   2509:                 }
                   2510:             } else {
                   2511:                 $result = &mt('Currently using local (institutional) authentication.');
                   2512:                 return $result;
1.165     raeburn  2513:             }
                   2514:         }
1.586     raeburn  2515:     } else {
                   2516:         if ($authnum == 1) {
1.784     bisitz   2517:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2518:         }
                   2519:     }
                   2520:     if (!$can_assign{'loc'}) {
                   2521:         return;
1.587     raeburn  2522:     } elsif ($authtype eq '') {
1.591     raeburn  2523:         if (defined($in{'mode'})) {
1.587     raeburn  2524:             if ($in{'mode'} eq 'modifycourse') {
                   2525:                 if ($authnum == 1) {
1.784     bisitz   2526:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2527:                 }
                   2528:             }
                   2529:         }
1.165     raeburn  2530:     }
1.586     raeburn  2531:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2532:     if ($authtype eq '') {
                   2533:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2534:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2535:                     $jscall.'" />';
                   2536:     }
                   2537:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2538:                $locarg.'" onchange="'.$jscall.'" />';
                   2539:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2540:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2541:     return $result;
                   2542: }
                   2543: 
                   2544: sub authform_filesystem{  
                   2545:     my %in = (
                   2546:               formname => 'document.cu',
                   2547:               kerb_def_dom => 'MSU.EDU',
                   2548:               @_,
                   2549:               );
1.586     raeburn  2550:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2551:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2552:     if (defined($in{'curr_authtype'})) {
                   2553:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2554:             if ($can_assign{'fsys'}) {
1.772     bisitz   2555:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2556:                 if (defined($in{'mode'})) {
                   2557:                     if ($in{'mode'} eq 'modifyuser') {
                   2558:                         $fsyscheck = '';
                   2559:                     }
                   2560:                 }
1.586     raeburn  2561:             } else {
                   2562:                 $result = &mt('Currently Filesystem Authenticated.');
                   2563:                 return $result;
                   2564:             }           
                   2565:         }
                   2566:     } else {
                   2567:         if ($authnum == 1) {
1.784     bisitz   2568:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2569:         }
                   2570:     }
                   2571:     if (!$can_assign{'fsys'}) {
                   2572:         return;
1.587     raeburn  2573:     } elsif ($authtype eq '') {
1.591     raeburn  2574:         if (defined($in{'mode'})) {
1.587     raeburn  2575:             if ($in{'mode'} eq 'modifycourse') {
                   2576:                 if ($authnum == 1) {
1.784     bisitz   2577:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2578:                 }
                   2579:             }
                   2580:         }
1.586     raeburn  2581:     }
                   2582:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2583:     if ($authtype eq '') {
                   2584:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2585:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2586:                     $jscall.'" />';
                   2587:     }
                   2588:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2589:                ' onchange="'.$jscall.'" />';
                   2590:     $result = &mt
1.144     matthew  2591:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2592:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2593:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2594:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2595:                   'onchange="'.$jscall.'" />');
1.32      matthew  2596:     return $result;
                   2597: }
                   2598: 
1.586     raeburn  2599: sub get_assignable_auth {
                   2600:     my ($dom) = @_;
                   2601:     if ($dom eq '') {
                   2602:         $dom = $env{'request.role.domain'};
                   2603:     }
                   2604:     my %can_assign = (
                   2605:                           krb4 => 1,
                   2606:                           krb5 => 1,
                   2607:                           int  => 1,
                   2608:                           loc  => 1,
                   2609:                      );
                   2610:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2611:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2612:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2613:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2614:             my $context;
                   2615:             if ($env{'request.role'} =~ /^au/) {
                   2616:                 $context = 'author';
                   2617:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2618:                 $context = 'domain';
                   2619:             } elsif ($env{'request.course.id'}) {
                   2620:                 $context = 'course';
                   2621:             }
                   2622:             if ($context) {
                   2623:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2624:                    %can_assign = %{$authhash->{$context}}; 
                   2625:                 }
                   2626:             }
                   2627:         }
                   2628:     }
                   2629:     my $authnum = 0;
                   2630:     foreach my $key (keys(%can_assign)) {
                   2631:         if ($can_assign{$key}) {
                   2632:             $authnum ++;
                   2633:         }
                   2634:     }
                   2635:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2636:         $authnum --;
                   2637:     }
                   2638:     return ($authnum,%can_assign);
                   2639: }
                   2640: 
1.80      albertel 2641: ###############################################################
                   2642: ##    Get Kerberos Defaults for Domain                 ##
                   2643: ###############################################################
                   2644: ##
                   2645: ## Returns default kerberos version and an associated argument
                   2646: ## as listed in file domain.tab. If not listed, provides
                   2647: ## appropriate default domain and kerberos version.
                   2648: ##
                   2649: #-------------------------------------------
                   2650: 
                   2651: =pod
                   2652: 
1.648     raeburn  2653: =item * &get_kerberos_defaults()
1.80      albertel 2654: 
                   2655: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2656: version and domain. If not found, it defaults to version 4 and the 
                   2657: domain of the server.
1.80      albertel 2658: 
1.648     raeburn  2659: =over 4
                   2660: 
1.80      albertel 2661: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2662: 
1.648     raeburn  2663: =back
                   2664: 
                   2665: =back
                   2666: 
1.80      albertel 2667: =cut
                   2668: 
                   2669: #-------------------------------------------
                   2670: sub get_kerberos_defaults {
                   2671:     my $domain=shift;
1.641     raeburn  2672:     my ($krbdef,$krbdefdom);
                   2673:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2674:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2675:         $krbdef = $domdefaults{'auth_def'};
                   2676:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2677:     } else {
1.80      albertel 2678:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2679:         my $krbdefdom=$1;
                   2680:         $krbdefdom=~tr/a-z/A-Z/;
                   2681:         $krbdef = "krb4";
                   2682:     }
                   2683:     return ($krbdef,$krbdefdom);
                   2684: }
1.112     bowersj2 2685: 
1.32      matthew  2686: 
1.46      matthew  2687: ###############################################################
                   2688: ##                Thesaurus Functions                        ##
                   2689: ###############################################################
1.20      www      2690: 
1.46      matthew  2691: =pod
1.20      www      2692: 
1.112     bowersj2 2693: =head1 Thesaurus Functions
                   2694: 
                   2695: =over 4
                   2696: 
1.648     raeburn  2697: =item * &initialize_keywords()
1.46      matthew  2698: 
                   2699: Initializes the package variable %Keywords if it is empty.  Uses the
                   2700: package variable $thesaurus_db_file.
                   2701: 
                   2702: =cut
                   2703: 
                   2704: ###################################################
                   2705: 
                   2706: sub initialize_keywords {
                   2707:     return 1 if (scalar keys(%Keywords));
                   2708:     # If we are here, %Keywords is empty, so fill it up
                   2709:     #   Make sure the file we need exists...
                   2710:     if (! -e $thesaurus_db_file) {
                   2711:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2712:                                  " failed because it does not exist");
                   2713:         return 0;
                   2714:     }
                   2715:     #   Set up the hash as a database
                   2716:     my %thesaurus_db;
                   2717:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2718:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2719:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2720:                                  $thesaurus_db_file);
                   2721:         return 0;
                   2722:     } 
                   2723:     #  Get the average number of appearances of a word.
                   2724:     my $avecount = $thesaurus_db{'average.count'};
                   2725:     #  Put keywords (those that appear > average) into %Keywords
                   2726:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2727:         my ($count,undef) = split /:/,$data;
                   2728:         $Keywords{$word}++ if ($count > $avecount);
                   2729:     }
                   2730:     untie %thesaurus_db;
                   2731:     # Remove special values from %Keywords.
1.356     albertel 2732:     foreach my $value ('total.count','average.count') {
                   2733:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2734:   }
1.46      matthew  2735:     return 1;
                   2736: }
                   2737: 
                   2738: ###################################################
                   2739: 
                   2740: =pod
                   2741: 
1.648     raeburn  2742: =item * &keyword($word)
1.46      matthew  2743: 
                   2744: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2745: than the average number of times in the thesaurus database.  Calls 
                   2746: &initialize_keywords
                   2747: 
                   2748: =cut
                   2749: 
                   2750: ###################################################
1.20      www      2751: 
                   2752: sub keyword {
1.46      matthew  2753:     return if (!&initialize_keywords());
                   2754:     my $word=lc(shift());
                   2755:     $word=~s/\W//g;
                   2756:     return exists($Keywords{$word});
1.20      www      2757: }
1.46      matthew  2758: 
                   2759: ###############################################################
                   2760: 
                   2761: =pod 
1.20      www      2762: 
1.648     raeburn  2763: =item * &get_related_words()
1.46      matthew  2764: 
1.160     matthew  2765: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2766: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2767: will be returned.  The order of the words returned is determined by the
                   2768: database which holds them.
                   2769: 
                   2770: Uses global $thesaurus_db_file.
                   2771: 
                   2772: =cut
                   2773: 
                   2774: ###############################################################
                   2775: sub get_related_words {
                   2776:     my $keyword = shift;
                   2777:     my %thesaurus_db;
                   2778:     if (! -e $thesaurus_db_file) {
                   2779:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2780:                                  "failed because the file does not exist");
                   2781:         return ();
                   2782:     }
                   2783:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2784:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2785:         return ();
                   2786:     } 
                   2787:     my @Words=();
1.429     www      2788:     my $count=0;
1.46      matthew  2789:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2790: 	# The first element is the number of times
                   2791: 	# the word appears.  We do not need it now.
1.429     www      2792: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2793: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2794: 	my $threshold=$mostfrequentcount/10;
                   2795:         foreach my $possibleword (@RelatedWords) {
                   2796:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2797:             if ($wordcount>$threshold) {
                   2798: 		push(@Words,$word);
                   2799:                 $count++;
                   2800:                 if ($count>10) { last; }
                   2801: 	    }
1.20      www      2802:         }
                   2803:     }
1.46      matthew  2804:     untie %thesaurus_db;
                   2805:     return @Words;
1.14      harris41 2806: }
1.46      matthew  2807: 
1.112     bowersj2 2808: =pod
                   2809: 
                   2810: =back
                   2811: 
                   2812: =cut
1.61      www      2813: 
                   2814: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2815: =pod
                   2816: 
1.112     bowersj2 2817: =head1 User Name Functions
                   2818: 
                   2819: =over 4
                   2820: 
1.648     raeburn  2821: =item * &plainname($uname,$udom,$first)
1.81      albertel 2822: 
1.112     bowersj2 2823: Takes a users logon name and returns it as a string in
1.226     albertel 2824: "first middle last generation" form 
                   2825: if $first is set to 'lastname' then it returns it as
                   2826: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2827: 
                   2828: =cut
1.61      www      2829: 
1.295     www      2830: 
1.81      albertel 2831: ###############################################################
1.61      www      2832: sub plainname {
1.226     albertel 2833:     my ($uname,$udom,$first)=@_;
1.537     albertel 2834:     return if (!defined($uname) || !defined($udom));
1.295     www      2835:     my %names=&getnames($uname,$udom);
1.226     albertel 2836:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2837: 					  $names{'middlename'},
                   2838: 					  $names{'lastname'},
                   2839: 					  $names{'generation'},$first);
                   2840:     $name=~s/^\s+//;
1.62      www      2841:     $name=~s/\s+$//;
                   2842:     $name=~s/\s+/ /g;
1.353     albertel 2843:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2844:     return $name;
1.61      www      2845: }
1.66      www      2846: 
                   2847: # -------------------------------------------------------------------- Nickname
1.81      albertel 2848: =pod
                   2849: 
1.648     raeburn  2850: =item * &nickname($uname,$udom)
1.81      albertel 2851: 
                   2852: Gets a users name and returns it as a string as
                   2853: 
                   2854: "&quot;nickname&quot;"
1.66      www      2855: 
1.81      albertel 2856: if the user has a nickname or
                   2857: 
                   2858: "first middle last generation"
                   2859: 
                   2860: if the user does not
                   2861: 
                   2862: =cut
1.66      www      2863: 
                   2864: sub nickname {
                   2865:     my ($uname,$udom)=@_;
1.537     albertel 2866:     return if (!defined($uname) || !defined($udom));
1.295     www      2867:     my %names=&getnames($uname,$udom);
1.68      albertel 2868:     my $name=$names{'nickname'};
1.66      www      2869:     if ($name) {
                   2870:        $name='&quot;'.$name.'&quot;'; 
                   2871:     } else {
                   2872:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2873: 	     $names{'lastname'}.' '.$names{'generation'};
                   2874:        $name=~s/\s+$//;
                   2875:        $name=~s/\s+/ /g;
                   2876:     }
                   2877:     return $name;
                   2878: }
                   2879: 
1.295     www      2880: sub getnames {
                   2881:     my ($uname,$udom)=@_;
1.537     albertel 2882:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2883:     if ($udom eq 'public' && $uname eq 'public') {
                   2884: 	return ('lastname' => &mt('Public'));
                   2885:     }
1.295     www      2886:     my $id=$uname.':'.$udom;
                   2887:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2888:     if ($cached) {
                   2889: 	return %{$names};
                   2890:     } else {
                   2891: 	my %loadnames=&Apache::lonnet::get('environment',
                   2892:                     ['firstname','middlename','lastname','generation','nickname'],
                   2893: 					 $udom,$uname);
                   2894: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2895: 	return %loadnames;
                   2896:     }
                   2897: }
1.61      www      2898: 
1.542     raeburn  2899: # -------------------------------------------------------------------- getemails
1.648     raeburn  2900: 
1.542     raeburn  2901: =pod
                   2902: 
1.648     raeburn  2903: =item * &getemails($uname,$udom)
1.542     raeburn  2904: 
                   2905: Gets a user's email information and returns it as a hash with keys:
                   2906: notification, critnotification, permanentemail
                   2907: 
                   2908: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2909: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2910:  
1.648     raeburn  2911: 
1.542     raeburn  2912: =cut
                   2913: 
1.648     raeburn  2914: 
1.466     albertel 2915: sub getemails {
                   2916:     my ($uname,$udom)=@_;
                   2917:     if ($udom eq 'public' && $uname eq 'public') {
                   2918: 	return;
                   2919:     }
1.467     www      2920:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2921:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2922:     my $id=$uname.':'.$udom;
                   2923:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2924:     if ($cached) {
                   2925: 	return %{$names};
                   2926:     } else {
                   2927: 	my %loadnames=&Apache::lonnet::get('environment',
                   2928:                     			   ['notification','critnotification',
                   2929: 					    'permanentemail'],
                   2930: 					   $udom,$uname);
                   2931: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2932: 	return %loadnames;
                   2933:     }
                   2934: }
                   2935: 
1.551     albertel 2936: sub flush_email_cache {
                   2937:     my ($uname,$udom)=@_;
                   2938:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2939:     if (!$uname) { $uname=$env{'user.name'};   }
                   2940:     return if ($udom eq 'public' && $uname eq 'public');
                   2941:     my $id=$uname.':'.$udom;
                   2942:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2943: }
                   2944: 
1.728     raeburn  2945: # -------------------------------------------------------------------- getlangs
                   2946: 
                   2947: =pod
                   2948: 
                   2949: =item * &getlangs($uname,$udom)
                   2950: 
                   2951: Gets a user's language preference and returns it as a hash with key:
                   2952: language.
                   2953: 
                   2954: =cut
                   2955: 
                   2956: 
                   2957: sub getlangs {
                   2958:     my ($uname,$udom) = @_;
                   2959:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2960:     if (!$uname) { $uname=$env{'user.name'};   }
                   2961:     my $id=$uname.':'.$udom;
                   2962:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2963:     if ($cached) {
                   2964:         return %{$langs};
                   2965:     } else {
                   2966:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2967:                                            $udom,$uname);
                   2968:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2969:         return %loadlangs;
                   2970:     }
                   2971: }
                   2972: 
                   2973: sub flush_langs_cache {
                   2974:     my ($uname,$udom)=@_;
                   2975:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2976:     if (!$uname) { $uname=$env{'user.name'};   }
                   2977:     return if ($udom eq 'public' && $uname eq 'public');
                   2978:     my $id=$uname.':'.$udom;
                   2979:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2980: }
                   2981: 
1.61      www      2982: # ------------------------------------------------------------------ Screenname
1.81      albertel 2983: 
                   2984: =pod
                   2985: 
1.648     raeburn  2986: =item * &screenname($uname,$udom)
1.81      albertel 2987: 
                   2988: Gets a users screenname and returns it as a string
                   2989: 
                   2990: =cut
1.61      www      2991: 
                   2992: sub screenname {
                   2993:     my ($uname,$udom)=@_;
1.258     albertel 2994:     if ($uname eq $env{'user.name'} &&
                   2995: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2996:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2997:     return $names{'screenname'};
1.62      www      2998: }
                   2999: 
1.212     albertel 3000: 
1.802     bisitz   3001: # ------------------------------------------------------------- Confirm Wrapper
                   3002: =pod
                   3003: 
                   3004: =item confirmwrapper
                   3005: 
                   3006: Wrap messages about completion of operation in box
                   3007: 
                   3008: =cut
                   3009: 
                   3010: sub confirmwrapper {
                   3011:     my ($message)=@_;
                   3012:     if ($message) {
                   3013:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3014:                .$message."\n"
                   3015:                .'</div>'."\n";
                   3016:     } else {
                   3017:         return $message;
                   3018:     }
                   3019: }
                   3020: 
1.62      www      3021: # ------------------------------------------------------------- Message Wrapper
                   3022: 
                   3023: sub messagewrapper {
1.369     www      3024:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3025:     return 
1.441     albertel 3026:         '<a href="/adm/email?compose=individual&amp;'.
                   3027:         'recname='.$username.'&amp;recdom='.$domain.
                   3028: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3029:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3030: }
1.802     bisitz   3031: 
1.74      www      3032: # --------------------------------------------------------------- Notes Wrapper
                   3033: 
                   3034: sub noteswrapper {
                   3035:     my ($link,$un,$do)=@_;
                   3036:     return 
1.896     amueller 3037: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3038: }
1.802     bisitz   3039: 
1.62      www      3040: # ------------------------------------------------------------- Aboutme Wrapper
                   3041: 
                   3042: sub aboutmewrapper {
1.166     www      3043:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3044:     if (!defined($username)  && !defined($domain)) {
                   3045:         return;
                   3046:     }
1.892     amueller 3047:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3048: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3049: }
                   3050: 
                   3051: # ------------------------------------------------------------ Syllabus Wrapper
                   3052: 
                   3053: sub syllabuswrapper {
1.707     bisitz   3054:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3055:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3056: }
1.14      harris41 3057: 
1.802     bisitz   3058: # -----------------------------------------------------------------------------
                   3059: 
1.208     matthew  3060: sub track_student_link {
1.887     raeburn  3061:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3062:     my $link ="/adm/trackstudent?";
1.208     matthew  3063:     my $title = 'View recent activity';
                   3064:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3065:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3066:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3067:         $title .= ' of this student';
1.268     albertel 3068:     } 
1.208     matthew  3069:     if (defined($target) && $target !~ /^\s*$/) {
                   3070:         $target = qq{target="$target"};
                   3071:     } else {
                   3072:         $target = '';
                   3073:     }
1.268     albertel 3074:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3075:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3076:     $title = &mt($title);
                   3077:     $linktext = &mt($linktext);
1.448     albertel 3078:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3079: 	&help_open_topic('View_recent_activity');
1.208     matthew  3080: }
                   3081: 
1.781     raeburn  3082: sub slot_reservations_link {
                   3083:     my ($linktext,$sname,$sdom,$target) = @_;
                   3084:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3085:     my $title = 'View slot reservation history';
                   3086:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3087:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3088:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3089:         $title .= ' of this student';
                   3090:     }
                   3091:     if (defined($target) && $target !~ /^\s*$/) {
                   3092:         $target = qq{target="$target"};
                   3093:     } else {
                   3094:         $target = '';
                   3095:     }
                   3096:     $title = &mt($title);
                   3097:     $linktext = &mt($linktext);
                   3098:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3099: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3100: 
                   3101: }
                   3102: 
1.508     www      3103: # ===================================================== Display a student photo
                   3104: 
                   3105: 
1.509     albertel 3106: sub student_image_tag {
1.508     www      3107:     my ($domain,$user)=@_;
                   3108:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3109:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3110: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3111:     } else {
                   3112: 	return '';
                   3113:     }
                   3114: }
                   3115: 
1.112     bowersj2 3116: =pod
                   3117: 
                   3118: =back
                   3119: 
                   3120: =head1 Access .tab File Data
                   3121: 
                   3122: =over 4
                   3123: 
1.648     raeburn  3124: =item * &languageids() 
1.112     bowersj2 3125: 
                   3126: returns list of all language ids
                   3127: 
                   3128: =cut
                   3129: 
1.14      harris41 3130: sub languageids {
1.16      harris41 3131:     return sort(keys(%language));
1.14      harris41 3132: }
                   3133: 
1.112     bowersj2 3134: =pod
                   3135: 
1.648     raeburn  3136: =item * &languagedescription() 
1.112     bowersj2 3137: 
                   3138: returns description of a specified language id
                   3139: 
                   3140: =cut
                   3141: 
1.14      harris41 3142: sub languagedescription {
1.125     www      3143:     my $code=shift;
                   3144:     return  ($supported_language{$code}?'* ':'').
                   3145:             $language{$code}.
1.126     www      3146: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3147: }
                   3148: 
                   3149: sub plainlanguagedescription {
                   3150:     my $code=shift;
                   3151:     return $language{$code};
                   3152: }
                   3153: 
                   3154: sub supportedlanguagecode {
                   3155:     my $code=shift;
                   3156:     return $supported_language{$code};
1.97      www      3157: }
                   3158: 
1.112     bowersj2 3159: =pod
                   3160: 
1.648     raeburn  3161: =item * &copyrightids() 
1.112     bowersj2 3162: 
                   3163: returns list of all copyrights
                   3164: 
                   3165: =cut
                   3166: 
                   3167: sub copyrightids {
                   3168:     return sort(keys(%cprtag));
                   3169: }
                   3170: 
                   3171: =pod
                   3172: 
1.648     raeburn  3173: =item * &copyrightdescription() 
1.112     bowersj2 3174: 
                   3175: returns description of a specified copyright id
                   3176: 
                   3177: =cut
                   3178: 
                   3179: sub copyrightdescription {
1.166     www      3180:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3181: }
1.197     matthew  3182: 
                   3183: =pod
                   3184: 
1.648     raeburn  3185: =item * &source_copyrightids() 
1.192     taceyjo1 3186: 
                   3187: returns list of all source copyrights
                   3188: 
                   3189: =cut
                   3190: 
                   3191: sub source_copyrightids {
                   3192:     return sort(keys(%scprtag));
                   3193: }
                   3194: 
                   3195: =pod
                   3196: 
1.648     raeburn  3197: =item * &source_copyrightdescription() 
1.192     taceyjo1 3198: 
                   3199: returns description of a specified source copyright id
                   3200: 
                   3201: =cut
                   3202: 
                   3203: sub source_copyrightdescription {
                   3204:     return &mt($scprtag{shift(@_)});
                   3205: }
1.112     bowersj2 3206: 
                   3207: =pod
                   3208: 
1.648     raeburn  3209: =item * &filecategories() 
1.112     bowersj2 3210: 
                   3211: returns list of all file categories
                   3212: 
                   3213: =cut
                   3214: 
                   3215: sub filecategories {
                   3216:     return sort(keys(%category_extensions));
                   3217: }
                   3218: 
                   3219: =pod
                   3220: 
1.648     raeburn  3221: =item * &filecategorytypes() 
1.112     bowersj2 3222: 
                   3223: returns list of file types belonging to a given file
                   3224: category
                   3225: 
                   3226: =cut
                   3227: 
                   3228: sub filecategorytypes {
1.356     albertel 3229:     my ($cat) = @_;
                   3230:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3231: }
                   3232: 
                   3233: =pod
                   3234: 
1.648     raeburn  3235: =item * &fileembstyle() 
1.112     bowersj2 3236: 
                   3237: returns embedding style for a specified file type
                   3238: 
                   3239: =cut
                   3240: 
                   3241: sub fileembstyle {
                   3242:     return $fe{lc(shift(@_))};
1.169     www      3243: }
                   3244: 
1.351     www      3245: sub filemimetype {
                   3246:     return $fm{lc(shift(@_))};
                   3247: }
                   3248: 
1.169     www      3249: 
                   3250: sub filecategoryselect {
                   3251:     my ($name,$value)=@_;
1.189     matthew  3252:     return &select_form($value,$name,
1.169     www      3253: 			'' => &mt('Any category'),
                   3254: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3255: }
                   3256: 
                   3257: =pod
                   3258: 
1.648     raeburn  3259: =item * &filedescription() 
1.112     bowersj2 3260: 
                   3261: returns description for a specified file type
                   3262: 
                   3263: =cut
                   3264: 
                   3265: sub filedescription {
1.188     matthew  3266:     my $file_description = $fd{lc(shift())};
                   3267:     $file_description =~ s:([\[\]]):~$1:g;
                   3268:     return &mt($file_description);
1.112     bowersj2 3269: }
                   3270: 
                   3271: =pod
                   3272: 
1.648     raeburn  3273: =item * &filedescriptionex() 
1.112     bowersj2 3274: 
                   3275: returns description for a specified file type with
                   3276: extra formatting
                   3277: 
                   3278: =cut
                   3279: 
                   3280: sub filedescriptionex {
                   3281:     my $ex=shift;
1.188     matthew  3282:     my $file_description = $fd{lc($ex)};
                   3283:     $file_description =~ s:([\[\]]):~$1:g;
                   3284:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3285: }
                   3286: 
                   3287: # End of .tab access
                   3288: =pod
                   3289: 
                   3290: =back
                   3291: 
                   3292: =cut
                   3293: 
                   3294: # ------------------------------------------------------------------ File Types
                   3295: sub fileextensions {
                   3296:     return sort(keys(%fe));
                   3297: }
                   3298: 
1.97      www      3299: # ----------------------------------------------------------- Display Languages
                   3300: # returns a hash with all desired display languages
                   3301: #
                   3302: 
                   3303: sub display_languages {
                   3304:     my %languages=();
1.695     raeburn  3305:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3306: 	$languages{$lang}=1;
1.97      www      3307:     }
                   3308:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3309:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3310: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3311: 	    $languages{$lang}=1;
1.97      www      3312:         }
                   3313:     }
                   3314:     return %languages;
1.14      harris41 3315: }
                   3316: 
1.582     albertel 3317: sub languages {
                   3318:     my ($possible_langs) = @_;
1.695     raeburn  3319:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3320:     if (!ref($possible_langs)) {
                   3321: 	if( wantarray ) {
                   3322: 	    return @preferred_langs;
                   3323: 	} else {
                   3324: 	    return $preferred_langs[0];
                   3325: 	}
                   3326:     }
                   3327:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3328:     my @preferred_possibilities;
                   3329:     foreach my $preferred_lang (@preferred_langs) {
                   3330: 	if (exists($possibilities{$preferred_lang})) {
                   3331: 	    push(@preferred_possibilities, $preferred_lang);
                   3332: 	}
                   3333:     }
                   3334:     if( wantarray ) {
                   3335: 	return @preferred_possibilities;
                   3336:     }
                   3337:     return $preferred_possibilities[0];
                   3338: }
                   3339: 
1.742     raeburn  3340: sub user_lang {
                   3341:     my ($touname,$toudom,$fromcid) = @_;
                   3342:     my @userlangs;
                   3343:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3344:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3345:                     $env{'course.'.$fromcid.'.languages'}));
                   3346:     } else {
                   3347:         my %langhash = &getlangs($touname,$toudom);
                   3348:         if ($langhash{'languages'} ne '') {
                   3349:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3350:         } else {
                   3351:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3352:             if ($domdefs{'lang_def'} ne '') {
                   3353:                 @userlangs = ($domdefs{'lang_def'});
                   3354:             }
                   3355:         }
                   3356:     }
                   3357:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3358:     my $user_lh = Apache::localize->get_handle(@languages);
                   3359:     return $user_lh;
                   3360: }
                   3361: 
                   3362: 
1.112     bowersj2 3363: ###############################################################
                   3364: ##               Student Answer Attempts                     ##
                   3365: ###############################################################
                   3366: 
                   3367: =pod
                   3368: 
                   3369: =head1 Alternate Problem Views
                   3370: 
                   3371: =over 4
                   3372: 
1.648     raeburn  3373: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3374:     $getattempt, $regexp, $gradesub)
                   3375: 
                   3376: Return string with previous attempt on problem. Arguments:
                   3377: 
                   3378: =over 4
                   3379: 
                   3380: =item * $symb: Problem, including path
                   3381: 
                   3382: =item * $username: username of the desired student
                   3383: 
                   3384: =item * $domain: domain of the desired student
1.14      harris41 3385: 
1.112     bowersj2 3386: =item * $course: Course ID
1.14      harris41 3387: 
1.112     bowersj2 3388: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3389:     something
1.14      harris41 3390: 
1.112     bowersj2 3391: =item * $regexp: if string matches this regexp, the string will be
                   3392:     sent to $gradesub
1.14      harris41 3393: 
1.112     bowersj2 3394: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3395: 
1.112     bowersj2 3396: =back
1.14      harris41 3397: 
1.112     bowersj2 3398: The output string is a table containing all desired attempts, if any.
1.16      harris41 3399: 
1.112     bowersj2 3400: =cut
1.1       albertel 3401: 
                   3402: sub get_previous_attempt {
1.43      ng       3403:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3404:   my $prevattempts='';
1.43      ng       3405:   no strict 'refs';
1.1       albertel 3406:   if ($symb) {
1.3       albertel 3407:     my (%returnhash)=
                   3408:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3409:     if ($returnhash{'version'}) {
                   3410:       my %lasthash=();
                   3411:       my $version;
                   3412:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3413:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3414: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3415:         }
1.1       albertel 3416:       }
1.596     albertel 3417:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3418:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3419:       foreach my $key (sort(keys(%lasthash))) {
                   3420: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3421: 	if ($#parts > 0) {
1.31      albertel 3422: 	  my $data=$parts[-1];
                   3423: 	  pop(@parts);
1.596     albertel 3424: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3425: 	} else {
1.41      ng       3426: 	  if ($#parts == 0) {
                   3427: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3428: 	  } else {
                   3429: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3430: 	  }
1.31      albertel 3431: 	}
1.16      harris41 3432:       }
1.596     albertel 3433:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3434:       if ($getattempt eq '') {
                   3435: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3436: 	  $prevattempts.=&start_data_table_row().
                   3437: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3438: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3439: 		my $value = &format_previous_attempt_value($key,
                   3440: 							   $returnhash{$version.':'.$key});
                   3441: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3442: 	    }
1.596     albertel 3443: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3444: 	 }
1.1       albertel 3445:       }
1.596     albertel 3446:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3447:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3448: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3449: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3450: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3451:       }
1.596     albertel 3452:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3453:     } else {
1.596     albertel 3454:       $prevattempts=
                   3455: 	  &start_data_table().&start_data_table_row().
                   3456: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3457: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3458:     }
                   3459:   } else {
1.596     albertel 3460:     $prevattempts=
                   3461: 	  &start_data_table().&start_data_table_row().
                   3462: 	  '<td>'.&mt('No data.').'</td>'.
                   3463: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3464:   }
1.10      albertel 3465: }
                   3466: 
1.581     albertel 3467: sub format_previous_attempt_value {
                   3468:     my ($key,$value) = @_;
                   3469:     if ($key =~ /timestamp/) {
                   3470: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3471:     } elsif (ref($value) eq 'ARRAY') {
                   3472: 	$value = '('.join(', ', @{ $value }).')';
                   3473:     } else {
                   3474: 	$value = &unescape($value);
                   3475:     }
                   3476:     return $value;
                   3477: }
                   3478: 
                   3479: 
1.107     albertel 3480: sub relative_to_absolute {
                   3481:     my ($url,$output)=@_;
                   3482:     my $parser=HTML::TokeParser->new(\$output);
                   3483:     my $token;
                   3484:     my $thisdir=$url;
                   3485:     my @rlinks=();
                   3486:     while ($token=$parser->get_token) {
                   3487: 	if ($token->[0] eq 'S') {
                   3488: 	    if ($token->[1] eq 'a') {
                   3489: 		if ($token->[2]->{'href'}) {
                   3490: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3491: 		}
                   3492: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3493: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3494: 	    } elsif ($token->[1] eq 'base') {
                   3495: 		$thisdir=$token->[2]->{'href'};
                   3496: 	    }
                   3497: 	}
                   3498:     }
                   3499:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3500:     foreach my $link (@rlinks) {
1.726     raeburn  3501: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3502: 		($link=~/^\//) ||
                   3503: 		($link=~/^javascript:/i) ||
                   3504: 		($link=~/^mailto:/i) ||
                   3505: 		($link=~/^\#/)) {
                   3506: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3507: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3508: 	}
                   3509:     }
                   3510: # -------------------------------------------------- Deal with Applet codebases
                   3511:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3512:     return $output;
                   3513: }
                   3514: 
1.112     bowersj2 3515: =pod
                   3516: 
1.648     raeburn  3517: =item * &get_student_view()
1.112     bowersj2 3518: 
                   3519: show a snapshot of what student was looking at
                   3520: 
                   3521: =cut
                   3522: 
1.10      albertel 3523: sub get_student_view {
1.186     albertel 3524:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3525:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3526:   my (%form);
1.10      albertel 3527:   my @elements=('symb','courseid','domain','username');
                   3528:   foreach my $element (@elements) {
1.186     albertel 3529:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3530:   }
1.186     albertel 3531:   if (defined($moreenv)) {
                   3532:       %form=(%form,%{$moreenv});
                   3533:   }
1.236     albertel 3534:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3535:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3536:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3537:   $userview=~s/\<body[^\>]*\>//gi;
                   3538:   $userview=~s/\<\/body\>//gi;
                   3539:   $userview=~s/\<html\>//gi;
                   3540:   $userview=~s/\<\/html\>//gi;
                   3541:   $userview=~s/\<head\>//gi;
                   3542:   $userview=~s/\<\/head\>//gi;
                   3543:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3544:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3545:   if (wantarray) {
                   3546:      return ($userview,$response);
                   3547:   } else {
                   3548:      return $userview;
                   3549:   }
                   3550: }
                   3551: 
                   3552: sub get_student_view_with_retries {
                   3553:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3554: 
                   3555:     my $ok = 0;                 # True if we got a good response.
                   3556:     my $content;
                   3557:     my $response;
                   3558: 
                   3559:     # Try to get the student_view done. within the retries count:
                   3560:     
                   3561:     do {
                   3562:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3563:          $ok      = $response->is_success;
                   3564:          if (!$ok) {
                   3565:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3566:          }
                   3567:          $retries--;
                   3568:     } while (!$ok && ($retries > 0));
                   3569:     
                   3570:     if (!$ok) {
                   3571:        $content = '';          # On error return an empty content.
                   3572:     }
1.651     www      3573:     if (wantarray) {
                   3574:        return ($content, $response);
                   3575:     } else {
                   3576:        return $content;
                   3577:     }
1.11      albertel 3578: }
                   3579: 
1.112     bowersj2 3580: =pod
                   3581: 
1.648     raeburn  3582: =item * &get_student_answers() 
1.112     bowersj2 3583: 
                   3584: show a snapshot of how student was answering problem
                   3585: 
                   3586: =cut
                   3587: 
1.11      albertel 3588: sub get_student_answers {
1.100     sakharuk 3589:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3590:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3591:   my (%moreenv);
1.11      albertel 3592:   my @elements=('symb','courseid','domain','username');
                   3593:   foreach my $element (@elements) {
1.186     albertel 3594:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3595:   }
1.186     albertel 3596:   $moreenv{'grade_target'}='answer';
                   3597:   %moreenv=(%form,%moreenv);
1.497     raeburn  3598:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3599:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3600:   return $userview;
1.1       albertel 3601: }
1.116     albertel 3602: 
                   3603: =pod
                   3604: 
                   3605: =item * &submlink()
                   3606: 
1.242     albertel 3607: Inputs: $text $uname $udom $symb $target
1.116     albertel 3608: 
                   3609: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3610: 
                   3611: =cut
                   3612: 
                   3613: ###############################################
                   3614: sub submlink {
1.242     albertel 3615:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3616:     if (!($uname && $udom)) {
                   3617: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3618: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3619: 	if (!$symb) { $symb=$cursymb; }
                   3620:     }
1.254     matthew  3621:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3622:     $symb=&escape($symb);
1.242     albertel 3623:     if ($target) { $target="target=\"$target\""; }
                   3624:     return '<a href="/adm/grades?&command=submission&'.
                   3625: 	'symb='.$symb.'&student='.$uname.
                   3626: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3627: }
                   3628: ##############################################
                   3629: 
                   3630: =pod
                   3631: 
                   3632: =item * &pgrdlink()
                   3633: 
                   3634: Inputs: $text $uname $udom $symb $target
                   3635: 
                   3636: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3637: 
                   3638: =cut
                   3639: 
                   3640: ###############################################
                   3641: sub pgrdlink {
                   3642:     my $link=&submlink(@_);
                   3643:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3644:     return $link;
                   3645: }
                   3646: ##############################################
                   3647: 
                   3648: =pod
                   3649: 
                   3650: =item * &pprmlink()
                   3651: 
                   3652: Inputs: $text $uname $udom $symb $target
                   3653: 
                   3654: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3655: student and a specific resource
1.242     albertel 3656: 
                   3657: =cut
                   3658: 
                   3659: ###############################################
                   3660: sub pprmlink {
                   3661:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3662:     if (!($uname && $udom)) {
                   3663: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3664: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3665: 	if (!$symb) { $symb=$cursymb; }
                   3666:     }
1.254     matthew  3667:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3668:     $symb=&escape($symb);
1.242     albertel 3669:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3670:     return '<a href="/adm/parmset?command=set&amp;'.
                   3671: 	'symb='.$symb.'&amp;uname='.$uname.
                   3672: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3673: }
                   3674: ##############################################
1.37      matthew  3675: 
1.112     bowersj2 3676: =pod
                   3677: 
                   3678: =back
                   3679: 
                   3680: =cut
                   3681: 
1.37      matthew  3682: ###############################################
1.51      www      3683: 
                   3684: 
                   3685: sub timehash {
1.687     raeburn  3686:     my ($thistime) = @_;
                   3687:     my $timezone = &Apache::lonlocal::gettimezone();
                   3688:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3689:                      ->set_time_zone($timezone);
                   3690:     my $wday = $dt->day_of_week();
                   3691:     if ($wday == 7) { $wday = 0; }
                   3692:     return ( 'second' => $dt->second(),
                   3693:              'minute' => $dt->minute(),
                   3694:              'hour'   => $dt->hour(),
                   3695:              'day'     => $dt->day_of_month(),
                   3696:              'month'   => $dt->month(),
                   3697:              'year'    => $dt->year(),
                   3698:              'weekday' => $wday,
                   3699:              'dayyear' => $dt->day_of_year(),
                   3700:              'dlsav'   => $dt->is_dst() );
1.51      www      3701: }
                   3702: 
1.370     www      3703: sub utc_string {
                   3704:     my ($date)=@_;
1.371     www      3705:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3706: }
                   3707: 
1.51      www      3708: sub maketime {
                   3709:     my %th=@_;
1.687     raeburn  3710:     my ($epoch_time,$timezone,$dt);
                   3711:     $timezone = &Apache::lonlocal::gettimezone();
                   3712:     eval {
                   3713:         $dt = DateTime->new( year   => $th{'year'},
                   3714:                              month  => $th{'month'},
                   3715:                              day    => $th{'day'},
                   3716:                              hour   => $th{'hour'},
                   3717:                              minute => $th{'minute'},
                   3718:                              second => $th{'second'},
                   3719:                              time_zone => $timezone,
                   3720:                          );
                   3721:     };
                   3722:     if (!$@) {
                   3723:         $epoch_time = $dt->epoch;
                   3724:         if ($epoch_time) {
                   3725:             return $epoch_time;
                   3726:         }
                   3727:     }
1.51      www      3728:     return POSIX::mktime(
                   3729:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3730:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3731: }
                   3732: 
                   3733: #########################################
1.51      www      3734: 
                   3735: sub findallcourses {
1.482     raeburn  3736:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3737:     my %roles;
                   3738:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3739:     my %courses;
1.51      www      3740:     my $now=time;
1.482     raeburn  3741:     if (!defined($uname)) {
                   3742:         $uname = $env{'user.name'};
                   3743:     }
                   3744:     if (!defined($udom)) {
                   3745:         $udom = $env{'user.domain'};
                   3746:     }
                   3747:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3748:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3749:         if (!%roles) {
                   3750:             %roles = (
                   3751:                        cc => 1,
1.907     raeburn  3752:                        co => 1,
1.482     raeburn  3753:                        in => 1,
                   3754:                        ep => 1,
                   3755:                        ta => 1,
                   3756:                        cr => 1,
                   3757:                        st => 1,
                   3758:              );
                   3759:         }
                   3760:         foreach my $entry (keys(%roleshash)) {
                   3761:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3762:             if ($trole =~ /^cr/) { 
                   3763:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3764:             } else {
                   3765:                 next if (!exists($roles{$trole}));
                   3766:             }
                   3767:             if ($tend) {
                   3768:                 next if ($tend < $now);
                   3769:             }
                   3770:             if ($tstart) {
                   3771:                 next if ($tstart > $now);
                   3772:             }
                   3773:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3774:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3775:             if ($secpart eq '') {
                   3776:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3777:                 $sec = 'none';
                   3778:                 $realsec = '';
                   3779:             } else {
                   3780:                 $cnum = $cnumpart;
                   3781:                 ($sec,$role) = split(/_/,$secpart);
                   3782:                 $realsec = $sec;
1.490     raeburn  3783:             }
1.482     raeburn  3784:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3785:         }
                   3786:     } else {
                   3787:         foreach my $key (keys(%env)) {
1.483     albertel 3788: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3789:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3790: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3791: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3792: 	        next if (%roles && !exists($roles{$role}));
                   3793: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3794:                 my $active=1;
                   3795:                 if ($starttime) {
                   3796: 		    if ($now<$starttime) { $active=0; }
                   3797:                 }
                   3798:                 if ($endtime) {
                   3799:                     if ($now>$endtime) { $active=0; }
                   3800:                 }
                   3801:                 if ($active) {
                   3802:                     if ($sec eq '') {
                   3803:                         $sec = 'none';
                   3804:                     }
                   3805:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3806:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3807:                 }
                   3808:             }
1.51      www      3809:         }
                   3810:     }
1.474     raeburn  3811:     return %courses;
1.51      www      3812: }
1.37      matthew  3813: 
1.54      www      3814: ###############################################
1.474     raeburn  3815: 
                   3816: sub blockcheck {
1.482     raeburn  3817:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3818: 
                   3819:     if (!defined($udom)) {
                   3820:         $udom = $env{'user.domain'};
                   3821:     }
                   3822:     if (!defined($uname)) {
                   3823:         $uname = $env{'user.name'};
                   3824:     }
                   3825: 
                   3826:     # If uname and udom are for a course, check for blocks in the course.
                   3827: 
                   3828:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3829:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3830:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3831:         return ($startblock,$endblock);
                   3832:     }
1.474     raeburn  3833: 
1.502     raeburn  3834:     my $startblock = 0;
                   3835:     my $endblock = 0;
1.482     raeburn  3836:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3837: 
1.490     raeburn  3838:     # If uname is for a user, and activity is course-specific, i.e.,
                   3839:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3840: 
1.490     raeburn  3841:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3842:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3843:         foreach my $key (keys(%live_courses)) {
                   3844:             if ($key ne $env{'request.course.id'}) {
                   3845:                 delete($live_courses{$key});
                   3846:             }
                   3847:         }
                   3848:     }
                   3849: 
                   3850:     my $otheruser = 0;
                   3851:     my %own_courses;
                   3852:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3853:         # Resource belongs to user other than current user.
                   3854:         $otheruser = 1;
                   3855:         # Gather courses for current user
                   3856:         %own_courses = 
                   3857:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3858:     }
                   3859: 
                   3860:     # Gather active course roles - course coordinator, instructor, 
                   3861:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3862: 
                   3863:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3864:         my ($cdom,$cnum);
                   3865:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3866:             $cdom = $env{'course.'.$course.'.domain'};
                   3867:             $cnum = $env{'course.'.$course.'.num'};
                   3868:         } else {
1.490     raeburn  3869:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3870:         }
                   3871:         my $no_ownblock = 0;
                   3872:         my $no_userblock = 0;
1.533     raeburn  3873:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3874:             # Check if current user has 'evb' priv for this
                   3875:             if (defined($own_courses{$course})) {
                   3876:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3877:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3878:                     if ($sec ne 'none') {
                   3879:                         $checkrole .= '/'.$sec;
                   3880:                     }
                   3881:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3882:                         $no_ownblock = 1;
                   3883:                         last;
                   3884:                     }
                   3885:                 }
                   3886:             }
                   3887:             # if they have 'evb' priv and are currently not playing student
                   3888:             next if (($no_ownblock) &&
                   3889:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3890:         }
1.474     raeburn  3891:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3892:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3893:             if ($sec ne 'none') {
1.482     raeburn  3894:                 $checkrole .= '/'.$sec;
1.474     raeburn  3895:             }
1.490     raeburn  3896:             if ($otheruser) {
                   3897:                 # Resource belongs to user other than current user.
                   3898:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3899:                 my ($trole,$tdom,$tnum,$tsec);
                   3900:                 my $entry = $live_courses{$course}{$sec};
                   3901:                 if ($entry =~ /^cr/) {
                   3902:                     ($trole,$tdom,$tnum,$tsec) = 
                   3903:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3904:                 } else {
                   3905:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3906:                 }
                   3907:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3908:                 $area = '/'.$tdom.'/'.$tnum;
                   3909:                 $trest = $tnum;
                   3910:                 if ($tsec ne '') {
                   3911:                     $area .= '/'.$tsec;
                   3912:                     $trest .= '/'.$tsec;
                   3913:                 }
                   3914:                 $spec = $trole.'.'.$area;
                   3915:                 if ($trole =~ /^cr/) {
                   3916:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3917:                                                       $tdom,$spec,$trest,$area);
                   3918:                 } else {
                   3919:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3920:                                                        $tdom,$spec,$trest,$area);
                   3921:                 }
                   3922:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3923:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3924:                     if ($1) {
                   3925:                         $no_userblock = 1;
                   3926:                         last;
                   3927:                     }
                   3928:                 }
1.490     raeburn  3929:             } else {
                   3930:                 # Resource belongs to current user
                   3931:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3932:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3933:                     $no_ownblock = 1;
                   3934:                     last;
                   3935:                 }
1.474     raeburn  3936:             }
                   3937:         }
                   3938:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3939:         next if (($no_ownblock) &&
1.491     albertel 3940:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3941:         next if ($no_userblock);
1.474     raeburn  3942: 
1.866     kalberla 3943:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3944:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3945:         
                   3946:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3947:         if (($start != 0) && 
                   3948:             (($startblock == 0) || ($startblock > $start))) {
                   3949:             $startblock = $start;
                   3950:         }
                   3951:         if (($end != 0)  &&
                   3952:             (($endblock == 0) || ($endblock < $end))) {
                   3953:             $endblock = $end;
                   3954:         }
1.490     raeburn  3955:     }
                   3956:     return ($startblock,$endblock);
                   3957: }
                   3958: 
                   3959: sub get_blocks {
                   3960:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3961:     my $startblock = 0;
                   3962:     my $endblock = 0;
                   3963:     my $course = $cdom.'_'.$cnum;
                   3964:     $setters->{$course} = {};
                   3965:     $setters->{$course}{'staff'} = [];
                   3966:     $setters->{$course}{'times'} = [];
                   3967:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3968:     foreach my $record (keys(%records)) {
                   3969:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3970:         if ($start <= time && $end >= time) {
                   3971:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3972:                 &parse_block_record($records{$record});
                   3973:             if ($blocks->{$activity} eq 'on') {
                   3974:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3975:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3976:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3977:                     $startblock = $start;
1.490     raeburn  3978:                 }
1.491     albertel 3979:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3980:                     $endblock = $end;
1.474     raeburn  3981:                 }
                   3982:             }
                   3983:         }
                   3984:     }
                   3985:     return ($startblock,$endblock);
                   3986: }
                   3987: 
                   3988: sub parse_block_record {
                   3989:     my ($record) = @_;
                   3990:     my ($setuname,$setudom,$title,$blocks);
                   3991:     if (ref($record) eq 'HASH') {
                   3992:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3993:         $title = &unescape($record->{'event'});
                   3994:         $blocks = $record->{'blocks'};
                   3995:     } else {
                   3996:         my @data = split(/:/,$record,3);
                   3997:         if (scalar(@data) eq 2) {
                   3998:             $title = $data[1];
                   3999:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4000:         } else {
                   4001:             ($setuname,$setudom,$title) = @data;
                   4002:         }
                   4003:         $blocks = { 'com' => 'on' };
                   4004:     }
                   4005:     return ($setuname,$setudom,$title,$blocks);
                   4006: }
                   4007: 
1.854     kalberla 4008: sub blocking_status {
                   4009:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 4010:   my %setters;
1.890     droeschl 4011: 
                   4012:   # check for active blocking
1.867     kalberla 4013:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4014: 
1.890     droeschl 4015:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4016: 
                   4017:   # caller just wants to know whether a block is active
                   4018:   if (!wantarray) { return $blocked; }
                   4019: 
                   4020:   # build a link to a popup window containing the details
                   4021:   my $querystring  = "?activity=$activity";
                   4022:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4023:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4024:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4025: 
                   4026:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4027:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4028:         var options = "width=" + w + ",height=" + h + ",";
                   4029:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4030:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4031:         var newWin = window.open(url, wdwName, options);
                   4032:         newWin.focus();
                   4033:     }
1.890     droeschl 4034: END_MYBLOCK
1.854     kalberla 4035: 
1.890     droeschl 4036:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4037:   
1.854     kalberla 4038:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4039:   my $text = mt('Communication Blocked');
                   4040: 
1.867     kalberla 4041:   $output .= <<"END_BLOCK";
                   4042: <div class='LC_comblock'>
1.869     kalberla 4043:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4044:   title='$text'>
                   4045:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4046:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4047:   title='$text'>$text</a>
1.867     kalberla 4048: </div>
                   4049: 
                   4050: END_BLOCK
1.474     raeburn  4051: 
1.854     kalberla 4052:   return ($blocked, $output);
                   4053: }
1.490     raeburn  4054: 
1.60      matthew  4055: ###############################################
                   4056: 
1.682     raeburn  4057: sub check_ip_acc {
                   4058:     my ($acc)=@_;
                   4059:     &Apache::lonxml::debug("acc is $acc");
                   4060:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4061:         return 1;
                   4062:     }
                   4063:     my $allowed=0;
                   4064:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4065: 
                   4066:     my $name;
                   4067:     foreach my $pattern (split(',',$acc)) {
                   4068:         $pattern =~ s/^\s*//;
                   4069:         $pattern =~ s/\s*$//;
                   4070:         if ($pattern =~ /\*$/) {
                   4071:             #35.8.*
                   4072:             $pattern=~s/\*//;
                   4073:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4074:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4075:             #35.8.3.[34-56]
                   4076:             my $low=$2;
                   4077:             my $high=$3;
                   4078:             $pattern=$1;
                   4079:             if ($ip =~ /^\Q$pattern\E/) {
                   4080:                 my $last=(split(/\./,$ip))[3];
                   4081:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4082:             }
                   4083:         } elsif ($pattern =~ /^\*/) {
                   4084:             #*.msu.edu
                   4085:             $pattern=~s/\*//;
                   4086:             if (!defined($name)) {
                   4087:                 use Socket;
                   4088:                 my $netaddr=inet_aton($ip);
                   4089:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4090:             }
                   4091:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4092:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4093:             #127.0.0.1
                   4094:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4095:         } else {
                   4096:             #some.name.com
                   4097:             if (!defined($name)) {
                   4098:                 use Socket;
                   4099:                 my $netaddr=inet_aton($ip);
                   4100:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4101:             }
                   4102:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4103:         }
                   4104:         if ($allowed) { last; }
                   4105:     }
                   4106:     return $allowed;
                   4107: }
                   4108: 
                   4109: ###############################################
                   4110: 
1.60      matthew  4111: =pod
                   4112: 
1.112     bowersj2 4113: =head1 Domain Template Functions
                   4114: 
                   4115: =over 4
                   4116: 
                   4117: =item * &determinedomain()
1.60      matthew  4118: 
                   4119: Inputs: $domain (usually will be undef)
                   4120: 
1.63      www      4121: Returns: Determines which domain should be used for designs
1.60      matthew  4122: 
                   4123: =cut
1.54      www      4124: 
1.60      matthew  4125: ###############################################
1.63      www      4126: sub determinedomain {
                   4127:     my $domain=shift;
1.531     albertel 4128:     if (! $domain) {
1.60      matthew  4129:         # Determine domain if we have not been given one
1.893     raeburn  4130:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4131:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4132:         if ($env{'request.role.domain'}) { 
                   4133:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4134:         }
                   4135:     }
1.63      www      4136:     return $domain;
                   4137: }
                   4138: ###############################################
1.517     raeburn  4139: 
1.518     albertel 4140: sub devalidate_domconfig_cache {
                   4141:     my ($udom)=@_;
                   4142:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4143: }
                   4144: 
                   4145: # ---------------------- Get domain configuration for a domain
                   4146: sub get_domainconf {
                   4147:     my ($udom) = @_;
                   4148:     my $cachetime=1800;
                   4149:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4150:     if (defined($cached)) { return %{$result}; }
                   4151: 
                   4152:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4153: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4154:     my (%designhash,%legacy);
1.518     albertel 4155:     if (keys(%domconfig) > 0) {
                   4156:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4157:             if (keys(%{$domconfig{'login'}})) {
                   4158:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4159:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4160:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4161:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4162:                                 $domconfig{'login'}{$key}{$img};
                   4163:                         }
                   4164:                     } else {
                   4165:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4166:                     }
1.632     raeburn  4167:                 }
                   4168:             } else {
                   4169:                 $legacy{'login'} = 1;
1.518     albertel 4170:             }
1.632     raeburn  4171:         } else {
                   4172:             $legacy{'login'} = 1;
1.518     albertel 4173:         }
                   4174:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4175:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4176:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4177:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4178:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4179:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4180:                         }
1.518     albertel 4181:                     }
                   4182:                 }
1.632     raeburn  4183:             } else {
                   4184:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4185:             }
1.632     raeburn  4186:         } else {
                   4187:             $legacy{'rolecolors'} = 1;
1.518     albertel 4188:         }
1.632     raeburn  4189:         if (keys(%legacy) > 0) {
                   4190:             my %legacyhash = &get_legacy_domconf($udom);
                   4191:             foreach my $item (keys(%legacyhash)) {
                   4192:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4193:                     if ($legacy{'login'}) { 
                   4194:                         $designhash{$item} = $legacyhash{$item};
                   4195:                     }
                   4196:                 } else {
                   4197:                     if ($legacy{'rolecolors'}) {
                   4198:                         $designhash{$item} = $legacyhash{$item};
                   4199:                     }
1.518     albertel 4200:                 }
                   4201:             }
                   4202:         }
1.632     raeburn  4203:     } else {
                   4204:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4205:     }
                   4206:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4207: 				  $cachetime);
                   4208:     return %designhash;
                   4209: }
                   4210: 
1.632     raeburn  4211: sub get_legacy_domconf {
                   4212:     my ($udom) = @_;
                   4213:     my %legacyhash;
                   4214:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4215:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4216:     if (-e $designfile) {
                   4217:         if ( open (my $fh,"<$designfile") ) {
                   4218:             while (my $line = <$fh>) {
                   4219:                 next if ($line =~ /^\#/);
                   4220:                 chomp($line);
                   4221:                 my ($key,$val)=(split(/\=/,$line));
                   4222:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4223:             }
                   4224:             close($fh);
                   4225:         }
                   4226:     }
                   4227:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4228:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4229:     }
                   4230:     return %legacyhash;
                   4231: }
                   4232: 
1.63      www      4233: =pod
                   4234: 
1.112     bowersj2 4235: =item * &domainlogo()
1.63      www      4236: 
                   4237: Inputs: $domain (usually will be undef)
                   4238: 
                   4239: Returns: A link to a domain logo, if the domain logo exists.
                   4240: If the domain logo does not exist, a description of the domain.
                   4241: 
                   4242: =cut
1.112     bowersj2 4243: 
1.63      www      4244: ###############################################
                   4245: sub domainlogo {
1.517     raeburn  4246:     my $domain = &determinedomain(shift);
1.518     albertel 4247:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4248:     # See if there is a logo
                   4249:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4250:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4251:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4252: 	    if ($imgsrc =~ m{^/res/}) {
                   4253: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4254: 		&Apache::lonnet::repcopy($local_name);
                   4255: 	    }
                   4256: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4257:         } 
                   4258:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4259:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4260:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4261:     } else {
1.60      matthew  4262:         return '';
1.59      www      4263:     }
                   4264: }
1.63      www      4265: ##############################################
                   4266: 
                   4267: =pod
                   4268: 
1.112     bowersj2 4269: =item * &designparm()
1.63      www      4270: 
                   4271: Inputs: $which parameter; $domain (usually will be undef)
                   4272: 
                   4273: Returns: value of designparamter $which
                   4274: 
                   4275: =cut
1.112     bowersj2 4276: 
1.397     albertel 4277: 
1.400     albertel 4278: ##############################################
1.397     albertel 4279: sub designparm {
                   4280:     my ($which,$domain)=@_;
                   4281:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4282:         return $env{'environment.color.'.$which};
1.96      www      4283:     }
1.63      www      4284:     $domain=&determinedomain($domain);
1.518     albertel 4285:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4286:     my $output;
1.517     raeburn  4287:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4288:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4289:     } else {
1.520     raeburn  4290:         $output = $defaultdesign{$which};
                   4291:     }
                   4292:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4293:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4294:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4295:             if ($output =~ m{^/res/}) {
                   4296:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4297:                 &Apache::lonnet::repcopy($local_name);
                   4298:             }
1.520     raeburn  4299:             $output = &lonhttpdurl($output);
                   4300:         }
1.63      www      4301:     }
1.520     raeburn  4302:     return $output;
1.63      www      4303: }
1.59      www      4304: 
1.822     bisitz   4305: ##############################################
                   4306: =pod
                   4307: 
1.832     bisitz   4308: =item * &authorspace()
                   4309: 
                   4310: Inputs: ./.
                   4311: 
                   4312: Returns: Path to the Construction Space of the current user's
                   4313:          accessed author space
                   4314:          The author space will be that of the current user
                   4315:          when accessing the own author space
                   4316:          and that of the co-author/assistent co-author
                   4317:          when accessing the co-author's/assistent co-author's
                   4318:          space
                   4319: 
                   4320: =cut
                   4321: 
                   4322: sub authorspace {
                   4323:     my $caname = '';
                   4324:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4325:         (undef,$caname) =
                   4326:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4327:     } else {
                   4328:         $caname = $env{'user.name'};
                   4329:     }
                   4330:     return '/priv/'.$caname.'/';
                   4331: }
                   4332: 
                   4333: ##############################################
                   4334: =pod
                   4335: 
1.822     bisitz   4336: =item * &head_subbox()
                   4337: 
                   4338: Inputs: $content (contains HTML code with page functions, etc.)
                   4339: 
                   4340: Returns: HTML div with $content
                   4341:          To be included in page header
                   4342: 
                   4343: =cut
                   4344: 
                   4345: sub head_subbox {
                   4346:     my ($content)=@_;
                   4347:     my $output =
1.844     bisitz   4348:         '<div id="LC_head_subbox">'
1.822     bisitz   4349:        .$content
                   4350:        .'</div>'
                   4351: }
                   4352: 
                   4353: ##############################################
                   4354: =pod
                   4355: 
                   4356: =item * &CSTR_pageheader()
                   4357: 
                   4358: Inputs: ./.
                   4359: 
                   4360: Returns: HTML div with CSTR path and recent box
                   4361:          To be included on Construction Space pages
                   4362: 
                   4363: =cut
                   4364: 
                   4365: sub CSTR_pageheader {
                   4366:     # this is for resources; directories have customtitle, and crumbs
                   4367:             # and select recent are created in lonpubdir.pm  
                   4368:     my ($uname,$thisdisfn)=
                   4369:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4370:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4371:     $formaction=~s/\/+/\//g;
                   4372: 
                   4373:     my $parentpath = '';
                   4374:     my $lastitem = '';
                   4375:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4376:         $parentpath = $1;
                   4377:         $lastitem = $2;
                   4378:     } else {
                   4379:         $lastitem = $thisdisfn;
                   4380:     }
1.921     bisitz   4381: 
                   4382:     my $output =
1.822     bisitz   4383:          '<div>'
                   4384:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4385:         .'<b>'.&mt('Construction Space:').'</b> '
                   4386:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4387:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
                   4388:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef);
                   4389: 
                   4390:     if ($lastitem) {
                   4391:         $output .=
                   4392:              '<span class="LC_filename">'
                   4393:             .$lastitem
                   4394:             .'</span>';
                   4395:     }
                   4396:     $output .=
                   4397:          '<br />'
1.822     bisitz   4398:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4399:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4400:         .'</form>'
                   4401:         .&Apache::lonmenu::constspaceform()
                   4402:         .'</div>';
1.921     bisitz   4403: 
                   4404:     return $output;
1.822     bisitz   4405: }
                   4406: 
1.60      matthew  4407: ###############################################
                   4408: ###############################################
                   4409: 
                   4410: =pod
                   4411: 
1.112     bowersj2 4412: =back
                   4413: 
1.549     albertel 4414: =head1 HTML Helpers
1.112     bowersj2 4415: 
                   4416: =over 4
                   4417: 
                   4418: =item * &bodytag()
1.60      matthew  4419: 
                   4420: Returns a uniform header for LON-CAPA web pages.
                   4421: 
                   4422: Inputs: 
                   4423: 
1.112     bowersj2 4424: =over 4
                   4425: 
                   4426: =item * $title, A title to be displayed on the page.
                   4427: 
                   4428: =item * $function, the current role (can be undef).
                   4429: 
                   4430: =item * $addentries, extra parameters for the <body> tag.
                   4431: 
                   4432: =item * $bodyonly, if defined, only return the <body> tag.
                   4433: 
                   4434: =item * $domain, if defined, force a given domain.
                   4435: 
                   4436: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4437:             text interface only)
1.60      matthew  4438: 
1.814     bisitz   4439: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4440:                      navigational links
1.317     albertel 4441: 
1.338     albertel 4442: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4443: 
1.361     albertel 4444: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4445:          'Switch To Inline Menu' link
                   4446: 
1.460     albertel 4447: =item * $args, optional argument valid values are
                   4448:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4449:             inherit_jsmath -> when creating popup window in a page,
                   4450:                               should it have jsmath forced on by the
                   4451:                               current page
1.460     albertel 4452: 
1.112     bowersj2 4453: =back
                   4454: 
1.60      matthew  4455: Returns: A uniform header for LON-CAPA web pages.  
                   4456: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4457: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4458: other decorations will be returned.
                   4459: 
                   4460: =cut
                   4461: 
1.54      www      4462: sub bodytag {
1.831     bisitz   4463:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4464:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4465: 
1.460     albertel 4466:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4467: 
1.183     matthew  4468:     $function = &get_users_function() if (!$function);
1.339     albertel 4469:     my $img =    &designparm($function.'.img',$domain);
                   4470:     my $font =   &designparm($function.'.font',$domain);
                   4471:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4472: 
1.803     bisitz   4473:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4474: 		   'bgcolor' => $pgbg,
1.339     albertel 4475: 		   'text'    => $font,
                   4476:                    'alink'   => &designparm($function.'.alink',$domain),
                   4477: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4478: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4479:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4480: 
1.925.2.4  raeburn  4481:     my $custommenu;
                   4482:     if ($env{'environment.remote'} eq 'off') {
                   4483:         $custommenu = &needs_gci_custom();
                   4484:     }
1.63      www      4485:  # role and realm
1.378     raeburn  4486:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4487:     if ($role  eq 'ca') {
1.479     albertel 4488:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4489:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4490:     } 
1.55      www      4491: # realm
1.258     albertel 4492:     if ($env{'request.course.id'}) {
1.378     raeburn  4493:         if ($env{'request.role'} !~ /^cr/) {
1.925.2.4  raeburn  4494:             if (($custommenu) && ($role eq 'cm')) {
                   4495:                 undef($role);
                   4496:             } else {
                   4497:                 $role = &Apache::lonnet::plaintext($role,&course_type());
                   4498:             }
1.378     raeburn  4499:         }
1.898     raeburn  4500:         if ($env{'request.course.sec'}) {
                   4501:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4502:         }   
1.359     albertel 4503: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4504:     } else {
1.925.2.4  raeburn  4505:         if (($custommenu) && ($role eq 'cm')) {
                   4506:             undef($role);
                   4507:         } else {
                   4508:             $role = &Apache::lonnet::plaintext($role);
                   4509:         }
1.54      www      4510:     }
1.433     albertel 4511: 
1.359     albertel 4512:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4513: # Set messages
1.60      matthew  4514:     my $messages=&domainlogo($domain);
1.330     albertel 4515: 
1.438     albertel 4516:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4517: 
1.101     www      4518: # construct main body tag
1.359     albertel 4519:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4520: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4521: 
1.530     albertel 4522:     if ($bodyonly) {
1.60      matthew  4523:         return $bodytag;
1.798     tempelho 4524:     } 
1.359     albertel 4525: 
1.410     albertel 4526:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4527:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4528: 	undef($role);
1.434     albertel 4529:     } else {
                   4530: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4531:     }
1.359     albertel 4532:     
1.762     bisitz   4533:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4534:     #
                   4535:     # Extra info if you are the DC
                   4536:     my $dc_info = '';
                   4537:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4538:                         $env{'course.'.$env{'request.course.id'}.
                   4539:                                  '.domain'}.'/'})) {
                   4540:         my $cid = $env{'request.course.id'};
1.917     raeburn  4541:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4542:         $dc_info =~ s/\s+$//;
1.359     albertel 4543:     }
                   4544: 
1.898     raeburn  4545:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4546:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4547: 
1.837     bisitz   4548:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4549:         # No Remote
1.916     droeschl 4550:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4551:             return $bodytag; 
                   4552:         } 
1.903     droeschl 4553: 
                   4554:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4555: 
                   4556:         #    if ($env{'request.state'} eq 'construct') {
                   4557:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4558:         #    }
                   4559: 
1.925.2.4  raeburn  4560:         my $role_selector;
                   4561:         if (($custommenu) && ($env{'request.course.id'}) && 
1.925.2.14  raeburn  4562:             ($env{'course.'.$env{'request.course.id'}.'.domain'} eq 'gcitest')) {
1.925.2.4  raeburn  4563:             $role_selector = &Apache::lonmenu::roles_selector(
                   4564:                         $env{'course.' . $env{'request.course.id'} . '.domain'},
                   4565:                         $env{'course.' . $env{'request.course.id'} . '.num'}  );
                   4566:             if ($role_selector) {
                   4567:                 $role_selector = '<br />'.$role_selector;
                   4568:             }
                   4569:         }
1.925.2.14  raeburn  4570:         my $cid = $env{'request.course.id'};
                   4571:         my %gcicourses = (
                   4572:                            gci_9615072b469884921gcil1 => 'review',
                   4573:                            gci_1H96711d710194bfegcil1 => 'submit',
                   4574:                            gci_5422913620b814c90gcil1 => 'tutorial',
                   4575:                          );
                   4576:         if (($custommenu && $cid && !$gcicourses{$cid}) || ($env{'user.domain'} eq 'gcitest')) {
                   4577:             my $role = 'st';
                   4578:             if ($custommenu) {
                   4579:                 $role = 'cc';
                   4580:             }
                   4581:             my ($switcher_js,$switcher,$formname);
                   4582:             $formname = 'pickrole';
                   4583:             my %courses = &existing_gcitest_courses($role);
                   4584:             my $numcourses = keys(%courses);
                   4585:             my $reqdcount = 0;
                   4586:             if ($cid) {
                   4587:                 if ($courses{$cid}) {
                   4588:                     $reqdcount = 1; 
                   4589:                 }
                   4590:             }
                   4591:             if ($numcourses > $reqdcount) {
                   4592:                 $switcher = &gcitest_switcher($role,$formname,%courses);
                   4593:                 my $current;
                   4594:                 if ($cid) {
                   4595:                     $current = $role.'./'.$env{'course.'.$cid.'.domain'}.
                   4596:                                '/'.$env{'course.'.$cid.'.num'};
                   4597:                 }
                   4598:                 $switcher_js = &Apache::loncommon::gcitest_switcher_js($current,$numcourses,$formname);
                   4599:                 if ($switcher_js) {  
                   4600:                     $switcher_js= <<"ENDSCRIPT";
                   4601: <script type="text/javascript">
                   4602: // <![CDATA[
                   4603: 
                   4604: $switcher_js
                   4605: 
                   4606: // ]]>
                   4607: </script>
                   4608: ENDSCRIPT
                   4609:                 }
                   4610:             }
                   4611:             if ($switcher) {
                   4612:                 $switcher = $switcher_js.$switcher;
                   4613:                 if ($role_selector) {
                   4614:                     $role_selector .= '&nbsp;&nbsp;&nbsp;'.$switcher;
                   4615:                 } else {
                   4616:                     $role_selector .= '<br />'.$switcher;
                   4617:                 }
                   4618:             }
                   4619:         }
1.359     albertel 4620: 
1.916     droeschl 4621:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4622:              if ($dc_info) {
                   4623:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4624:              }
1.916     droeschl 4625:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4626:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4627:             return $bodytag;
                   4628:         }
1.894     droeschl 4629: 
1.925.2.14  raeburn  4630:         if ($cid && $gcicourses{$cid} eq 'tutorial') {
                   4631:             $bodytag .= '<div class="LC_page_header">';
                   4632:         } 
1.925.2.4  raeburn  4633:         $bodytag .= qq|<div id="LC_nav_bar">$name $role $role_selector</div>|;
1.916     droeschl 4634: 
1.903     droeschl 4635:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.925.2.2  raeburn  4636:             Apache::lonmenu::utilityfunctions('',$custommenu), 'start');
1.816     bisitz   4637: 
1.903     droeschl 4638:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4639: 
1.917     raeburn  4640:         if ($dc_info) {
                   4641:             $dc_info = &dc_courseid_toggle($dc_info);
                   4642:         }
                   4643:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.925.2.14  raeburn  4644:         if ($cid && $gcicourses{$cid} eq 'tutorial') {
                   4645:             $bodytag .= '</div>';
                   4646:         }
1.916     droeschl 4647: 
1.903     droeschl 4648:         #don't show menus for public users
                   4649:         if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
1.925.2.5  raeburn  4650:             if (($custommenu) && 
                   4651:                 ($env{'request.role'} !~ m{^st\./gcitest/$match_courseid})) {
1.925.2.2  raeburn  4652:                 $bodytag .= &Apache::lonmenu::gci_secondary_menu();
1.925.2.16! raeburn  4653:             } elsif ($env{'request.role'} ne 'cm' || &check_for_gci_dc()) {    
1.925.2.2  raeburn  4654:                 $bodytag .= Apache::lonmenu::secondary_menu();
                   4655:             }
1.903     droeschl 4656:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4657:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4658:             if ($env{'request.state'} eq 'construct') {
                   4659:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,'',
                   4660:                                 $args->{'bread_crumbs'});
                   4661:             } elsif ($forcereg) { 
                   4662:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
1.925.2.14  raeburn  4663:             } elsif ($custommenu && $env{'request.course.id'} && 
                   4664:                      &Apache::lonnet::allowed('mdc', $env{'request.course.id'})) {
1.925.2.16! raeburn  4665:                 if (($env{'request.noversionuri'} eq '/adm/navmaps') ||
        !          4666:                     ($env{'request.noversionuri'} eq '/adm/coursedocs') ||
        !          4667:                     ($env{'request.noversionuri'} eq '/adm/createuser') ||
        !          4668:                     ($env{'request.noversionuri'} eq '/adm/whatsnew') ||
        !          4669:                     ($env{'request.noversionuri'} eq '/cgi-bin/printout.pl') ||
        !          4670:                     ($env{'request.noversionuri'} eq '/adm/printout') ||
        !          4671:                     ($env{'request.noversionuri'} eq '/adm/statistics')) {
        !          4672: 
1.925.2.14  raeburn  4673:                     my @advtools = &concept_test_manager();
1.925.2.16! raeburn  4674:                     &Apache::lonhtmlcommon::clear_breadcrumbs();
1.925.2.14  raeburn  4675:                     &Apache::lonhtmlcommon::add_breadcrumb_tool(
                   4676:                                       'advtools',@advtools);
                   4677:                     my $advlinks;
                   4678:                     my $legendtext = '<a class="LC_menubuttons_link" href="/adm/menu">'.&mt('Management').'</a>';
                   4679:                     &Apache::lonhtmlcommon::render_advtools(\$advlinks,$legendtext);
                   4680:                     $bodytag .= $advlinks;
                   4681:                 }
1.920     raeburn  4682:             }
1.903     droeschl 4683:         }else{
                   4684:             # this is to seperate menu from content when there's no secondary
                   4685:             # menu. Especially needed for public accessible ressources.
                   4686:             $bodytag .= '<hr style="clear:both" />';
                   4687:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4688:         }
1.903     droeschl 4689: 
1.235     raeburn  4690:         return $bodytag;
1.94      www      4691:     }
1.95      www      4692: 
1.93      www      4693: #
1.95      www      4694: # Top frame rendering, Remote is up
1.93      www      4695: #
1.359     albertel 4696: 
1.517     raeburn  4697:     my $imgsrc = $img;
                   4698:     if ($img =~ /^\/adm/) {
1.575     albertel 4699:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4700:     }
                   4701:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4702: 
1.305     www      4703:     # Explicit link to get inline menu
1.361     albertel 4704:     my $menu= ($no_inline_link?''
1.883     droeschl 4705: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917     raeburn  4706: 
                   4707:     if ($dc_info) {
                   4708:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   4709:     }
                   4710: 
1.916     droeschl 4711:     $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897     wenzelju 4712:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4713:                 <li>$menu</li>
1.917     raeburn  4714:             </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94      www      4715:     return(<<ENDBODY);
1.60      matthew  4716: $bodytag
1.359     albertel 4717: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4718: <tr><td>$upperleft</td>
                   4719:     <td>$messages&nbsp;</td>
1.54      www      4720: </tr>
1.359     albertel 4721: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4722: </tr>
1.356     albertel 4723: </table>
1.54      www      4724: ENDBODY
1.182     matthew  4725: }
                   4726: 
1.925.2.14  raeburn  4727: sub concept_test_manager {
                   4728:     my @advtools;
                   4729:     my  %items = (
                   4730:                    docs => { 
                   4731:                               desc    => 'Edit Test',
                   4732:                               action  => "go('/adm/coursedocs')",
                   4733:                               tooltip => 'Assemble or modify Concept Test'
                   4734:                            },
                   4735:                    cprv => {
                   4736:                               desc => 'Enrollment/Activity',
                   4737:                               action => "go('/adm/createuser')",
                   4738:                               tooltip => 'Enrollment and student activity',
                   4739:                            },
                   4740:                    new => { 
                   4741:                               desc   => "What's New?",
                   4742:                               action => "go('/adm/whatsnew')",
                   4743:                               tooltip => 'Recent events/action items in Concept Test' ,
                   4744:                            },
                   4745:                    prnt => {
                   4746:                               desc => 'Print Test',
                   4747:                               action => "go('/adm/printout');",
                   4748:                               tooltip => 'Prepare printable Concept Test',
                   4749:                            },
                   4750:                    chrt => { 
                   4751:                               desc   => 'Test Statistics',
                   4752:                               action => "go('/adm/statistics');",
                   4753:                               tooltip => 'Concept Test Statistics',
                   4754:                            },
                   4755:                    rcrs => {
                   4756:                               desc   => 'Create New Test',
                   4757:                               action  => "switchpage('createtest');",
                   4758:                               tooltip => 'Create new Concept Test',
                   4759:                            },
                   4760:                  );
                   4761:     my @ordered = ('docs','cprv','new','prnt','chrt','rcrs');
                   4762:     foreach my $item (@ordered) {
                   4763:          push(@advtools,
                   4764:                   '<a title="'.$items{$item}{tooltip}.'" class="LC_menubuttons_link" href="javascript:'.
                   4765:                   $items{$item}{action}.';">'.
                   4766:                   '<img src="'.'/res/adm/pages/'.$item.'22.png" alt="'.$items{$item}{tooltip}.
                   4767:                   '" border="0" class="LC_icon" />'.
                   4768:                   '<span class="LC_menubuttons_inline_text">'.$items{$item}{desc}.'</span></a>');
                   4769:     }
                   4770:     return @advtools;
                   4771: }
                   4772: 
1.917     raeburn  4773: sub dc_courseid_toggle {
                   4774:     my ($dc_info) = @_;
                   4775:     return ' <span id="dccidtext" class="LC_cusr_subheading">'.
                   4776:            '<a href="javascript:showCourseID();">'.
                   4777:            &mt('(More ...)').'</a></span>'.
                   4778:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4779: }
                   4780: 
1.330     albertel 4781: sub make_attr_string {
                   4782:     my ($register,$attr_ref) = @_;
                   4783: 
                   4784:     if ($attr_ref && !ref($attr_ref)) {
                   4785: 	die("addentries Must be a hash ref ".
                   4786: 	    join(':',caller(1))." ".
                   4787: 	    join(':',caller(0))." ");
                   4788:     }
                   4789: 
                   4790:     if ($register) {
1.339     albertel 4791: 	my ($on_load,$on_unload);
                   4792: 	foreach my $key (keys(%{$attr_ref})) {
                   4793: 	    if      (lc($key) eq 'onload') {
                   4794: 		$on_load.=$attr_ref->{$key}.';';
                   4795: 		delete($attr_ref->{$key});
                   4796: 
                   4797: 	    } elsif (lc($key) eq 'onunload') {
                   4798: 		$on_unload.=$attr_ref->{$key}.';';
                   4799: 		delete($attr_ref->{$key});
                   4800: 	    }
                   4801: 	}
                   4802: 	$attr_ref->{'onload'}  =
                   4803: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4804: 	$attr_ref->{'onunload'}=
                   4805: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4806:     }
                   4807: 
                   4808: # Accessibility font enhance
                   4809:     if ($env{'browser.fontenhance'} eq 'on') {
                   4810: 	my $style;
                   4811: 	foreach my $key (keys(%{$attr_ref})) {
                   4812: 	    if (lc($key) eq 'style') {
                   4813: 		$style.=$attr_ref->{$key}.';';
                   4814: 		delete($attr_ref->{$key});
                   4815: 	    }
                   4816: 	}
                   4817: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4818:     }
1.339     albertel 4819: 
1.330     albertel 4820:     my $attr_string;
                   4821:     foreach my $attr (keys(%$attr_ref)) {
                   4822: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4823:     }
                   4824:     return $attr_string;
                   4825: }
                   4826: 
                   4827: 
1.182     matthew  4828: ###############################################
1.251     albertel 4829: ###############################################
                   4830: 
                   4831: =pod
                   4832: 
                   4833: =item * &endbodytag()
                   4834: 
                   4835: Returns a uniform footer for LON-CAPA web pages.
                   4836: 
1.635     raeburn  4837: Inputs: 1 - optional reference to an args hash
                   4838: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4839: a 'Continue' link is not displayed if the page contains an
                   4840: internal redirect in the <head></head> section,
                   4841: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4842: 
                   4843: =cut
                   4844: 
                   4845: sub endbodytag {
1.635     raeburn  4846:     my ($args) = @_;
1.251     albertel 4847:     my $endbodytag='</body>';
1.269     albertel 4848:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4849:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4850:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4851: 	    $endbodytag=
                   4852: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4853: 	        &mt('Continue').'</a>'.
                   4854: 	        $endbodytag;
                   4855:         }
1.315     albertel 4856:     }
1.251     albertel 4857:     return $endbodytag;
                   4858: }
                   4859: 
1.352     albertel 4860: =pod
                   4861: 
                   4862: =item * &standard_css()
                   4863: 
                   4864: Returns a style sheet
                   4865: 
                   4866: Inputs: (all optional)
                   4867:             domain         -> force to color decorate a page for a specific
                   4868:                                domain
                   4869:             function       -> force usage of a specific rolish color scheme
                   4870:             bgcolor        -> override the default page bgcolor
                   4871: 
                   4872: =cut
                   4873: 
1.343     albertel 4874: sub standard_css {
1.345     albertel 4875:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4876:     $function  = &get_users_function() if (!$function);
                   4877:     my $img    = &designparm($function.'.img',   $domain);
                   4878:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4879:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4880:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4881: #second colour for later usage
1.345     albertel 4882:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4883:     my $pgbg_or_bgcolor =
                   4884: 	         $bgcolor ||
1.352     albertel 4885: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4886:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4887:     my $alink  = &designparm($function.'.alink', $domain);
                   4888:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4889:     my $link   = &designparm($function.'.link',  $domain);
                   4890: 
1.704     muellerd 4891:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4892:     my $bgcol = &designparm('login.bgcol',$domain);
                   4893:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4894: 
1.602     albertel 4895:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4896:     my $mono                 = 'monospace';
1.850     bisitz   4897:     my $data_table_head      = $sidebg;
                   4898:     my $data_table_light     = '#FAFAFA';
                   4899:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4900:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4901:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4902:     my $mail_new             = '#FFBB77';
                   4903:     my $mail_new_hover       = '#DD9955';
                   4904:     my $mail_read            = '#BBBB77';
                   4905:     my $mail_read_hover      = '#999944';
                   4906:     my $mail_replied         = '#AAAA88';
                   4907:     my $mail_replied_hover   = '#888855';
                   4908:     my $mail_other           = '#99BBBB';
                   4909:     my $mail_other_hover     = '#669999';
1.391     albertel 4910:     my $table_header         = '#DDDDDD';
1.489     raeburn  4911:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4912:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4913: 
1.608     albertel 4914:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4915:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4916:                                              : '0 3px 0 4px';
1.448     albertel 4917: 
1.523     albertel 4918: 
1.343     albertel 4919:     return <<END;
1.795     www      4920: body {
1.911     bisitz   4921:   font-family: $sans;
                   4922:   line-height:130%;
                   4923:   font-size:0.83em;
                   4924:   color:$font;
1.795     www      4925: }
                   4926: 
1.911     bisitz   4927: a:focus {
1.795     www      4928:   color: red;
1.911     bisitz   4929:   background: yellow;
1.795     www      4930: }
1.698     harmsja  4931: 
1.911     bisitz   4932: form, .inline {
                   4933:   display: inline;
1.795     www      4934: }
1.721     harmsja  4935: 
1.795     www      4936: .LC_right {
1.911     bisitz   4937:   text-align:right;
1.795     www      4938: }
                   4939: 
                   4940: .LC_middle {
1.911     bisitz   4941:   vertical-align:middle;
1.795     www      4942: }
1.721     harmsja  4943: 
                   4944: /* just for tests */
1.911     bisitz   4945: .LC_400Box {
                   4946:   width:400px;
                   4947: }
1.721     harmsja  4948: /* end */
                   4949: 
1.778     bisitz   4950: .LC_filename {
                   4951:   font-family: $mono;
                   4952:   white-space:pre;
1.921     bisitz   4953:   font-size: 120%;
1.778     bisitz   4954: }
                   4955: 
                   4956: .LC_fileicon {
                   4957:   border: none;
                   4958:   height: 1.3em;
                   4959:   vertical-align: text-bottom;
                   4960:   margin-right: 0.3em;
                   4961:   text-decoration:none;
                   4962: }
                   4963: 
1.350     albertel 4964: .LC_error {
                   4965:   color: red;
                   4966:   font-size: larger;
                   4967: }
1.795     www      4968: 
1.457     albertel 4969: .LC_warning,
                   4970: .LC_diff_removed {
1.733     bisitz   4971:   color: red;
1.394     albertel 4972: }
1.532     albertel 4973: 
                   4974: .LC_info,
1.457     albertel 4975: .LC_success,
                   4976: .LC_diff_added {
1.350     albertel 4977:   color: green;
                   4978: }
1.795     www      4979: 
1.802     bisitz   4980: div.LC_confirm_box {
                   4981:   background-color: #FAFAFA;
                   4982:   border: 1px solid $lg_border_color;
                   4983:   margin-right: 0;
                   4984:   padding: 5px;
                   4985: }
                   4986: 
                   4987: div.LC_confirm_box .LC_error img,
                   4988: div.LC_confirm_box .LC_success img {
                   4989:   vertical-align: middle;
                   4990: }
                   4991: 
1.440     albertel 4992: .LC_icon {
1.771     droeschl 4993:   border: none;
1.790     droeschl 4994:   vertical-align: middle;
1.771     droeschl 4995: }
                   4996: 
1.543     albertel 4997: .LC_docs_spacer {
                   4998:   width: 25px;
                   4999:   height: 1px;
1.771     droeschl 5000:   border: none;
1.543     albertel 5001: }
1.346     albertel 5002: 
1.532     albertel 5003: .LC_internal_info {
1.735     bisitz   5004:   color: #999999;
1.532     albertel 5005: }
                   5006: 
1.794     www      5007: .LC_discussion {
1.911     bisitz   5008:   background: $tabbg;
                   5009:   border: 1px solid black;
                   5010:   margin: 2px;
1.794     www      5011: }
                   5012: 
                   5013: .LC_disc_action_links_bar {
1.911     bisitz   5014:   background: $tabbg;
                   5015:   border: none;
                   5016:   margin: 4px;
1.794     www      5017: }
                   5018: 
                   5019: .LC_disc_action_left {
1.911     bisitz   5020:   text-align: left;
1.794     www      5021: }
                   5022: 
                   5023: .LC_disc_action_right {
1.911     bisitz   5024:   text-align: right;
1.794     www      5025: }
                   5026: 
                   5027: .LC_disc_new_item {
1.911     bisitz   5028:   background: white;
                   5029:   border: 2px solid red;
                   5030:   margin: 2px;
1.794     www      5031: }
                   5032: 
                   5033: .LC_disc_old_item {
1.911     bisitz   5034:   background: white;
                   5035:   border: 1px solid black;
                   5036:   margin: 2px;
1.794     www      5037: }
                   5038: 
1.458     albertel 5039: table.LC_pastsubmission {
                   5040:   border: 1px solid black;
                   5041:   margin: 2px;
                   5042: }
                   5043: 
1.924     bisitz   5044: table#LC_menubuttons {
1.345     albertel 5045:   width: 100%;
                   5046:   background: $pgbg;
1.392     albertel 5047:   border: 2px;
1.402     albertel 5048:   border-collapse: separate;
1.803     bisitz   5049:   padding: 0;
1.345     albertel 5050: }
1.392     albertel 5051: 
1.801     tempelho 5052: table#LC_title_bar a {
                   5053:   color: $fontmenu;
                   5054: }
1.836     bisitz   5055: 
1.807     droeschl 5056: table#LC_title_bar {
1.819     tempelho 5057:   clear: both;
1.836     bisitz   5058:   display: none;
1.807     droeschl 5059: }
                   5060: 
1.795     www      5061: table#LC_title_bar,
                   5062: table.LC_breadcrumbs,
1.393     albertel 5063: table#LC_title_bar.LC_with_remote {
1.359     albertel 5064:   width: 100%;
1.392     albertel 5065:   border-color: $pgbg;
                   5066:   border-style: solid;
                   5067:   border-width: $border;
1.379     albertel 5068:   background: $pgbg;
1.801     tempelho 5069:   color: $fontmenu;
1.392     albertel 5070:   border-collapse: collapse;
1.803     bisitz   5071:   padding: 0;
1.819     tempelho 5072:   margin: 0;
1.359     albertel 5073: }
1.795     www      5074: 
1.925.2.14  raeburn  5075: ul.LC_breadcrumb_tools_outerlist {
                   5076:     margin: 0;
                   5077:     padding: 0;
                   5078:     position: relative;
                   5079:     list-style: none;
                   5080: }
                   5081: ul.LC_breadcrumb_tools_outerlist li {
                   5082:     display: inline;
                   5083: }
                   5084: 
                   5085: .LC_breadcrumb_tools_navigation {
                   5086:     padding: 0;
                   5087:     margin: 0;
                   5088:     float: left;
                   5089: }
                   5090: .LC_breadcrumb_tools_tools {
                   5091:     padding: 0;
                   5092:     margin: 0;
                   5093:     float: right;
                   5094: }
                   5095: 
                   5096: div.LC_GCI_Menu {
                   5097:     width:900px;
                   5098: }
                   5099: 
                   5100: div.LC_GCI_Menu:after {
                   5101:     content:'';
                   5102:     display:block;
                   5103:     clear:both;
                   5104: }
                   5105: 
                   5106: div.LC_GCI_Menu_left {
                   5107:     float:left;
                   5108:     width:400px;
                   5109: }
                   5110: 
                   5111: div.LC_GCI_Menu_right {
                   5112:     float:left;
                   5113:     width:400px;;
                   5114: }
                   5115: 
1.925.2.13  raeburn  5116: dl.LC_GCI_Menu {
                   5117:     width:300px;
                   5118:     float:left;
                   5119:     margin-right:2em;
                   5120: }
                   5121: 
                   5122: dl.LC_GCI_Menu dt {
                   5123:     font-weight: bold;
                   5124:     font-size:0.9em;
                   5125:     margin-bottom:0.7em;
                   5126: }
                   5127: 
1.925.2.14  raeburn  5128: dl.LC_GCI_Menu dt a {
                   5129:     color: $font;
                   5130: }
                   5131: 
1.925.2.13  raeburn  5132: dl.LC_GCI_Menu dd {
                   5133:     font-size:0.8em;
                   5134:     margin:0 0 2em 0;
                   5135:     padding-left:4.5em;
                   5136:     line-height:1.5em;
                   5137:     background:none no-repeat left top;
                   5138: }
                   5139: 
1.359     albertel 5140: table#LC_title_bar td {
                   5141:   background: $tabbg;
                   5142: }
1.795     www      5143: 
1.911     bisitz   5144: table#LC_menubuttons img {
1.803     bisitz   5145:   border: none;
1.346     albertel 5146: }
1.795     www      5147: 
1.842     droeschl 5148: .LC_breadcrumbs_component {
1.911     bisitz   5149:   float: right;
1.925.2.14  raeburn  5150:   margin: 0.25em 1em;
1.357     albertel 5151: }
1.842     droeschl 5152: .LC_breadcrumbs_component img {
1.911     bisitz   5153:   vertical-align: middle;
1.777     tempelho 5154: }
1.795     www      5155: 
1.383     albertel 5156: td.LC_table_cell_checkbox {
                   5157:   text-align: center;
                   5158: }
1.795     www      5159: 
                   5160: .LC_fontsize_small {
1.911     bisitz   5161:   font-size: 70%;
1.705     tempelho 5162: }
                   5163: 
1.844     bisitz   5164: #LC_breadcrumbs {
1.911     bisitz   5165:   clear:both;
                   5166:   background: $sidebg;
                   5167:   border-bottom: 1px solid $lg_border_color;
                   5168:   line-height: 2.5em;
1.925.2.14  raeburn  5169:   overflow: hidden;
1.911     bisitz   5170:   margin: 0;
                   5171:   padding: 0;
1.925.2.14  raeburn  5172:   text-align: left;
1.819     tempelho 5173: }
1.862     bisitz   5174: 
1.839     droeschl 5175: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5176: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5177:   display:none;
1.839     droeschl 5178: }
1.819     tempelho 5179: 
1.844     bisitz   5180: #LC_head_subbox {
1.911     bisitz   5181:   clear:both;
                   5182:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5183:   border: 1px solid $sidebg;
1.925.2.14  raeburn  5184:   margin: 0 0 0 0;      
1.822     bisitz   5185: }
                   5186: 
1.795     www      5187: .LC_fontsize_medium {
1.911     bisitz   5188:   font-size: 85%;
1.705     tempelho 5189: }
                   5190: 
1.795     www      5191: .LC_fontsize_large {
1.911     bisitz   5192:   font-size: 120%;
1.705     tempelho 5193: }
                   5194: 
1.346     albertel 5195: .LC_menubuttons_inline_text {
                   5196:   color: $font;
1.698     harmsja  5197:   font-size: 90%;
1.701     harmsja  5198:   padding-left:3px;
1.346     albertel 5199: }
                   5200: 
1.526     www      5201: .LC_menubuttons_link {
                   5202:   text-decoration: none;
                   5203: }
1.795     www      5204: 
1.522     albertel 5205: .LC_menubuttons_category {
1.521     www      5206:   color: $font;
1.526     www      5207:   background: $pgbg;
1.521     www      5208:   font-size: larger;
                   5209:   font-weight: bold;
                   5210: }
                   5211: 
1.346     albertel 5212: td.LC_menubuttons_text {
1.911     bisitz   5213:   color: $font;
1.346     albertel 5214: }
1.706     harmsja  5215: 
1.346     albertel 5216: .LC_current_location {
                   5217:   background: $tabbg;
                   5218: }
1.795     www      5219: 
                   5220: table.LC_data_table,
                   5221: table.LC_mail_list {
1.347     albertel 5222:   border: 1px solid #000000;
1.402     albertel 5223:   border-collapse: separate;
1.426     albertel 5224:   border-spacing: 1px;
1.610     albertel 5225:   background: $pgbg;
1.347     albertel 5226: }
1.795     www      5227: 
1.422     albertel 5228: .LC_data_table_dense {
                   5229:   font-size: small;
                   5230: }
1.795     www      5231: 
1.507     raeburn  5232: table.LC_nested_outer {
                   5233:   border: 1px solid #000000;
1.589     raeburn  5234:   border-collapse: collapse;
1.803     bisitz   5235:   border-spacing: 0;
1.507     raeburn  5236:   width: 100%;
                   5237: }
1.795     www      5238: 
1.879     raeburn  5239: table.LC_innerpickbox,
1.507     raeburn  5240: table.LC_nested {
1.803     bisitz   5241:   border: none;
1.589     raeburn  5242:   border-collapse: collapse;
1.803     bisitz   5243:   border-spacing: 0;
1.507     raeburn  5244:   width: 100%;
                   5245: }
1.795     www      5246: 
1.911     bisitz   5247: table.LC_data_table tr th,
                   5248: table.LC_calendar tr th,
1.795     www      5249: table.LC_mail_list tr th,
1.879     raeburn  5250: table.LC_prior_tries tr th,
                   5251: table.LC_innerpickbox tr th {
1.349     albertel 5252:   font-weight: bold;
                   5253:   background-color: $data_table_head;
1.801     tempelho 5254:   color:$fontmenu;
1.701     harmsja  5255:   font-size:90%;
1.347     albertel 5256: }
1.795     www      5257: 
1.879     raeburn  5258: table.LC_innerpickbox tr th,
                   5259: table.LC_innerpickbox tr td {
                   5260:   vertical-align: top;
                   5261: }
                   5262: 
1.711     raeburn  5263: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5264:   background-color: #CCCCCC;
1.711     raeburn  5265:   font-weight: bold;
                   5266:   text-align: left;
                   5267: }
1.795     www      5268: 
1.912     bisitz   5269: table.LC_data_table tr.LC_odd_row > td {
                   5270:   background-color: $data_table_light;
                   5271:   padding: 2px;
                   5272:   vertical-align: top;
                   5273: }
                   5274: 
1.809     bisitz   5275: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5276:   background-color: $data_table_light;
1.912     bisitz   5277:   vertical-align: top;
                   5278: }
                   5279: 
                   5280: table.LC_data_table tr.LC_even_row > td {
                   5281:   background-color: $data_table_dark;
1.425     albertel 5282:   padding: 2px;
1.900     bisitz   5283:   vertical-align: top;
1.347     albertel 5284: }
1.795     www      5285: 
1.809     bisitz   5286: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5287:   background-color: $data_table_dark;
1.900     bisitz   5288:   vertical-align: top;
1.347     albertel 5289: }
1.795     www      5290: 
1.425     albertel 5291: table.LC_data_table tr.LC_data_table_highlight td {
                   5292:   background-color: $data_table_darker;
                   5293: }
1.795     www      5294: 
1.639     raeburn  5295: table.LC_data_table tr td.LC_leftcol_header {
                   5296:   background-color: $data_table_head;
                   5297:   font-weight: bold;
                   5298: }
1.795     www      5299: 
1.451     albertel 5300: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5301: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5302:   background-color: #FFFFFF;
1.421     albertel 5303:   font-weight: bold;
                   5304:   font-style: italic;
                   5305:   text-align: center;
                   5306:   padding: 8px;
1.347     albertel 5307: }
1.795     www      5308: 
1.890     droeschl 5309: table.LC_caption {
                   5310: }
                   5311: 
1.507     raeburn  5312: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5313:   padding: 4ex
                   5314: }
1.795     www      5315: 
1.507     raeburn  5316: table.LC_nested_outer tr th {
                   5317:   font-weight: bold;
1.801     tempelho 5318:   color:$fontmenu;
1.507     raeburn  5319:   background-color: $data_table_head;
1.701     harmsja  5320:   font-size: small;
1.507     raeburn  5321:   border-bottom: 1px solid #000000;
                   5322: }
1.795     www      5323: 
1.507     raeburn  5324: table.LC_nested_outer tr td.LC_subheader {
                   5325:   background-color: $data_table_head;
                   5326:   font-weight: bold;
                   5327:   font-size: small;
                   5328:   border-bottom: 1px solid #000000;
                   5329:   text-align: right;
1.451     albertel 5330: }
1.795     www      5331: 
1.507     raeburn  5332: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5333:   background-color: #CCCCCC;
1.451     albertel 5334:   font-weight: bold;
                   5335:   font-size: small;
1.507     raeburn  5336:   text-align: center;
                   5337: }
1.795     www      5338: 
1.589     raeburn  5339: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5340: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5341:   text-align: left;
1.451     albertel 5342: }
1.795     www      5343: 
1.507     raeburn  5344: table.LC_nested td {
1.735     bisitz   5345:   background-color: #FFFFFF;
1.451     albertel 5346:   font-size: small;
1.507     raeburn  5347: }
1.795     www      5348: 
1.507     raeburn  5349: table.LC_nested_outer tr th.LC_right_item,
                   5350: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5351: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5352: table.LC_nested tr td.LC_right_item {
1.451     albertel 5353:   text-align: right;
                   5354: }
                   5355: 
1.507     raeburn  5356: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5357:   background-color: #EEEEEE;
1.451     albertel 5358: }
                   5359: 
1.473     raeburn  5360: table.LC_createuser {
                   5361: }
                   5362: 
                   5363: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5364:   font-size: small;
1.473     raeburn  5365: }
                   5366: 
                   5367: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5368:   background-color: #CCCCCC;
1.473     raeburn  5369:   font-weight: bold;
                   5370:   text-align: center;
                   5371: }
                   5372: 
1.349     albertel 5373: table.LC_calendar {
                   5374:   border: 1px solid #000000;
                   5375:   border-collapse: collapse;
1.917     raeburn  5376:   width: 98%;
1.349     albertel 5377: }
1.795     www      5378: 
1.349     albertel 5379: table.LC_calendar_pickdate {
                   5380:   font-size: xx-small;
                   5381: }
1.795     www      5382: 
1.349     albertel 5383: table.LC_calendar tr td {
                   5384:   border: 1px solid #000000;
                   5385:   vertical-align: top;
1.917     raeburn  5386:   width: 14%;
1.349     albertel 5387: }
1.795     www      5388: 
1.349     albertel 5389: table.LC_calendar tr td.LC_calendar_day_empty {
                   5390:   background-color: $data_table_dark;
                   5391: }
1.795     www      5392: 
1.779     bisitz   5393: table.LC_calendar tr td.LC_calendar_day_current {
                   5394:   background-color: $data_table_highlight;
1.777     tempelho 5395: }
1.795     www      5396: 
1.349     albertel 5397: table.LC_mail_list tr.LC_mail_new {
                   5398:   background-color: $mail_new;
                   5399: }
1.795     www      5400: 
1.349     albertel 5401: table.LC_mail_list tr.LC_mail_new:hover {
                   5402:   background-color: $mail_new_hover;
                   5403: }
1.795     www      5404: 
1.349     albertel 5405: table.LC_mail_list tr.LC_mail_read {
                   5406:   background-color: $mail_read;
                   5407: }
1.795     www      5408: 
1.349     albertel 5409: table.LC_mail_list tr.LC_mail_read:hover {
                   5410:   background-color: $mail_read_hover;
                   5411: }
1.795     www      5412: 
1.349     albertel 5413: table.LC_mail_list tr.LC_mail_replied {
                   5414:   background-color: $mail_replied;
                   5415: }
1.795     www      5416: 
1.349     albertel 5417: table.LC_mail_list tr.LC_mail_replied:hover {
                   5418:   background-color: $mail_replied_hover;
                   5419: }
1.795     www      5420: 
1.349     albertel 5421: table.LC_mail_list tr.LC_mail_other {
                   5422:   background-color: $mail_other;
                   5423: }
1.795     www      5424: 
1.349     albertel 5425: table.LC_mail_list tr.LC_mail_other:hover {
                   5426:   background-color: $mail_other_hover;
                   5427: }
1.494     raeburn  5428: 
1.777     tempelho 5429: table.LC_data_table tr > td.LC_browser_file,
                   5430: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5431:   background: #AAEE77;
1.389     albertel 5432: }
1.795     www      5433: 
1.777     tempelho 5434: table.LC_data_table tr > td.LC_browser_file_locked,
                   5435: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5436:   background: #FFAA99;
1.387     albertel 5437: }
1.795     www      5438: 
1.777     tempelho 5439: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5440:   background: #888888;
1.779     bisitz   5441: }
1.795     www      5442: 
1.777     tempelho 5443: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5444: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5445:   background: #F8F866;
1.777     tempelho 5446: }
1.795     www      5447: 
1.696     bisitz   5448: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5449:   background: #E0E8FF;
1.387     albertel 5450: }
1.696     bisitz   5451: 
1.707     bisitz   5452: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5453:   /* background: #77FF77; */
1.707     bisitz   5454: }
1.795     www      5455: 
1.707     bisitz   5456: table.LC_data_table tr > td.LC_roles_future {
                   5457:   background: #FFFF77;
                   5458: }
1.795     www      5459: 
1.707     bisitz   5460: table.LC_data_table tr > td.LC_roles_will {
                   5461:   background: #FFAA77;
                   5462: }
1.795     www      5463: 
1.707     bisitz   5464: table.LC_data_table tr > td.LC_roles_expired {
                   5465:   background: #FF7777;
                   5466: }
1.795     www      5467: 
1.707     bisitz   5468: table.LC_data_table tr > td.LC_roles_will_not {
                   5469:   background: #AAFF77;
                   5470: }
1.795     www      5471: 
1.707     bisitz   5472: table.LC_data_table tr > td.LC_roles_selected {
                   5473:   background: #11CC55;
                   5474: }
                   5475: 
1.388     albertel 5476: span.LC_current_location {
1.701     harmsja  5477:   font-size:larger;
1.388     albertel 5478:   background: $pgbg;
                   5479: }
1.387     albertel 5480: 
1.395     albertel 5481: span.LC_parm_menu_item {
                   5482:   font-size: larger;
                   5483: }
1.795     www      5484: 
1.395     albertel 5485: span.LC_parm_scope_all {
                   5486:   color: red;
                   5487: }
1.795     www      5488: 
1.395     albertel 5489: span.LC_parm_scope_folder {
                   5490:   color: green;
                   5491: }
1.795     www      5492: 
1.395     albertel 5493: span.LC_parm_scope_resource {
                   5494:   color: orange;
                   5495: }
1.795     www      5496: 
1.395     albertel 5497: span.LC_parm_part {
                   5498:   color: blue;
                   5499: }
1.795     www      5500: 
1.911     bisitz   5501: span.LC_parm_folder,
                   5502: span.LC_parm_symb {
1.395     albertel 5503:   font-size: x-small;
                   5504:   font-family: $mono;
                   5505:   color: #AAAAAA;
                   5506: }
                   5507: 
1.795     www      5508: td.LC_parm_overview_level_menu,
                   5509: td.LC_parm_overview_map_menu,
                   5510: td.LC_parm_overview_parm_selectors,
                   5511: td.LC_parm_overview_restrictions  {
1.396     albertel 5512:   border: 1px solid black;
                   5513:   border-collapse: collapse;
                   5514: }
1.795     www      5515: 
1.396     albertel 5516: table.LC_parm_overview_restrictions td {
                   5517:   border-width: 1px 4px 1px 4px;
                   5518:   border-style: solid;
                   5519:   border-color: $pgbg;
                   5520:   text-align: center;
                   5521: }
1.795     www      5522: 
1.396     albertel 5523: table.LC_parm_overview_restrictions th {
                   5524:   background: $tabbg;
                   5525:   border-width: 1px 4px 1px 4px;
                   5526:   border-style: solid;
                   5527:   border-color: $pgbg;
                   5528: }
1.795     www      5529: 
1.398     albertel 5530: table#LC_helpmenu {
1.803     bisitz   5531:   border: none;
1.398     albertel 5532:   height: 55px;
1.803     bisitz   5533:   border-spacing: 0;
1.398     albertel 5534: }
                   5535: 
                   5536: table#LC_helpmenu fieldset legend {
                   5537:   font-size: larger;
                   5538: }
1.795     www      5539: 
1.397     albertel 5540: table#LC_helpmenu_links {
                   5541:   width: 100%;
                   5542:   border: 1px solid black;
                   5543:   background: $pgbg;
1.803     bisitz   5544:   padding: 0;
1.397     albertel 5545:   border-spacing: 1px;
                   5546: }
1.795     www      5547: 
1.397     albertel 5548: table#LC_helpmenu_links tr td {
                   5549:   padding: 1px;
                   5550:   background: $tabbg;
1.399     albertel 5551:   text-align: center;
                   5552:   font-weight: bold;
1.397     albertel 5553: }
1.396     albertel 5554: 
1.795     www      5555: table#LC_helpmenu_links a:link,
                   5556: table#LC_helpmenu_links a:visited,
1.397     albertel 5557: table#LC_helpmenu_links a:active {
                   5558:   text-decoration: none;
                   5559:   color: $font;
                   5560: }
1.795     www      5561: 
1.397     albertel 5562: table#LC_helpmenu_links a:hover {
                   5563:   text-decoration: underline;
                   5564:   color: $vlink;
                   5565: }
1.396     albertel 5566: 
1.417     albertel 5567: .LC_chrt_popup_exists {
                   5568:   border: 1px solid #339933;
                   5569:   margin: -1px;
                   5570: }
1.795     www      5571: 
1.417     albertel 5572: .LC_chrt_popup_up {
                   5573:   border: 1px solid yellow;
                   5574:   margin: -1px;
                   5575: }
1.795     www      5576: 
1.417     albertel 5577: .LC_chrt_popup {
                   5578:   border: 1px solid #8888FF;
                   5579:   background: #CCCCFF;
                   5580: }
1.795     www      5581: 
1.421     albertel 5582: table.LC_pick_box {
                   5583:   border-collapse: separate;
                   5584:   background: white;
                   5585:   border: 1px solid black;
                   5586:   border-spacing: 1px;
                   5587: }
1.795     www      5588: 
1.421     albertel 5589: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5590:   background: $sidebg;
1.421     albertel 5591:   font-weight: bold;
1.900     bisitz   5592:   text-align: left;
1.740     bisitz   5593:   vertical-align: top;
1.421     albertel 5594:   width: 184px;
                   5595:   padding: 8px;
                   5596: }
1.795     www      5597: 
1.579     raeburn  5598: table.LC_pick_box td.LC_pick_box_value {
                   5599:   text-align: left;
                   5600:   padding: 8px;
                   5601: }
1.795     www      5602: 
1.579     raeburn  5603: table.LC_pick_box td.LC_pick_box_select {
                   5604:   text-align: left;
                   5605:   padding: 8px;
                   5606: }
1.795     www      5607: 
1.424     albertel 5608: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5609:   padding: 0;
1.421     albertel 5610:   height: 1px;
                   5611:   background: black;
                   5612: }
1.795     www      5613: 
1.421     albertel 5614: table.LC_pick_box td.LC_pick_box_submit {
                   5615:   text-align: right;
                   5616: }
1.795     www      5617: 
1.579     raeburn  5618: table.LC_pick_box td.LC_evenrow_value {
                   5619:   text-align: left;
                   5620:   padding: 8px;
                   5621:   background-color: $data_table_light;
                   5622: }
1.795     www      5623: 
1.579     raeburn  5624: table.LC_pick_box td.LC_oddrow_value {
                   5625:   text-align: left;
                   5626:   padding: 8px;
                   5627:   background-color: $data_table_light;
                   5628: }
1.795     www      5629: 
1.579     raeburn  5630: span.LC_helpform_receipt_cat {
                   5631:   font-weight: bold;
                   5632: }
1.795     www      5633: 
1.424     albertel 5634: table.LC_group_priv_box {
                   5635:   background: white;
                   5636:   border: 1px solid black;
                   5637:   border-spacing: 1px;
                   5638: }
1.795     www      5639: 
1.424     albertel 5640: table.LC_group_priv_box td.LC_pick_box_title {
                   5641:   background: $tabbg;
                   5642:   font-weight: bold;
                   5643:   text-align: right;
                   5644:   width: 184px;
                   5645: }
1.795     www      5646: 
1.424     albertel 5647: table.LC_group_priv_box td.LC_groups_fixed {
                   5648:   background: $data_table_light;
                   5649:   text-align: center;
                   5650: }
1.795     www      5651: 
1.424     albertel 5652: table.LC_group_priv_box td.LC_groups_optional {
                   5653:   background: $data_table_dark;
                   5654:   text-align: center;
                   5655: }
1.795     www      5656: 
1.424     albertel 5657: table.LC_group_priv_box td.LC_groups_functionality {
                   5658:   background: $data_table_darker;
                   5659:   text-align: center;
                   5660:   font-weight: bold;
                   5661: }
1.795     www      5662: 
1.424     albertel 5663: table.LC_group_priv td {
                   5664:   text-align: left;
1.803     bisitz   5665:   padding: 0;
1.424     albertel 5666: }
                   5667: 
1.421     albertel 5668: table.LC_notify_front_page {
                   5669:   background: white;
                   5670:   border: 1px solid black;
                   5671:   padding: 8px;
                   5672: }
1.795     www      5673: 
1.421     albertel 5674: table.LC_notify_front_page td {
                   5675:   padding: 8px;
                   5676: }
1.795     www      5677: 
1.424     albertel 5678: .LC_navbuttons {
                   5679:   margin: 2ex 0ex 2ex 0ex;
                   5680: }
1.795     www      5681: 
1.423     albertel 5682: .LC_topic_bar {
                   5683:   font-weight: bold;
                   5684:   background: $tabbg;
1.918     wenzelju 5685:   margin: 1em 0em 1em 2em;
1.805     bisitz   5686:   padding: 3px;
1.918     wenzelju 5687:   font-size: 1.2em;
1.423     albertel 5688: }
1.795     www      5689: 
1.423     albertel 5690: .LC_topic_bar span {
1.918     wenzelju 5691:   left: 0.5em;
                   5692:   position: absolute;
1.423     albertel 5693:   vertical-align: middle;
1.918     wenzelju 5694:   font-size: 1.2em;
1.423     albertel 5695: }
1.795     www      5696: 
1.423     albertel 5697: .LC_topic_bar img {
                   5698:   vertical-align: bottom;
                   5699: }
1.795     www      5700: 
1.423     albertel 5701: table.LC_course_group_status {
                   5702:   margin: 20px;
                   5703: }
1.795     www      5704: 
1.423     albertel 5705: table.LC_status_selector td {
                   5706:   vertical-align: top;
                   5707:   text-align: center;
1.424     albertel 5708:   padding: 4px;
                   5709: }
1.795     www      5710: 
1.599     albertel 5711: div.LC_feedback_link {
1.616     albertel 5712:   clear: both;
1.829     kalberla 5713:   background: $sidebg;
1.779     bisitz   5714:   width: 100%;
1.829     kalberla 5715:   padding-bottom: 10px;
                   5716:   border: 1px $tabbg solid;
1.833     kalberla 5717:   height: 22px;
                   5718:   line-height: 22px;
                   5719:   padding-top: 5px;
                   5720: }
                   5721: 
                   5722: div.LC_feedback_link img {
                   5723:   height: 22px;
1.867     kalberla 5724:   vertical-align:middle;
1.829     kalberla 5725: }
                   5726: 
1.911     bisitz   5727: div.LC_feedback_link a {
1.829     kalberla 5728:   text-decoration: none;
1.489     raeburn  5729: }
1.795     www      5730: 
1.867     kalberla 5731: div.LC_comblock {
1.911     bisitz   5732:   display:inline;
1.867     kalberla 5733:   color:$font;
                   5734:   font-size:90%;
                   5735: }
                   5736: 
                   5737: div.LC_feedback_link div.LC_comblock {
                   5738:   padding-left:5px;
                   5739: }
                   5740: 
                   5741: div.LC_feedback_link div.LC_comblock a {
                   5742:   color:$font;
                   5743: }
                   5744: 
1.489     raeburn  5745: span.LC_feedback_link {
1.858     bisitz   5746:   /* background: $feedback_link_bg; */
1.599     albertel 5747:   font-size: larger;
                   5748: }
1.795     www      5749: 
1.599     albertel 5750: span.LC_message_link {
1.858     bisitz   5751:   /* background: $feedback_link_bg; */
1.599     albertel 5752:   font-size: larger;
                   5753:   position: absolute;
                   5754:   right: 1em;
1.489     raeburn  5755: }
1.421     albertel 5756: 
1.515     albertel 5757: table.LC_prior_tries {
1.524     albertel 5758:   border: 1px solid #000000;
                   5759:   border-collapse: separate;
                   5760:   border-spacing: 1px;
1.515     albertel 5761: }
1.523     albertel 5762: 
1.515     albertel 5763: table.LC_prior_tries td {
1.524     albertel 5764:   padding: 2px;
1.515     albertel 5765: }
1.523     albertel 5766: 
                   5767: .LC_answer_correct {
1.795     www      5768:   background: lightgreen;
                   5769:   color: darkgreen;
                   5770:   padding: 6px;
1.523     albertel 5771: }
1.795     www      5772: 
1.523     albertel 5773: .LC_answer_charged_try {
1.797     www      5774:   background: #FFAAAA;
1.795     www      5775:   color: darkred;
                   5776:   padding: 6px;
1.523     albertel 5777: }
1.795     www      5778: 
1.779     bisitz   5779: .LC_answer_not_charged_try,
1.523     albertel 5780: .LC_answer_no_grade,
                   5781: .LC_answer_late {
1.795     www      5782:   background: lightyellow;
1.523     albertel 5783:   color: black;
1.795     www      5784:   padding: 6px;
1.523     albertel 5785: }
1.795     www      5786: 
1.523     albertel 5787: .LC_answer_previous {
1.795     www      5788:   background: lightblue;
                   5789:   color: darkblue;
                   5790:   padding: 6px;
1.523     albertel 5791: }
1.795     www      5792: 
1.779     bisitz   5793: .LC_answer_no_message {
1.777     tempelho 5794:   background: #FFFFFF;
                   5795:   color: black;
1.795     www      5796:   padding: 6px;
1.779     bisitz   5797: }
1.795     www      5798: 
1.779     bisitz   5799: .LC_answer_unknown {
                   5800:   background: orange;
                   5801:   color: black;
1.795     www      5802:   padding: 6px;
1.777     tempelho 5803: }
1.795     www      5804: 
1.529     albertel 5805: span.LC_prior_numerical,
                   5806: span.LC_prior_string,
                   5807: span.LC_prior_custom,
                   5808: span.LC_prior_reaction,
                   5809: span.LC_prior_math {
1.925     bisitz   5810:   font-family: $mono;
1.523     albertel 5811:   white-space: pre;
                   5812: }
                   5813: 
1.525     albertel 5814: span.LC_prior_string {
1.925     bisitz   5815:   font-family: $mono;
1.525     albertel 5816:   white-space: pre;
                   5817: }
                   5818: 
1.523     albertel 5819: table.LC_prior_option {
                   5820:   width: 100%;
                   5821:   border-collapse: collapse;
                   5822: }
1.795     www      5823: 
1.911     bisitz   5824: table.LC_prior_rank,
1.795     www      5825: table.LC_prior_match {
1.528     albertel 5826:   border-collapse: collapse;
                   5827: }
1.795     www      5828: 
1.528     albertel 5829: table.LC_prior_option tr td,
                   5830: table.LC_prior_rank tr td,
                   5831: table.LC_prior_match tr td {
1.524     albertel 5832:   border: 1px solid #000000;
1.515     albertel 5833: }
                   5834: 
1.855     bisitz   5835: .LC_nobreak {
1.544     albertel 5836:   white-space: nowrap;
1.519     raeburn  5837: }
                   5838: 
1.576     raeburn  5839: span.LC_cusr_emph {
                   5840:   font-style: italic;
                   5841: }
                   5842: 
1.633     raeburn  5843: span.LC_cusr_subheading {
                   5844:   font-weight: normal;
                   5845:   font-size: 85%;
                   5846: }
                   5847: 
1.861     bisitz   5848: div.LC_docs_entry_move {
1.859     bisitz   5849:   border: 1px solid #BBBBBB;
1.545     albertel 5850:   background: #DDDDDD;
1.861     bisitz   5851:   width: 22px;
1.859     bisitz   5852:   padding: 1px;
                   5853:   margin: 0;
1.545     albertel 5854: }
                   5855: 
1.861     bisitz   5856: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5857: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5858:   background: #DDDDDD;
                   5859:   font-size: x-small;
                   5860: }
1.795     www      5861: 
1.861     bisitz   5862: .LC_docs_entry_parameter {
                   5863:   white-space: nowrap;
                   5864: }
                   5865: 
1.544     albertel 5866: .LC_docs_copy {
1.545     albertel 5867:   color: #000099;
1.544     albertel 5868: }
1.795     www      5869: 
1.544     albertel 5870: .LC_docs_cut {
1.545     albertel 5871:   color: #550044;
1.544     albertel 5872: }
1.795     www      5873: 
1.544     albertel 5874: .LC_docs_rename {
1.545     albertel 5875:   color: #009900;
1.544     albertel 5876: }
1.795     www      5877: 
1.544     albertel 5878: .LC_docs_remove {
1.545     albertel 5879:   color: #990000;
                   5880: }
                   5881: 
1.547     albertel 5882: .LC_docs_reinit_warn,
                   5883: .LC_docs_ext_edit {
                   5884:   font-size: x-small;
                   5885: }
                   5886: 
1.545     albertel 5887: table.LC_docs_adddocs td,
                   5888: table.LC_docs_adddocs th {
                   5889:   border: 1px solid #BBBBBB;
                   5890:   padding: 4px;
                   5891:   background: #DDDDDD;
1.543     albertel 5892: }
                   5893: 
1.584     albertel 5894: table.LC_sty_begin {
                   5895:   background: #BBFFBB;
                   5896: }
1.795     www      5897: 
1.584     albertel 5898: table.LC_sty_end {
                   5899:   background: #FFBBBB;
                   5900: }
                   5901: 
1.589     raeburn  5902: table.LC_double_column {
1.803     bisitz   5903:   border-width: 0;
1.589     raeburn  5904:   border-collapse: collapse;
                   5905:   width: 100%;
                   5906:   padding: 2px;
                   5907: }
                   5908: 
                   5909: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5910:   top: 2px;
1.589     raeburn  5911:   left: 2px;
                   5912:   width: 47%;
                   5913:   vertical-align: top;
                   5914: }
                   5915: 
                   5916: table.LC_double_column tr td.LC_right_col {
                   5917:   top: 2px;
1.779     bisitz   5918:   right: 2px;
1.589     raeburn  5919:   width: 47%;
                   5920:   vertical-align: top;
                   5921: }
                   5922: 
1.591     raeburn  5923: div.LC_left_float {
                   5924:   float: left;
                   5925:   padding-right: 5%;
1.597     albertel 5926:   padding-bottom: 4px;
1.591     raeburn  5927: }
                   5928: 
                   5929: div.LC_clear_float_header {
1.597     albertel 5930:   padding-bottom: 2px;
1.591     raeburn  5931: }
                   5932: 
                   5933: div.LC_clear_float_footer {
1.597     albertel 5934:   padding-top: 10px;
1.591     raeburn  5935:   clear: both;
                   5936: }
                   5937: 
1.597     albertel 5938: div.LC_grade_show_user {
                   5939:   margin-top: 20px;
                   5940:   border: 1px solid black;
                   5941: }
1.795     www      5942: 
1.597     albertel 5943: div.LC_grade_user_name {
                   5944:   background: #DDDDEE;
                   5945:   border-bottom: 1px solid black;
1.705     tempelho 5946:   font-weight: bold;
                   5947:   font-size: large;
1.597     albertel 5948: }
1.795     www      5949: 
1.597     albertel 5950: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5951:   background: #DDEEDD;
                   5952: }
                   5953: 
                   5954: div.LC_grade_show_problem,
                   5955: div.LC_grade_submissions,
                   5956: div.LC_grade_message_center,
                   5957: div.LC_grade_info_links,
                   5958: div.LC_grade_assign {
                   5959:   margin: 5px;
                   5960:   width: 99%;
                   5961:   background: #FFFFFF;
                   5962: }
1.795     www      5963: 
1.597     albertel 5964: div.LC_grade_show_problem_header,
                   5965: div.LC_grade_submissions_header,
                   5966: div.LC_grade_message_center_header,
                   5967: div.LC_grade_assign_header {
1.705     tempelho 5968:   font-weight: bold;
                   5969:   font-size: large;
1.597     albertel 5970: }
1.795     www      5971: 
1.597     albertel 5972: div.LC_grade_show_problem_problem,
                   5973: div.LC_grade_submissions_body,
                   5974: div.LC_grade_message_center_body,
                   5975: div.LC_grade_assign_body {
                   5976:   border: 1px solid black;
                   5977:   width: 99%;
                   5978:   background: #FFFFFF;
                   5979: }
1.795     www      5980: 
1.598     albertel 5981: span.LC_grade_check_note {
1.705     tempelho 5982:   font-weight: normal;
                   5983:   font-size: medium;
1.598     albertel 5984:   display: inline;
                   5985:   position: absolute;
                   5986:   right: 1em;
                   5987: }
1.597     albertel 5988: 
1.613     albertel 5989: table.LC_scantron_action {
                   5990:   width: 100%;
                   5991: }
1.795     www      5992: 
1.613     albertel 5993: table.LC_scantron_action tr th {
1.698     harmsja  5994:   font-weight:bold;
                   5995:   font-style:normal;
1.613     albertel 5996: }
1.795     www      5997: 
1.779     bisitz   5998: .LC_edit_problem_header,
1.614     albertel 5999: div.LC_edit_problem_footer {
1.705     tempelho 6000:   font-weight: normal;
                   6001:   font-size:  medium;
1.602     albertel 6002:   margin: 2px;
1.600     albertel 6003: }
1.795     www      6004: 
1.600     albertel 6005: div.LC_edit_problem_header,
1.602     albertel 6006: div.LC_edit_problem_header div,
1.614     albertel 6007: div.LC_edit_problem_footer,
                   6008: div.LC_edit_problem_footer div,
1.602     albertel 6009: div.LC_edit_problem_editxml_header,
                   6010: div.LC_edit_problem_editxml_header div {
1.600     albertel 6011:   margin-top: 5px;
                   6012: }
1.795     www      6013: 
1.600     albertel 6014: div.LC_edit_problem_header_title {
1.705     tempelho 6015:   font-weight: bold;
                   6016:   font-size: larger;
1.602     albertel 6017:   background: $tabbg;
                   6018:   padding: 3px;
                   6019: }
1.795     www      6020: 
1.602     albertel 6021: table.LC_edit_problem_header_title {
1.705     tempelho 6022:   font-size: larger;
                   6023:   font-weight:  bold;
1.602     albertel 6024:   width: 100%;
                   6025:   border-color: $pgbg;
                   6026:   border-style: solid;
                   6027:   border-width: $border;
1.600     albertel 6028:   background: $tabbg;
1.602     albertel 6029:   border-collapse: collapse;
1.803     bisitz   6030:   padding: 0;
1.602     albertel 6031: }
                   6032: 
                   6033: div.LC_edit_problem_discards {
                   6034:   float: left;
                   6035:   padding-bottom: 5px;
                   6036: }
1.795     www      6037: 
1.602     albertel 6038: div.LC_edit_problem_saves {
                   6039:   float: right;
                   6040:   padding-bottom: 5px;
1.600     albertel 6041: }
1.795     www      6042: 
1.911     bisitz   6043: img.stift {
1.803     bisitz   6044:   border-width: 0;
                   6045:   vertical-align: middle;
1.677     riegler  6046: }
1.680     riegler  6047: 
1.923     bisitz   6048: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6049:   vertical-align: top;
1.777     tempelho 6050: }
1.795     www      6051: 
1.716     raeburn  6052: div.LC_createcourse {
1.911     bisitz   6053:   margin: 10px 10px 10px 10px;
1.716     raeburn  6054: }
                   6055: 
1.917     raeburn  6056: .LC_dccid {
                   6057:   margin: 0.2em 0 0 0;
                   6058:   padding: 0;
                   6059:   font-size: 90%;
                   6060:   display:none;
                   6061: }
                   6062: 
1.693     droeschl 6063: /* ---- Remove when done ----
                   6064: # The following styles is part of the redesign of LON-CAPA and are
                   6065: # subject to change during this project.
                   6066: # Don't rely on their current functionality as they might be 
                   6067: # changed or removed.
                   6068: # --------------------------*/
                   6069: 
1.698     harmsja  6070: a:hover,
1.897     wenzelju 6071: ol.LC_primary_menu a:hover,
1.721     harmsja  6072: ol#LC_MenuBreadcrumbs a:hover,
                   6073: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6074: ul#LC_secondary_menu a:hover,
1.721     harmsja  6075: .LC_FormSectionClearButton input:hover
1.795     www      6076: ul.LC_TabContent   li:hover a {
1.911     bisitz   6077:   color:#BF2317;
                   6078:   text-decoration:none;
1.693     droeschl 6079: }
                   6080: 
1.779     bisitz   6081: h1 {
1.911     bisitz   6082:   padding: 0;
                   6083:   line-height:130%;
1.693     droeschl 6084: }
1.698     harmsja  6085: 
1.911     bisitz   6086: h2,
                   6087: h3,
                   6088: h4,
                   6089: h5,
                   6090: h6 {
                   6091:   margin: 5px 0 5px 0;
                   6092:   padding: 0;
                   6093:   line-height:130%;
1.693     droeschl 6094: }
1.795     www      6095: 
                   6096: .LC_hcell {
1.911     bisitz   6097:   padding:3px 15px 3px 15px;
                   6098:   margin: 0;
                   6099:   background-color:$tabbg;
                   6100:   color:$fontmenu;
                   6101:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6102: }
1.795     www      6103: 
1.840     bisitz   6104: .LC_Box > .LC_hcell {
1.911     bisitz   6105:   margin: 0 -10px 10px -10px;
1.835     bisitz   6106: }
                   6107: 
1.721     harmsja  6108: .LC_noBorder {
1.911     bisitz   6109:   border: 0;
1.698     harmsja  6110: }
1.693     droeschl 6111: 
1.721     harmsja  6112: .LC_FormSectionClearButton input {
1.911     bisitz   6113:   background-color:transparent;
                   6114:   border: none;
                   6115:   cursor:pointer;
                   6116:   text-decoration:underline;
1.693     droeschl 6117: }
1.763     bisitz   6118: 
                   6119: .LC_help_open_topic {
1.911     bisitz   6120:   color: #FFFFFF;
                   6121:   background-color: #EEEEFF;
                   6122:   margin: 1px;
                   6123:   padding: 4px;
                   6124:   border: 1px solid #000033;
                   6125:   white-space: nowrap;
                   6126:   /* vertical-align: middle; */
1.759     neumanie 6127: }
1.693     droeschl 6128: 
1.911     bisitz   6129: dl,
                   6130: ul,
                   6131: div,
                   6132: fieldset {
                   6133:   margin: 10px 10px 10px 0;
                   6134:   /* overflow: hidden; */
1.693     droeschl 6135: }
1.795     www      6136: 
1.838     bisitz   6137: fieldset > legend {
1.911     bisitz   6138:   font-weight: bold;
                   6139:   padding: 0 5px 0 5px;
1.838     bisitz   6140: }
                   6141: 
1.925.2.14  raeburn  6142: div.LC_page_header {
                   6143:   background-color: $pgbg_or_bgcolor;
                   6144:   margin: 0 0 1.0em 0;
                   6145: }
                   6146: 
1.813     bisitz   6147: #LC_nav_bar {
1.911     bisitz   6148:   float: left;
                   6149:   margin: 0.2em 0 0 0;
1.807     droeschl 6150: }
                   6151: 
1.916     droeschl 6152: #LC_realm {
                   6153:   margin: 0.2em 0 0 0;
                   6154:   padding: 0;
                   6155:   font-weight: bold;
                   6156:   text-align: center;
                   6157: }
                   6158: 
1.911     bisitz   6159: #LC_nav_bar em {
                   6160:   font-weight: bold;
                   6161:   font-style: normal;
1.807     droeschl 6162: }
                   6163: 
1.897     wenzelju 6164: ol.LC_primary_menu {
1.911     bisitz   6165:   float: right;
                   6166:   margin: 0.2em 0 0 0;
1.807     droeschl 6167: }
                   6168: 
1.925.2.15  raeburn  6169: span.LC_new_message{
                   6170:   font-weight:bold;
                   6171:   color: darkred;
                   6172: }
                   6173: 
1.852     droeschl 6174: ol#LC_PathBreadcrumbs {
1.911     bisitz   6175:   margin: 0;
1.693     droeschl 6176: }
                   6177: 
1.897     wenzelju 6178: ol.LC_primary_menu li {
1.911     bisitz   6179:   display: inline;
                   6180:   padding: 5px 5px 0 10px;
                   6181:   vertical-align: top;
1.693     droeschl 6182: }
                   6183: 
1.897     wenzelju 6184: ol.LC_primary_menu li img {
1.911     bisitz   6185:   vertical-align: bottom;
1.693     droeschl 6186: }
                   6187: 
1.897     wenzelju 6188: ol.LC_primary_menu a {
1.911     bisitz   6189:   font-size: 90%;
                   6190:   color: RGB(80, 80, 80);
                   6191:   text-decoration: none;
1.693     droeschl 6192: }
1.795     www      6193: 
1.897     wenzelju 6194: ul#LC_secondary_menu {
1.911     bisitz   6195:   clear: both;
                   6196:   color: $fontmenu;
                   6197:   background: $tabbg;
                   6198:   list-style: none;
                   6199:   padding: 0;
                   6200:   margin: 0;
                   6201:   width: 100%;
1.808     droeschl 6202: }
                   6203: 
1.897     wenzelju 6204: ul#LC_secondary_menu li {
1.911     bisitz   6205:   font-weight: bold;
                   6206:   line-height: 1.8em;
                   6207:   padding: 0 0.8em;
                   6208:   border-right: 1px solid black;
                   6209:   display: inline;
                   6210:   vertical-align: middle;
1.807     droeschl 6211: }
                   6212: 
1.847     tempelho 6213: ul.LC_TabContent {
1.911     bisitz   6214:   display:block;
                   6215:   background: $sidebg;
                   6216:   border-bottom: solid 1px $lg_border_color;
                   6217:   list-style:none;
                   6218:   margin: 0 -10px;
                   6219:   padding: 0;
1.693     droeschl 6220: }
                   6221: 
1.795     www      6222: ul.LC_TabContent li,
                   6223: ul.LC_TabContentBigger li {
1.911     bisitz   6224:   float:left;
1.741     harmsja  6225: }
1.795     www      6226: 
1.897     wenzelju 6227: ul#LC_secondary_menu li a {
1.911     bisitz   6228:   color: $fontmenu;
                   6229:   text-decoration: none;
1.693     droeschl 6230: }
1.795     www      6231: 
1.721     harmsja  6232: ul.LC_TabContent {
1.911     bisitz   6233:   min-height:1.5em;
1.721     harmsja  6234: }
1.795     www      6235: 
                   6236: ul.LC_TabContent li {
1.911     bisitz   6237:   vertical-align:middle;
                   6238:   padding: 0 10px 0 10px;
                   6239:   background-color:$tabbg;
                   6240:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6241: }
1.795     www      6242: 
1.847     tempelho 6243: ul.LC_TabContent .right {
1.911     bisitz   6244:   float:right;
1.847     tempelho 6245: }
                   6246: 
1.911     bisitz   6247: ul.LC_TabContent li a,
                   6248: ul.LC_TabContent li {
                   6249:   color:rgb(47,47,47);
                   6250:   text-decoration:none;
                   6251:   font-size:95%;
                   6252:   font-weight:bold;
                   6253:   padding-right: 16px;
1.721     harmsja  6254: }
1.795     www      6255: 
1.911     bisitz   6256: ul.LC_TabContent li:hover,
                   6257: ul.LC_TabContent li.active {
                   6258:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6259:   border-bottom:solid 2px #FFFFFF;
                   6260:   padding-right: 16px;
1.744     ehlerst  6261: }
1.795     www      6262: 
1.870     tempelho 6263: #maincoursedoc {
1.911     bisitz   6264:   clear:both;
1.870     tempelho 6265: }
                   6266: 
                   6267: ul.LC_TabContentBigger {
1.911     bisitz   6268:   display:block;
                   6269:   list-style:none;
                   6270:   padding: 0;
1.870     tempelho 6271: }
                   6272: 
1.795     www      6273: ul.LC_TabContentBigger li {
1.911     bisitz   6274:   vertical-align:bottom;
                   6275:   height: 30px;
                   6276:   font-size:110%;
                   6277:   font-weight:bold;
                   6278:   color: #737373;
1.841     tempelho 6279: }
                   6280: 
1.870     tempelho 6281: 
                   6282: ul.LC_TabContentBigger li a {
1.911     bisitz   6283:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6284:   height: 30px;
                   6285:   line-height: 30px;
                   6286:   text-align: center;
                   6287:   display: block;
                   6288:   text-decoration: none;
1.741     harmsja  6289: }
1.795     www      6290: 
1.911     bisitz   6291: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6292: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6293:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6294:   color:$font;
                   6295:   text-decoration: underline;
1.744     ehlerst  6296: }
1.795     www      6297: 
1.870     tempelho 6298: 
                   6299: ul.LC_TabContentBigger li b {
1.911     bisitz   6300:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6301:   display: block;
                   6302:   float: left;
                   6303:   padding: 0 30px;
1.870     tempelho 6304: }
                   6305: 
                   6306: ul.LC_TabContentBigger li:hover b,
                   6307: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6308:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6309:   color:$font;
                   6310:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6311: }
1.693     droeschl 6312: 
1.870     tempelho 6313: 
1.862     bisitz   6314: ul.LC_CourseBreadcrumbs {
                   6315:   background: $sidebg;
                   6316:   line-height: 32px;
                   6317:   padding-left: 10px;
                   6318:   margin: 0 0 10px 0;
                   6319:   list-style-position: inside;
                   6320: 
                   6321: }
                   6322: 
1.911     bisitz   6323: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6324: ol#LC_PathBreadcrumbs {
1.911     bisitz   6325:   padding-left: 10px;
                   6326:   margin: 0;
1.925.2.14  raeburn  6327:   margin: 0;
                   6328:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6329: }
                   6330: 
1.911     bisitz   6331: ol#LC_MenuBreadcrumbs li,
                   6332: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6333: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6334:   display: inline;
1.925.2.14  raeburn  6335:   white-space: normal;
1.693     droeschl 6336: }
                   6337: 
1.823     bisitz   6338: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6339: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6340:   text-decoration: none;
                   6341:   font-size:90%;
1.693     droeschl 6342: }
1.795     www      6343: 
1.925.2.14  raeburn  6344: ol#LC_MenuBreadcrumbs h1 {
                   6345:   display: inline;
                   6346:   font-size: 90%;
                   6347:   line-height: 2.5em;
                   6348:   margin: 0;
                   6349:   padding: 0;
                   6350: }
                   6351: 
1.795     www      6352: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6353:   text-decoration:none;
                   6354:   font-size:100%;
                   6355:   font-weight:bold;
1.693     droeschl 6356: }
1.795     www      6357: 
1.840     bisitz   6358: .LC_Box {
1.911     bisitz   6359:   border: solid 1px $lg_border_color;
                   6360:   padding: 0 10px 10px 10px;
1.746     neumanie 6361: }
1.795     www      6362: 
                   6363: .LC_AboutMe_Image {
1.911     bisitz   6364:   float:left;
                   6365:   margin-right:10px;
1.747     neumanie 6366: }
1.795     www      6367: 
                   6368: .LC_Clear_AboutMe_Image {
1.911     bisitz   6369:   clear:left;
1.747     neumanie 6370: }
1.795     www      6371: 
1.721     harmsja  6372: dl.LC_ListStyleClean dt {
1.911     bisitz   6373:   padding-right: 5px;
                   6374:   display: table-header-group;
1.693     droeschl 6375: }
                   6376: 
1.721     harmsja  6377: dl.LC_ListStyleClean dd {
1.911     bisitz   6378:   display: table-row;
1.693     droeschl 6379: }
                   6380: 
1.721     harmsja  6381: .LC_ListStyleClean,
                   6382: .LC_ListStyleSimple,
                   6383: .LC_ListStyleNormal,
1.795     www      6384: .LC_ListStyleSpecial {
1.911     bisitz   6385:   /* display:block; */
                   6386:   list-style-position: inside;
                   6387:   list-style-type: none;
                   6388:   overflow: hidden;
                   6389:   padding: 0;
1.693     droeschl 6390: }
                   6391: 
1.721     harmsja  6392: .LC_ListStyleSimple li,
                   6393: .LC_ListStyleSimple dd,
                   6394: .LC_ListStyleNormal li,
                   6395: .LC_ListStyleNormal dd,
                   6396: .LC_ListStyleSpecial li,
1.795     www      6397: .LC_ListStyleSpecial dd {
1.911     bisitz   6398:   margin: 0;
                   6399:   padding: 5px 5px 5px 10px;
                   6400:   clear: both;
1.693     droeschl 6401: }
                   6402: 
1.721     harmsja  6403: .LC_ListStyleClean li,
                   6404: .LC_ListStyleClean dd {
1.911     bisitz   6405:   padding-top: 0;
                   6406:   padding-bottom: 0;
1.693     droeschl 6407: }
                   6408: 
1.721     harmsja  6409: .LC_ListStyleSimple dd,
1.795     www      6410: .LC_ListStyleSimple li {
1.911     bisitz   6411:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6412: }
                   6413: 
1.721     harmsja  6414: .LC_ListStyleSpecial li,
                   6415: .LC_ListStyleSpecial dd {
1.911     bisitz   6416:   list-style-type: none;
                   6417:   background-color: RGB(220, 220, 220);
                   6418:   margin-bottom: 4px;
1.693     droeschl 6419: }
                   6420: 
1.721     harmsja  6421: table.LC_SimpleTable {
1.911     bisitz   6422:   margin:5px;
                   6423:   border:solid 1px $lg_border_color;
1.795     www      6424: }
1.693     droeschl 6425: 
1.721     harmsja  6426: table.LC_SimpleTable tr {
1.911     bisitz   6427:   padding: 0;
                   6428:   border:solid 1px $lg_border_color;
1.693     droeschl 6429: }
1.795     www      6430: 
                   6431: table.LC_SimpleTable thead {
1.911     bisitz   6432:   background:rgb(220,220,220);
1.693     droeschl 6433: }
                   6434: 
1.721     harmsja  6435: div.LC_columnSection {
1.911     bisitz   6436:   display: block;
                   6437:   clear: both;
                   6438:   overflow: hidden;
                   6439:   margin: 0;
1.693     droeschl 6440: }
                   6441: 
1.721     harmsja  6442: div.LC_columnSection>* {
1.911     bisitz   6443:   float: left;
                   6444:   margin: 10px 20px 10px 0;
                   6445:   overflow:hidden;
1.693     droeschl 6446: }
1.721     harmsja  6447: 
1.694     tempelho 6448: .LC_loginpage_container {
1.911     bisitz   6449:   text-align:left;
                   6450:   margin : 0 auto;
                   6451:   width:90%;
                   6452:   padding: 10px;
                   6453:   height: auto;
                   6454:   background-color:#FFFFFF;
                   6455:   border:1px solid #CCCCCC;
1.694     tempelho 6456: }
                   6457: 
                   6458: 
                   6459: .LC_loginpage_loginContainer {
1.911     bisitz   6460:   float:left;
                   6461:   width: 182px;
                   6462:   padding: 2px;
                   6463:   border:1px solid #CCCCCC;
                   6464:   background-color:$loginbg;
1.694     tempelho 6465: }
                   6466: 
1.795     www      6467: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6468:   margin-top: 0;
                   6469:   display:block;
                   6470:   background:$bgcol;
                   6471:   color:$textcol;
                   6472:   padding-left:5px;
1.712     muellerd 6473: }
1.785     tempelho 6474: 
1.694     tempelho 6475: .LC_loginpage_loginInfo {
1.911     bisitz   6476:   float:left;
                   6477:   width:182px;
                   6478:   border:1px solid #CCCCCC;
                   6479:   padding:2px;
1.712     muellerd 6480: }
                   6481: 
1.694     tempelho 6482: .LC_loginpage_space {
1.911     bisitz   6483:   clear: both;
                   6484:   margin-bottom: 20px;
                   6485:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6486: }
                   6487: 
1.785     tempelho 6488: .LC_loginpage_floatLeft {
1.911     bisitz   6489:   float: left;
                   6490:   width: 200px;
                   6491:   margin: 0;
1.785     tempelho 6492: }
                   6493: 
1.795     www      6494: table em {
1.911     bisitz   6495:   font-weight: bold;
                   6496:   font-style: normal;
1.748     schulted 6497: }
1.795     www      6498: 
1.779     bisitz   6499: table.LC_tableBrowseRes,
1.795     www      6500: table.LC_tableOfContent {
1.911     bisitz   6501:   border:none;
                   6502:   border-spacing: 1px;
                   6503:   padding: 3px;
                   6504:   background-color: #FFFFFF;
                   6505:   font-size: 90%;
1.753     droeschl 6506: }
1.789     droeschl 6507: 
1.911     bisitz   6508: table.LC_tableOfContent {
                   6509:   border-collapse: collapse;
1.789     droeschl 6510: }
                   6511: 
1.771     droeschl 6512: table.LC_tableBrowseRes a,
1.768     schulted 6513: table.LC_tableOfContent a {
1.911     bisitz   6514:   background-color: transparent;
                   6515:   text-decoration: none;
1.753     droeschl 6516: }
                   6517: 
1.795     www      6518: table.LC_tableOfContent img {
1.911     bisitz   6519:   border: none;
                   6520:   height: 1.3em;
                   6521:   vertical-align: text-bottom;
                   6522:   margin-right: 0.3em;
1.753     droeschl 6523: }
1.757     schulted 6524: 
1.795     www      6525: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6526:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6527: }
                   6528: 
1.795     www      6529: a#LC_content_toolbar_launchnav {
1.911     bisitz   6530:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6531: }
                   6532: 
1.795     www      6533: a#LC_content_toolbar_closenav {
1.911     bisitz   6534:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6535: }
                   6536: 
1.795     www      6537: a#LC_content_toolbar_everything {
1.911     bisitz   6538:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6539: }
                   6540: 
1.795     www      6541: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6542:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6543: }
                   6544: 
1.795     www      6545: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6546:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6547: }
                   6548: 
1.795     www      6549: a#LC_content_toolbar_changefolder {
1.911     bisitz   6550:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6551: }
                   6552: 
1.795     www      6553: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6554:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6555: }
                   6556: 
1.795     www      6557: ul#LC_toolbar li a:hover {
1.911     bisitz   6558:   background-position: bottom center;
1.757     schulted 6559: }
                   6560: 
1.795     www      6561: ul#LC_toolbar {
1.911     bisitz   6562:   padding: 0;
                   6563:   margin: 2px;
                   6564:   list-style:none;
                   6565:   position:relative;
                   6566:   background-color:white;
1.757     schulted 6567: }
                   6568: 
1.795     www      6569: ul#LC_toolbar li {
1.911     bisitz   6570:   border:1px solid white;
                   6571:   padding: 0;
                   6572:   margin: 0;
                   6573:   float: left;
                   6574:   display:inline;
                   6575:   vertical-align:middle;
                   6576: }
1.757     schulted 6577: 
1.783     amueller 6578: 
1.795     www      6579: a.LC_toolbarItem {
1.911     bisitz   6580:   display:block;
                   6581:   padding: 0;
                   6582:   margin: 0;
                   6583:   height: 32px;
                   6584:   width: 32px;
                   6585:   color:white;
                   6586:   border: none;
                   6587:   background-repeat:no-repeat;
                   6588:   background-color:transparent;
1.757     schulted 6589: }
                   6590: 
1.915     droeschl 6591: ul.LC_funclist {
                   6592:     margin: 0;
                   6593:     padding: 0.5em 1em 0.5em 0;
                   6594: }
                   6595: 
1.925.2.14  raeburn  6596: ul.LC_funclist > li:first-child {
                   6597:     font-weight:bold;
                   6598:     margin-left:0.8em;
                   6599: }
                   6600: 
1.915     droeschl 6601: ul.LC_funclist + ul.LC_funclist {
                   6602:     /* 
                   6603:        left border as a seperator if we have more than
                   6604:        one list 
                   6605:     */
                   6606:     border-left: 1px solid $sidebg;
                   6607:     /* 
                   6608:        this hides the left border behind the border of the 
                   6609:        outer box if element is wrapped to the next 'line' 
                   6610:     */
                   6611:     margin-left: -1px;
                   6612: }
                   6613: 
1.843     bisitz   6614: ul.LC_funclist li {
1.915     droeschl 6615:   display: inline;
1.782     bisitz   6616:   white-space: nowrap;
1.915     droeschl 6617:   margin: 0 0 0 25px;
                   6618:   line-height: 150%;
1.782     bisitz   6619: }
                   6620: 
1.925.2.1  raeburn  6621: #gciheader {
                   6622:   float:left;
                   6623:   width:100%;
                   6624:   background:#DAE0D2 url("/gcimenu_bg.gif") repeat-x bottom;
                   6625:   font-size:93%;
                   6626:   line-height:normal;
1.925.2.14  raeburn  6627:   margin: 0.5em 0 0.5em 0;
1.925.2.1  raeburn  6628: }
                   6629: #gciheader ul {
                   6630:   margin:0;
1.925.2.16! raeburn  6631:   padding:10px 10px 0;
1.925.2.1  raeburn  6632:   list-style:none;
                   6633: }
                   6634: #gciheader li {
                   6635:   float:left;
                   6636:   background:url("/gcimenu_left.gif") no-repeat left top;
                   6637:   margin:0;
                   6638:   padding:0 0 0 9px;
                   6639: }
                   6640: #gciheader a {
                   6641:   display:block;
                   6642:   background:url("/gcimenu_right.gif") no-repeat right top;
                   6643:   padding:5px 15px 4px 6px;
                   6644: }
                   6645: #gciheader #current {
                   6646:   background-image:url("/gcimenu_left_on.gif");
                   6647: }
                   6648: #gciheader #current a {
                   6649:   background-image:url("/gcimenu_right_on.gif");
                   6650:   padding-bottom:5px;
                   6651: }
1.757     schulted 6652: 
1.343     albertel 6653: END
                   6654: }
                   6655: 
1.306     albertel 6656: =pod
                   6657: 
                   6658: =item * &headtag()
                   6659: 
                   6660: Returns a uniform footer for LON-CAPA web pages.
                   6661: 
1.307     albertel 6662: Inputs: $title - optional title for the head
                   6663:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6664:         $args - optional arguments
1.319     albertel 6665:             force_register - if is true call registerurl so the remote is 
                   6666:                              informed
1.415     albertel 6667:             redirect       -> array ref of
                   6668:                                    1- seconds before redirect occurs
                   6669:                                    2- url to redirect to
                   6670:                                    3- whether the side effect should occur
1.315     albertel 6671:                            (side effect of setting 
                   6672:                                $env{'internal.head.redirect'} to the url 
                   6673:                                redirected too)
1.352     albertel 6674:             domain         -> force to color decorate a page for a specific
                   6675:                                domain
                   6676:             function       -> force usage of a specific rolish color scheme
                   6677:             bgcolor        -> override the default page bgcolor
1.460     albertel 6678:             no_auto_mt_title
                   6679:                            -> prevent &mt()ing the title arg
1.464     albertel 6680: 
1.306     albertel 6681: =cut
                   6682: 
                   6683: sub headtag {
1.313     albertel 6684:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6685:     
1.363     albertel 6686:     my $function = $args->{'function'} || &get_users_function();
                   6687:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6688:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6689:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6690: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6691: 		   #time(),
1.418     albertel 6692: 		   $env{'environment.color.timestamp'},
1.363     albertel 6693: 		   $function,$domain,$bgcolor);
                   6694: 
1.369     www      6695:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6696: 
1.308     albertel 6697:     my $result =
                   6698: 	'<head>'.
1.461     albertel 6699: 	&font_settings();
1.319     albertel 6700: 
1.461     albertel 6701:     if (!$args->{'frameset'}) {
                   6702: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6703:     }
1.319     albertel 6704:     if ($args->{'force_register'}) {
                   6705: 	$result .= &Apache::lonmenu::registerurl(1);
                   6706:     }
1.436     albertel 6707:     if (!$args->{'no_nav_bar'} 
                   6708: 	&& !$args->{'only_body'}
                   6709: 	&& !$args->{'frameset'}) {
                   6710: 	$result .= &help_menu_js();
                   6711:     }
1.319     albertel 6712: 
1.314     albertel 6713:     if (ref($args->{'redirect'})) {
1.414     albertel 6714: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6715: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6716: 	if (!$inhibit_continue) {
                   6717: 	    $env{'internal.head.redirect'} = $url;
                   6718: 	}
1.313     albertel 6719: 	$result.=<<ADDMETA
                   6720: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6721: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6722: ADDMETA
                   6723:     }
1.306     albertel 6724:     if (!defined($title)) {
                   6725: 	$title = 'The LearningOnline Network with CAPA';
                   6726:     }
1.460     albertel 6727:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6728:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6729: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6730: 	.$head_extra;
1.306     albertel 6731:     return $result;
                   6732: }
                   6733: 
                   6734: =pod
                   6735: 
1.340     albertel 6736: =item * &font_settings()
                   6737: 
                   6738: Returns neccessary <meta> to set the proper encoding
                   6739: 
                   6740: Inputs: none
                   6741: 
                   6742: =cut
                   6743: 
                   6744: sub font_settings {
                   6745:     my $headerstring='';
1.647     www      6746:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6747: 	$headerstring.=
                   6748: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6749:     }
                   6750:     return $headerstring;
                   6751: }
                   6752: 
1.341     albertel 6753: =pod
                   6754: 
                   6755: =item * &xml_begin()
                   6756: 
                   6757: Returns the needed doctype and <html>
                   6758: 
                   6759: Inputs: none
                   6760: 
                   6761: =cut
                   6762: 
                   6763: sub xml_begin {
                   6764:     my $output='';
                   6765: 
1.592     albertel 6766:     if ($env{'internal.start_page'}==1) {
                   6767: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6768:     }
1.342     albertel 6769: 
1.341     albertel 6770:     if ($env{'browser.mathml'}) {
                   6771: 	$output='<?xml version="1.0"?>'
                   6772:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6773: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6774:             
                   6775: #	    .'<!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">] >'
                   6776: 	    .'<!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">'
                   6777:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6778: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6779:     } else {
1.849     bisitz   6780: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6781:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6782:     }
                   6783:     return $output;
                   6784: }
1.340     albertel 6785: 
                   6786: =pod
                   6787: 
1.306     albertel 6788: =item * &endheadtag()
                   6789: 
                   6790: Returns a uniform </head> for LON-CAPA web pages.
                   6791: 
                   6792: Inputs: none
                   6793: 
                   6794: =cut
                   6795: 
                   6796: sub endheadtag {
                   6797:     return '</head>';
                   6798: }
                   6799: 
                   6800: =pod
                   6801: 
                   6802: =item * &head()
                   6803: 
                   6804: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6805: 
1.648     raeburn  6806: Inputs:
                   6807: 
                   6808: =over 4
                   6809: 
                   6810: $title - optional title for the page
                   6811: 
                   6812: $head_extra - optional extra HTML to put inside the <head>
                   6813: 
                   6814: =back
1.405     albertel 6815: 
1.306     albertel 6816: =cut
                   6817: 
                   6818: sub head {
1.325     albertel 6819:     my ($title,$head_extra,$args) = @_;
                   6820:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6821: }
                   6822: 
                   6823: =pod
                   6824: 
                   6825: =item * &start_page()
                   6826: 
                   6827: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6828: 
1.648     raeburn  6829: Inputs:
                   6830: 
                   6831: =over 4
                   6832: 
                   6833: $title - optional title for the page
                   6834: 
                   6835: $head_extra - optional extra HTML to incude inside the <head>
                   6836: 
                   6837: $args - additional optional args supported are:
                   6838: 
                   6839: =over 8
                   6840: 
                   6841:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6842:                                     arg on
1.814     bisitz   6843:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6844:              add_entries    -> additional attributes to add to the  <body>
                   6845:              domain         -> force to color decorate a page for a 
1.317     albertel 6846:                                     specific domain
1.648     raeburn  6847:              function       -> force usage of a specific rolish color
1.317     albertel 6848:                                     scheme
1.648     raeburn  6849:              redirect       -> see &headtag()
                   6850:              bgcolor        -> override the default page bg color
                   6851:              js_ready       -> return a string ready for being used in 
1.317     albertel 6852:                                     a javascript writeln
1.648     raeburn  6853:              html_encode    -> return a string ready for being used in 
1.320     albertel 6854:                                     a html attribute
1.648     raeburn  6855:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6856:                                     $forcereg arg
1.648     raeburn  6857:              frameset       -> if true will start with a <frameset>
1.330     albertel 6858:                                     rather than <body>
1.648     raeburn  6859:              skip_phases    -> hash ref of 
1.338     albertel 6860:                                     head -> skip the <html><head> generation
                   6861:                                     body -> skip all <body> generation
1.648     raeburn  6862:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6863:                                     'Switch To Inline Menu' link
1.648     raeburn  6864:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6865:              inherit_jsmath -> when creating popup window in a page,
                   6866:                                     should it have jsmath forced on by the
                   6867:                                     current page
1.867     kalberla 6868:              bread_crumbs ->             Array containing breadcrumbs
                   6869:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6870: 
1.648     raeburn  6871: =back
1.460     albertel 6872: 
1.648     raeburn  6873: =back
1.562     albertel 6874: 
1.306     albertel 6875: =cut
                   6876: 
                   6877: sub start_page {
1.309     albertel 6878:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6879:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6880:     my %head_args;
1.352     albertel 6881:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6882: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6883: 		     'no_auto_mt_title') {
1.319     albertel 6884: 	if (defined($args->{$arg})) {
1.324     raeburn  6885: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6886: 	}
1.313     albertel 6887:     }
1.319     albertel 6888: 
1.315     albertel 6889:     $env{'internal.start_page'}++;
1.338     albertel 6890:     my $result;
                   6891:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6892: 	$result.=
1.341     albertel 6893: 	    &xml_begin().
1.338     albertel 6894: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6895:     }
                   6896:     
                   6897:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6898: 	if ($args->{'frameset'}) {
                   6899: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6900: 						$args->{'add_entries'});
                   6901: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6902:         } else {
                   6903:             $result .=
                   6904:                 &bodytag($title, 
                   6905:                          $args->{'function'},       $args->{'add_entries'},
                   6906:                          $args->{'only_body'},      $args->{'domain'},
                   6907:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6908:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6909:                          $args);
                   6910:         }
1.330     albertel 6911:     }
1.338     albertel 6912: 
1.315     albertel 6913:     if ($args->{'js_ready'}) {
1.713     kaisler  6914: 		$result = &js_ready($result);
1.315     albertel 6915:     }
1.320     albertel 6916:     if ($args->{'html_encode'}) {
1.713     kaisler  6917: 		$result = &html_encode($result);
                   6918:     }
                   6919: 
1.813     bisitz   6920:     # Preparation for new and consistent functionlist at top of screen
                   6921:     # if ($args->{'functionlist'}) {
                   6922:     #            $result .= &build_functionlist();
                   6923:     #}
                   6924: 
                   6925:     # Don't add anything more if only_body wanted
                   6926:     return $result if $args->{'only_body'};
                   6927: 
1.920     raeburn  6928:     #Breadcrumbs for Construction Space provided by &bodytag. 
                   6929:     if (($env{'environment.remote'} eq 'off') && ($env{'request.state'} eq 'construct')) {
                   6930:         return $result;
                   6931:     }
                   6932:  
1.813     bisitz   6933:     #Breadcrumbs
1.758     kaisler  6934:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6935: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6936: 		#if any br links exists, add them to the breadcrumbs
                   6937: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6938: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6939: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6940: 			}
                   6941: 		}
                   6942: 
                   6943: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6944: 		if(exists($args->{'bread_crumbs_component'})){
                   6945: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
1.925.2.16! raeburn  6946: 		} elsif (exists($args->{'bread_crumbs_menulink'})) {
        !          6947:                 	$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$args->{'bread_crumbs_menulink'});
        !          6948:                 } else {
1.925.2.14  raeburn  6949:                 	$result .= &Apache::lonhtmlcommon::breadcrumbs(); 
1.758     kaisler  6950: 		}
1.320     albertel 6951:     }
1.315     albertel 6952:     return $result;
1.306     albertel 6953: }
                   6954: 
1.330     albertel 6955: 
1.306     albertel 6956: =pod
                   6957: 
                   6958: =item * &head()
                   6959: 
                   6960: Returns a complete </body></html> section for LON-CAPA web pages.
                   6961: 
1.315     albertel 6962: Inputs:         $args - additional optional args supported are:
                   6963:                  js_ready     -> return a string ready for being used in 
                   6964:                                  a javascript writeln
1.320     albertel 6965:                  html_encode  -> return a string ready for being used in 
                   6966:                                  a html attribute
1.330     albertel 6967:                  frameset     -> if true will start with a <frameset>
                   6968:                                  rather than <body>
1.493     albertel 6969:                  dicsussion   -> if true will get discussion from
                   6970:                                   lonxml::xmlend
                   6971:                                  (you can pass the target and parser arguments
                   6972:                                   through optional 'target' and 'parser' args
                   6973:                                   to this routine)
1.306     albertel 6974: 
                   6975: =cut
                   6976: 
                   6977: sub end_page {
1.315     albertel 6978:     my ($args) = @_;
                   6979:     $env{'internal.end_page'}++;
1.330     albertel 6980:     my $result;
1.335     albertel 6981:     if ($args->{'discussion'}) {
                   6982: 	my ($target,$parser);
                   6983: 	if (ref($args->{'discussion'})) {
                   6984: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6985: 				$args->{'discussion'}{'parser'});
                   6986: 	}
                   6987: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6988:     }
                   6989: 
1.330     albertel 6990:     if ($args->{'frameset'}) {
                   6991: 	$result .= '</frameset>';
                   6992:     } else {
1.635     raeburn  6993: 	$result .= &endbodytag($args);
1.330     albertel 6994:     }
                   6995:     $result .= "\n</html>";
                   6996: 
1.315     albertel 6997:     if ($args->{'js_ready'}) {
1.317     albertel 6998: 	$result = &js_ready($result);
1.315     albertel 6999:     }
1.335     albertel 7000: 
1.320     albertel 7001:     if ($args->{'html_encode'}) {
                   7002: 	$result = &html_encode($result);
                   7003:     }
1.335     albertel 7004: 
1.315     albertel 7005:     return $result;
                   7006: }
                   7007: 
1.320     albertel 7008: sub html_encode {
                   7009:     my ($result) = @_;
                   7010: 
1.322     albertel 7011:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7012:     
                   7013:     return $result;
                   7014: }
1.317     albertel 7015: sub js_ready {
                   7016:     my ($result) = @_;
                   7017: 
1.323     albertel 7018:     $result =~ s/[\n\r]/ /xmsg;
                   7019:     $result =~ s/\\/\\\\/xmsg;
                   7020:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7021:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7022:     
                   7023:     return $result;
                   7024: }
                   7025: 
1.315     albertel 7026: sub validate_page {
                   7027:     if (  exists($env{'internal.start_page'})
1.316     albertel 7028: 	  &&     $env{'internal.start_page'} > 1) {
                   7029: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7030: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7031: 				 $ENV{'request.filename'});
1.315     albertel 7032:     }
                   7033:     if (  exists($env{'internal.end_page'})
1.316     albertel 7034: 	  &&     $env{'internal.end_page'} > 1) {
                   7035: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7036: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7037: 				 $env{'request.filename'});
1.315     albertel 7038:     }
                   7039:     if (     exists($env{'internal.start_page'})
                   7040: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7041: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7042: 				 $env{'request.filename'});
1.315     albertel 7043:     }
                   7044:     if (   ! exists($env{'internal.start_page'})
                   7045: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7046: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7047: 				 $env{'request.filename'});
1.315     albertel 7048:     }
1.306     albertel 7049: }
1.315     albertel 7050: 
1.318     albertel 7051: sub simple_error_page {
                   7052:     my ($r,$title,$msg) = @_;
                   7053:     my $page =
                   7054: 	&Apache::loncommon::start_page($title).
                   7055: 	&mt($msg).
                   7056: 	&Apache::loncommon::end_page();
                   7057:     if (ref($r)) {
                   7058: 	$r->print($page);
1.327     albertel 7059: 	return;
1.318     albertel 7060:     }
                   7061:     return $page;
                   7062: }
1.347     albertel 7063: 
                   7064: {
1.610     albertel 7065:     my @row_count;
1.347     albertel 7066:     sub start_data_table {
1.422     albertel 7067: 	my ($add_class) = @_;
                   7068: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 7069: 	unshift(@row_count,0);
1.422     albertel 7070: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 7071:     }
                   7072: 
                   7073:     sub end_data_table {
1.610     albertel 7074: 	shift(@row_count);
1.389     albertel 7075: 	return '</table>'."\n";;
1.347     albertel 7076:     }
                   7077: 
                   7078:     sub start_data_table_row {
1.422     albertel 7079: 	my ($add_class) = @_;
1.610     albertel 7080: 	$row_count[0]++;
                   7081: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7082: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 7083: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 7084:     }
1.471     banghart 7085:     
                   7086:     sub continue_data_table_row {
                   7087: 	my ($add_class) = @_;
1.610     albertel 7088: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7089: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 7090: 	return  '<tr class="'.$css_class.'">'."\n";;
                   7091:     }
1.347     albertel 7092: 
                   7093:     sub end_data_table_row {
1.389     albertel 7094: 	return '</tr>'."\n";;
1.347     albertel 7095:     }
1.367     www      7096: 
1.421     albertel 7097:     sub start_data_table_empty_row {
1.707     bisitz   7098: #	$row_count[0]++;
1.421     albertel 7099: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7100:     }
                   7101: 
                   7102:     sub end_data_table_empty_row {
                   7103: 	return '</tr>'."\n";;
                   7104:     }
                   7105: 
1.367     www      7106:     sub start_data_table_header_row {
1.389     albertel 7107: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7108:     }
                   7109: 
                   7110:     sub end_data_table_header_row {
1.389     albertel 7111: 	return '</tr>'."\n";;
1.367     www      7112:     }
1.890     droeschl 7113: 
                   7114:     sub data_table_caption {
                   7115:         my $caption = shift;
                   7116:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7117:     }
1.347     albertel 7118: }
                   7119: 
1.548     albertel 7120: =pod
                   7121: 
                   7122: =item * &inhibit_menu_check($arg)
                   7123: 
                   7124: Checks for a inhibitmenu state and generates output to preserve it
                   7125: 
                   7126: Inputs:         $arg - can be any of
                   7127:                      - undef - in which case the return value is a string 
                   7128:                                to add  into arguments list of a uri
                   7129:                      - 'input' - in which case the return value is a HTML
                   7130:                                  <form> <input> field of type hidden to
                   7131:                                  preserve the value
                   7132:                      - a url - in which case the return value is the url with
                   7133:                                the neccesary cgi args added to preserve the
                   7134:                                inhibitmenu state
                   7135:                      - a ref to a url - no return value, but the string is
                   7136:                                         updated to include the neccessary cgi
                   7137:                                         args to preserve the inhibitmenu state
                   7138: 
                   7139: =cut
                   7140: 
                   7141: sub inhibit_menu_check {
                   7142:     my ($arg) = @_;
                   7143:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7144:     if ($arg eq 'input') {
                   7145: 	if ($env{'form.inhibitmenu'}) {
                   7146: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7147: 	} else {
                   7148: 	    return
                   7149: 	}
                   7150:     }
                   7151:     if ($env{'form.inhibitmenu'}) {
                   7152: 	if (ref($arg)) {
                   7153: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7154: 	} elsif ($arg eq '') {
                   7155: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7156: 	} else {
                   7157: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7158: 	}
                   7159:     }
                   7160:     if (!ref($arg)) {
                   7161: 	return $arg;
                   7162:     }
                   7163: }
                   7164: 
1.251     albertel 7165: ###############################################
1.182     matthew  7166: 
                   7167: =pod
                   7168: 
1.549     albertel 7169: =back
                   7170: 
                   7171: =head1 User Information Routines
                   7172: 
                   7173: =over 4
                   7174: 
1.405     albertel 7175: =item * &get_users_function()
1.182     matthew  7176: 
                   7177: Used by &bodytag to determine the current users primary role.
                   7178: Returns either 'student','coordinator','admin', or 'author'.
                   7179: 
                   7180: =cut
                   7181: 
                   7182: ###############################################
                   7183: sub get_users_function {
1.815     tempelho 7184:     my $function = 'norole';
1.818     tempelho 7185:     if ($env{'request.role'}=~/^(st)/) {
                   7186:         $function='student';
                   7187:     }
1.907     raeburn  7188:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7189:         $function='coordinator';
                   7190:     }
1.258     albertel 7191:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7192:         $function='admin';
                   7193:     }
1.826     bisitz   7194:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7195:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7196:         $function='author';
                   7197:     }
                   7198:     return $function;
1.54      www      7199: }
1.99      www      7200: 
                   7201: ###############################################
                   7202: 
1.233     raeburn  7203: =pod
                   7204: 
1.821     raeburn  7205: =item * &show_course()
                   7206: 
                   7207: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7208: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7209: 
                   7210: Inputs:
                   7211: None
                   7212: 
                   7213: Outputs:
                   7214: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7215: 
                   7216: =cut
                   7217: 
                   7218: ###############################################
                   7219: sub show_course {
                   7220:     my $course = !$env{'user.adv'};
                   7221:     if (!$env{'user.adv'}) {
                   7222:         foreach my $env (keys(%env)) {
                   7223:             next if ($env !~ m/^user\.priv\./);
                   7224:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7225:                 $course = 0;
                   7226:                 last;
                   7227:             }
                   7228:         }
                   7229:     }
                   7230:     return $course;
                   7231: }
                   7232: 
                   7233: ###############################################
                   7234: 
                   7235: =pod
                   7236: 
1.542     raeburn  7237: =item * &check_user_status()
1.274     raeburn  7238: 
                   7239: Determines current status of supplied role for a
                   7240: specific user. Roles can be active, previous or future.
                   7241: 
                   7242: Inputs: 
                   7243: user's domain, user's username, course's domain,
1.375     raeburn  7244: course's number, optional section ID.
1.274     raeburn  7245: 
                   7246: Outputs:
                   7247: role status: active, previous or future. 
                   7248: 
                   7249: =cut
                   7250: 
                   7251: sub check_user_status {
1.412     raeburn  7252:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7253:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7254:     my @uroles = keys %userinfo;
                   7255:     my $srchstr;
                   7256:     my $active_chk = 'none';
1.412     raeburn  7257:     my $now = time;
1.274     raeburn  7258:     if (@uroles > 0) {
1.908     raeburn  7259:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7260:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7261:         } else {
1.412     raeburn  7262:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7263:         }
                   7264:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7265:             my $role_end = 0;
                   7266:             my $role_start = 0;
                   7267:             $active_chk = 'active';
1.412     raeburn  7268:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7269:                 $role_end = $1;
                   7270:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7271:                     $role_start = $1;
1.274     raeburn  7272:                 }
                   7273:             }
                   7274:             if ($role_start > 0) {
1.412     raeburn  7275:                 if ($now < $role_start) {
1.274     raeburn  7276:                     $active_chk = 'future';
                   7277:                 }
                   7278:             }
                   7279:             if ($role_end > 0) {
1.412     raeburn  7280:                 if ($now > $role_end) {
1.274     raeburn  7281:                     $active_chk = 'previous';
                   7282:                 }
                   7283:             }
                   7284:         }
                   7285:     }
                   7286:     return $active_chk;
                   7287: }
                   7288: 
                   7289: ###############################################
                   7290: 
                   7291: =pod
                   7292: 
1.405     albertel 7293: =item * &get_sections()
1.233     raeburn  7294: 
                   7295: Determines all the sections for a course including
                   7296: sections with students and sections containing other roles.
1.419     raeburn  7297: Incoming parameters: 
                   7298: 
                   7299: 1. domain
                   7300: 2. course number 
                   7301: 3. reference to array containing roles for which sections should 
                   7302: be gathered (optional).
                   7303: 4. reference to array containing status types for which sections 
                   7304: should be gathered (optional).
                   7305: 
                   7306: If the third argument is undefined, sections are gathered for any role. 
                   7307: If the fourth argument is undefined, sections are gathered for any status.
                   7308: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7309:  
1.374     raeburn  7310: Returns section hash (keys are section IDs, values are
                   7311: number of users in each section), subject to the
1.419     raeburn  7312: optional roles filter, optional status filter 
1.233     raeburn  7313: 
                   7314: =cut
                   7315: 
                   7316: ###############################################
                   7317: sub get_sections {
1.419     raeburn  7318:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7319:     if (!defined($cdom) || !defined($cnum)) {
                   7320:         my $cid =  $env{'request.course.id'};
                   7321: 
                   7322: 	return if (!defined($cid));
                   7323: 
                   7324:         $cdom = $env{'course.'.$cid.'.domain'};
                   7325:         $cnum = $env{'course.'.$cid.'.num'};
                   7326:     }
                   7327: 
                   7328:     my %sectioncount;
1.419     raeburn  7329:     my $now = time;
1.240     albertel 7330: 
1.366     albertel 7331:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7332: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7333: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7334: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7335:         my $start_index = &Apache::loncoursedata::CL_START();
                   7336:         my $end_index = &Apache::loncoursedata::CL_END();
                   7337:         my $status;
1.366     albertel 7338: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7339: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7340: 				                     $data->[$status_index],
                   7341:                                                      $data->[$start_index],
                   7342:                                                      $data->[$end_index]);
                   7343:             if ($stu_status eq 'Active') {
                   7344:                 $status = 'active';
                   7345:             } elsif ($end < $now) {
                   7346:                 $status = 'previous';
                   7347:             } elsif ($start > $now) {
                   7348:                 $status = 'future';
                   7349:             } 
                   7350: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7351:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7352:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7353: 		    $sectioncount{$section}++;
                   7354:                 }
1.240     albertel 7355: 	    }
                   7356: 	}
                   7357:     }
                   7358:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7359:     foreach my $user (sort(keys(%courseroles))) {
                   7360: 	if ($user !~ /^(\w{2})/) { next; }
                   7361: 	my ($role) = ($user =~ /^(\w{2})/);
                   7362: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7363: 	my ($section,$status);
1.240     albertel 7364: 	if ($role eq 'cr' &&
                   7365: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7366: 	    $section=$1;
                   7367: 	}
                   7368: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7369: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7370:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7371:         if ($end == -1 && $start == -1) {
                   7372:             next; #deleted role
                   7373:         }
                   7374:         if (!defined($possible_status)) { 
                   7375:             $sectioncount{$section}++;
                   7376:         } else {
                   7377:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7378:                 $status = 'active';
                   7379:             } elsif ($end < $now) {
                   7380:                 $status = 'future';
                   7381:             } elsif ($start > $now) {
                   7382:                 $status = 'previous';
                   7383:             }
                   7384:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7385:                 $sectioncount{$section}++;
                   7386:             }
                   7387:         }
1.233     raeburn  7388:     }
1.366     albertel 7389:     return %sectioncount;
1.233     raeburn  7390: }
                   7391: 
1.274     raeburn  7392: ###############################################
1.294     raeburn  7393: 
                   7394: =pod
1.405     albertel 7395: 
                   7396: =item * &get_course_users()
                   7397: 
1.275     raeburn  7398: Retrieves usernames:domains for users in the specified course
                   7399: with specific role(s), and access status. 
                   7400: 
                   7401: Incoming parameters:
1.277     albertel 7402: 1. course domain
                   7403: 2. course number
                   7404: 3. access status: users must have - either active, 
1.275     raeburn  7405: previous, future, or all.
1.277     albertel 7406: 4. reference to array of permissible roles
1.288     raeburn  7407: 5. reference to array of section restrictions (optional)
                   7408: 6. reference to results object (hash of hashes).
                   7409: 7. reference to optional userdata hash
1.609     raeburn  7410: 8. reference to optional statushash
1.630     raeburn  7411: 9. flag if privileged users (except those set to unhide in
                   7412:    course settings) should be excluded    
1.609     raeburn  7413: Keys of top level results hash are roles.
1.275     raeburn  7414: Keys of inner hashes are username:domain, with 
                   7415: values set to access type.
1.288     raeburn  7416: Optional userdata hash returns an array with arguments in the 
                   7417: same order as loncoursedata::get_classlist() for student data.
                   7418: 
1.609     raeburn  7419: Optional statushash returns
                   7420: 
1.288     raeburn  7421: Entries for end, start, section and status are blank because
                   7422: of the possibility of multiple values for non-student roles.
                   7423: 
1.275     raeburn  7424: =cut
1.405     albertel 7425: 
1.275     raeburn  7426: ###############################################
1.405     albertel 7427: 
1.275     raeburn  7428: sub get_course_users {
1.630     raeburn  7429:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7430:     my %idx = ();
1.419     raeburn  7431:     my %seclists;
1.288     raeburn  7432: 
                   7433:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7434:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7435:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7436:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7437:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7438:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7439:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7440:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7441: 
1.290     albertel 7442:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7443:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7444:         my $now = time;
1.277     albertel 7445:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7446:             my $match = 0;
1.412     raeburn  7447:             my $secmatch = 0;
1.419     raeburn  7448:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7449:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7450:             if ($section eq '') {
                   7451:                 $section = 'none';
                   7452:             }
1.291     albertel 7453:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7454:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7455:                     $secmatch = 1;
                   7456:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7457:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7458:                         $secmatch = 1;
                   7459:                     }
                   7460:                 } else {  
1.419     raeburn  7461: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7462: 		        $secmatch = 1;
                   7463:                     }
1.290     albertel 7464: 		}
1.412     raeburn  7465:                 if (!$secmatch) {
                   7466:                     next;
                   7467:                 }
1.419     raeburn  7468:             }
1.275     raeburn  7469:             if (defined($$types{'active'})) {
1.288     raeburn  7470:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7471:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7472:                     $match = 1;
1.275     raeburn  7473:                 }
                   7474:             }
                   7475:             if (defined($$types{'previous'})) {
1.609     raeburn  7476:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7477:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7478:                     $match = 1;
1.275     raeburn  7479:                 }
                   7480:             }
                   7481:             if (defined($$types{'future'})) {
1.609     raeburn  7482:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7483:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7484:                     $match = 1;
1.275     raeburn  7485:                 }
                   7486:             }
1.609     raeburn  7487:             if ($match) {
                   7488:                 push(@{$seclists{$student}},$section);
                   7489:                 if (ref($userdata) eq 'HASH') {
                   7490:                     $$userdata{$student} = $$classlist{$student};
                   7491:                 }
                   7492:                 if (ref($statushash) eq 'HASH') {
                   7493:                     $statushash->{$student}{'st'}{$section} = $status;
                   7494:                 }
1.288     raeburn  7495:             }
1.275     raeburn  7496:         }
                   7497:     }
1.412     raeburn  7498:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7499:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7500:         my $now = time;
1.609     raeburn  7501:         my %displaystatus = ( previous => 'Expired',
                   7502:                               active   => 'Active',
                   7503:                               future   => 'Future',
                   7504:                             );
1.630     raeburn  7505:         my %nothide;
                   7506:         if ($hidepriv) {
                   7507:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7508:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7509:                 if ($user !~ /:/) {
                   7510:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7511:                 } else {
                   7512:                     $nothide{$user} = 1;
                   7513:                 }
                   7514:             }
                   7515:         }
1.439     raeburn  7516:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7517:             my $match = 0;
1.412     raeburn  7518:             my $secmatch = 0;
1.439     raeburn  7519:             my $status;
1.412     raeburn  7520:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7521:             $user =~ s/:$//;
1.439     raeburn  7522:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7523:             if ($end == -1 || $start == -1) {
                   7524:                 next;
                   7525:             }
                   7526:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7527:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7528:                 my ($uname,$udom) = split(/:/,$user);
                   7529:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7530:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7531:                         $secmatch = 1;
                   7532:                     } elsif ($usec eq '') {
1.420     albertel 7533:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7534:                             $secmatch = 1;
                   7535:                         }
                   7536:                     } else {
                   7537:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7538:                             $secmatch = 1;
                   7539:                         }
                   7540:                     }
                   7541:                     if (!$secmatch) {
                   7542:                         next;
                   7543:                     }
1.288     raeburn  7544:                 }
1.419     raeburn  7545:                 if ($usec eq '') {
                   7546:                     $usec = 'none';
                   7547:                 }
1.275     raeburn  7548:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7549:                     if ($hidepriv) {
                   7550:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7551:                             (!$nothide{$uname.':'.$udom})) {
                   7552:                             next;
                   7553:                         }
                   7554:                     }
1.503     raeburn  7555:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7556:                         $status = 'previous';
                   7557:                     } elsif ($start > $now) {
                   7558:                         $status = 'future';
                   7559:                     } else {
                   7560:                         $status = 'active';
                   7561:                     }
1.277     albertel 7562:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7563:                         if ($status eq $type) {
1.420     albertel 7564:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7565:                                 push(@{$$users{$role}{$user}},$type);
                   7566:                             }
1.288     raeburn  7567:                             $match = 1;
                   7568:                         }
                   7569:                     }
1.419     raeburn  7570:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7571:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7572: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7573:                         }
1.420     albertel 7574:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7575:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7576:                         }
1.609     raeburn  7577:                         if (ref($statushash) eq 'HASH') {
                   7578:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7579:                         }
1.275     raeburn  7580:                     }
                   7581:                 }
                   7582:             }
                   7583:         }
1.290     albertel 7584:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7585:             if ((defined($cdom)) && (defined($cnum))) {
                   7586:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7587:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7588:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7589:                     next if ($owner eq '');
                   7590:                     my ($ownername,$ownerdom);
                   7591:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7592:                         $ownername = $1;
                   7593:                         $ownerdom = $2;
                   7594:                     } else {
                   7595:                         $ownername = $owner;
                   7596:                         $ownerdom = $cdom;
                   7597:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7598:                     }
                   7599:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7600:                     if (defined($userdata) && 
1.609     raeburn  7601: 			!exists($$userdata{$owner})) {
                   7602: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7603:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7604:                             push(@{$seclists{$owner}},'none');
                   7605:                         }
                   7606:                         if (ref($statushash) eq 'HASH') {
                   7607:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7608:                         }
1.290     albertel 7609: 		    }
1.279     raeburn  7610:                 }
                   7611:             }
                   7612:         }
1.419     raeburn  7613:         foreach my $user (keys(%seclists)) {
                   7614:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7615:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7616:         }
1.275     raeburn  7617:     }
                   7618:     return;
                   7619: }
                   7620: 
1.288     raeburn  7621: sub get_user_info {
                   7622:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7623:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7624: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7625:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7626:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7627:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7628:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7629:     return;
                   7630: }
1.275     raeburn  7631: 
1.472     raeburn  7632: ###############################################
                   7633: 
                   7634: =pod
                   7635: 
                   7636: =item * &get_user_quota()
                   7637: 
                   7638: Retrieves quota assigned for storage of portfolio files for a user  
                   7639: 
                   7640: Incoming parameters:
                   7641: 1. user's username
                   7642: 2. user's domain
                   7643: 
                   7644: Returns:
1.536     raeburn  7645: 1. Disk quota (in Mb) assigned to student.
                   7646: 2. (Optional) Type of setting: custom or default
                   7647:    (individually assigned or default for user's 
                   7648:    institutional status).
                   7649: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7650:    or student - types as defined in localenroll::inst_usertypes 
                   7651:    for user's domain, which determines default quota for user.
                   7652: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7653: 
                   7654: If a value has been stored in the user's environment, 
1.536     raeburn  7655: it will return that, otherwise it returns the maximal default
                   7656: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7657: 
                   7658: =cut
                   7659: 
                   7660: ###############################################
                   7661: 
                   7662: 
                   7663: sub get_user_quota {
                   7664:     my ($uname,$udom) = @_;
1.536     raeburn  7665:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7666:     if (!defined($udom)) {
                   7667:         $udom = $env{'user.domain'};
                   7668:     }
                   7669:     if (!defined($uname)) {
                   7670:         $uname = $env{'user.name'};
                   7671:     }
                   7672:     if (($udom eq '' || $uname eq '') ||
                   7673:         ($udom eq 'public') && ($uname eq 'public')) {
                   7674:         $quota = 0;
1.536     raeburn  7675:         $quotatype = 'default';
                   7676:         $defquota = 0; 
1.472     raeburn  7677:     } else {
1.536     raeburn  7678:         my $inststatus;
1.472     raeburn  7679:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7680:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7681:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7682:         } else {
1.536     raeburn  7683:             my %userenv = 
                   7684:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7685:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7686:             my ($tmp) = keys(%userenv);
                   7687:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7688:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7689:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7690:             } else {
                   7691:                 undef(%userenv);
                   7692:             }
                   7693:         }
1.536     raeburn  7694:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7695:         if ($quota eq '') {
1.536     raeburn  7696:             $quota = $defquota;
                   7697:             $quotatype = 'default';
                   7698:         } else {
                   7699:             $quotatype = 'custom';
1.472     raeburn  7700:         }
                   7701:     }
1.536     raeburn  7702:     if (wantarray) {
                   7703:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7704:     } else {
                   7705:         return $quota;
                   7706:     }
1.472     raeburn  7707: }
                   7708: 
                   7709: ###############################################
                   7710: 
                   7711: =pod
                   7712: 
                   7713: =item * &default_quota()
                   7714: 
1.536     raeburn  7715: Retrieves default quota assigned for storage of user portfolio files,
                   7716: given an (optional) user's institutional status.
1.472     raeburn  7717: 
                   7718: Incoming parameters:
                   7719: 1. domain
1.536     raeburn  7720: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7721:    status types (e.g., faculty, staff, student etc.)
                   7722:    which apply to the user for whom the default is being retrieved.
                   7723:    If the institutional status string in undefined, the domain
                   7724:    default quota will be returned. 
1.472     raeburn  7725: 
                   7726: Returns:
                   7727: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7728: 2. (Optional) institutional type which determined the value of the
                   7729:    default quota.
1.472     raeburn  7730: 
                   7731: If a value has been stored in the domain's configuration db,
                   7732: it will return that, otherwise it returns 20 (for backwards 
                   7733: compatibility with domains which have not set up a configuration
                   7734: db file; the original statically defined portfolio quota was 20 Mb). 
                   7735: 
1.536     raeburn  7736: If the user's status includes multiple types (e.g., staff and student),
                   7737: the largest default quota which applies to the user determines the
                   7738: default quota returned.
                   7739: 
1.780     raeburn  7740: =back
                   7741: 
1.472     raeburn  7742: =cut
                   7743: 
                   7744: ###############################################
                   7745: 
                   7746: 
                   7747: sub default_quota {
1.536     raeburn  7748:     my ($udom,$inststatus) = @_;
                   7749:     my ($defquota,$settingstatus);
                   7750:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7751:                                             ['quotas'],$udom);
                   7752:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7753:         if ($inststatus ne '') {
1.765     raeburn  7754:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7755:             foreach my $item (@statuses) {
1.711     raeburn  7756:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7757:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7758:                         if ($defquota eq '') {
                   7759:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7760:                             $settingstatus = $item;
                   7761:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7762:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7763:                             $settingstatus = $item;
                   7764:                         }
                   7765:                     }
                   7766:                 } else {
                   7767:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7768:                         if ($defquota eq '') {
                   7769:                             $defquota = $quotahash{'quotas'}{$item};
                   7770:                             $settingstatus = $item;
                   7771:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7772:                             $defquota = $quotahash{'quotas'}{$item};
                   7773:                             $settingstatus = $item;
                   7774:                         }
1.536     raeburn  7775:                     }
                   7776:                 }
                   7777:             }
                   7778:         }
                   7779:         if ($defquota eq '') {
1.711     raeburn  7780:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7781:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7782:             } else {
                   7783:                 $defquota = $quotahash{'quotas'}{'default'};
                   7784:             }
1.536     raeburn  7785:             $settingstatus = 'default';
                   7786:         }
                   7787:     } else {
                   7788:         $settingstatus = 'default';
                   7789:         $defquota = 20;
                   7790:     }
                   7791:     if (wantarray) {
                   7792:         return ($defquota,$settingstatus);
1.472     raeburn  7793:     } else {
1.536     raeburn  7794:         return $defquota;
1.472     raeburn  7795:     }
                   7796: }
                   7797: 
1.384     raeburn  7798: sub get_secgrprole_info {
                   7799:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7800:     my %sections_count = &get_sections($cdom,$cnum);
                   7801:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7802:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7803:     my @groups = sort(keys(%curr_groups));
                   7804:     my $allroles = [];
                   7805:     my $rolehash;
                   7806:     my $accesshash = {
                   7807:                      active => 'Currently has access',
                   7808:                      future => 'Will have future access',
                   7809:                      previous => 'Previously had access',
                   7810:                   };
                   7811:     if ($needroles) {
                   7812:         $rolehash = {'all' => 'all'};
1.385     albertel 7813:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7814: 	if (&Apache::lonnet::error(%user_roles)) {
                   7815: 	    undef(%user_roles);
                   7816: 	}
                   7817:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7818:             my ($role)=split(/\:/,$item,2);
                   7819:             if ($role eq 'cr') { next; }
                   7820:             if ($role =~ /^cr/) {
                   7821:                 $$rolehash{$role} = (split('/',$role))[3];
                   7822:             } else {
                   7823:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7824:             }
                   7825:         }
                   7826:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7827:             push(@{$allroles},$key);
                   7828:         }
                   7829:         push (@{$allroles},'st');
                   7830:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7831:     }
                   7832:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7833: }
                   7834: 
1.555     raeburn  7835: sub user_picker {
1.627     raeburn  7836:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7837:     my $currdom = $dom;
                   7838:     my %curr_selected = (
                   7839:                         srchin => 'dom',
1.580     raeburn  7840:                         srchby => 'lastname',
1.555     raeburn  7841:                       );
                   7842:     my $srchterm;
1.625     raeburn  7843:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7844:         if ($srch->{'srchby'} ne '') {
                   7845:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7846:         }
                   7847:         if ($srch->{'srchin'} ne '') {
                   7848:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7849:         }
                   7850:         if ($srch->{'srchtype'} ne '') {
                   7851:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7852:         }
                   7853:         if ($srch->{'srchdomain'} ne '') {
                   7854:             $currdom = $srch->{'srchdomain'};
                   7855:         }
                   7856:         $srchterm = $srch->{'srchterm'};
                   7857:     }
                   7858:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7859:                     'usr'       => 'Search criteria',
1.563     raeburn  7860:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7861:                     'uname'     => 'username',
                   7862:                     'lastname'  => 'last name',
1.555     raeburn  7863:                     'lastfirst' => 'last name, first name',
1.558     albertel 7864:                     'crs'       => 'in this course',
1.576     raeburn  7865:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7866:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7867:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7868:                     'exact'     => 'is',
                   7869:                     'contains'  => 'contains',
1.569     raeburn  7870:                     'begins'    => 'begins with',
1.571     raeburn  7871:                     'youm'      => "You must include some text to search for.",
                   7872:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7873:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7874:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7875:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7876:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7877:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7878:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7879:                                        );
1.925.2.13  raeburn  7880:     my $domform = &select_dom_form($currdom,'srchdomain',undef,1);
1.563     raeburn  7881:     my $srchinsel = ' <select name="srchin">';
1.925.2.13  raeburn  7882:      
1.555     raeburn  7883:     my @srchins = ('crs','dom','alc','instd');
                   7884: 
                   7885:     foreach my $option (@srchins) {
                   7886:         # FIXME 'alc' option unavailable until 
                   7887:         #       loncreateuser::print_user_query_page()
                   7888:         #       has been completed.
                   7889:         next if ($option eq 'alc');
1.880     raeburn  7890:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7891:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.925.2.13  raeburn  7892:         next if ($option eq 'instd');
1.563     raeburn  7893:         if ($curr_selected{'srchin'} eq $option) {
                   7894:             $srchinsel .= ' 
1.925.2.13  raeburn  7895:        <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
1.563     raeburn  7896:         } else {
                   7897:             $srchinsel .= '
1.925.2.13  raeburn  7898:     <option value="'.$option.'">'.$lt{$option}.'</option>';
1.563     raeburn  7899:         }
1.555     raeburn  7900:     }
1.563     raeburn  7901:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7902: 
                   7903:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7904:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7905:         if ($curr_selected{'srchby'} eq $option) {
                   7906:             $srchbysel .= '
                   7907:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7908:         } else {
                   7909:             $srchbysel .= '
                   7910:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7911:          }
                   7912:     }
                   7913:     $srchbysel .= "\n  </select>\n";
                   7914: 
                   7915:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7916:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7917:         if ($curr_selected{'srchtype'} eq $option) {
                   7918:             $srchtypesel .= '
                   7919:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7920:         } else {
                   7921:             $srchtypesel .= '
                   7922:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7923:         }
                   7924:     }
                   7925:     $srchtypesel .= "\n  </select>\n";
                   7926: 
1.558     albertel 7927:     my ($newuserscript,$new_user_create);
1.556     raeburn  7928: 
                   7929:     if ($forcenewuser) {
1.576     raeburn  7930:         if (ref($srch) eq 'HASH') {
                   7931:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7932:                 if ($cancreate) {
                   7933:                     $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>';
                   7934:                 } else {
1.799     bisitz   7935:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7936:                     my %usertypetext = (
                   7937:                         official   => 'institutional',
                   7938:                         unofficial => 'non-institutional',
                   7939:                     );
1.799     bisitz   7940:                     $new_user_create = '<p class="LC_warning">'
                   7941:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
1.925.2.13  raeburn  7942:                                       .'<br />'
                   7943:                                       .&mt('Enter a valid e-mail address as the username for the new user.').' '.&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7944:                                       ,'<a href="'.$helplink.'">','</a>')
1.799     bisitz   7945:                                       .'</p><br />';
1.627     raeburn  7946:                 }
1.576     raeburn  7947:             }
                   7948:         }
                   7949: 
1.556     raeburn  7950:         $newuserscript = <<"ENDSCRIPT";
                   7951: 
1.570     raeburn  7952: function setSearch(createnew,callingForm) {
1.556     raeburn  7953:     if (createnew == 1) {
1.570     raeburn  7954:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7955:             if (callingForm.srchby.options[i].value == 'uname') {
                   7956:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7957:             }
                   7958:         }
1.570     raeburn  7959:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7960:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7961: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7962:             }
                   7963:         }
1.570     raeburn  7964:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7965:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7966:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7967:             }
                   7968:         }
1.570     raeburn  7969:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7970:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7971:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7972:             }
                   7973:         }
                   7974:     }
                   7975: }
                   7976: ENDSCRIPT
1.558     albertel 7977: 
1.556     raeburn  7978:     }
                   7979: 
1.555     raeburn  7980:     my $output = <<"END_BLOCK";
1.556     raeburn  7981: <script type="text/javascript">
1.824     bisitz   7982: // <![CDATA[
1.570     raeburn  7983: function validateEntry(callingForm) {
1.558     albertel 7984: 
1.556     raeburn  7985:     var checkok = 1;
1.558     albertel 7986:     var srchin;
1.570     raeburn  7987:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7988: 	if ( callingForm.srchin[i].checked ) {
                   7989: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7990: 	}
                   7991:     }
                   7992: 
1.570     raeburn  7993:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7994:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7995:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7996:     var srchterm =  callingForm.srchterm.value;
                   7997:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7998:     var msg = "";
                   7999: 
                   8000:     if (srchterm == "") {
                   8001:         checkok = 0;
1.571     raeburn  8002:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8003:     }
                   8004: 
1.569     raeburn  8005:     if (srchtype== 'begins') {
                   8006:         if (srchterm.length < 2) {
                   8007:             checkok = 0;
1.571     raeburn  8008:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8009:         }
                   8010:     }
                   8011: 
1.556     raeburn  8012:     if (srchtype== 'contains') {
                   8013:         if (srchterm.length < 3) {
                   8014:             checkok = 0;
1.571     raeburn  8015:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8016:         }
                   8017:     }
                   8018:     if (srchin == 'instd') {
                   8019:         if (srchdomain == '') {
                   8020:             checkok = 0;
1.571     raeburn  8021:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8022:         }
                   8023:     }
                   8024:     if (srchin == 'dom') {
                   8025:         if (srchdomain == '') {
                   8026:             checkok = 0;
1.571     raeburn  8027:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8028:         }
                   8029:     }
                   8030:     if (srchby == 'lastfirst') {
                   8031:         if (srchterm.indexOf(",") == -1) {
                   8032:             checkok = 0;
1.571     raeburn  8033:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8034:         }
                   8035:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8036:             checkok = 0;
1.571     raeburn  8037:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8038:         }
                   8039:     }
                   8040:     if (checkok == 0) {
1.571     raeburn  8041:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8042:         return;
                   8043:     }
                   8044:     if (checkok == 1) {
1.570     raeburn  8045:         callingForm.submit();
1.556     raeburn  8046:     }
                   8047: }
                   8048: 
                   8049: $newuserscript
                   8050: 
1.824     bisitz   8051: // ]]>
1.556     raeburn  8052: </script>
1.558     albertel 8053: 
                   8054: $new_user_create
                   8055: 
1.555     raeburn  8056: END_BLOCK
1.558     albertel 8057: 
1.876     raeburn  8058:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8059:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8060:                $domform.
                   8061:                &Apache::lonhtmlcommon::row_closure().
                   8062:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8063:                $srchbysel.
                   8064:                $srchtypesel. 
                   8065:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8066:                $srchinsel.
                   8067:                &Apache::lonhtmlcommon::row_closure(1). 
                   8068:                &Apache::lonhtmlcommon::end_pick_box().
                   8069:                '<br />';
1.555     raeburn  8070:     return $output;
                   8071: }
                   8072: 
1.612     raeburn  8073: sub user_rule_check {
1.615     raeburn  8074:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8075:     my $response;
                   8076:     if (ref($usershash) eq 'HASH') {
                   8077:         foreach my $user (keys(%{$usershash})) {
                   8078:             my ($uname,$udom) = split(/:/,$user);
                   8079:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8080:             my ($id,$newuser);
1.612     raeburn  8081:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8082:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8083:                 $id = $usershash->{$user}->{'id'};
                   8084:             }
                   8085:             my $inst_response;
                   8086:             if (ref($checks) eq 'HASH') {
                   8087:                 if (defined($checks->{'username'})) {
1.615     raeburn  8088:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8089:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8090:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8091:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8092:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8093:                 }
1.615     raeburn  8094:             } else {
                   8095:                 ($inst_response,%{$inst_results->{$user}}) =
                   8096:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8097:                 return;
1.612     raeburn  8098:             }
1.615     raeburn  8099:             if (!$got_rules->{$udom}) {
1.612     raeburn  8100:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8101:                                                   ['usercreation'],$udom);
                   8102:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8103:                     foreach my $item ('username','id') {
1.612     raeburn  8104:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8105:                             $$curr_rules{$udom}{$item} = 
                   8106:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8107:                         }
                   8108:                     }
                   8109:                 }
1.615     raeburn  8110:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8111:             }
1.612     raeburn  8112:             foreach my $item (keys(%{$checks})) {
                   8113:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8114:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8115:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8116:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8117:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8118:                                 if ($rule_check{$rule}) {
                   8119:                                     $$rulematch{$user}{$item} = $rule;
                   8120:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8121:                                         if (ref($inst_results) eq 'HASH') {
                   8122:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8123:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8124:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8125:                                                 }
1.612     raeburn  8126:                                             }
                   8127:                                         }
1.615     raeburn  8128:                                     }
                   8129:                                     last;
1.585     raeburn  8130:                                 }
                   8131:                             }
                   8132:                         }
                   8133:                     }
                   8134:                 }
                   8135:             }
                   8136:         }
                   8137:     }
1.612     raeburn  8138:     return;
                   8139: }
                   8140: 
                   8141: sub user_rule_formats {
                   8142:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8143:     my %text = ( 
                   8144:                  'username' => 'Usernames',
                   8145:                  'id'       => 'IDs',
                   8146:                );
                   8147:     my $output;
                   8148:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8149:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8150:         if (@{$ruleorder} > 0) {
                   8151:             $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>';
                   8152:             foreach my $rule (@{$ruleorder}) {
                   8153:                 if (ref($curr_rules) eq 'ARRAY') {
                   8154:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8155:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8156:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8157:                                         $rules->{$rule}{'desc'}.'</li>';
                   8158:                         }
                   8159:                     }
                   8160:                 }
                   8161:             }
                   8162:             $output .= '</ul>';
                   8163:         }
                   8164:     }
                   8165:     return $output;
                   8166: }
                   8167: 
                   8168: sub instrule_disallow_msg {
1.615     raeburn  8169:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8170:     my $response;
                   8171:     my %text = (
                   8172:                   item   => 'username',
                   8173:                   items  => 'usernames',
                   8174:                   match  => 'matches',
                   8175:                   do     => 'does',
                   8176:                   action => 'a username',
                   8177:                   one    => 'one',
                   8178:                );
                   8179:     if ($count > 1) {
                   8180:         $text{'item'} = 'usernames';
                   8181:         $text{'match'} ='match';
                   8182:         $text{'do'} = 'do';
                   8183:         $text{'action'} = 'usernames',
                   8184:         $text{'one'} = 'ones';
                   8185:     }
                   8186:     if ($checkitem eq 'id') {
                   8187:         $text{'items'} = 'IDs';
                   8188:         $text{'item'} = 'ID';
                   8189:         $text{'action'} = 'an ID';
1.615     raeburn  8190:         if ($count > 1) {
                   8191:             $text{'item'} = 'IDs';
                   8192:             $text{'action'} = 'IDs';
                   8193:         }
1.612     raeburn  8194:     }
1.674     bisitz   8195:     $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  8196:     if ($mode eq 'upload') {
                   8197:         if ($checkitem eq 'username') {
                   8198:             $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'}.");
                   8199:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8200:             $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  8201:         }
1.669     raeburn  8202:     } elsif ($mode eq 'selfcreate') {
                   8203:         if ($checkitem eq 'id') {
                   8204:             $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.");
                   8205:         }
1.615     raeburn  8206:     } else {
                   8207:         if ($checkitem eq 'username') {
                   8208:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8209:         } elsif ($checkitem eq 'id') {
                   8210:             $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.");
                   8211:         }
1.612     raeburn  8212:     }
                   8213:     return $response;
1.585     raeburn  8214: }
                   8215: 
1.624     raeburn  8216: sub personal_data_fieldtitles {
                   8217:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8218:                         id => 'Student/Employee ID',
                   8219:                         permanentemail => 'E-mail address',
                   8220:                         lastname => 'Last Name',
                   8221:                         firstname => 'First Name',
                   8222:                         middlename => 'Middle Name',
                   8223:                         generation => 'Generation',
                   8224:                         gen => 'Generation',
1.765     raeburn  8225:                         inststatus => 'Affiliation',
1.624     raeburn  8226:                    );
                   8227:     return %fieldtitles;
                   8228: }
                   8229: 
1.642     raeburn  8230: sub sorted_inst_types {
                   8231:     my ($dom) = @_;
                   8232:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8233:     my $othertitle = &mt('All users');
                   8234:     if ($env{'request.course.id'}) {
1.668     raeburn  8235:         $othertitle  = &mt('Any users');
1.642     raeburn  8236:     }
                   8237:     my @types;
                   8238:     if (ref($order) eq 'ARRAY') {
                   8239:         @types = @{$order};
                   8240:     }
                   8241:     if (@types == 0) {
                   8242:         if (ref($usertypes) eq 'HASH') {
                   8243:             @types = sort(keys(%{$usertypes}));
                   8244:         }
                   8245:     }
                   8246:     if (keys(%{$usertypes}) > 0) {
                   8247:         $othertitle = &mt('Other users');
                   8248:     }
                   8249:     return ($othertitle,$usertypes,\@types);
                   8250: }
                   8251: 
1.645     raeburn  8252: sub get_institutional_codes {
                   8253:     my ($settings,$allcourses,$LC_code) = @_;
                   8254: # Get complete list of course sections to update
                   8255:     my @currsections = ();
                   8256:     my @currxlists = ();
                   8257:     my $coursecode = $$settings{'internal.coursecode'};
                   8258: 
                   8259:     if ($$settings{'internal.sectionnums'} ne '') {
                   8260:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8261:     }
                   8262: 
                   8263:     if ($$settings{'internal.crosslistings'} ne '') {
                   8264:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8265:     }
                   8266: 
                   8267:     if (@currxlists > 0) {
                   8268:         foreach (@currxlists) {
                   8269:             if (m/^([^:]+):(\w*)$/) {
                   8270:                 unless (grep/^$1$/,@{$allcourses}) {
                   8271:                     push @{$allcourses},$1;
                   8272:                     $$LC_code{$1} = $2;
                   8273:                 }
                   8274:             }
                   8275:         }
                   8276:     }
                   8277:  
                   8278:     if (@currsections > 0) {
                   8279:         foreach (@currsections) {
                   8280:             if (m/^(\w+):(\w*)$/) {
                   8281:                 my $sec = $coursecode.$1;
                   8282:                 my $lc_sec = $2;
                   8283:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8284:                     push @{$allcourses},$sec;
                   8285:                     $$LC_code{$sec} = $lc_sec;
                   8286:                 }
                   8287:             }
                   8288:         }
                   8289:     }
                   8290:     return;
                   8291: }
                   8292: 
1.112     bowersj2 8293: =pod
                   8294: 
1.780     raeburn  8295: =head1 Slot Helpers
                   8296: 
                   8297: =over 4
                   8298: 
                   8299: =item * sorted_slots()
                   8300: 
                   8301: Sorts an array of slot names in order of slot start time (earliest first). 
                   8302: 
                   8303: Inputs:
                   8304: 
                   8305: =over 4
                   8306: 
                   8307: slotsarr  - Reference to array of unsorted slot names.
                   8308: 
                   8309: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8310: 
1.549     albertel 8311: =back
                   8312: 
1.780     raeburn  8313: Returns:
                   8314: 
                   8315: =over 4
                   8316: 
                   8317: sorted   - An array of slot names sorted by the start time of the slot.
                   8318: 
                   8319: =back
                   8320: 
                   8321: =back
                   8322: 
                   8323: =cut
                   8324: 
                   8325: 
                   8326: sub sorted_slots {
                   8327:     my ($slotsarr,$slots) = @_;
                   8328:     my @sorted;
                   8329:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8330:         @sorted =
                   8331:             sort {
                   8332:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8333:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8334:                      }
                   8335:                      if (ref($slots->{$a})) { return -1;}
                   8336:                      if (ref($slots->{$b})) { return 1;}
                   8337:                      return 0;
                   8338:                  } @{$slotsarr};
                   8339:     }
                   8340:     return @sorted;
                   8341: }
                   8342: 
                   8343: 
                   8344: =pod
                   8345: 
1.549     albertel 8346: =head1 HTTP Helpers
                   8347: 
                   8348: =over 4
                   8349: 
1.648     raeburn  8350: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8351: 
1.258     albertel 8352: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8353: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8354: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8355: 
                   8356: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8357: $possible_names is an ref to an array of form element names.  As an example:
                   8358: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8359: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8360: 
                   8361: =cut
1.1       albertel 8362: 
1.6       albertel 8363: sub get_unprocessed_cgi {
1.25      albertel 8364:   my ($query,$possible_names)= @_;
1.26      matthew  8365:   # $Apache::lonxml::debug=1;
1.356     albertel 8366:   foreach my $pair (split(/&/,$query)) {
                   8367:     my ($name, $value) = split(/=/,$pair);
1.369     www      8368:     $name = &unescape($name);
1.25      albertel 8369:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8370:       $value =~ tr/+/ /;
                   8371:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8372:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8373:     }
1.16      harris41 8374:   }
1.6       albertel 8375: }
                   8376: 
1.112     bowersj2 8377: =pod
                   8378: 
1.648     raeburn  8379: =item * &cacheheader() 
1.112     bowersj2 8380: 
                   8381: returns cache-controlling header code
                   8382: 
                   8383: =cut
                   8384: 
1.7       albertel 8385: sub cacheheader {
1.258     albertel 8386:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8387:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8388:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8389:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8390:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8391:     return $output;
1.7       albertel 8392: }
                   8393: 
1.112     bowersj2 8394: =pod
                   8395: 
1.648     raeburn  8396: =item * &no_cache($r) 
1.112     bowersj2 8397: 
                   8398: specifies header code to not have cache
                   8399: 
                   8400: =cut
                   8401: 
1.9       albertel 8402: sub no_cache {
1.216     albertel 8403:     my ($r) = @_;
                   8404:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8405: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8406:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8407:     $r->no_cache(1);
                   8408:     $r->header_out("Expires" => $date);
                   8409:     $r->header_out("Pragma" => "no-cache");
1.123     www      8410: }
                   8411: 
                   8412: sub content_type {
1.181     albertel 8413:     my ($r,$type,$charset) = @_;
1.299     foxr     8414:     if ($r) {
                   8415: 	#  Note that printout.pl calls this with undef for $r.
                   8416: 	&no_cache($r);
                   8417:     }
1.258     albertel 8418:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8419:     unless ($charset) {
                   8420: 	$charset=&Apache::lonlocal::current_encoding;
                   8421:     }
                   8422:     if ($charset) { $type.='; charset='.$charset; }
                   8423:     if ($r) {
                   8424: 	$r->content_type($type);
                   8425:     } else {
                   8426: 	print("Content-type: $type\n\n");
                   8427:     }
1.9       albertel 8428: }
1.25      albertel 8429: 
1.112     bowersj2 8430: =pod
                   8431: 
1.648     raeburn  8432: =item * &add_to_env($name,$value) 
1.112     bowersj2 8433: 
1.258     albertel 8434: adds $name to the %env hash with value
1.112     bowersj2 8435: $value, if $name already exists, the entry is converted to an array
                   8436: reference and $value is added to the array.
                   8437: 
                   8438: =cut
                   8439: 
1.25      albertel 8440: sub add_to_env {
                   8441:   my ($name,$value)=@_;
1.258     albertel 8442:   if (defined($env{$name})) {
                   8443:     if (ref($env{$name})) {
1.25      albertel 8444:       #already have multiple values
1.258     albertel 8445:       push(@{ $env{$name} },$value);
1.25      albertel 8446:     } else {
                   8447:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8448:       my $first=$env{$name};
                   8449:       undef($env{$name});
                   8450:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8451:     }
                   8452:   } else {
1.258     albertel 8453:     $env{$name}=$value;
1.25      albertel 8454:   }
1.31      albertel 8455: }
1.149     albertel 8456: 
                   8457: =pod
                   8458: 
1.648     raeburn  8459: =item * &get_env_multiple($name) 
1.149     albertel 8460: 
1.258     albertel 8461: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8462: values may be defined and end up as an array ref.
                   8463: 
                   8464: returns an array of values
                   8465: 
                   8466: =cut
                   8467: 
                   8468: sub get_env_multiple {
                   8469:     my ($name) = @_;
                   8470:     my @values;
1.258     albertel 8471:     if (defined($env{$name})) {
1.149     albertel 8472:         # exists is it an array
1.258     albertel 8473:         if (ref($env{$name})) {
                   8474:             @values=@{ $env{$name} };
1.149     albertel 8475:         } else {
1.258     albertel 8476:             $values[0]=$env{$name};
1.149     albertel 8477:         }
                   8478:     }
                   8479:     return(@values);
                   8480: }
                   8481: 
1.660     raeburn  8482: sub ask_for_embedded_content {
                   8483:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8484:     my $upload_output = '
                   8485:    <form name="upload_embedded" action="'.$actionurl.'"
                   8486:                   method="post" enctype="multipart/form-data">';
                   8487:     $upload_output .= $state;
1.661     raeburn  8488:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8489: 
                   8490:     my $num = 0;
                   8491:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8492:         $upload_output .= &start_data_table_row().
                   8493:             '<td>'.$embed_file.'</td><td>';
                   8494:         if ($args->{'ignore_remote_references'}
                   8495:             && $embed_file =~ m{^\w+://}) {
                   8496:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8497:         } elsif ($args->{'error_on_invalid_names'}
                   8498:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8499: 
                   8500:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8501: 
                   8502:         } else {
                   8503:             $upload_output .='
1.661     raeburn  8504:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8505:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8506:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8507:             $upload_output .=
                   8508:                 "\n\t\t".
                   8509:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8510:                 $attrib.'" />';
                   8511:             if (exists($$codebase{$embed_file})) {
                   8512:                 $upload_output .=
                   8513:                     "\n\t\t".
                   8514:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8515:                     &escape($$codebase{$embed_file}).'" />';
                   8516:             }
                   8517:         }
                   8518:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8519:         $num++;
                   8520:     }
                   8521:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8522:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8523:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8524:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8525:    </form>';
                   8526:     return $upload_output;
                   8527: }
                   8528: 
1.661     raeburn  8529: sub upload_embedded {
                   8530:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8531:         $current_disk_usage) = @_;
                   8532:     my $output;
                   8533:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8534:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8535:         my $orig_uploaded_filename =
                   8536:             $env{'form.embedded_item_'.$i.'.filename'};
                   8537: 
                   8538:         $env{'form.embedded_orig_'.$i} =
                   8539:             &unescape($env{'form.embedded_orig_'.$i});
                   8540:         my ($path,$fname) =
                   8541:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8542:         # no path, whole string is fname
                   8543:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8544: 
                   8545:         $path = $env{'form.currentpath'}.$path;
                   8546:         $fname = &Apache::lonnet::clean_filename($fname);
                   8547:         # See if there is anything left
                   8548:         next if ($fname eq '');
                   8549: 
                   8550:         # Check if file already exists as a file or directory.
                   8551:         my ($state,$msg);
                   8552:         if ($context eq 'portfolio') {
                   8553:             my $port_path = $dirpath;
                   8554:             if ($group ne '') {
                   8555:                 $port_path = "groups/$group/$port_path";
                   8556:             }
                   8557:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8558:                                               $dir_root,$port_path,$disk_quota,
                   8559:                                               $current_disk_usage,$uname,$udom);
                   8560:             if ($state eq 'will_exceed_quota'
                   8561:                 || $state eq 'file_locked'
                   8562:                 || $state eq 'file_exists' ) {
                   8563:                 $output .= $msg;
                   8564:                 next;
                   8565:             }
                   8566:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8567:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8568:             if ($state eq 'exists') {
                   8569:                 $output .= $msg;
                   8570:                 next;
                   8571:             }
                   8572:         }
                   8573:         # Check if extension is valid
                   8574:         if (($fname =~ /\.(\w+)$/) &&
                   8575:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8576:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8577:             next;
                   8578:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8579:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8580:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8581:             next;
                   8582:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8583:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8584:             next;
                   8585:         }
                   8586: 
                   8587:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8588:         if ($context eq 'portfolio') {
                   8589:             my $result=
                   8590:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8591:                                                 $dirpath.$path);
                   8592:             if ($result !~ m|^/uploaded/|) {
                   8593:                 $output .= '<span class="LC_error">'
                   8594:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8595:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8596:                       .'</span><br />';
                   8597:                 next;
                   8598:             } else {
                   8599:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8600:                            $path.$fname.'</span>').'</p>';     
                   8601:             }
                   8602:         } else {
                   8603: # Save the file
                   8604:             my $target = $env{'form.embedded_item_'.$i};
                   8605:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8606:             my $dest = $fullpath.$fname;
                   8607:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8608:             my @parts=split(/\//,$fullpath);
                   8609:             my $count;
                   8610:             my $filepath = $dir_root;
                   8611:             for ($count=4;$count<=$#parts;$count++) {
                   8612:                 $filepath .= "/$parts[$count]";
                   8613:                 if ((-e $filepath)!=1) {
                   8614:                     mkdir($filepath,0770);
                   8615:                 }
                   8616:             }
                   8617:             my $fh;
                   8618:             if (!open($fh,'>'.$dest)) {
                   8619:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8620:                 $output .= '<span class="LC_error">'.
                   8621:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8622:                            '</span><br />';
                   8623:             } else {
                   8624:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8625:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8626:                     $output .= '<span class="LC_error">'.
                   8627:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8628:                               '</span><br />';
                   8629:                 } else {
                   8630:                     if ($context eq 'testbank') {
                   8631:                         $output .= &mt('Embedded file uploaded successfully:').
                   8632:                                    '&nbsp;<a href="'.$url.'">'.
                   8633:                                    $orig_uploaded_filename.'</a><br />';
                   8634:                     } else {
1.705     tempelho 8635:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8636:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8637:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8638:                     }
                   8639:                 }
                   8640:                 close($fh);
                   8641:             }
                   8642:         }
                   8643:     }
                   8644:     return $output;
                   8645: }
                   8646: 
                   8647: sub check_for_existing {
                   8648:     my ($path,$fname,$element) = @_;
                   8649:     my ($state,$msg);
                   8650:     if (-d $path.'/'.$fname) {
                   8651:         $state = 'exists';
                   8652:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8653:     } elsif (-e $path.'/'.$fname) {
                   8654:         $state = 'exists';
                   8655:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8656:     }
                   8657:     if ($state eq 'exists') {
                   8658:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8659:     }
                   8660:     return ($state,$msg);
                   8661: }
                   8662: 
                   8663: sub check_for_upload {
                   8664:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8665:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8666:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8667:     my $getpropath = 1;
                   8668:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8669:                                             $getpropath);
                   8670:     my $found_file = 0;
                   8671:     my $locked_file = 0;
                   8672:     foreach my $line (@dir_list) {
                   8673:         my ($file_name)=split(/\&/,$line,2);
                   8674:         if ($file_name eq $fname){
                   8675:             $file_name = $path.$file_name;
                   8676:             if ($group ne '') {
                   8677:                 $file_name = $group.$file_name;
                   8678:             }
                   8679:             $found_file = 1;
                   8680:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8681:                 $locked_file = 1;
                   8682:             }
                   8683:         }
                   8684:     }
                   8685:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8686:         my $msg = '<span class="LC_error">'.
                   8687:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8688:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8689:         return ('will_exceed_quota',$msg);
                   8690:     } elsif ($found_file) {
                   8691:         if ($locked_file) {
                   8692:             my $msg = '<span class="LC_error">';
                   8693:             $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>');
                   8694:             $msg .= '</span><br />';
                   8695:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8696:             return ('file_locked',$msg);
                   8697:         } else {
                   8698:             my $msg = '<span class="LC_error">';
                   8699:             $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'});
                   8700:             $msg .= '</span>';
                   8701:             $msg .= '<br />';
                   8702:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8703:             return ('file_exists',$msg);
                   8704:         }
                   8705:     }
                   8706: }
                   8707: 
1.31      albertel 8708: 
1.41      ng       8709: =pod
1.45      matthew  8710: 
1.464     albertel 8711: =back
1.41      ng       8712: 
1.112     bowersj2 8713: =head1 CSV Upload/Handling functions
1.38      albertel 8714: 
1.41      ng       8715: =over 4
                   8716: 
1.648     raeburn  8717: =item * &upfile_store($r)
1.41      ng       8718: 
                   8719: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8720: needs $env{'form.upfile'}
1.41      ng       8721: returns $datatoken to be put into hidden field
                   8722: 
                   8723: =cut
1.31      albertel 8724: 
                   8725: sub upfile_store {
                   8726:     my $r=shift;
1.258     albertel 8727:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8728:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8729:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8730:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8731: 
1.258     albertel 8732:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8733: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8734:     {
1.158     raeburn  8735:         my $datafile = $r->dir_config('lonDaemons').
                   8736:                            '/tmp/'.$datatoken.'.tmp';
                   8737:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8738:             print $fh $env{'form.upfile'};
1.158     raeburn  8739:             close($fh);
                   8740:         }
1.31      albertel 8741:     }
                   8742:     return $datatoken;
                   8743: }
                   8744: 
1.56      matthew  8745: =pod
                   8746: 
1.648     raeburn  8747: =item * &load_tmp_file($r)
1.41      ng       8748: 
                   8749: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8750: needs $env{'form.datatoken'},
                   8751: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8752: 
                   8753: =cut
1.31      albertel 8754: 
                   8755: sub load_tmp_file {
                   8756:     my $r=shift;
                   8757:     my @studentdata=();
                   8758:     {
1.158     raeburn  8759:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8760:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8761:         if ( open(my $fh,"<$studentfile") ) {
                   8762:             @studentdata=<$fh>;
                   8763:             close($fh);
                   8764:         }
1.31      albertel 8765:     }
1.258     albertel 8766:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8767: }
                   8768: 
1.56      matthew  8769: =pod
                   8770: 
1.648     raeburn  8771: =item * &upfile_record_sep()
1.41      ng       8772: 
                   8773: Separate uploaded file into records
                   8774: returns array of records,
1.258     albertel 8775: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8776: 
                   8777: =cut
1.31      albertel 8778: 
                   8779: sub upfile_record_sep {
1.258     albertel 8780:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8781:     } else {
1.248     albertel 8782: 	my @records;
1.258     albertel 8783: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8784: 	    if ($line=~/^\s*$/) { next; }
                   8785: 	    push(@records,$line);
                   8786: 	}
                   8787: 	return @records;
1.31      albertel 8788:     }
                   8789: }
                   8790: 
1.56      matthew  8791: =pod
                   8792: 
1.648     raeburn  8793: =item * &record_sep($record)
1.41      ng       8794: 
1.258     albertel 8795: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8796: 
                   8797: =cut
                   8798: 
1.263     www      8799: sub takeleft {
                   8800:     my $index=shift;
                   8801:     return substr('0000'.$index,-4,4);
                   8802: }
                   8803: 
1.31      albertel 8804: sub record_sep {
                   8805:     my $record=shift;
                   8806:     my %components=();
1.258     albertel 8807:     if ($env{'form.upfiletype'} eq 'xml') {
                   8808:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8809:         my $i=0;
1.356     albertel 8810:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8811:             $field=~s/^(\"|\')//;
                   8812:             $field=~s/(\"|\')$//;
1.263     www      8813:             $components{&takeleft($i)}=$field;
1.31      albertel 8814:             $i++;
                   8815:         }
1.258     albertel 8816:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8817:         my $i=0;
1.356     albertel 8818:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8819:             $field=~s/^(\"|\')//;
                   8820:             $field=~s/(\"|\')$//;
1.263     www      8821:             $components{&takeleft($i)}=$field;
1.31      albertel 8822:             $i++;
                   8823:         }
                   8824:     } else {
1.561     www      8825:         my $separator=',';
1.480     banghart 8826:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8827:             $separator=';';
1.480     banghart 8828:         }
1.31      albertel 8829:         my $i=0;
1.561     www      8830: # the character we are looking for to indicate the end of a quote or a record 
                   8831:         my $looking_for=$separator;
                   8832: # do not add the characters to the fields
                   8833:         my $ignore=0;
                   8834: # we just encountered a separator (or the beginning of the record)
                   8835:         my $just_found_separator=1;
                   8836: # store the field we are working on here
                   8837:         my $field='';
                   8838: # work our way through all characters in record
                   8839:         foreach my $character ($record=~/(.)/g) {
                   8840:             if ($character eq $looking_for) {
                   8841:                if ($character ne $separator) {
                   8842: # Found the end of a quote, again looking for separator
                   8843:                   $looking_for=$separator;
                   8844:                   $ignore=1;
                   8845:                } else {
                   8846: # Found a separator, store away what we got
                   8847:                   $components{&takeleft($i)}=$field;
                   8848: 	          $i++;
                   8849:                   $just_found_separator=1;
                   8850:                   $ignore=0;
                   8851:                   $field='';
                   8852:                }
                   8853:                next;
                   8854:             }
                   8855: # single or double quotation marks after a separator indicate beginning of a quote
                   8856: # we are now looking for the end of the quote and need to ignore separators
                   8857:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8858:                $looking_for=$character;
                   8859:                next;
                   8860:             }
                   8861: # ignore would be true after we reached the end of a quote
                   8862:             if ($ignore) { next; }
                   8863:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8864:             $field.=$character;
                   8865:             $just_found_separator=0; 
1.31      albertel 8866:         }
1.561     www      8867: # catch the very last entry, since we never encountered the separator
                   8868:         $components{&takeleft($i)}=$field;
1.31      albertel 8869:     }
                   8870:     return %components;
                   8871: }
                   8872: 
1.144     matthew  8873: ######################################################
                   8874: ######################################################
                   8875: 
1.56      matthew  8876: =pod
                   8877: 
1.648     raeburn  8878: =item * &upfile_select_html()
1.41      ng       8879: 
1.144     matthew  8880: Return HTML code to select a file from the users machine and specify 
                   8881: the file type.
1.41      ng       8882: 
                   8883: =cut
                   8884: 
1.144     matthew  8885: ######################################################
                   8886: ######################################################
1.31      albertel 8887: sub upfile_select_html {
1.144     matthew  8888:     my %Types = (
                   8889:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8890:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8891:                  space => &mt('Space separated'),
                   8892:                  tab   => &mt('Tabulator separated'),
                   8893: #                 xml   => &mt('HTML/XML'),
                   8894:                  );
                   8895:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8896:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8897:     foreach my $type (sort(keys(%Types))) {
                   8898:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8899:     }
                   8900:     $Str .= "</select>\n";
                   8901:     return $Str;
1.31      albertel 8902: }
                   8903: 
1.301     albertel 8904: sub get_samples {
                   8905:     my ($records,$toget) = @_;
                   8906:     my @samples=({});
                   8907:     my $got=0;
                   8908:     foreach my $rec (@$records) {
                   8909: 	my %temp = &record_sep($rec);
                   8910: 	if (! grep(/\S/, values(%temp))) { next; }
                   8911: 	if (%temp) {
                   8912: 	    $samples[$got]=\%temp;
                   8913: 	    $got++;
                   8914: 	    if ($got == $toget) { last; }
                   8915: 	}
                   8916:     }
                   8917:     return \@samples;
                   8918: }
                   8919: 
1.144     matthew  8920: ######################################################
                   8921: ######################################################
                   8922: 
1.56      matthew  8923: =pod
                   8924: 
1.648     raeburn  8925: =item * &csv_print_samples($r,$records)
1.41      ng       8926: 
                   8927: Prints a table of sample values from each column uploaded $r is an
                   8928: Apache Request ref, $records is an arrayref from
                   8929: &Apache::loncommon::upfile_record_sep
                   8930: 
                   8931: =cut
                   8932: 
1.144     matthew  8933: ######################################################
                   8934: ######################################################
1.31      albertel 8935: sub csv_print_samples {
                   8936:     my ($r,$records) = @_;
1.662     bisitz   8937:     my $samples = &get_samples($records,5);
1.301     albertel 8938: 
1.594     raeburn  8939:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8940:               &start_data_table_header_row());
1.356     albertel 8941:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8942:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8943:     $r->print(&end_data_table_header_row());
1.301     albertel 8944:     foreach my $hash (@$samples) {
1.594     raeburn  8945: 	$r->print(&start_data_table_row());
1.356     albertel 8946: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8947: 	    $r->print('<td>');
1.356     albertel 8948: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8949: 	    $r->print('</td>');
                   8950: 	}
1.594     raeburn  8951: 	$r->print(&end_data_table_row());
1.31      albertel 8952:     }
1.594     raeburn  8953:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8954: }
                   8955: 
1.144     matthew  8956: ######################################################
                   8957: ######################################################
                   8958: 
1.56      matthew  8959: =pod
                   8960: 
1.648     raeburn  8961: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8962: 
                   8963: Prints a table to create associations between values and table columns.
1.144     matthew  8964: 
1.41      ng       8965: $r is an Apache Request ref,
                   8966: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8967: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8968: 
                   8969: =cut
                   8970: 
1.144     matthew  8971: ######################################################
                   8972: ######################################################
1.31      albertel 8973: sub csv_print_select_table {
                   8974:     my ($r,$records,$d) = @_;
1.301     albertel 8975:     my $i=0;
                   8976:     my $samples = &get_samples($records,1);
1.144     matthew  8977:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8978: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8979:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8980:               '<th>'.&mt('Column').'</th>'.
                   8981:               &end_data_table_header_row()."\n");
1.356     albertel 8982:     foreach my $array_ref (@$d) {
                   8983: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8984: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8985: 
1.875     bisitz   8986: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8987: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8988: 	$r->print('<option value="none"></option>');
1.356     albertel 8989: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8990: 	    $r->print('<option value="'.$sample.'"'.
                   8991:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8992:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8993: 	}
1.594     raeburn  8994: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8995: 	$i++;
                   8996:     }
1.594     raeburn  8997:     $r->print(&end_data_table());
1.31      albertel 8998:     $i--;
                   8999:     return $i;
                   9000: }
1.56      matthew  9001: 
1.144     matthew  9002: ######################################################
                   9003: ######################################################
                   9004: 
1.56      matthew  9005: =pod
1.31      albertel 9006: 
1.648     raeburn  9007: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       9008: 
                   9009: Prints a table of sample values from the upload and can make associate samples to internal names.
                   9010: 
                   9011: $r is an Apache Request ref,
                   9012: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   9013: $d is an array of 2 element arrays (internal name, displayed name)
                   9014: 
                   9015: =cut
                   9016: 
1.144     matthew  9017: ######################################################
                   9018: ######################################################
1.31      albertel 9019: sub csv_samples_select_table {
                   9020:     my ($r,$records,$d) = @_;
                   9021:     my $i=0;
1.144     matthew  9022:     #
1.662     bisitz   9023:     my $max_samples = 5;
                   9024:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  9025:     $r->print(&start_data_table().
                   9026:               &start_data_table_header_row().'<th>'.
                   9027:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   9028:               &end_data_table_header_row());
1.301     albertel 9029: 
                   9030:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  9031: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  9032: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 9033: 	foreach my $option (@$d) {
                   9034: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  9035: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 9036:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  9037:                       $display.'</option>');
1.31      albertel 9038: 	}
                   9039: 	$r->print('</select></td><td>');
1.662     bisitz   9040: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 9041: 	    if (defined($samples->[$line]{$key})) { 
                   9042: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   9043: 	    }
                   9044: 	}
1.594     raeburn  9045: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 9046: 	$i++;
                   9047:     }
1.594     raeburn  9048:     $r->print(&end_data_table());
1.31      albertel 9049:     $i--;
                   9050:     return($i);
1.115     matthew  9051: }
                   9052: 
1.144     matthew  9053: ######################################################
                   9054: ######################################################
                   9055: 
1.115     matthew  9056: =pod
                   9057: 
1.648     raeburn  9058: =item * &clean_excel_name($name)
1.115     matthew  9059: 
                   9060: Returns a replacement for $name which does not contain any illegal characters.
                   9061: 
                   9062: =cut
                   9063: 
1.144     matthew  9064: ######################################################
                   9065: ######################################################
1.115     matthew  9066: sub clean_excel_name {
                   9067:     my ($name) = @_;
                   9068:     $name =~ s/[:\*\?\/\\]//g;
                   9069:     if (length($name) > 31) {
                   9070:         $name = substr($name,0,31);
                   9071:     }
                   9072:     return $name;
1.25      albertel 9073: }
1.84      albertel 9074: 
1.85      albertel 9075: =pod
                   9076: 
1.648     raeburn  9077: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 9078: 
                   9079: Returns either 1 or undef
                   9080: 
                   9081: 1 if the part is to be hidden, undef if it is to be shown
                   9082: 
                   9083: Arguments are:
                   9084: 
                   9085: $id the id of the part to be checked
                   9086: $symb, optional the symb of the resource to check
                   9087: $udom, optional the domain of the user to check for
                   9088: $uname, optional the username of the user to check for
                   9089: 
                   9090: =cut
1.84      albertel 9091: 
                   9092: sub check_if_partid_hidden {
                   9093:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 9094:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 9095: 					 $symb,$udom,$uname);
1.141     albertel 9096:     my $truth=1;
                   9097:     #if the string starts with !, then the list is the list to show not hide
                   9098:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 9099:     my @hiddenlist=split(/,/,$hiddenparts);
                   9100:     foreach my $checkid (@hiddenlist) {
1.141     albertel 9101: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 9102:     }
1.141     albertel 9103:     return !$truth;
1.84      albertel 9104: }
1.127     matthew  9105: 
1.138     matthew  9106: 
                   9107: ############################################################
                   9108: ############################################################
                   9109: 
                   9110: =pod
                   9111: 
1.157     matthew  9112: =back 
                   9113: 
1.138     matthew  9114: =head1 cgi-bin script and graphing routines
                   9115: 
1.157     matthew  9116: =over 4
                   9117: 
1.648     raeburn  9118: =item * &get_cgi_id()
1.138     matthew  9119: 
                   9120: Inputs: none
                   9121: 
                   9122: Returns an id which can be used to pass environment variables
                   9123: to various cgi-bin scripts.  These environment variables will
                   9124: be removed from the users environment after a given time by
                   9125: the routine &Apache::lonnet::transfer_profile_to_env.
                   9126: 
                   9127: =cut
                   9128: 
                   9129: ############################################################
                   9130: ############################################################
1.152     albertel 9131: my $uniq=0;
1.136     matthew  9132: sub get_cgi_id {
1.154     albertel 9133:     $uniq=($uniq+1)%100000;
1.280     albertel 9134:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  9135: }
                   9136: 
1.127     matthew  9137: ############################################################
                   9138: ############################################################
                   9139: 
                   9140: =pod
                   9141: 
1.648     raeburn  9142: =item * &DrawBarGraph()
1.127     matthew  9143: 
1.138     matthew  9144: Facilitates the plotting of data in a (stacked) bar graph.
                   9145: Puts plot definition data into the users environment in order for 
                   9146: graph.png to plot it.  Returns an <img> tag for the plot.
                   9147: The bars on the plot are labeled '1','2',...,'n'.
                   9148: 
                   9149: Inputs:
                   9150: 
                   9151: =over 4
                   9152: 
                   9153: =item $Title: string, the title of the plot
                   9154: 
                   9155: =item $xlabel: string, text describing the X-axis of the plot
                   9156: 
                   9157: =item $ylabel: string, text describing the Y-axis of the plot
                   9158: 
                   9159: =item $Max: scalar, the maximum Y value to use in the plot
                   9160: If $Max is < any data point, the graph will not be rendered.
                   9161: 
1.140     matthew  9162: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  9163: they are plotted.  If undefined, default values will be used.
                   9164: 
1.178     matthew  9165: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   9166: 
1.138     matthew  9167: =item @Values: An array of array references.  Each array reference holds data
                   9168: to be plotted in a stacked bar chart.
                   9169: 
1.239     matthew  9170: =item If the final element of @Values is a hash reference the key/value
                   9171: pairs will be added to the graph definition.
                   9172: 
1.138     matthew  9173: =back
                   9174: 
                   9175: Returns:
                   9176: 
                   9177: An <img> tag which references graph.png and the appropriate identifying
                   9178: information for the plot.
                   9179: 
1.127     matthew  9180: =cut
                   9181: 
                   9182: ############################################################
                   9183: ############################################################
1.134     matthew  9184: sub DrawBarGraph {
1.178     matthew  9185:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  9186:     #
                   9187:     if (! defined($colors)) {
                   9188:         $colors = ['#33ff00', 
                   9189:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9190:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9191:                   ]; 
                   9192:     }
1.228     matthew  9193:     my $extra_settings = {};
                   9194:     if (ref($Values[-1]) eq 'HASH') {
                   9195:         $extra_settings = pop(@Values);
                   9196:     }
1.127     matthew  9197:     #
1.136     matthew  9198:     my $identifier = &get_cgi_id();
                   9199:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9200:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9201:         return '';
                   9202:     }
1.225     matthew  9203:     #
                   9204:     my @Labels;
                   9205:     if (defined($labels)) {
                   9206:         @Labels = @$labels;
                   9207:     } else {
                   9208:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9209:             push (@Labels,$i+1);
                   9210:         }
                   9211:     }
                   9212:     #
1.129     matthew  9213:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9214:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9215:     my %ValuesHash;
                   9216:     my $NumSets=1;
                   9217:     foreach my $array (@Values) {
                   9218:         next if (! ref($array));
1.136     matthew  9219:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9220:             join(',',@$array);
1.129     matthew  9221:     }
1.127     matthew  9222:     #
1.136     matthew  9223:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9224:     if ($NumBars < 3) {
                   9225:         $width = 120+$NumBars*32;
1.220     matthew  9226:         $xskip = 1;
1.225     matthew  9227:         $bar_width = 30;
                   9228:     } elsif ($NumBars < 5) {
                   9229:         $width = 120+$NumBars*20;
                   9230:         $xskip = 1;
                   9231:         $bar_width = 20;
1.220     matthew  9232:     } elsif ($NumBars < 10) {
1.136     matthew  9233:         $width = 120+$NumBars*15;
                   9234:         $xskip = 1;
                   9235:         $bar_width = 15;
                   9236:     } elsif ($NumBars <= 25) {
                   9237:         $width = 120+$NumBars*11;
                   9238:         $xskip = 5;
                   9239:         $bar_width = 8;
                   9240:     } elsif ($NumBars <= 50) {
                   9241:         $width = 120+$NumBars*8;
                   9242:         $xskip = 5;
                   9243:         $bar_width = 4;
                   9244:     } else {
                   9245:         $width = 120+$NumBars*8;
                   9246:         $xskip = 5;
                   9247:         $bar_width = 4;
                   9248:     }
                   9249:     #
1.137     matthew  9250:     $Max = 1 if ($Max < 1);
                   9251:     if ( int($Max) < $Max ) {
                   9252:         $Max++;
                   9253:         $Max = int($Max);
                   9254:     }
1.127     matthew  9255:     $Title  = '' if (! defined($Title));
                   9256:     $xlabel = '' if (! defined($xlabel));
                   9257:     $ylabel = '' if (! defined($ylabel));
1.369     www      9258:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9259:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9260:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9261:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9262:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9263:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9264:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9265:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9266:     $ValuesHash{$id.'.height'}   = $height;
                   9267:     $ValuesHash{$id.'.width'}    = $width;
                   9268:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9269:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9270:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9271:     #
1.228     matthew  9272:     # Deal with other parameters
                   9273:     while (my ($key,$value) = each(%$extra_settings)) {
                   9274:         $ValuesHash{$id.'.'.$key} = $value;
                   9275:     }
                   9276:     #
1.646     raeburn  9277:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9278:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9279: }
                   9280: 
                   9281: ############################################################
                   9282: ############################################################
                   9283: 
                   9284: =pod
                   9285: 
1.648     raeburn  9286: =item * &DrawXYGraph()
1.137     matthew  9287: 
1.138     matthew  9288: Facilitates the plotting of data in an XY graph.
                   9289: Puts plot definition data into the users environment in order for 
                   9290: graph.png to plot it.  Returns an <img> tag for the plot.
                   9291: 
                   9292: Inputs:
                   9293: 
                   9294: =over 4
                   9295: 
                   9296: =item $Title: string, the title of the plot
                   9297: 
                   9298: =item $xlabel: string, text describing the X-axis of the plot
                   9299: 
                   9300: =item $ylabel: string, text describing the Y-axis of the plot
                   9301: 
                   9302: =item $Max: scalar, the maximum Y value to use in the plot
                   9303: If $Max is < any data point, the graph will not be rendered.
                   9304: 
                   9305: =item $colors: Array ref containing the hex color codes for the data to be 
                   9306: plotted in.  If undefined, default values will be used.
                   9307: 
                   9308: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9309: 
                   9310: =item $Ydata: Array ref containing Array refs.  
1.185     www      9311: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9312: 
                   9313: =item %Values: hash indicating or overriding any default values which are 
                   9314: passed to graph.png.  
                   9315: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9316: 
                   9317: =back
                   9318: 
                   9319: Returns:
                   9320: 
                   9321: An <img> tag which references graph.png and the appropriate identifying
                   9322: information for the plot.
                   9323: 
1.137     matthew  9324: =cut
                   9325: 
                   9326: ############################################################
                   9327: ############################################################
                   9328: sub DrawXYGraph {
                   9329:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9330:     #
                   9331:     # Create the identifier for the graph
                   9332:     my $identifier = &get_cgi_id();
                   9333:     my $id = 'cgi.'.$identifier;
                   9334:     #
                   9335:     $Title  = '' if (! defined($Title));
                   9336:     $xlabel = '' if (! defined($xlabel));
                   9337:     $ylabel = '' if (! defined($ylabel));
                   9338:     my %ValuesHash = 
                   9339:         (
1.369     www      9340:          $id.'.title'  => &escape($Title),
                   9341:          $id.'.xlabel' => &escape($xlabel),
                   9342:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9343:          $id.'.y_max_value'=> $Max,
                   9344:          $id.'.labels'     => join(',',@$Xlabels),
                   9345:          $id.'.PlotType'   => 'XY',
                   9346:          );
                   9347:     #
                   9348:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9349:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9350:     }
                   9351:     #
                   9352:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9353:         return '';
                   9354:     }
                   9355:     my $NumSets=1;
1.138     matthew  9356:     foreach my $array (@{$Ydata}){
1.137     matthew  9357:         next if (! ref($array));
                   9358:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9359:     }
1.138     matthew  9360:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9361:     #
                   9362:     # Deal with other parameters
                   9363:     while (my ($key,$value) = each(%Values)) {
                   9364:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9365:     }
                   9366:     #
1.646     raeburn  9367:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9368:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9369: }
                   9370: 
                   9371: ############################################################
                   9372: ############################################################
                   9373: 
                   9374: =pod
                   9375: 
1.648     raeburn  9376: =item * &DrawXYYGraph()
1.138     matthew  9377: 
                   9378: Facilitates the plotting of data in an XY graph with two Y axes.
                   9379: Puts plot definition data into the users environment in order for 
                   9380: graph.png to plot it.  Returns an <img> tag for the plot.
                   9381: 
                   9382: Inputs:
                   9383: 
                   9384: =over 4
                   9385: 
                   9386: =item $Title: string, the title of the plot
                   9387: 
                   9388: =item $xlabel: string, text describing the X-axis of the plot
                   9389: 
                   9390: =item $ylabel: string, text describing the Y-axis of the plot
                   9391: 
                   9392: =item $colors: Array ref containing the hex color codes for the data to be 
                   9393: plotted in.  If undefined, default values will be used.
                   9394: 
                   9395: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9396: 
                   9397: =item $Ydata1: The first data set
                   9398: 
                   9399: =item $Min1: The minimum value of the left Y-axis
                   9400: 
                   9401: =item $Max1: The maximum value of the left Y-axis
                   9402: 
                   9403: =item $Ydata2: The second data set
                   9404: 
                   9405: =item $Min2: The minimum value of the right Y-axis
                   9406: 
                   9407: =item $Max2: The maximum value of the left Y-axis
                   9408: 
                   9409: =item %Values: hash indicating or overriding any default values which are 
                   9410: passed to graph.png.  
                   9411: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9412: 
                   9413: =back
                   9414: 
                   9415: Returns:
                   9416: 
                   9417: An <img> tag which references graph.png and the appropriate identifying
                   9418: information for the plot.
1.136     matthew  9419: 
                   9420: =cut
                   9421: 
                   9422: ############################################################
                   9423: ############################################################
1.137     matthew  9424: sub DrawXYYGraph {
                   9425:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9426:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9427:     #
                   9428:     # Create the identifier for the graph
                   9429:     my $identifier = &get_cgi_id();
                   9430:     my $id = 'cgi.'.$identifier;
                   9431:     #
                   9432:     $Title  = '' if (! defined($Title));
                   9433:     $xlabel = '' if (! defined($xlabel));
                   9434:     $ylabel = '' if (! defined($ylabel));
                   9435:     my %ValuesHash = 
                   9436:         (
1.369     www      9437:          $id.'.title'  => &escape($Title),
                   9438:          $id.'.xlabel' => &escape($xlabel),
                   9439:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9440:          $id.'.labels' => join(',',@$Xlabels),
                   9441:          $id.'.PlotType' => 'XY',
                   9442:          $id.'.NumSets' => 2,
1.137     matthew  9443:          $id.'.two_axes' => 1,
                   9444:          $id.'.y1_max_value' => $Max1,
                   9445:          $id.'.y1_min_value' => $Min1,
                   9446:          $id.'.y2_max_value' => $Max2,
                   9447:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9448:          );
                   9449:     #
1.137     matthew  9450:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9451:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9452:     }
                   9453:     #
                   9454:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9455:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9456:         return '';
                   9457:     }
                   9458:     my $NumSets=1;
1.137     matthew  9459:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9460:         next if (! ref($array));
                   9461:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9462:     }
                   9463:     #
                   9464:     # Deal with other parameters
                   9465:     while (my ($key,$value) = each(%Values)) {
                   9466:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9467:     }
                   9468:     #
1.646     raeburn  9469:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9470:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9471: }
                   9472: 
                   9473: ############################################################
                   9474: ############################################################
                   9475: 
                   9476: =pod
                   9477: 
1.157     matthew  9478: =back 
                   9479: 
1.139     matthew  9480: =head1 Statistics helper routines?  
                   9481: 
                   9482: Bad place for them but what the hell.
                   9483: 
1.157     matthew  9484: =over 4
                   9485: 
1.648     raeburn  9486: =item * &chartlink()
1.139     matthew  9487: 
                   9488: Returns a link to the chart for a specific student.  
                   9489: 
                   9490: Inputs:
                   9491: 
                   9492: =over 4
                   9493: 
                   9494: =item $linktext: The text of the link
                   9495: 
                   9496: =item $sname: The students username
                   9497: 
                   9498: =item $sdomain: The students domain
                   9499: 
                   9500: =back
                   9501: 
1.157     matthew  9502: =back
                   9503: 
1.139     matthew  9504: =cut
                   9505: 
                   9506: ############################################################
                   9507: ############################################################
                   9508: sub chartlink {
                   9509:     my ($linktext, $sname, $sdomain) = @_;
                   9510:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9511:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9512:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9513:        '">'.$linktext.'</a>';
1.153     matthew  9514: }
                   9515: 
                   9516: #######################################################
                   9517: #######################################################
                   9518: 
                   9519: =pod
                   9520: 
                   9521: =head1 Course Environment Routines
1.157     matthew  9522: 
                   9523: =over 4
1.153     matthew  9524: 
1.648     raeburn  9525: =item * &restore_course_settings()
1.153     matthew  9526: 
1.648     raeburn  9527: =item * &store_course_settings()
1.153     matthew  9528: 
                   9529: Restores/Store indicated form parameters from the course environment.
                   9530: Will not overwrite existing values of the form parameters.
                   9531: 
                   9532: Inputs: 
                   9533: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9534: 
                   9535: a hash ref describing the data to be stored.  For example:
                   9536:    
                   9537: %Save_Parameters = ('Status' => 'scalar',
                   9538:     'chartoutputmode' => 'scalar',
                   9539:     'chartoutputdata' => 'scalar',
                   9540:     'Section' => 'array',
1.373     raeburn  9541:     'Group' => 'array',
1.153     matthew  9542:     'StudentData' => 'array',
                   9543:     'Maps' => 'array');
                   9544: 
                   9545: Returns: both routines return nothing
                   9546: 
1.631     raeburn  9547: =back
                   9548: 
1.153     matthew  9549: =cut
                   9550: 
                   9551: #######################################################
                   9552: #######################################################
                   9553: sub store_course_settings {
1.496     albertel 9554:     return &store_settings($env{'request.course.id'},@_);
                   9555: }
                   9556: 
                   9557: sub store_settings {
1.153     matthew  9558:     # save to the environment
                   9559:     # appenv the same items, just to be safe
1.300     albertel 9560:     my $udom  = $env{'user.domain'};
                   9561:     my $uname = $env{'user.name'};
1.496     albertel 9562:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9563:     my %SaveHash;
                   9564:     my %AppHash;
                   9565:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9566:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9567:         my $envname = 'environment.'.$basename;
1.258     albertel 9568:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9569:             # Save this value away
                   9570:             if ($type eq 'scalar' &&
1.258     albertel 9571:                 (! exists($env{$envname}) || 
                   9572:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9573:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9574:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9575:             } elsif ($type eq 'array') {
                   9576:                 my $stored_form;
1.258     albertel 9577:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9578:                     $stored_form = join(',',
                   9579:                                         map {
1.369     www      9580:                                             &escape($_);
1.258     albertel 9581:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9582:                 } else {
                   9583:                     $stored_form = 
1.369     www      9584:                         &escape($env{'form.'.$setting});
1.153     matthew  9585:                 }
                   9586:                 # Determine if the array contents are the same.
1.258     albertel 9587:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9588:                     $SaveHash{$basename} = $stored_form;
                   9589:                     $AppHash{$envname}   = $stored_form;
                   9590:                 }
                   9591:             }
                   9592:         }
                   9593:     }
                   9594:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9595:                                           $udom,$uname);
1.153     matthew  9596:     if ($put_result !~ /^(ok|delayed)/) {
                   9597:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9598:                                  'got error:'.$put_result);
                   9599:     }
                   9600:     # Make sure these settings stick around in this session, too
1.646     raeburn  9601:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9602:     return;
                   9603: }
                   9604: 
                   9605: sub restore_course_settings {
1.499     albertel 9606:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9607: }
                   9608: 
                   9609: sub restore_settings {
                   9610:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9611:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9612:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9613:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9614:             '.'.$setting;
1.258     albertel 9615:         if (exists($env{$envname})) {
1.153     matthew  9616:             if ($type eq 'scalar') {
1.258     albertel 9617:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9618:             } elsif ($type eq 'array') {
1.258     albertel 9619:                 $env{'form.'.$setting} = [ 
1.153     matthew  9620:                                            map { 
1.369     www      9621:                                                &unescape($_); 
1.258     albertel 9622:                                            } split(',',$env{$envname})
1.153     matthew  9623:                                            ];
                   9624:             }
                   9625:         }
                   9626:     }
1.127     matthew  9627: }
                   9628: 
1.618     raeburn  9629: #######################################################
                   9630: #######################################################
                   9631: 
                   9632: =pod
                   9633: 
                   9634: =head1 Domain E-mail Routines  
                   9635: 
                   9636: =over 4
                   9637: 
1.648     raeburn  9638: =item * &build_recipient_list()
1.618     raeburn  9639: 
1.884     raeburn  9640: Build recipient lists for five types of e-mail:
1.766     raeburn  9641: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9642: (d) Help requests, (e) Course requests needing approval,  generated by
                   9643: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9644: loncoursequeueadmin.pm respectively.
1.618     raeburn  9645: 
                   9646: Inputs:
1.619     raeburn  9647: defmail (scalar - email address of default recipient), 
1.618     raeburn  9648: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9649: defdom (domain for which to retrieve configuration settings),
                   9650: origmail (scalar - email address of recipient from loncapa.conf, 
                   9651: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9652: 
1.655     raeburn  9653: Returns: comma separated list of addresses to which to send e-mail.
                   9654: 
                   9655: =back
1.618     raeburn  9656: 
                   9657: =cut
                   9658: 
                   9659: ############################################################
                   9660: ############################################################
                   9661: sub build_recipient_list {
1.619     raeburn  9662:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9663:     my @recipients;
                   9664:     my $otheremails;
                   9665:     my %domconfig =
                   9666:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9667:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9668:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9669:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9670:                 my @contacts = ('adminemail','supportemail');
                   9671:                 foreach my $item (@contacts) {
                   9672:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9673:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9674:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9675:                             push(@recipients,$addr);
                   9676:                         }
1.619     raeburn  9677:                     }
1.766     raeburn  9678:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9679:                 }
                   9680:             }
1.766     raeburn  9681:         } elsif ($origmail ne '') {
                   9682:             push(@recipients,$origmail);
1.618     raeburn  9683:         }
1.619     raeburn  9684:     } elsif ($origmail ne '') {
                   9685:         push(@recipients,$origmail);
1.618     raeburn  9686:     }
1.688     raeburn  9687:     if (defined($defmail)) {
                   9688:         if ($defmail ne '') {
                   9689:             push(@recipients,$defmail);
                   9690:         }
1.618     raeburn  9691:     }
                   9692:     if ($otheremails) {
1.619     raeburn  9693:         my @others;
                   9694:         if ($otheremails =~ /,/) {
                   9695:             @others = split(/,/,$otheremails);
1.618     raeburn  9696:         } else {
1.619     raeburn  9697:             push(@others,$otheremails);
                   9698:         }
                   9699:         foreach my $addr (@others) {
                   9700:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9701:                 push(@recipients,$addr);
                   9702:             }
1.618     raeburn  9703:         }
                   9704:     }
1.619     raeburn  9705:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9706:     return $recipientlist;
                   9707: }
                   9708: 
1.127     matthew  9709: ############################################################
                   9710: ############################################################
1.154     albertel 9711: 
1.655     raeburn  9712: =pod
                   9713: 
                   9714: =head1 Course Catalog Routines
                   9715: 
                   9716: =over 4
                   9717: 
                   9718: =item * &gather_categories()
                   9719: 
                   9720: Converts category definitions - keys of categories hash stored in  
                   9721: coursecategories in configuration.db on the primary library server in a 
                   9722: domain - to an array.  Also generates javascript and idx hash used to 
                   9723: generate Domain Coordinator interface for editing Course Categories.
                   9724: 
                   9725: Inputs:
1.663     raeburn  9726: 
1.655     raeburn  9727: categories (reference to hash of category definitions).
1.663     raeburn  9728: 
1.655     raeburn  9729: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9730:       categories and subcategories).
1.663     raeburn  9731: 
1.655     raeburn  9732: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9733:       editing Course Categories).
1.663     raeburn  9734: 
1.655     raeburn  9735: jsarray (reference to array of categories used to create Javascript arrays for
                   9736:          Domain Coordinator interface for editing Course Categories).
                   9737: 
                   9738: Returns: nothing
                   9739: 
                   9740: Side effects: populates cats, idx and jsarray. 
                   9741: 
                   9742: =cut
                   9743: 
                   9744: sub gather_categories {
                   9745:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9746:     my %counters;
                   9747:     my $num = 0;
                   9748:     foreach my $item (keys(%{$categories})) {
                   9749:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9750:         if ($container eq '' && $depth == 0) {
                   9751:             $cats->[$depth][$categories->{$item}] = $cat;
                   9752:         } else {
                   9753:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9754:         }
                   9755:         my ($escitem,$tail) = split(/:/,$item,2);
                   9756:         if ($counters{$tail} eq '') {
                   9757:             $counters{$tail} = $num;
                   9758:             $num ++;
                   9759:         }
                   9760:         if (ref($idx) eq 'HASH') {
                   9761:             $idx->{$item} = $counters{$tail};
                   9762:         }
                   9763:         if (ref($jsarray) eq 'ARRAY') {
                   9764:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9765:         }
                   9766:     }
                   9767:     return;
                   9768: }
                   9769: 
                   9770: =pod
                   9771: 
                   9772: =item * &extract_categories()
                   9773: 
                   9774: Used to generate breadcrumb trails for course categories.
                   9775: 
                   9776: Inputs:
1.663     raeburn  9777: 
1.655     raeburn  9778: categories (reference to hash of category definitions).
1.663     raeburn  9779: 
1.655     raeburn  9780: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9781:       categories and subcategories).
1.663     raeburn  9782: 
1.655     raeburn  9783: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9784: 
1.655     raeburn  9785: allitems (reference to hash - key is category key 
                   9786:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9787: 
1.655     raeburn  9788: idx (reference to hash of counters used in Domain Coordinator interface for
                   9789:       editing Course Categories).
1.663     raeburn  9790: 
1.655     raeburn  9791: jsarray (reference to array of categories used to create Javascript arrays for
                   9792:          Domain Coordinator interface for editing Course Categories).
                   9793: 
1.665     raeburn  9794: subcats (reference to hash of arrays containing all subcategories within each 
                   9795:          category, -recursive)
                   9796: 
1.655     raeburn  9797: Returns: nothing
                   9798: 
                   9799: Side effects: populates trails and allitems hash references.
                   9800: 
                   9801: =cut
                   9802: 
                   9803: sub extract_categories {
1.665     raeburn  9804:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9805:     if (ref($categories) eq 'HASH') {
                   9806:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9807:         if (ref($cats->[0]) eq 'ARRAY') {
                   9808:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9809:                 my $name = $cats->[0][$i];
                   9810:                 my $item = &escape($name).'::0';
                   9811:                 my $trailstr;
                   9812:                 if ($name eq 'instcode') {
                   9813:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  9814:                 } elsif ($name eq 'communities') {
                   9815:                     $trailstr = &mt('Communities');
1.655     raeburn  9816:                 } else {
                   9817:                     $trailstr = $name;
                   9818:                 }
                   9819:                 if ($allitems->{$item} eq '') {
                   9820:                     push(@{$trails},$trailstr);
                   9821:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9822:                 }
                   9823:                 my @parents = ($name);
                   9824:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9825:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9826:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9827:                         if (ref($subcats) eq 'HASH') {
                   9828:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9829:                         }
                   9830:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9831:                     }
                   9832:                 } else {
                   9833:                     if (ref($subcats) eq 'HASH') {
                   9834:                         $subcats->{$item} = [];
1.655     raeburn  9835:                     }
                   9836:                 }
                   9837:             }
                   9838:         }
                   9839:     }
                   9840:     return;
                   9841: }
                   9842: 
                   9843: =pod
                   9844: 
                   9845: =item *&recurse_categories()
                   9846: 
                   9847: Recursively used to generate breadcrumb trails for course categories.
                   9848: 
                   9849: Inputs:
1.663     raeburn  9850: 
1.655     raeburn  9851: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9852:       categories and subcategories).
1.663     raeburn  9853: 
1.655     raeburn  9854: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9855: 
                   9856: category (current course category, for which breadcrumb trail is being generated).
                   9857: 
                   9858: trails (reference to array of breadcrumb trails for each category).
                   9859: 
1.655     raeburn  9860: allitems (reference to hash - key is category key
                   9861:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9862: 
1.655     raeburn  9863: parents (array containing containers directories for current category, 
                   9864:          back to top level). 
                   9865: 
                   9866: Returns: nothing
                   9867: 
                   9868: Side effects: populates trails and allitems hash references
                   9869: 
                   9870: =cut
                   9871: 
                   9872: sub recurse_categories {
1.665     raeburn  9873:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9874:     my $shallower = $depth - 1;
                   9875:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9876:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9877:             my $name = $cats->[$depth]{$category}[$k];
                   9878:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9879:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9880:             if ($allitems->{$item} eq '') {
                   9881:                 push(@{$trails},$trailstr);
                   9882:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9883:             }
                   9884:             my $deeper = $depth+1;
                   9885:             push(@{$parents},$category);
1.665     raeburn  9886:             if (ref($subcats) eq 'HASH') {
                   9887:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9888:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9889:                     my $higher;
                   9890:                     if ($j > 0) {
                   9891:                         $higher = &escape($parents->[$j]).':'.
                   9892:                                   &escape($parents->[$j-1]).':'.$j;
                   9893:                     } else {
                   9894:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9895:                     }
                   9896:                     push(@{$subcats->{$higher}},$subcat);
                   9897:                 }
                   9898:             }
                   9899:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9900:                                 $subcats);
1.655     raeburn  9901:             pop(@{$parents});
                   9902:         }
                   9903:     } else {
                   9904:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9905:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9906:         if ($allitems->{$item} eq '') {
                   9907:             push(@{$trails},$trailstr);
                   9908:             $allitems->{$item} = scalar(@{$trails})-1;
                   9909:         }
                   9910:     }
                   9911:     return;
                   9912: }
                   9913: 
1.663     raeburn  9914: =pod
                   9915: 
                   9916: =item *&assign_categories_table()
                   9917: 
                   9918: Create a datatable for display of hierarchical categories in a domain,
                   9919: with checkboxes to allow a course to be categorized. 
                   9920: 
                   9921: Inputs:
                   9922: 
                   9923: cathash - reference to hash of categories defined for the domain (from
                   9924:           configuration.db)
                   9925: 
                   9926: currcat - scalar with an & separated list of categories assigned to a course. 
                   9927: 
1.919     raeburn  9928: type    - scalar contains course type (Course or Community).
                   9929: 
1.663     raeburn  9930: Returns: $output (markup to be displayed) 
                   9931: 
                   9932: =cut
                   9933: 
                   9934: sub assign_categories_table {
1.919     raeburn  9935:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  9936:     my $output;
                   9937:     if (ref($cathash) eq 'HASH') {
                   9938:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9939:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9940:         $maxdepth = scalar(@cats);
                   9941:         if (@cats > 0) {
                   9942:             my $itemcount = 0;
                   9943:             if (ref($cats[0]) eq 'ARRAY') {
                   9944:                 my @currcategories;
                   9945:                 if ($currcat ne '') {
                   9946:                     @currcategories = split('&',$currcat);
                   9947:                 }
1.919     raeburn  9948:                 my $table;
1.663     raeburn  9949:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9950:                     my $parent = $cats[0][$i];
1.919     raeburn  9951:                     next if ($parent eq 'instcode');
                   9952:                     if ($type eq 'Community') {
                   9953:                         next unless ($parent eq 'communities');
                   9954:                     } else {
                   9955:                         next if ($parent eq 'communities');
                   9956:                     }
1.663     raeburn  9957:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9958:                     my $item = &escape($parent).'::0';
                   9959:                     my $checked = '';
                   9960:                     if (@currcategories > 0) {
                   9961:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9962:                             $checked = ' checked="checked"';
1.663     raeburn  9963:                         }
                   9964:                     }
1.919     raeburn  9965:                     my $parent_title = $parent;
                   9966:                     if ($parent eq 'communities') {
                   9967:                         $parent_title = &mt('Communities');
                   9968:                     }
                   9969:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9970:                               '<input type="checkbox" name="usecategory" value="'.
                   9971:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   9972:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9973:                     my $depth = 1;
                   9974:                     push(@path,$parent);
1.919     raeburn  9975:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  9976:                     pop(@path);
1.919     raeburn  9977:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  9978:                     $itemcount ++;
                   9979:                 }
1.919     raeburn  9980:                 if ($itemcount) {
                   9981:                     $output = &Apache::loncommon::start_data_table().
                   9982:                               $table.
                   9983:                               &Apache::loncommon::end_data_table();
                   9984:                 }
1.663     raeburn  9985:             }
                   9986:         }
                   9987:     }
                   9988:     return $output;
                   9989: }
                   9990: 
                   9991: =pod
                   9992: 
                   9993: =item *&assign_category_rows()
                   9994: 
                   9995: Create a datatable row for display of nested categories in a domain,
                   9996: with checkboxes to allow a course to be categorized,called recursively.
                   9997: 
                   9998: Inputs:
                   9999: 
                   10000: itemcount - track row number for alternating colors
                   10001: 
                   10002: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   10003:       categories and subcategories.
                   10004: 
                   10005: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   10006: 
                   10007: parent - parent of current category item
                   10008: 
                   10009: path - Array containing all categories back up through the hierarchy from the
                   10010:        current category to the top level.
                   10011: 
                   10012: currcategories - reference to array of current categories assigned to the course
                   10013: 
                   10014: Returns: $output (markup to be displayed).
                   10015: 
                   10016: =cut
                   10017: 
                   10018: sub assign_category_rows {
                   10019:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   10020:     my ($text,$name,$item,$chgstr);
                   10021:     if (ref($cats) eq 'ARRAY') {
                   10022:         my $maxdepth = scalar(@{$cats});
                   10023:         if (ref($cats->[$depth]) eq 'HASH') {
                   10024:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   10025:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   10026:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   10027:                 $text .= '<td><table class="LC_datatable">';
                   10028:                 for (my $j=0; $j<$numchildren; $j++) {
                   10029:                     $name = $cats->[$depth]{$parent}[$j];
                   10030:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   10031:                     my $deeper = $depth+1;
                   10032:                     my $checked = '';
                   10033:                     if (ref($currcategories) eq 'ARRAY') {
                   10034:                         if (@{$currcategories} > 0) {
                   10035:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   10036:                                 $checked = ' checked="checked"';
1.663     raeburn  10037:                             }
                   10038:                         }
                   10039:                     }
1.664     raeburn  10040:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   10041:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  10042:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   10043:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   10044:                              '</td><td>';
1.663     raeburn  10045:                     if (ref($path) eq 'ARRAY') {
                   10046:                         push(@{$path},$name);
                   10047:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   10048:                         pop(@{$path});
                   10049:                     }
                   10050:                     $text .= '</td></tr>';
                   10051:                 }
                   10052:                 $text .= '</table></td>';
                   10053:             }
                   10054:         }
                   10055:     }
                   10056:     return $text;
                   10057: }
                   10058: 
1.655     raeburn  10059: ############################################################
                   10060: ############################################################
                   10061: 
                   10062: 
1.443     albertel 10063: sub commit_customrole {
1.664     raeburn  10064:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  10065:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 10066:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   10067:                          ($end?', ending '.localtime($end):'').': <b>'.
                   10068:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  10069:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 10070:                  '</b><br />';
                   10071:     return $output;
                   10072: }
                   10073: 
                   10074: sub commit_standardrole {
1.541     raeburn  10075:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   10076:     my ($output,$logmsg,$linefeed);
                   10077:     if ($context eq 'auto') {
                   10078:         $linefeed = "\n";
                   10079:     } else {
                   10080:         $linefeed = "<br />\n";
                   10081:     }  
1.443     albertel 10082:     if ($three eq 'st') {
1.541     raeburn  10083:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   10084:                                          $one,$two,$sec,$context);
                   10085:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  10086:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   10087:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 10088:         } else {
1.541     raeburn  10089:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 10090:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10091:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   10092:             if ($context eq 'auto') {
                   10093:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   10094:             } else {
                   10095:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   10096:                &mt('Add to classlist').': <b>ok</b>';
                   10097:             }
                   10098:             $output .= $linefeed;
1.443     albertel 10099:         }
                   10100:     } else {
                   10101:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   10102:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  10103:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  10104:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  10105:         if ($context eq 'auto') {
                   10106:             $output .= $result.$linefeed;
                   10107:         } else {
                   10108:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   10109:         }
1.443     albertel 10110:     }
                   10111:     return $output;
                   10112: }
                   10113: 
                   10114: sub commit_studentrole {
1.541     raeburn  10115:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  10116:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  10117:     if ($context eq 'auto') {
                   10118:         $linefeed = "\n";
                   10119:     } else {
                   10120:         $linefeed = '<br />'."\n";
                   10121:     }
1.443     albertel 10122:     if (defined($one) && defined($two)) {
                   10123:         my $cid=$one.'_'.$two;
                   10124:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   10125:         my $secchange = 0;
                   10126:         my $expire_role_result;
                   10127:         my $modify_section_result;
1.628     raeburn  10128:         if ($oldsec ne '-1') { 
                   10129:             if ($oldsec ne $sec) {
1.443     albertel 10130:                 $secchange = 1;
1.628     raeburn  10131:                 my $now = time;
1.443     albertel 10132:                 my $uurl='/'.$cid;
                   10133:                 $uurl=~s/\_/\//g;
                   10134:                 if ($oldsec) {
                   10135:                     $uurl.='/'.$oldsec;
                   10136:                 }
1.626     raeburn  10137:                 $oldsecurl = $uurl;
1.628     raeburn  10138:                 $expire_role_result = 
1.652     raeburn  10139:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  10140:                 if ($env{'request.course.sec'} ne '') { 
                   10141:                     if ($expire_role_result eq 'refused') {
                   10142:                         my @roles = ('st');
                   10143:                         my @statuses = ('previous');
                   10144:                         my @roledoms = ($one);
                   10145:                         my $withsec = 1;
                   10146:                         my %roleshash = 
                   10147:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   10148:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   10149:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   10150:                             my ($oldstart,$oldend) = 
                   10151:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   10152:                             if ($oldend > 0 && $oldend <= $now) {
                   10153:                                 $expire_role_result = 'ok';
                   10154:                             }
                   10155:                         }
                   10156:                     }
                   10157:                 }
1.443     albertel 10158:                 $result = $expire_role_result;
                   10159:             }
                   10160:         }
                   10161:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  10162:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 10163:             if ($modify_section_result =~ /^ok/) {
                   10164:                 if ($secchange == 1) {
1.628     raeburn  10165:                     if ($sec eq '') {
                   10166:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   10167:                     } else {
                   10168:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   10169:                     }
1.443     albertel 10170:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  10171:                     if ($sec eq '') {
                   10172:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   10173:                     } else {
                   10174:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10175:                     }
1.443     albertel 10176:                 } else {
1.628     raeburn  10177:                     if ($sec eq '') {
                   10178:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   10179:                     } else {
                   10180:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10181:                     }
1.443     albertel 10182:                 }
                   10183:             } else {
1.628     raeburn  10184:                 if ($secchange) {       
                   10185:                     $$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;
                   10186:                 } else {
                   10187:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10188:                 }
1.443     albertel 10189:             }
                   10190:             $result = $modify_section_result;
                   10191:         } elsif ($secchange == 1) {
1.628     raeburn  10192:             if ($oldsec eq '') {
                   10193:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10194:             } else {
                   10195:                 $$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;
                   10196:             }
1.626     raeburn  10197:             if ($expire_role_result eq 'refused') {
                   10198:                 my $newsecurl = '/'.$cid;
                   10199:                 $newsecurl =~ s/\_/\//g;
                   10200:                 if ($sec ne '') {
                   10201:                     $newsecurl.='/'.$sec;
                   10202:                 }
                   10203:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10204:                     if ($sec eq '') {
                   10205:                         $$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;
                   10206:                     } else {
                   10207:                         $$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;
                   10208:                     }
                   10209:                 }
                   10210:             }
1.443     albertel 10211:         }
                   10212:     } else {
1.626     raeburn  10213:         $$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 10214:         $result = "error: incomplete course id\n";
                   10215:     }
                   10216:     return $result;
                   10217: }
                   10218: 
                   10219: ############################################################
                   10220: ############################################################
                   10221: 
1.566     albertel 10222: sub check_clone {
1.578     raeburn  10223:     my ($args,$linefeed) = @_;
1.566     albertel 10224:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10225:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10226:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10227:     my $clonemsg;
                   10228:     my $can_clone = 0;
1.925.2.11  raeburn  10229:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  10230:     if ($lctype ne 'community') {
                   10231:         $lctype = 'course';
                   10232:     }
1.566     albertel 10233:     if ($clonehome eq 'no_host') {
1.925.2.11  raeburn  10234:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10235:             $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'});
                   10236:         } else {
                   10237:             $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'});
                   10238:         }     
1.566     albertel 10239:     } else {
                   10240: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.925.2.11  raeburn  10241:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10242:             if ($clonedesc{'type'} ne 'Community') {
                   10243:                  $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'});
                   10244:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10245:             }
                   10246:         }
1.882     raeburn  10247: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10248:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10249: 	    $can_clone = 1;
                   10250: 	} else {
                   10251: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10252: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10253: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10254:             if (grep(/^\*$/,@cloners)) {
                   10255:                 $can_clone = 1;
                   10256:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10257:                 $can_clone = 1;
                   10258:             } else {
1.908     raeburn  10259:                 my $ccrole = 'cc';
1.925.2.11  raeburn  10260:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10261:                     $ccrole = 'co';
                   10262:                 }
1.578     raeburn  10263: 	        my %roleshash =
                   10264: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10265: 					 $args->{'ccdomain'},
1.908     raeburn  10266:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10267: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10268: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10269: 		    $can_clone = 1;
                   10270: 	        } else {
1.925.2.11  raeburn  10271:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  10272:                         $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'});
                   10273:                     } else {
                   10274:                         $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'});
                   10275:                     }
1.578     raeburn  10276: 	        }
1.566     albertel 10277: 	    }
1.578     raeburn  10278:         }
1.566     albertel 10279:     }
                   10280:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10281: }
                   10282: 
1.444     albertel 10283: sub construct_course {
1.885     raeburn  10284:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10285:     my $outcome;
1.541     raeburn  10286:     my $linefeed =  '<br />'."\n";
                   10287:     if ($context eq 'auto') {
                   10288:         $linefeed = "\n";
                   10289:     }
1.566     albertel 10290: 
                   10291: #
                   10292: # Are we cloning?
                   10293: #
                   10294:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10295:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10296: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10297: 	if ($context ne 'auto') {
1.578     raeburn  10298:             if ($clonemsg ne '') {
                   10299: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10300:             }
1.566     albertel 10301: 	}
                   10302: 	$outcome .= $clonemsg.$linefeed;
                   10303: 
                   10304:         if (!$can_clone) {
                   10305: 	    return (0,$outcome);
                   10306: 	}
                   10307:     }
                   10308: 
1.444     albertel 10309: #
                   10310: # Open course
                   10311: #
                   10312:     my $crstype = lc($args->{'crstype'});
                   10313:     my %cenv=();
                   10314:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10315:                                              $args->{'cdescr'},
                   10316:                                              $args->{'curl'},
                   10317:                                              $args->{'course_home'},
                   10318:                                              $args->{'nonstandard'},
                   10319:                                              $args->{'crscode'},
                   10320:                                              $args->{'ccuname'}.':'.
                   10321:                                              $args->{'ccdomain'},
1.882     raeburn  10322:                                              $args->{'crstype'},
1.885     raeburn  10323:                                              $cnum,$context,$category);
1.444     albertel 10324: 
                   10325:     # Note: The testing routines depend on this being output; see 
                   10326:     # Utils::Course. This needs to at least be output as a comment
                   10327:     # if anyone ever decides to not show this, and Utils::Course::new
                   10328:     # will need to be suitably modified.
1.541     raeburn  10329:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10330: #
                   10331: # Check if created correctly
                   10332: #
1.479     albertel 10333:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10334:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10335:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10336: 
1.444     albertel 10337: #
1.566     albertel 10338: # Do the cloning
                   10339: #   
                   10340:     if ($can_clone && $cloneid) {
                   10341: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10342: 	if ($context ne 'auto') {
                   10343: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10344: 	}
                   10345: 	$outcome .= $clonemsg.$linefeed;
                   10346: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10347: # Copy all files
1.637     www      10348: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10349: # Restore URL
1.566     albertel 10350: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10351: # Restore title
1.566     albertel 10352: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10353: # Mark as cloned
1.566     albertel 10354: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10355: # Need to clone grading mode
                   10356:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10357:         $cenv{'grading'}=$newenv{'grading'};
                   10358: # Do not clone these environment entries
                   10359:         &Apache::lonnet::del('environment',
                   10360:                   ['default_enrollment_start_date',
                   10361:                    'default_enrollment_end_date',
                   10362:                    'question.email',
                   10363:                    'policy.email',
                   10364:                    'comment.email',
                   10365:                    'pch.users.denied',
1.725     raeburn  10366:                    'plc.users.denied',
                   10367:                    'hidefromcat',
                   10368:                    'categories'],
1.638     www      10369:                    $$crsudom,$$crsunum);
1.444     albertel 10370:     }
1.566     albertel 10371: 
1.444     albertel 10372: #
                   10373: # Set environment (will override cloned, if existing)
                   10374: #
                   10375:     my @sections = ();
                   10376:     my @xlists = ();
                   10377:     if ($args->{'crstype'}) {
                   10378:         $cenv{'type'}=$args->{'crstype'};
                   10379:     }
                   10380:     if ($args->{'crsid'}) {
                   10381:         $cenv{'courseid'}=$args->{'crsid'};
                   10382:     }
                   10383:     if ($args->{'crscode'}) {
                   10384:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10385:     }
                   10386:     if ($args->{'crsquota'} ne '') {
                   10387:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10388:     } else {
                   10389:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10390:     }
                   10391:     if ($args->{'ccuname'}) {
                   10392:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10393:                                         ':'.$args->{'ccdomain'};
                   10394:     } else {
                   10395:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10396:     }
                   10397:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10398:     if ($args->{'crssections'}) {
                   10399:         $cenv{'internal.sectionnums'} = '';
                   10400:         if ($args->{'crssections'} =~ m/,/) {
                   10401:             @sections = split/,/,$args->{'crssections'};
                   10402:         } else {
                   10403:             $sections[0] = $args->{'crssections'};
                   10404:         }
                   10405:         if (@sections > 0) {
                   10406:             foreach my $item (@sections) {
                   10407:                 my ($sec,$gp) = split/:/,$item;
                   10408:                 my $class = $args->{'crscode'}.$sec;
                   10409:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10410:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10411:                 unless ($addcheck eq 'ok') {
                   10412:                     push @badclasses, $class;
                   10413:                 }
                   10414:             }
                   10415:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10416:         }
                   10417:     }
                   10418: # do not hide course coordinator from staff listing, 
                   10419: # even if privileged
                   10420:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10421: # add crosslistings
                   10422:     if ($args->{'crsxlist'}) {
                   10423:         $cenv{'internal.crosslistings'}='';
                   10424:         if ($args->{'crsxlist'} =~ m/,/) {
                   10425:             @xlists = split/,/,$args->{'crsxlist'};
                   10426:         } else {
                   10427:             $xlists[0] = $args->{'crsxlist'};
                   10428:         }
                   10429:         if (@xlists > 0) {
                   10430:             foreach my $item (@xlists) {
                   10431:                 my ($xl,$gp) = split/:/,$item;
                   10432:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10433:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10434:                 unless ($addcheck eq 'ok') {
                   10435:                     push @badclasses, $xl;
                   10436:                 }
                   10437:             }
                   10438:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10439:         }
                   10440:     }
                   10441:     if ($args->{'autoadds'}) {
                   10442:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10443:     }
                   10444:     if ($args->{'autodrops'}) {
                   10445:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10446:     }
                   10447: # check for notification of enrollment changes
                   10448:     my @notified = ();
                   10449:     if ($args->{'notify_owner'}) {
                   10450:         if ($args->{'ccuname'} ne '') {
                   10451:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10452:         }
                   10453:     }
                   10454:     if ($args->{'notify_dc'}) {
                   10455:         if ($uname ne '') { 
1.630     raeburn  10456:             push(@notified,$uname.':'.$udom);
1.444     albertel 10457:         }
                   10458:     }
                   10459:     if (@notified > 0) {
                   10460:         my $notifylist;
                   10461:         if (@notified > 1) {
                   10462:             $notifylist = join(',',@notified);
                   10463:         } else {
                   10464:             $notifylist = $notified[0];
                   10465:         }
                   10466:         $cenv{'internal.notifylist'} = $notifylist;
                   10467:     }
                   10468:     if (@badclasses > 0) {
                   10469:         my %lt=&Apache::lonlocal::texthash(
                   10470:                 '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',
                   10471:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10472:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10473:         );
1.541     raeburn  10474:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10475:                            ' ('.$lt{'adby'}.')';
                   10476:         if ($context eq 'auto') {
                   10477:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10478:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10479:             foreach my $item (@badclasses) {
                   10480:                 if ($context eq 'auto') {
                   10481:                     $outcome .= " - $item\n";
                   10482:                 } else {
                   10483:                     $outcome .= "<li>$item</li>\n";
                   10484:                 }
                   10485:             }
                   10486:             if ($context eq 'auto') {
                   10487:                 $outcome .= $linefeed;
                   10488:             } else {
1.566     albertel 10489:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10490:             }
                   10491:         } 
1.444     albertel 10492:     }
                   10493:     if ($args->{'no_end_date'}) {
                   10494:         $args->{'endaccess'} = 0;
                   10495:     }
                   10496:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10497:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10498:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10499:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10500:     if ($args->{'showphotos'}) {
                   10501:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10502:     }
                   10503:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10504:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10505:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10506:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10507:             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'); 
                   10508:             if ($context eq 'auto') {
                   10509:                 $outcome .= $krb_msg;
                   10510:             } else {
1.566     albertel 10511:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10512:             }
                   10513:             $outcome .= $linefeed;
1.444     albertel 10514:         }
                   10515:     }
                   10516:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10517:        if ($args->{'setpolicy'}) {
                   10518:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10519:        }
                   10520:        if ($args->{'setcontent'}) {
                   10521:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10522:        }
                   10523:     }
                   10524:     if ($args->{'reshome'}) {
                   10525: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10526: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10527:     }
                   10528: #
                   10529: # course has keyed access
                   10530: #
                   10531:     if ($args->{'setkeys'}) {
                   10532:        $cenv{'keyaccess'}='yes';
                   10533:     }
                   10534: # if specified, key authority is not course, but user
                   10535: # only active if keyaccess is yes
                   10536:     if ($args->{'keyauth'}) {
1.487     albertel 10537: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10538: 	$user = &LONCAPA::clean_username($user);
                   10539: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10540: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10541: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10542: 	}
                   10543:     }
                   10544: 
                   10545:     if ($args->{'disresdis'}) {
                   10546:         $cenv{'pch.roles.denied'}='st';
                   10547:     }
                   10548:     if ($args->{'disablechat'}) {
                   10549:         $cenv{'plc.roles.denied'}='st';
                   10550:     }
                   10551: 
                   10552:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10553:     # course
                   10554:     $cenv{'course.helper.not.run'} = 1;
                   10555:     #
                   10556:     # Use new Randomseed
                   10557:     #
                   10558:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10559:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10560:     #
                   10561:     # The encryption code and receipt prefix for this course
                   10562:     #
                   10563:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10564:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10565:     #
                   10566:     # By default, use standard grading
                   10567:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10568: 
1.541     raeburn  10569:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10570:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10571: #
                   10572: # Open all assignments
                   10573: #
                   10574:     if ($args->{'openall'}) {
                   10575:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10576:        my %storecontent = ($storeunder         => time,
                   10577:                            $storeunder.'.type' => 'date_start');
                   10578:        
                   10579:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10580:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10581:    }
                   10582: #
                   10583: # Set first page
                   10584: #
                   10585:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10586: 	    || ($cloneid)) {
1.445     albertel 10587: 	use LONCAPA::map;
1.444     albertel 10588: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10589: 
                   10590: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10591:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10592: 
1.444     albertel 10593:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10594:         my $title; my $url;
                   10595:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10596: 	    $title=&mt('Syllabus');
1.444     albertel 10597:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10598:         } else {
1.690     bisitz   10599:             $title=&mt('Navigate Contents');
1.444     albertel 10600:             $url='/adm/navmaps';
                   10601:         }
1.445     albertel 10602: 
                   10603:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10604: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10605: 
                   10606: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10607:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10608:     }
1.566     albertel 10609: 
1.925.2.12  raeburn  10610:     if ($args->{'cloneroster'}) {
                   10611:         my ($numadded,$clisterror) = &Apache::lonclonecourse::copyroster($cloneid,$$courseid,$args->{'startaccess'},$args->{'endaccess'});
                   10612:         if ($clisterror) {
                   10613:             $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;
                   10614:             if ($numadded) {
                   10615:                 $outcome .= &mt('Although [quant,_1,student] have received roles in the new course the roster does not report this. It is  ').$linefeed;
                   10616:             } 
                   10617:         } else {
                   10618:             if ($numadded) {
                   10619:                 $outcome .= "\0".&mt('[quant,_1,student] copied from roster for old course to roster for new course.',$numadded).$linefeed;
                   10620:             } else {
                   10621:                 $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;
                   10622:             }
                   10623:         }
                   10624:     }
1.566     albertel 10625:     return (1,$outcome);
1.444     albertel 10626: }
                   10627: 
                   10628: ############################################################
                   10629: ############################################################
                   10630: 
1.378     raeburn  10631: sub course_type {
                   10632:     my ($cid) = @_;
                   10633:     if (!defined($cid)) {
                   10634:         $cid = $env{'request.course.id'};
                   10635:     }
1.404     albertel 10636:     if (defined($env{'course.'.$cid.'.type'})) {
                   10637:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10638:     } else {
                   10639:         return 'Course';
1.377     raeburn  10640:     }
                   10641: }
1.156     albertel 10642: 
1.406     raeburn  10643: sub group_term {
                   10644:     my $crstype = &course_type();
                   10645:     my %names = (
                   10646:                   'Course' => 'group',
1.865     raeburn  10647:                   'Community' => 'group',
1.406     raeburn  10648:                 );
                   10649:     return $names{$crstype};
                   10650: }
                   10651: 
1.902     raeburn  10652: sub course_types {
                   10653:     my @types = ('official','unofficial','community');
                   10654:     my %typename = (
                   10655:                          official   => 'Official course',
                   10656:                          unofficial => 'Unofficial course',
                   10657:                          community  => 'Community',
                   10658:                    );
                   10659:     return (\@types,\%typename);
                   10660: }
                   10661: 
1.156     albertel 10662: sub icon {
                   10663:     my ($file)=@_;
1.505     albertel 10664:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10665:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10666:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10667:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10668: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10669: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10670: 	            $curfext.".gif") {
                   10671: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10672: 		$curfext.".gif";
                   10673: 	}
                   10674:     }
1.249     albertel 10675:     return &lonhttpdurl($iconname);
1.154     albertel 10676: } 
1.84      albertel 10677: 
1.575     albertel 10678: sub lonhttpdurl {
1.692     www      10679: #
                   10680: # Had been used for "small fry" static images on separate port 8080.
                   10681: # Modify here if lightweight http functionality desired again.
                   10682: # Currently eliminated due to increasing firewall issues.
                   10683: #
1.575     albertel 10684:     my ($url)=@_;
1.692     www      10685:     return $url;
1.215     albertel 10686: }
                   10687: 
1.213     albertel 10688: sub connection_aborted {
                   10689:     my ($r)=@_;
                   10690:     $r->print(" ");$r->rflush();
                   10691:     my $c = $r->connection;
                   10692:     return $c->aborted();
                   10693: }
                   10694: 
1.221     foxr     10695: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10696: #    strings as 'strings'.
                   10697: sub escape_single {
1.221     foxr     10698:     my ($input) = @_;
1.223     albertel 10699:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10700:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10701:     return $input;
                   10702: }
1.223     albertel 10703: 
1.222     foxr     10704: #  Same as escape_single, but escape's "'s  This 
                   10705: #  can be used for  "strings"
                   10706: sub escape_double {
                   10707:     my ($input) = @_;
                   10708:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10709:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10710:     return $input;
                   10711: }
1.223     albertel 10712:  
1.222     foxr     10713: #   Escapes the last element of a full URL.
                   10714: sub escape_url {
                   10715:     my ($url)   = @_;
1.238     raeburn  10716:     my @urlslices = split(/\//, $url,-1);
1.369     www      10717:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10718:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10719: }
1.462     albertel 10720: 
1.820     raeburn  10721: sub compare_arrays {
                   10722:     my ($arrayref1,$arrayref2) = @_;
                   10723:     my (@difference,%count);
                   10724:     @difference = ();
                   10725:     %count = ();
                   10726:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10727:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10728:         foreach my $element (keys(%count)) {
                   10729:             if ($count{$element} == 1) {
                   10730:                 push(@difference,$element);
                   10731:             }
                   10732:         }
                   10733:     }
                   10734:     return @difference;
                   10735: }
                   10736: 
1.817     bisitz   10737: # -------------------------------------------------------- Initialize user login
1.462     albertel 10738: sub init_user_environment {
1.463     albertel 10739:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10740:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10741: 
                   10742:     my $public=($username eq 'public' && $domain eq 'public');
                   10743: 
                   10744: # See if old ID present, if so, remove
                   10745: 
                   10746:     my ($filename,$cookie,$userroles);
                   10747:     my $now=time;
                   10748: 
                   10749:     if ($public) {
                   10750: 	my $max_public=100;
                   10751: 	my $oldest;
                   10752: 	my $oldest_time=0;
                   10753: 	for(my $next=1;$next<=$max_public;$next++) {
                   10754: 	    if (-e $lonids."/publicuser_$next.id") {
                   10755: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10756: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10757: 		    $oldest_time=$mtime;
                   10758: 		    $oldest=$next;
                   10759: 		}
                   10760: 	    } else {
                   10761: 		$cookie="publicuser_$next";
                   10762: 		last;
                   10763: 	    }
                   10764: 	}
                   10765: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10766:     } else {
1.463     albertel 10767: 	# if this isn't a robot, kill any existing non-robot sessions
                   10768: 	if (!$args->{'robot'}) {
                   10769: 	    opendir(DIR,$lonids);
                   10770: 	    while ($filename=readdir(DIR)) {
                   10771: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10772: 		    unlink($lonids.'/'.$filename);
                   10773: 		}
1.462     albertel 10774: 	    }
1.463     albertel 10775: 	    closedir(DIR);
1.462     albertel 10776: 	}
                   10777: # Give them a new cookie
1.463     albertel 10778: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10779: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10780: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10781:     
                   10782: # Initialize roles
                   10783: 
                   10784: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10785:     }
                   10786: # ------------------------------------ Check browser type and MathML capability
                   10787: 
                   10788:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10789:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10790: 
                   10791: # ------------------------------------------------------------- Get environment
                   10792: 
                   10793:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10794:     my ($tmp) = keys(%userenv);
                   10795:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10796: 	# default remote control to off
                   10797: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10798:     } else {
                   10799: 	undef(%userenv);
                   10800:     }
                   10801:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10802: 	$form->{'interface'}=$userenv{'interface'};
                   10803:     }
                   10804:     $env{'environment.remote'}=$userenv{'remote'};
                   10805:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10806: 
                   10807: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10808:     foreach my $option ('interface','localpath','localres') {
                   10809:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10810:     }
                   10811: # --------------------------------------------------------- Write first profile
                   10812: 
                   10813:     {
                   10814: 	my %initial_env = 
                   10815: 	    ("user.name"          => $username,
                   10816: 	     "user.domain"        => $domain,
                   10817: 	     "user.home"          => $authhost,
                   10818: 	     "browser.type"       => $clientbrowser,
                   10819: 	     "browser.version"    => $clientversion,
                   10820: 	     "browser.mathml"     => $clientmathml,
                   10821: 	     "browser.unicode"    => $clientunicode,
                   10822: 	     "browser.os"         => $clientos,
                   10823: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10824: 	     "request.course.fn"  => '',
                   10825: 	     "request.course.uri" => '',
                   10826: 	     "request.course.sec" => '',
                   10827: 	     "request.role"       => 'cm',
                   10828: 	     "request.role.adv"   => $env{'user.adv'},
                   10829: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10830: 
                   10831:         if ($form->{'localpath'}) {
                   10832: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10833: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10834:         }
                   10835: 	
                   10836: 	if ($public) {
                   10837: 	    $initial_env{"environment.remote"} = "off";
                   10838: 	}
                   10839: 	if ($form->{'interface'}) {
                   10840: 	    $form->{'interface'}=~s/\W//gs;
                   10841: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10842: 	    $env{'browser.interface'}=$form->{'interface'};
                   10843: 	}
                   10844: 
1.724     raeburn  10845:         foreach my $tool ('aboutme','blog','portfolio') {
                   10846:             $userenv{'availabletools.'.$tool} = 
                   10847:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10848:         }
                   10849: 
1.864     raeburn  10850:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10851:             $userenv{'canrequest.'.$crstype} =
                   10852:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10853:                                                   'reload','requestcourses');
                   10854:         }
                   10855: 
1.462     albertel 10856: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10857: 	
                   10858: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10859: 		 &GDBM_WRCREAT(),0640)) {
                   10860: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10861: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10862: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10863: 	    if (ref($args->{'extra_env'})) {
                   10864: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10865: 	    }
1.462     albertel 10866: 	    untie(%disk_env);
                   10867: 	} else {
1.705     tempelho 10868: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10869: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10870: 	    return 'error: '.$!;
                   10871: 	}
                   10872:     }
                   10873:     $env{'request.role'}='cm';
                   10874:     $env{'request.role.adv'}=$env{'user.adv'};
                   10875:     $env{'browser.type'}=$clientbrowser;
                   10876: 
                   10877:     return $cookie;
                   10878: 
                   10879: }
                   10880: 
                   10881: sub _add_to_env {
                   10882:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10883:     if (ref($env_data) eq 'HASH') {
                   10884:         while (my ($key,$value) = each(%$env_data)) {
                   10885: 	    $idf->{$prefix.$key} = $value;
                   10886: 	    $env{$prefix.$key}   = $value;
                   10887:         }
1.462     albertel 10888:     }
                   10889: }
                   10890: 
1.925.2.8  raeburn  10891: sub new_roles_update {
                   10892:     my $rolecount = 0;
                   10893:     foreach my $envkey (keys(%env)) {
                   10894:         next unless ($envkey =~ /^user\.role\./);
                   10895:         $rolecount ++;
                   10896:     }
1.925.2.9  raeburn  10897:     my $newrolecount = 0;
1.925.2.8  raeburn  10898:     if (!$rolecount) {
                   10899:         my %userenv;
                   10900:         foreach my $crstype ('official','unofficial','community') {
                   10901:             $userenv{'canrequest.'.$crstype} =
                   10902:                 &Apache::lonnet::usertools_access($env{'user.name'},
                   10903:                 $env{'user.domain'},$crstype,'reload','requestcourses');
                   10904:         }
                   10905:         my $then=$env{'user.login.time'};
                   10906:         my $refresh=time;
                   10907:         my (%userroles,%allroles,%allgroups,@newroles);
                   10908:         my %roleshash =
                   10909:             &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active','future','previous'],undef,undef,1);
                   10910:         foreach my $item (keys(%roleshash)) {
                   10911:             my ($uname,$udom,$role,$section) = split(':',$item);
                   10912:             my $where = '/'.$udom.'/'.$uname;
                   10913:             my ($tstart,$tend) = split(':',$roleshash{$item});
                   10914:             if ($section ne '') {
                   10915:                 $where .= '/'.$section;
                   10916:             }
                   10917:             my $spec = $role.'.'.$where;
                   10918:             &Apache::lonnet::set_arearole($role,$where,$tstart,$tend,
                   10919:                                           $env{'user.domain'},$env{'user.name'});
                   10920:             $userroles{'user.role.'.$spec} = $tstart.'.'.$tend;
1.925.2.9  raeburn  10921:             $newrolecount ++;
1.925.2.8  raeburn  10922:             unless (grep(/^\Q$role\E$/,@newroles)) {
                   10923:                 push(@newroles,$role);
                   10924:             }
                   10925:             my $status =
                   10926:                 &Apache::lonnet::curr_role_status($tstart,$tend,$refresh,$then);
                   10927:             if ($status eq 'active') {
                   10928:                 &Apache::lonnet::gather_roleprivs(\%allroles,\%allgroups,\%userroles,
                   10929:                                                   $where,$role,$tstart,$tend);
                   10930:             }
                   10931:         }
                   10932:         if (@newroles) {
                   10933:             my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles,
                   10934:                                                                \%allgroups);
1.925.2.10  raeburn  10935:             &Apache::lonnet::appenv(\%userroles,[@newroles,'cm']);
1.925.2.8  raeburn  10936:             $userenv{'user.adv'} = $adv;
                   10937:             $userenv{'user.author'} = $author;
                   10938:             $userenv{'user.refresh.time'} = $refresh;
                   10939:         }
                   10940:         &Apache::lonnet::appenv(\%userenv);
                   10941:     }
1.925.2.9  raeburn  10942:     return $newrolecount;
1.925.2.8  raeburn  10943: }
                   10944: 
1.685     tempelho 10945: # --- Get the symbolic name of a problem and the url
                   10946: sub get_symb {
                   10947:     my ($request,$silent) = @_;
1.726     raeburn  10948:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10949:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10950:     if ($symb eq '') {
                   10951:         if (!$silent) {
                   10952:             $request->print("Unable to handle ambiguous references:$url:.");
                   10953:             return ();
                   10954:         }
                   10955:     }
                   10956:     &Apache::lonenc::check_decrypt(\$symb);
                   10957:     return ($symb);
                   10958: }
                   10959: 
                   10960: # --------------------------------------------------------------Get annotation
                   10961: 
                   10962: sub get_annotation {
                   10963:     my ($symb,$enc) = @_;
                   10964: 
                   10965:     my $key = $symb;
                   10966:     if (!$enc) {
                   10967:         $key =
                   10968:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10969:     }
                   10970:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10971:     return $annotation{$key};
                   10972: }
                   10973: 
                   10974: sub clean_symb {
1.731     raeburn  10975:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10976: 
                   10977:     &Apache::lonenc::check_decrypt(\$symb);
                   10978:     my $enc = $env{'request.enc'};
1.731     raeburn  10979:     if ($delete_enc) {
1.730     raeburn  10980:         delete($env{'request.enc'});
                   10981:     }
1.685     tempelho 10982: 
                   10983:     return ($symb,$enc);
                   10984: }
1.462     albertel 10985: 
1.925.2.1  raeburn  10986: sub needs_gci_custom {
                   10987:     my $custommenu;
                   10988:     my $numdc = &check_for_gci_dc();
                   10989:     unless ($numdc) {
                   10990:         my $then=$env{'user.login.time'};
                   10991:         my $now = time;
                   10992:         my %cnums = (
                   10993:                         review => '9615072b469884921gcil1',
                   10994:                         submit => '1H96711d710194bfegcil1',
                   10995:                     );
                   10996:         if ($env{'user.role.st./gci/'.$cnums{'review'}}) {
                   10997:             my ($start,$end) =
                   10998:                 split('.',$env{'user.role.st./gci/'.$cnums{'review'}});
                   10999:             if (((!$start) || ($start && $start <= $now)) &&
                   11000:                 ((!$end) || ($end > $now))) {
                   11001:                 $custommenu = 1;
                   11002:                 if ($env{'user.role.cc./gci/'.$cnums{'review'}}) {
                   11003:                     my ($ccstart,$ccend) =
                   11004:                         split('.',$env{'user.role.cc./gci/'.$cnums{'review'}});
                   11005:                     if (((!$start) || ($start && $start <= $now)) &&
                   11006:                             ((!$end) || ($end > $now))) {
                   11007:                         $custommenu = '';
                   11008:                     }
                   11009:                 }
                   11010:             }
                   11011:         }
                   11012:     }
                   11013:     return $custommenu;
                   11014: }
                   11015: 
                   11016: sub check_for_gci_dc {
                   11017:     my $then=$env{'user.login.time'};
                   11018:     my $numdc = 0;
                   11019:     foreach my $dom ('gci','gcitest') {
                   11020:         if ($env{'user.role.dc./'.$dom.'/'}) {
                   11021:             my $livedc = 1;
                   11022:             my ($tstart,$tend)=split(/\./,$env{'user.role.dc./'.$dom.'/'});
                   11023:             if ($tstart && $tstart>$then) { $livedc = 0; }
                   11024:             if ($tend   && $tend  <$then) { $livedc = 0; }
                   11025:             if ($livedc) {
                   11026:                 $numdc++;
                   11027:             }
                   11028:         }
                   11029:     }
                   11030:     return $numdc;
                   11031: }
                   11032: 
                   11033: sub existing_gcitest_courses {
1.925.2.6  raeburn  11034:     my ($role) = @_;
1.925.2.1  raeburn  11035:     my %courses;
                   11036:     my $cdom = 'gcitest';
                   11037:     my $now = time;
                   11038:     foreach my $envkey (keys(%env)) {
                   11039:         my $cnum;
                   11040:         if ($envkey =~ m{^user\.role\.\Q$role\E\./\Q$cdom\E/($match_courseid)$}) {
                   11041:             $cnum = $1;
                   11042:         } else {
                   11043:             next;
                   11044:         }
1.925.2.16! raeburn  11045:         my ($tstart,$tend) = split(/\./,$env{$envkey});
1.925.2.1  raeburn  11046:         if (((!$tstart) || ($tstart < $now)) && ((!$tend) || ($tend > $now))) {
1.925.2.3  raeburn  11047:             my $descr = $env{'course.'.$cdom.'_'.$cnum.'.description'};
                   11048:             if ($descr ne '') {
                   11049:                 $courses{$cdom.'_'.$cnum}{'description'} = $descr;
1.925.2.1  raeburn  11050:             }
                   11051:         }
                   11052:     }
                   11053:     return %courses;
                   11054: }
                   11055: 
1.925.2.14  raeburn  11056: sub gcitest_switcher {
                   11057:     my ($role,$formname,%courses) = @_;
                   11058:     my $output;
                   11059:     my %Sortby;
                   11060:     foreach my $course (sort(keys(%courses))) {
                   11061:         next unless (ref($courses{$course}) eq 'HASH');
                   11062:         my $clean_title = $courses{$course}{'description'};
                   11063:         $clean_title =~ s/\W+//g;
                   11064:         if ($clean_title eq '') {
                   11065:             $clean_title = $courses{$course}{'description'};
                   11066:         }
                   11067:         push(@{$Sortby{$clean_title}},$course);
                   11068:     }
                   11069:     my @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby));
                   11070:     my $default;
                   11071:     if (@sorted_courses > 1) {
                   11072:         if (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11073:             $default = &mt('Switch concept test ...');
                   11074:         } else {
                   11075:             $default = &mt('Select a concept test ...');
                   11076:         }
                   11077:     } else {
                   11078:         unless (($env{'request.course.id'}) && ($courses{$env{'request.course.id'}})) {
                   11079:             $default = &mt('Select concept test ...');
                   11080:         }
                   11081:     }
                   11082:     if ($default) {
                   11083:         $output = '<form name="'.$formname.'" action="/adm/roles" method="post">'.
                   11084:                   '<select name="newrole" onchange="javascript:courseswitcher();">'.
                   11085:                   '<option value="" selected="selected">'.$default.'</option>';
                   11086:         foreach my $item (@sorted_courses) {
                   11087:             foreach my $course (@{$Sortby{$item}}) {
                   11088:                 my ($cdom,$cnum) = split('_',$course);
                   11089:                 $output .= '<option value="'.$role.'./'.$cdom.'/'.$cnum.'">'.$courses{$course}{'description'}.'</option>';
                   11090:             }
                   11091:         }
                   11092:         $output .= '</select><input type="hidden" name="selectrole" value="" /></form>';
                   11093:     }
                   11094:     return $output;
                   11095: }
                   11096: 
                   11097: sub gcitest_switcher_js {
                   11098:     my ($current,$numcourses,$formname) = @_;
                   11099:     my $output = <<"ENDJS";
                   11100: 
                   11101: function courseswitcher(caller) {
                   11102:     var numcourses = $numcourses;
                   11103:     var current = '$current';
                   11104:     var choice = document.$formname.newrole.options[document.$formname.newrole.selectedIndex].value;
                   11105:     if (choice == '') {
                   11106:         if (caller == 'icon') {
                   11107:             alert('No Concept Test selected');
                   11108:         }
                   11109:         document.$formname.selectrole.value = '';
                   11110:         return;
                   11111:     }
                   11112:     if (choice == current) {
                   11113:         if ((caller != 'icon') && (numcourses > 1)) {
                   11114:             alert('You have selected the current course.\\nPlease select a different Concept Test course');
                   11115:         }
                   11116:         document.$formname.newrole.selectedIndex = 0;
                   11117:         document.$formname.selectrole.value = '';
                   11118:         return;
                   11119:     }
                   11120:     document.$formname.selectrole.value = '1';
                   11121:     document.$formname.submit();
                   11122:     return;
                   11123: }
                   11124: 
                   11125: ENDJS
                   11126:     return $output;
                   11127: }
                   11128: 
                   11129: 
                   11130: 
1.41      ng       11131: =pod
                   11132: 
                   11133: =back
                   11134: 
1.112     bowersj2 11135: =cut
1.41      ng       11136: 
1.112     bowersj2 11137: 1;
                   11138: __END__;
1.41      ng       11139: 

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