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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1063  ! raeburn     4: # $Id: loncommon.pm,v 1.1062 2012/03/31 23:10:39 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.1048    foxr      157: my %latex_language;		# For choosing hyphenation in <transl..>
                    158: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  159: my %cprtag;
1.192     taceyjo1  160: my %scprtag;
1.351     www       161: my %fe; my %fd; my %fm;
1.41      ng        162: my %category_extensions;
1.12      harris41  163: 
1.46      matthew   164: # ---------------------------------------------- Thesaurus variables
1.144     matthew   165: #
                    166: # %Keywords:
                    167: #      A hash used by &keyword to determine if a word is considered a keyword.
                    168: # $thesaurus_db_file 
                    169: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   170: 
                    171: my %Keywords;
                    172: my $thesaurus_db_file;
                    173: 
1.144     matthew   174: #
                    175: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    176: # thesaurus.tab, and filecategories.tab.
                    177: #
1.18      www       178: BEGIN {
1.46      matthew   179:     # Variable initialization
                    180:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    181:     #
1.22      www       182:     unless ($readit) {
1.12      harris41  183: # ------------------------------------------------------------------- languages
                    184:     {
1.158     raeburn   185:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    186:                                    '/language.tab';
                    187:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  188:             while (my $line = <$fh>) {
                    189:                 next if ($line=~/^\#/);
                    190:                 chomp($line);
1.1048    foxr      191:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   192:                 $language{$key}=$val.' - '.$enc;
                    193:                 if ($sup) {
                    194:                     $supported_language{$key}=$sup;
                    195:                 }
1.1048    foxr      196: 		if ($latex) {
                    197: 		    $latex_language_bykey{$key} = $latex;
                    198: 		    $latex_language{$two} = $latex;
                    199: 		}
1.158     raeburn   200:             }
                    201:             close($fh);
                    202:         }
1.12      harris41  203:     }
                    204: # ------------------------------------------------------------------ copyrights
                    205:     {
1.158     raeburn   206:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    207:                                   '/copyright.tab';
                    208:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  209:             while (my $line = <$fh>) {
                    210:                 next if ($line=~/^\#/);
                    211:                 chomp($line);
                    212:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   213:                 $cprtag{$key}=$val;
                    214:             }
                    215:             close($fh);
                    216:         }
1.12      harris41  217:     }
1.351     www       218: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  219:     {
                    220:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    221:                                   '/source_copyright.tab';
                    222:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  223:             while (my $line = <$fh>) {
                    224:                 next if ($line =~ /^\#/);
                    225:                 chomp($line);
                    226:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  227:                 $scprtag{$key}=$val;
                    228:             }
                    229:             close($fh);
                    230:         }
                    231:     }
1.63      www       232: 
1.517     raeburn   233: # -------------------------------------------------------------- default domain designs
1.63      www       234:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   235:     my $designfile = $designdir.'/default.tab';
                    236:     if ( open (my $fh,"<$designfile") ) {
                    237:         while (my $line = <$fh>) {
                    238:             next if ($line =~ /^\#/);
                    239:             chomp($line);
                    240:             my ($key,$val)=(split(/\=/,$line));
                    241:             if ($val) { $defaultdesign{$key}=$val; }
                    242:         }
                    243:         close($fh);
1.63      www       244:     }
                    245: 
1.15      harris41  246: # ------------------------------------------------------------- file categories
                    247:     {
1.158     raeburn   248:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    249:                                   '/filecategories.tab';
                    250:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  251: 	    while (my $line = <$fh>) {
                    252: 		next if ($line =~ /^\#/);
                    253: 		chomp($line);
                    254:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   255:                 push @{$category_extensions{lc($category)}},$extension;
                    256:             }
                    257:             close($fh);
                    258:         }
                    259: 
1.15      harris41  260:     }
1.12      harris41  261: # ------------------------------------------------------------------ file types
                    262:     {
1.158     raeburn   263:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    264:                '/filetypes.tab';
                    265:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  266:             while (my $line = <$fh>) {
                    267: 		next if ($line =~ /^\#/);
                    268: 		chomp($line);
                    269:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   270:                 if ($descr ne '') {
                    271:                     $fe{$ending}=lc($emb);
                    272:                     $fd{$ending}=$descr;
1.351     www       273:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   274:                 }
                    275:             }
                    276:             close($fh);
                    277:         }
1.12      harris41  278:     }
1.22      www       279:     &Apache::lonnet::logthis(
1.705     tempelho  280:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       281:     $readit=1;
1.46      matthew   282:     }  # end of unless($readit) 
1.32      matthew   283:     
                    284: }
1.112     bowersj2  285: 
1.42      matthew   286: ###############################################################
                    287: ##           HTML and Javascript Helper Functions            ##
                    288: ###############################################################
                    289: 
                    290: =pod 
                    291: 
1.112     bowersj2  292: =head1 HTML and Javascript Functions
1.42      matthew   293: 
1.112     bowersj2  294: =over 4
                    295: 
1.648     raeburn   296: =item * &browser_and_searcher_javascript()
1.112     bowersj2  297: 
                    298: X<browsing, javascript>X<searching, javascript>Returns a string
                    299: containing javascript with two functions, C<openbrowser> and
                    300: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    301: tags.
1.42      matthew   302: 
1.648     raeburn   303: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   304: 
                    305: inputs: formname, elementname, only, omit
                    306: 
                    307: formname and elementname indicate the name of the html form and name of
                    308: the element that the results of the browsing selection are to be placed in. 
                    309: 
                    310: Specifying 'only' will restrict the browser to displaying only files
1.185     www       311: with the given extension.  Can be a comma separated list.
1.42      matthew   312: 
                    313: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       314: with the given extension.  Can be a comma separated list.
1.42      matthew   315: 
1.648     raeburn   316: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   317: 
                    318: Inputs: formname, elementname
                    319: 
                    320: formname and elementname specify the name of the html form and the name
                    321: of the element the selection from the search results will be placed in.
1.542     raeburn   322: 
1.42      matthew   323: =cut
                    324: 
                    325: sub browser_and_searcher_javascript {
1.199     albertel  326:     my ($mode)=@_;
                    327:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  328:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   329:     return <<END;
1.219     albertel  330: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   331:     var editbrowser = null;
1.135     albertel  332:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       333:         var url = '$resurl/?';
1.42      matthew   334:         if (editbrowser == null) {
                    335:             url += 'launch=1&';
                    336:         }
                    337:         url += 'catalogmode=interactive&';
1.199     albertel  338:         url += 'mode=$mode&';
1.611     albertel  339:         url += 'inhibitmenu=yes&';
1.42      matthew   340:         url += 'form=' + formname + '&';
                    341:         if (only != null) {
                    342:             url += 'only=' + only + '&';
1.217     albertel  343:         } else {
                    344:             url += 'only=&';
                    345: 	}
1.42      matthew   346:         if (omit != null) {
                    347:             url += 'omit=' + omit + '&';
1.217     albertel  348:         } else {
                    349:             url += 'omit=&';
                    350: 	}
1.135     albertel  351:         if (titleelement != null) {
                    352:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  353:         } else {
                    354: 	    url += 'titleelement=&';
                    355: 	}
1.42      matthew   356:         url += 'element=' + elementname + '';
                    357:         var title = 'Browser';
1.435     albertel  358:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   359:         options += ',width=700,height=600';
                    360:         editbrowser = open(url,title,options,'1');
                    361:         editbrowser.focus();
                    362:     }
                    363:     var editsearcher;
1.135     albertel  364:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   365:         var url = '/adm/searchcat?';
                    366:         if (editsearcher == null) {
                    367:             url += 'launch=1&';
                    368:         }
                    369:         url += 'catalogmode=interactive&';
1.199     albertel  370:         url += 'mode=$mode&';
1.42      matthew   371:         url += 'form=' + formname + '&';
1.135     albertel  372:         if (titleelement != null) {
                    373:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  374:         } else {
                    375: 	    url += 'titleelement=&';
                    376: 	}
1.42      matthew   377:         url += 'element=' + elementname + '';
                    378:         var title = 'Search';
1.435     albertel  379:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   380:         options += ',width=700,height=600';
                    381:         editsearcher = open(url,title,options,'1');
                    382:         editsearcher.focus();
                    383:     }
1.219     albertel  384: // END LON-CAPA Internal -->
1.42      matthew   385: END
1.170     www       386: }
                    387: 
                    388: sub lastresurl {
1.258     albertel  389:     if ($env{'environment.lastresurl'}) {
                    390: 	return $env{'environment.lastresurl'}
1.170     www       391:     } else {
                    392: 	return '/res';
                    393:     }
                    394: }
                    395: 
                    396: sub storeresurl {
                    397:     my $resurl=&Apache::lonnet::clutter(shift);
                    398:     unless ($resurl=~/^\/res/) { return 0; }
                    399:     $resurl=~s/\/$//;
                    400:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   401:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       402:     return 1;
1.42      matthew   403: }
                    404: 
1.74      www       405: sub studentbrowser_javascript {
1.111     www       406:    unless (
1.258     albertel  407:             (($env{'request.course.id'}) && 
1.302     albertel  408:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    409: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    410: 					  '/'.$env{'request.course.sec'})
                    411: 	      ))
1.258     albertel  412:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       413:           ) { return ''; }  
1.74      www       414:    return (<<'ENDSTDBRW');
1.776     bisitz    415: <script type="text/javascript" language="Javascript">
1.824     bisitz    416: // <![CDATA[
1.74      www       417:     var stdeditbrowser;
1.999     www       418:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74      www       419:         var url = '/adm/pickstudent?';
                    420:         var filter;
1.558     albertel  421: 	if (!ignorefilter) {
                    422: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    423: 	}
1.74      www       424:         if (filter != null) {
                    425:            if (filter != '') {
                    426:                url += 'filter='+filter+'&';
                    427: 	   }
                    428:         }
                    429:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       430:                                     '&udomelement='+udom+
                    431:                                     '&clicker='+clicker;
1.111     www       432: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   433:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       434:         var title = 'Student_Browser';
1.74      www       435:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    436:         options += ',width=700,height=600';
                    437:         stdeditbrowser = open(url,title,options,'1');
                    438:         stdeditbrowser.focus();
                    439:     }
1.824     bisitz    440: // ]]>
1.74      www       441: </script>
                    442: ENDSTDBRW
                    443: }
1.42      matthew   444: 
1.1003    www       445: sub resourcebrowser_javascript {
                    446:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       447:    return (<<'ENDRESBRW');
1.1003    www       448: <script type="text/javascript" language="Javascript">
                    449: // <![CDATA[
                    450:     var reseditbrowser;
1.1004    www       451:     function openresbrowser(formname,reslink) {
1.1005    www       452:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       453:         var title = 'Resource_Browser';
                    454:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       455:         options += ',width=700,height=500';
1.1004    www       456:         reseditbrowser = open(url,title,options,'1');
                    457:         reseditbrowser.focus();
1.1003    www       458:     }
                    459: // ]]>
                    460: </script>
1.1004    www       461: ENDRESBRW
1.1003    www       462: }
                    463: 
1.74      www       464: sub selectstudent_link {
1.999     www       465:    my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
                    466:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    467:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    468:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  469:    if ($env{'request.course.id'}) {  
1.302     albertel  470:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    471: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    472: 					'/'.$env{'request.course.sec'})) {
1.111     www       473: 	   return '';
                    474:        }
1.999     www       475:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793     raeburn   476:        if ($courseadvonly)  {
                    477:            $callargs .= ",'',1,1";
                    478:        }
                    479:        return '<span class="LC_nobreak">'.
                    480:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    481:               &mt('Select User').'</a></span>';
1.74      www       482:    }
1.258     albertel  483:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       484:        $callargs .= ",'',1"; 
1.793     raeburn   485:        return '<span class="LC_nobreak">'.
                    486:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    487:               &mt('Select User').'</a></span>';
1.111     www       488:    }
                    489:    return '';
1.91      www       490: }
                    491: 
1.1004    www       492: sub selectresource_link {
                    493:    my ($form,$reslink,$arg)=@_;
                    494:    
                    495:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    496:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    497:    unless ($env{'request.course.id'}) { return $arg; }
                    498:    return '<span class="LC_nobreak">'.
                    499:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    500:               $arg.'</a></span>';
                    501: }
                    502: 
                    503: 
                    504: 
1.653     raeburn   505: sub authorbrowser_javascript {
                    506:     return <<"ENDAUTHORBRW";
1.776     bisitz    507: <script type="text/javascript" language="JavaScript">
1.824     bisitz    508: // <![CDATA[
1.653     raeburn   509: var stdeditbrowser;
                    510: 
                    511: function openauthorbrowser(formname,udom) {
                    512:     var url = '/adm/pickauthor?';
                    513:     url += 'form='+formname+'&roledom='+udom;
                    514:     var title = 'Author_Browser';
                    515:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    516:     options += ',width=700,height=600';
                    517:     stdeditbrowser = open(url,title,options,'1');
                    518:     stdeditbrowser.focus();
                    519: }
                    520: 
1.824     bisitz    521: // ]]>
1.653     raeburn   522: </script>
                    523: ENDAUTHORBRW
                    524: }
                    525: 
1.91      www       526: sub coursebrowser_javascript {
1.909     raeburn   527:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
1.932     raeburn   528:     my $wintitle = 'Course_Browser';
1.931     raeburn   529:     if ($crstype eq 'Community') {
1.932     raeburn   530:         $wintitle = 'Community_Browser';
1.909     raeburn   531:     }
1.876     raeburn   532:     my $id_functions = &javascript_index_functions();
                    533:     my $output = '
1.776     bisitz    534: <script type="text/javascript" language="JavaScript">
1.824     bisitz    535: // <![CDATA[
1.468     raeburn   536:     var stdeditbrowser;'."\n";
1.876     raeburn   537: 
                    538:     $output .= <<"ENDSTDBRW";
1.909     raeburn   539:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       540:         var url = '/adm/pickcourse?';
1.895     raeburn   541:         var formid = getFormIdByName(formname);
1.876     raeburn   542:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  543:         if (domainfilter != null) {
                    544:            if (domainfilter != '') {
                    545:                url += 'domainfilter='+domainfilter+'&';
                    546: 	   }
                    547:         }
1.91      www       548:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  549: 	                            '&cdomelement='+udom+
                    550:                                     '&cnameelement='+desc;
1.468     raeburn   551:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   552:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   553:                 url += '&roleelement='+extra_element;
                    554:                 if (domainfilter == null || domainfilter == '') {
                    555:                     url += '&domainfilter='+extra_element;
                    556:                 }
1.234     raeburn   557:             }
1.468     raeburn   558:             else {
                    559:                 if (formname == 'portform') {
                    560:                     url += '&setroles='+extra_element;
1.800     raeburn   561:                 } else {
                    562:                     if (formname == 'rules') {
                    563:                         url += '&fixeddom='+extra_element; 
                    564:                     }
1.468     raeburn   565:                 }
                    566:             }     
1.230     raeburn   567:         }
1.909     raeburn   568:         if (type != null && type != '') {
                    569:             url += '&type='+type;
                    570:         }
                    571:         if (type_elem != null && type_elem != '') {
                    572:             url += '&typeelement='+type_elem;
                    573:         }
1.872     raeburn   574:         if (formname == 'ccrs') {
                    575:             var ownername = document.forms[formid].ccuname.value;
                    576:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    577:             url += '&cloner='+ownername+':'+ownerdom;
                    578:         }
1.293     raeburn   579:         if (multflag !=null && multflag != '') {
                    580:             url += '&multiple='+multflag;
                    581:         }
1.909     raeburn   582:         var title = '$wintitle';
1.91      www       583:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    584:         options += ',width=700,height=600';
                    585:         stdeditbrowser = open(url,title,options,'1');
                    586:         stdeditbrowser.focus();
                    587:     }
1.876     raeburn   588: $id_functions
                    589: ENDSTDBRW
1.905     raeburn   590:     if (($sec_element ne '') || ($role_element ne '')) {
                    591:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   592:     }
                    593:     $output .= '
                    594: // ]]>
                    595: </script>';
                    596:     return $output;
                    597: }
                    598: 
                    599: sub javascript_index_functions {
                    600:     return <<"ENDJS";
                    601: 
                    602: function getFormIdByName(formname) {
                    603:     for (var i=0;i<document.forms.length;i++) {
                    604:         if (document.forms[i].name == formname) {
                    605:             return i;
                    606:         }
                    607:     }
                    608:     return -1;
                    609: }
                    610: 
                    611: function getIndexByName(formid,item) {
                    612:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    613:         if (document.forms[formid].elements[i].name == item) {
                    614:             return i;
                    615:         }
                    616:     }
                    617:     return -1;
                    618: }
1.468     raeburn   619: 
1.876     raeburn   620: function getDomainFromSelectbox(formname,udom) {
                    621:     var userdom;
                    622:     var formid = getFormIdByName(formname);
                    623:     if (formid > -1) {
                    624:         var domid = getIndexByName(formid,udom);
                    625:         if (domid > -1) {
                    626:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    627:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    628:             }
                    629:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    630:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   631:             }
                    632:         }
                    633:     }
1.876     raeburn   634:     return userdom;
                    635: }
                    636: 
                    637: ENDJS
1.468     raeburn   638: 
1.876     raeburn   639: }
                    640: 
1.1017    raeburn   641: sub javascript_array_indexof {
1.1018    raeburn   642:     return <<ENDJS;
1.1017    raeburn   643: <script type="text/javascript" language="JavaScript">
                    644: // <![CDATA[
                    645: 
                    646: if (!Array.prototype.indexOf) {
                    647:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    648:         "use strict";
                    649:         if (this === void 0 || this === null) {
                    650:             throw new TypeError();
                    651:         }
                    652:         var t = Object(this);
                    653:         var len = t.length >>> 0;
                    654:         if (len === 0) {
                    655:             return -1;
                    656:         }
                    657:         var n = 0;
                    658:         if (arguments.length > 0) {
                    659:             n = Number(arguments[1]);
                    660:             if (n !== n) { // shortcut for verifying if it's NaN
                    661:                 n = 0;
                    662:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    663:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    664:             }
                    665:         }
                    666:         if (n >= len) {
                    667:             return -1;
                    668:         }
                    669:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    670:         for (; k < len; k++) {
                    671:             if (k in t && t[k] === searchElement) {
                    672:                 return k;
                    673:             }
                    674:         }
                    675:         return -1;
                    676:     }
                    677: }
                    678: 
                    679: // ]]>
                    680: </script>
                    681: 
                    682: ENDJS
                    683: 
                    684: }
                    685: 
1.876     raeburn   686: sub userbrowser_javascript {
                    687:     my $id_functions = &javascript_index_functions();
                    688:     return <<"ENDUSERBRW";
                    689: 
1.888     raeburn   690: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   691:     var url = '/adm/pickuser?';
                    692:     var userdom = getDomainFromSelectbox(formname,udom);
                    693:     if (userdom != null) {
                    694:        if (userdom != '') {
                    695:            url += 'srchdom='+userdom+'&';
                    696:        }
                    697:     }
                    698:     url += 'form=' + formname + '&unameelement='+uname+
                    699:                                 '&udomelement='+udom+
                    700:                                 '&ulastelement='+ulast+
                    701:                                 '&ufirstelement='+ufirst+
                    702:                                 '&uemailelement='+uemail+
1.881     raeburn   703:                                 '&hideudomelement='+hideudom+
                    704:                                 '&coursedom='+crsdom;
1.888     raeburn   705:     if ((caller != null) && (caller != undefined)) {
                    706:         url += '&caller='+caller;
                    707:     }
1.876     raeburn   708:     var title = 'User_Browser';
                    709:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    710:     options += ',width=700,height=600';
                    711:     var stdeditbrowser = open(url,title,options,'1');
                    712:     stdeditbrowser.focus();
                    713: }
                    714: 
1.888     raeburn   715: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   716:     var formid = getFormIdByName(formname);
                    717:     if (formid > -1) {
1.888     raeburn   718:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   719:         var domid = getIndexByName(formid,udom);
                    720:         var hidedomid = getIndexByName(formid,origdom);
                    721:         if (hidedomid > -1) {
                    722:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   723:             var unameval = document.forms[formid].elements[unameid].value;
                    724:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    725:                 if (domid > -1) {
                    726:                     var slct = document.forms[formid].elements[domid];
                    727:                     if (slct.type == 'select-one') {
                    728:                         var i;
                    729:                         for (i=0;i<slct.length;i++) {
                    730:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    731:                         }
                    732:                     }
                    733:                     if (slct.type == 'hidden') {
                    734:                         slct.value = fixeddom;
1.876     raeburn   735:                     }
                    736:                 }
1.468     raeburn   737:             }
                    738:         }
                    739:     }
1.876     raeburn   740:     return;
                    741: }
                    742: 
                    743: $id_functions
                    744: ENDUSERBRW
1.468     raeburn   745: }
                    746: 
                    747: sub setsec_javascript {
1.905     raeburn   748:     my ($sec_element,$formname,$role_element) = @_;
                    749:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    750:         $communityrolestr);
                    751:     if ($role_element ne '') {
                    752:         my @allroles = ('st','ta','ep','in','ad');
                    753:         foreach my $crstype ('Course','Community') {
                    754:             if ($crstype eq 'Community') {
                    755:                 foreach my $role (@allroles) {
                    756:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    757:                 }
                    758:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    759:             } else {
                    760:                 foreach my $role (@allroles) {
                    761:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    762:                 }
                    763:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    764:             }
                    765:         }
                    766:         $rolestr = '"'.join('","',@allroles).'"';
                    767:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    768:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    769:     }
1.468     raeburn   770:     my $setsections = qq|
                    771: function setSect(sectionlist) {
1.629     raeburn   772:     var sectionsArray = new Array();
                    773:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    774:         sectionsArray = sectionlist.split(",");
                    775:     }
1.468     raeburn   776:     var numSections = sectionsArray.length;
                    777:     document.$formname.$sec_element.length = 0;
                    778:     if (numSections == 0) {
                    779:         document.$formname.$sec_element.multiple=false;
                    780:         document.$formname.$sec_element.size=1;
                    781:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    782:     } else {
                    783:         if (numSections == 1) {
                    784:             document.$formname.$sec_element.multiple=false;
                    785:             document.$formname.$sec_element.size=1;
                    786:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    787:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    788:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    789:         } else {
                    790:             for (var i=0; i<numSections; i++) {
                    791:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    792:             }
                    793:             document.$formname.$sec_element.multiple=true
                    794:             if (numSections < 3) {
                    795:                 document.$formname.$sec_element.size=numSections;
                    796:             } else {
                    797:                 document.$formname.$sec_element.size=3;
                    798:             }
                    799:             document.$formname.$sec_element.options[0].selected = false
                    800:         }
                    801:     }
1.91      www       802: }
1.905     raeburn   803: 
                    804: function setRole(crstype) {
1.468     raeburn   805: |;
1.905     raeburn   806:     if ($role_element eq '') {
                    807:         $setsections .= '    return;
                    808: }
                    809: ';
                    810:     } else {
                    811:         $setsections .= qq|
                    812:     var elementLength = document.$formname.$role_element.length;
                    813:     var allroles = Array($rolestr);
                    814:     var courserolenames = Array($courserolestr);
                    815:     var communityrolenames = Array($communityrolestr);
                    816:     if (elementLength != undefined) {
                    817:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    818:             if (crstype == 'Course') {
                    819:                 return;
                    820:             } else {
                    821:                 allroles[5] = 'co';
                    822:                 for (var i=0; i<6; i++) {
                    823:                     document.$formname.$role_element.options[i].value = allroles[i];
                    824:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    825:                 }
                    826:             }
                    827:         } else {
                    828:             if (crstype == 'Community') {
                    829:                 return;
                    830:             } else {
                    831:                 allroles[5] = 'cc';
                    832:                 for (var i=0; i<6; i++) {
                    833:                     document.$formname.$role_element.options[i].value = allroles[i];
                    834:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    835:                 }
                    836:             }
                    837:         }
                    838:     }
                    839:     return;
                    840: }
                    841: |;
                    842:     }
1.468     raeburn   843:     return $setsections;
                    844: }
                    845: 
1.91      www       846: sub selectcourse_link {
1.909     raeburn   847:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    848:        $typeelement) = @_;
                    849:    my $type = $selecttype;
1.871     raeburn   850:    my $linktext = &mt('Select Course');
                    851:    if ($selecttype eq 'Community') {
1.909     raeburn   852:        $linktext = &mt('Select Community');
1.906     raeburn   853:    } elsif ($selecttype eq 'Course/Community') {
                    854:        $linktext = &mt('Select Course/Community');
1.909     raeburn   855:        $type = '';
1.1019    raeburn   856:    } elsif ($selecttype eq 'Select') {
                    857:        $linktext = &mt('Select');
                    858:        $type = '';
1.871     raeburn   859:    }
1.787     bisitz    860:    return '<span class="LC_nobreak">'
                    861:          ."<a href='"
                    862:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    863:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   864:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   865:          ."'>".$linktext.'</a>'
1.787     bisitz    866:          .'</span>';
1.74      www       867: }
1.42      matthew   868: 
1.653     raeburn   869: sub selectauthor_link {
                    870:    my ($form,$udom)=@_;
                    871:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    872:           &mt('Select Author').'</a>';
                    873: }
                    874: 
1.876     raeburn   875: sub selectuser_link {
1.881     raeburn   876:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   877:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   878:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   879:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   880:            ');">'.$linktext.'</a>';
1.876     raeburn   881: }
                    882: 
1.273     raeburn   883: sub check_uncheck_jscript {
                    884:     my $jscript = <<"ENDSCRT";
                    885: function checkAll(field) {
                    886:     if (field.length > 0) {
                    887:         for (i = 0; i < field.length; i++) {
                    888:             field[i].checked = true ;
                    889:         }
                    890:     } else {
                    891:         field.checked = true
                    892:     }
                    893: }
                    894:  
                    895: function uncheckAll(field) {
                    896:     if (field.length > 0) {
                    897:         for (i = 0; i < field.length; i++) {
                    898:             field[i].checked = false ;
1.543     albertel  899:         }
                    900:     } else {
1.273     raeburn   901:         field.checked = false ;
                    902:     }
                    903: }
                    904: ENDSCRT
                    905:     return $jscript;
                    906: }
                    907: 
1.656     www       908: sub select_timezone {
1.659     raeburn   909:    my ($name,$selected,$onchange,$includeempty)=@_;
                    910:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    911:    if ($includeempty) {
                    912:        $output .= '<option value=""';
                    913:        if (($selected eq '') || ($selected eq 'local')) {
                    914:            $output .= ' selected="selected" ';
                    915:        }
                    916:        $output .= '> </option>';
                    917:    }
1.657     raeburn   918:    my @timezones = DateTime::TimeZone->all_names;
                    919:    foreach my $tzone (@timezones) {
                    920:        $output.= '<option value="'.$tzone.'"';
                    921:        if ($tzone eq $selected) {
                    922:            $output.=' selected="selected"';
                    923:        }
                    924:        $output.=">$tzone</option>\n";
1.656     www       925:    }
                    926:    $output.="</select>";
                    927:    return $output;
                    928: }
1.273     raeburn   929: 
1.687     raeburn   930: sub select_datelocale {
                    931:     my ($name,$selected,$onchange,$includeempty)=@_;
                    932:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    933:     if ($includeempty) {
                    934:         $output .= '<option value=""';
                    935:         if ($selected eq '') {
                    936:             $output .= ' selected="selected" ';
                    937:         }
                    938:         $output .= '> </option>';
                    939:     }
                    940:     my (@possibles,%locale_names);
                    941:     my @locales = DateTime::Locale::Catalog::Locales;
                    942:     foreach my $locale (@locales) {
                    943:         if (ref($locale) eq 'HASH') {
                    944:             my $id = $locale->{'id'};
                    945:             if ($id ne '') {
                    946:                 my $en_terr = $locale->{'en_territory'};
                    947:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   948:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   949:                 if (grep(/^en$/,@languages) || !@languages) {
                    950:                     if ($en_terr ne '') {
                    951:                         $locale_names{$id} = '('.$en_terr.')';
                    952:                     } elsif ($native_terr ne '') {
                    953:                         $locale_names{$id} = $native_terr;
                    954:                     }
                    955:                 } else {
                    956:                     if ($native_terr ne '') {
                    957:                         $locale_names{$id} = $native_terr.' ';
                    958:                     } elsif ($en_terr ne '') {
                    959:                         $locale_names{$id} = '('.$en_terr.')';
                    960:                     }
                    961:                 }
                    962:                 push (@possibles,$id);
                    963:             }
                    964:         }
                    965:     }
                    966:     foreach my $item (sort(@possibles)) {
                    967:         $output.= '<option value="'.$item.'"';
                    968:         if ($item eq $selected) {
                    969:             $output.=' selected="selected"';
                    970:         }
                    971:         $output.=">$item";
                    972:         if ($locale_names{$item} ne '') {
                    973:             $output.="  $locale_names{$item}</option>\n";
                    974:         }
                    975:         $output.="</option>\n";
                    976:     }
                    977:     $output.="</select>";
                    978:     return $output;
                    979: }
                    980: 
1.792     raeburn   981: sub select_language {
                    982:     my ($name,$selected,$includeempty) = @_;
                    983:     my %langchoices;
                    984:     if ($includeempty) {
                    985:         %langchoices = ('' => 'No language preference');
                    986:     }
                    987:     foreach my $id (&languageids()) {
                    988:         my $code = &supportedlanguagecode($id);
                    989:         if ($code) {
                    990:             $langchoices{$code} = &plainlanguagedescription($id);
                    991:         }
                    992:     }
1.970     raeburn   993:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn   994: }
                    995: 
1.42      matthew   996: =pod
1.36      matthew   997: 
1.648     raeburn   998: =item * &linked_select_forms(...)
1.36      matthew   999: 
                   1000: linked_select_forms returns a string containing a <script></script> block
                   1001: and html for two <select> menus.  The select menus will be linked in that
                   1002: changing the value of the first menu will result in new values being placed
                   1003: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1004: order unless a defined order is provided.
1.36      matthew  1005: 
                   1006: linked_select_forms takes the following ordered inputs:
                   1007: 
                   1008: =over 4
                   1009: 
1.112     bowersj2 1010: =item * $formname, the name of the <form> tag
1.36      matthew  1011: 
1.112     bowersj2 1012: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1013: 
1.112     bowersj2 1014: =item * $firstdefault, the default value for the first menu
1.36      matthew  1015: 
1.112     bowersj2 1016: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1017: 
1.112     bowersj2 1018: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1019: 
1.112     bowersj2 1020: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1021: 
1.609     raeburn  1022: =item * $menuorder, the order of values in the first menu
                   1023: 
1.41      ng       1024: =back 
                   1025: 
1.36      matthew  1026: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1027: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1028: values for the first select menu.  The text that coincides with the 
1.41      ng       1029: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1030: and text for the second menu are given in the hash pointed to by 
                   1031: $menu{$choice1}->{'select2'}.  
                   1032: 
1.112     bowersj2 1033:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1034:                        default => "B3",
                   1035:                        select2 => { 
                   1036:                            B1 => "Choice B1",
                   1037:                            B2 => "Choice B2",
                   1038:                            B3 => "Choice B3",
                   1039:                            B4 => "Choice B4"
1.609     raeburn  1040:                            },
                   1041:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1042:                    },
                   1043:                A2 => { text =>"Choice A2" ,
                   1044:                        default => "C2",
                   1045:                        select2 => { 
                   1046:                            C1 => "Choice C1",
                   1047:                            C2 => "Choice C2",
                   1048:                            C3 => "Choice C3"
1.609     raeburn  1049:                            },
                   1050:                        order => ['C2','C1','C3'],
1.112     bowersj2 1051:                    },
                   1052:                A3 => { text =>"Choice A3" ,
                   1053:                        default => "D6",
                   1054:                        select2 => { 
                   1055:                            D1 => "Choice D1",
                   1056:                            D2 => "Choice D2",
                   1057:                            D3 => "Choice D3",
                   1058:                            D4 => "Choice D4",
                   1059:                            D5 => "Choice D5",
                   1060:                            D6 => "Choice D6",
                   1061:                            D7 => "Choice D7"
1.609     raeburn  1062:                            },
                   1063:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1064:                    }
                   1065:                );
1.36      matthew  1066: 
                   1067: =cut
                   1068: 
                   1069: sub linked_select_forms {
                   1070:     my ($formname,
                   1071:         $middletext,
                   1072:         $firstdefault,
                   1073:         $firstselectname,
                   1074:         $secondselectname, 
1.609     raeburn  1075:         $hashref,
                   1076:         $menuorder,
1.36      matthew  1077:         ) = @_;
                   1078:     my $second = "document.$formname.$secondselectname";
                   1079:     my $first = "document.$formname.$firstselectname";
                   1080:     # output the javascript to do the changing
                   1081:     my $result = '';
1.776     bisitz   1082:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1083:     $result.="// <![CDATA[\n";
1.36      matthew  1084:     $result.="var select2data = new Object();\n";
                   1085:     $" = '","';
                   1086:     my $debug = '';
                   1087:     foreach my $s1 (sort(keys(%$hashref))) {
                   1088:         $result.="select2data.d_$s1 = new Object();\n";        
                   1089:         $result.="select2data.d_$s1.def = new String('".
                   1090:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1091:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1092:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1093:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1094:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1095:         }
1.36      matthew  1096:         $result.="\"@s2values\");\n";
                   1097:         $result.="select2data.d_$s1.texts = new Array(";        
                   1098:         my @s2texts;
                   1099:         foreach my $value (@s2values) {
                   1100:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1101:         }
                   1102:         $result.="\"@s2texts\");\n";
                   1103:     }
                   1104:     $"=' ';
                   1105:     $result.= <<"END";
                   1106: 
                   1107: function select1_changed() {
                   1108:     // Determine new choice
                   1109:     var newvalue = "d_" + $first.value;
                   1110:     // update select2
                   1111:     var values     = select2data[newvalue].values;
                   1112:     var texts      = select2data[newvalue].texts;
                   1113:     var select2def = select2data[newvalue].def;
                   1114:     var i;
                   1115:     // out with the old
                   1116:     for (i = 0; i < $second.options.length; i++) {
                   1117:         $second.options[i] = null;
                   1118:     }
                   1119:     // in with the nuclear
                   1120:     for (i=0;i<values.length; i++) {
                   1121:         $second.options[i] = new Option(values[i]);
1.143     matthew  1122:         $second.options[i].value = values[i];
1.36      matthew  1123:         $second.options[i].text = texts[i];
                   1124:         if (values[i] == select2def) {
                   1125:             $second.options[i].selected = true;
                   1126:         }
                   1127:     }
                   1128: }
1.824     bisitz   1129: // ]]>
1.36      matthew  1130: </script>
                   1131: END
                   1132:     # output the initial values for the selection lists
                   1133:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1134:     my @order = sort(keys(%{$hashref}));
                   1135:     if (ref($menuorder) eq 'ARRAY') {
                   1136:         @order = @{$menuorder};
                   1137:     }
                   1138:     foreach my $value (@order) {
1.36      matthew  1139:         $result.="    <option value=\"$value\" ";
1.253     albertel 1140:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1141:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1142:     }
                   1143:     $result .= "</select>\n";
                   1144:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1145:     $result .= $middletext;
                   1146:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1147:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1148:     
                   1149:     my @secondorder = sort(keys(%select2));
                   1150:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1151:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1152:     }
                   1153:     foreach my $value (@secondorder) {
1.36      matthew  1154:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1155:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1156:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1157:     }
                   1158:     $result .= "</select>\n";
                   1159:     #    return $debug;
                   1160:     return $result;
                   1161: }   #  end of sub linked_select_forms {
                   1162: 
1.45      matthew  1163: =pod
1.44      bowersj2 1164: 
1.973     raeburn  1165: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1166: 
1.112     bowersj2 1167: Returns a string corresponding to an HTML link to the given help
                   1168: $topic, where $topic corresponds to the name of a .tex file in
                   1169: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1170: spaces. 
                   1171: 
                   1172: $text will optionally be linked to the same topic, allowing you to
                   1173: link text in addition to the graphic. If you do not want to link
                   1174: text, but wish to specify one of the later parameters, pass an
                   1175: empty string. 
                   1176: 
                   1177: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1178: the link will not open a new window. If false, the link will open
                   1179: a new window using Javascript. (Default is false.) 
                   1180: 
                   1181: $width and $height are optional numerical parameters that will
                   1182: override the width and height of the popped up window, which may
1.973     raeburn  1183: be useful for certain help topics with big pictures included.
                   1184: 
                   1185: $imgid is the id of the img tag used for the help icon. This may be
                   1186: used in a javascript call to switch the image src.  See 
                   1187: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1188: 
                   1189: =cut
                   1190: 
                   1191: sub help_open_topic {
1.973     raeburn  1192:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1193:     $text = "" if (not defined $text);
1.44      bowersj2 1194:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1195:     $width = 500 if (not defined $width);
1.44      bowersj2 1196:     $height = 400 if (not defined $height);
                   1197:     my $filename = $topic;
                   1198:     $filename =~ s/ /_/g;
                   1199: 
1.48      bowersj2 1200:     my $template = "";
                   1201:     my $link;
1.572     banghart 1202:     
1.159     www      1203:     $topic=~s/\W/\_/g;
1.44      bowersj2 1204: 
1.572     banghart 1205:     if (!$stayOnPage) {
1.1033    www      1206: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1207:     } elsif ($stayOnPage eq 'popup') {
                   1208:         $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 1209:     } else {
1.48      bowersj2 1210: 	$link = "/adm/help/${filename}.hlp";
                   1211:     }
                   1212: 
                   1213:     # Add the text
1.755     neumanie 1214:     if ($text ne "") {	
1.763     bisitz   1215: 	$template.='<span class="LC_help_open_topic">'
                   1216:                   .'<a target="_top" href="'.$link.'">'
                   1217:                   .$text.'</a>';
1.48      bowersj2 1218:     }
                   1219: 
1.763     bisitz   1220:     # (Always) Add the graphic
1.179     matthew  1221:     my $title = &mt('Online Help');
1.667     raeburn  1222:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1223:     if ($imgid ne '') {
                   1224:         $imgid = ' id="'.$imgid.'"';
                   1225:     }
1.763     bisitz   1226:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1227:               .'<img src="'.$helpicon.'" border="0"'
                   1228:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1229:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1230:               .' /></a>';
                   1231:     if ($text ne "") {	
                   1232:         $template.='</span>';
                   1233:     }
1.44      bowersj2 1234:     return $template;
                   1235: 
1.106     bowersj2 1236: }
                   1237: 
                   1238: # This is a quicky function for Latex cheatsheet editing, since it 
                   1239: # appears in at least four places
                   1240: sub helpLatexCheatsheet {
1.1037    www      1241:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1242:     my $out;
1.106     bowersj2 1243:     my $addOther = '';
1.732     raeburn  1244:     if ($topic) {
1.1037    www      1245: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1246:     }
                   1247:     $out = '<span>' # Start cheatsheet
                   1248: 	  .$addOther
                   1249:           .'<span>'
1.1037    www      1250: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1251: 	  .'</span> <span>'
1.1037    www      1252: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1253: 	  .'</span>';
1.732     raeburn  1254:     unless ($not_author) {
1.763     bisitz   1255:         $out .= ' <span>'
1.1037    www      1256: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763     bisitz   1257: 	       .'</span>';
1.732     raeburn  1258:     }
1.763     bisitz   1259:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1260:     return $out;
1.172     www      1261: }
                   1262: 
1.430     albertel 1263: sub general_help {
                   1264:     my $helptopic='Student_Intro';
                   1265:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1266: 	$helptopic='Authoring_Intro';
1.907     raeburn  1267:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1268: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1269:     } elsif ($env{'request.role'}=~/^dc/) {
                   1270:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1271:     }
                   1272:     return $helptopic;
                   1273: }
                   1274: 
                   1275: sub update_help_link {
                   1276:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1277:     my $origurl = $ENV{'REQUEST_URI'};
                   1278:     $origurl=~s|^/~|/priv/|;
                   1279:     my $timestamp = time;
                   1280:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1281:         $$datum = &escape($$datum);
                   1282:     }
                   1283: 
                   1284:     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";
                   1285:     my $output .= <<"ENDOUTPUT";
                   1286: <script type="text/javascript">
1.824     bisitz   1287: // <![CDATA[
1.430     albertel 1288: banner_link = '$banner_link';
1.824     bisitz   1289: // ]]>
1.430     albertel 1290: </script>
                   1291: ENDOUTPUT
                   1292:     return $output;
                   1293: }
                   1294: 
                   1295: # now just updates the help link and generates a blue icon
1.193     raeburn  1296: sub help_open_menu {
1.430     albertel 1297:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1298: 	= @_;    
1.949     droeschl 1299:     $stayOnPage = 1;
1.430     albertel 1300:     my $output;
                   1301:     if ($component_help) {
                   1302: 	if (!$text) {
                   1303: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1304: 				       $width,$height);
                   1305: 	} else {
                   1306: 	    my $help_text;
                   1307: 	    $help_text=&unescape($topic);
                   1308: 	    $output='<table><tr><td>'.
                   1309: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1310: 				 $width,$height).'</td></tr></table>';
                   1311: 	}
                   1312:     }
                   1313:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1314:     return $output.$banner_link;
                   1315: }
                   1316: 
                   1317: sub top_nav_help {
                   1318:     my ($text) = @_;
1.436     albertel 1319:     $text = &mt($text);
1.949     droeschl 1320:     my $stay_on_page = 1;
                   1321: 
1.572     banghart 1322:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1323: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1324:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1325: 
1.201     raeburn  1326:     my $title = &mt('Get help');
1.436     albertel 1327: 
                   1328:     return <<"END";
                   1329: $banner_link
                   1330:  <a href="$link" title="$title">$text</a>
                   1331: END
                   1332: }
                   1333: 
                   1334: sub help_menu_js {
                   1335:     my ($text) = @_;
1.949     droeschl 1336:     my $stayOnPage = 1;
1.436     albertel 1337:     my $width = 620;
                   1338:     my $height = 600;
1.430     albertel 1339:     my $helptopic=&general_help();
                   1340:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1341:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1342:     my $start_page =
                   1343:         &Apache::loncommon::start_page('Help Menu', undef,
                   1344: 				       {'frameset'    => 1,
                   1345: 					'js_ready'    => 1,
                   1346: 					'add_entries' => {
                   1347: 					    'border' => '0',
1.579     raeburn  1348: 					    'rows'   => "110,*",},});
1.331     albertel 1349:     my $end_page =
                   1350:         &Apache::loncommon::end_page({'frameset' => 1,
                   1351: 				      'js_ready' => 1,});
                   1352: 
1.436     albertel 1353:     my $template .= <<"ENDTEMPLATE";
                   1354: <script type="text/javascript">
1.877     bisitz   1355: // <![CDATA[
1.253     albertel 1356: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1357: var banner_link = '';
1.243     raeburn  1358: function helpMenu(target) {
                   1359:     var caller = this;
                   1360:     if (target == 'open') {
                   1361:         var newWindow = null;
                   1362:         try {
1.262     albertel 1363:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1364:         }
                   1365:         catch(error) {
                   1366:             writeHelp(caller);
                   1367:             return;
                   1368:         }
                   1369:         if (newWindow) {
                   1370:             caller = newWindow;
                   1371:         }
1.193     raeburn  1372:     }
1.243     raeburn  1373:     writeHelp(caller);
                   1374:     return;
                   1375: }
                   1376: function writeHelp(caller) {
1.430     albertel 1377:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1378:     caller.document.close()
                   1379:     caller.focus()
1.193     raeburn  1380: }
1.877     bisitz   1381: // END LON-CAPA Internal -->
1.253     albertel 1382: // ]]>
1.436     albertel 1383: </script>
1.193     raeburn  1384: ENDTEMPLATE
                   1385:     return $template;
                   1386: }
                   1387: 
1.172     www      1388: sub help_open_bug {
                   1389:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1390:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1391:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1392:     $text = "" if (not defined $text);
                   1393: 	$stayOnPage=1;
1.184     albertel 1394:     $width = 600 if (not defined $width);
                   1395:     $height = 600 if (not defined $height);
1.172     www      1396: 
                   1397:     $topic=~s/\W+/\+/g;
                   1398:     my $link='';
                   1399:     my $template='';
1.379     albertel 1400:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1401: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1402:     if (!$stayOnPage)
                   1403:     {
                   1404: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1405:     }
                   1406:     else
                   1407:     {
                   1408: 	$link = $url;
                   1409:     }
                   1410:     # Add the text
                   1411:     if ($text ne "")
                   1412:     {
                   1413: 	$template .= 
                   1414:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1415:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1416:     }
                   1417: 
                   1418:     # Add the graphic
1.179     matthew  1419:     my $title = &mt('Report a Bug');
1.215     albertel 1420:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1421:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1422:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1423: ENDTEMPLATE
                   1424:     if ($text ne '') { $template.='</td></tr></table>' };
                   1425:     return $template;
                   1426: 
                   1427: }
                   1428: 
                   1429: sub help_open_faq {
                   1430:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1431:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1432:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1433:     $text = "" if (not defined $text);
                   1434: 	$stayOnPage=1;
                   1435:     $width = 350 if (not defined $width);
                   1436:     $height = 400 if (not defined $height);
                   1437: 
                   1438:     $topic=~s/\W+/\+/g;
                   1439:     my $link='';
                   1440:     my $template='';
                   1441:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1442:     if (!$stayOnPage)
                   1443:     {
                   1444: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1445:     }
                   1446:     else
                   1447:     {
                   1448: 	$link = $url;
                   1449:     }
                   1450: 
                   1451:     # Add the text
                   1452:     if ($text ne "")
                   1453:     {
                   1454: 	$template .= 
1.173     www      1455:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1456:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1457:     }
                   1458: 
                   1459:     # Add the graphic
1.179     matthew  1460:     my $title = &mt('View the FAQ');
1.215     albertel 1461:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1462:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1463:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1464: ENDTEMPLATE
                   1465:     if ($text ne '') { $template.='</td></tr></table>' };
                   1466:     return $template;
                   1467: 
1.44      bowersj2 1468: }
1.37      matthew  1469: 
1.180     matthew  1470: ###############################################################
                   1471: ###############################################################
                   1472: 
1.45      matthew  1473: =pod
                   1474: 
1.648     raeburn  1475: =item * &change_content_javascript():
1.256     matthew  1476: 
                   1477: This and the next function allow you to create small sections of an
                   1478: otherwise static HTML page that you can update on the fly with
                   1479: Javascript, even in Netscape 4.
                   1480: 
                   1481: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1482: must be written to the HTML page once. It will prove the Javascript
                   1483: function "change(name, content)". Calling the change function with the
                   1484: name of the section 
                   1485: you want to update, matching the name passed to C<changable_area>, and
                   1486: the new content you want to put in there, will put the content into
                   1487: that area.
                   1488: 
                   1489: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1490: to contain room for the original contents. You need to "make space"
                   1491: for whatever changes you wish to make, and be B<sure> to check your
                   1492: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1493: it's adequate for updating a one-line status display, but little more.
                   1494: This script will set the space to 100% width, so you only need to
                   1495: worry about height in Netscape 4.
                   1496: 
                   1497: Modern browsers are much less limiting, and if you can commit to the
                   1498: user not using Netscape 4, this feature may be used freely with
                   1499: pretty much any HTML.
                   1500: 
                   1501: =cut
                   1502: 
                   1503: sub change_content_javascript {
                   1504:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1505:     if ($env{'browser.type'} eq 'netscape' &&
                   1506: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1507: 	return (<<NETSCAPE4);
                   1508: 	function change(name, content) {
                   1509: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1510: 	    doc.open();
                   1511: 	    doc.write(content);
                   1512: 	    doc.close();
                   1513: 	}
                   1514: NETSCAPE4
                   1515:     } else {
                   1516: 	# Otherwise, we need to use semi-standards-compliant code
                   1517: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1518: 	# is really scary, and every useful browser supports it
                   1519: 	return (<<DOMBASED);
                   1520: 	function change(name, content) {
                   1521: 	    element = document.getElementById(name);
                   1522: 	    element.innerHTML = content;
                   1523: 	}
                   1524: DOMBASED
                   1525:     }
                   1526: }
                   1527: 
                   1528: =pod
                   1529: 
1.648     raeburn  1530: =item * &changable_area($name,$origContent):
1.256     matthew  1531: 
                   1532: This provides a "changable area" that can be modified on the fly via
                   1533: the Javascript code provided in C<change_content_javascript>. $name is
                   1534: the name you will use to reference the area later; do not repeat the
                   1535: same name on a given HTML page more then once. $origContent is what
                   1536: the area will originally contain, which can be left blank.
                   1537: 
                   1538: =cut
                   1539: 
                   1540: sub changable_area {
                   1541:     my ($name, $origContent) = @_;
                   1542: 
1.258     albertel 1543:     if ($env{'browser.type'} eq 'netscape' &&
                   1544: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1545: 	# If this is netscape 4, we need to use the Layer tag
                   1546: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1547:     } else {
                   1548: 	return "<span id='$name'>$origContent</span>";
                   1549:     }
                   1550: }
                   1551: 
                   1552: =pod
                   1553: 
1.648     raeburn  1554: =item * &viewport_geometry_js 
1.590     raeburn  1555: 
                   1556: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1557: 
                   1558: =cut
                   1559: 
                   1560: 
                   1561: sub viewport_geometry_js { 
                   1562:     return <<"GEOMETRY";
                   1563: var Geometry = {};
                   1564: function init_geometry() {
                   1565:     if (Geometry.init) { return };
                   1566:     Geometry.init=1;
                   1567:     if (window.innerHeight) {
                   1568:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1569:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1570:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1571:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1572:     }
                   1573:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1574:         Geometry.getViewportHeight =
                   1575:             function() { return document.documentElement.clientHeight; };
                   1576:         Geometry.getViewportWidth =
                   1577:             function() { return document.documentElement.clientWidth; };
                   1578: 
                   1579:         Geometry.getHorizontalScroll =
                   1580:             function() { return document.documentElement.scrollLeft; };
                   1581:         Geometry.getVerticalScroll =
                   1582:             function() { return document.documentElement.scrollTop; };
                   1583:     }
                   1584:     else if (document.body.clientHeight) {
                   1585:         Geometry.getViewportHeight =
                   1586:             function() { return document.body.clientHeight; };
                   1587:         Geometry.getViewportWidth =
                   1588:             function() { return document.body.clientWidth; };
                   1589:         Geometry.getHorizontalScroll =
                   1590:             function() { return document.body.scrollLeft; };
                   1591:         Geometry.getVerticalScroll =
                   1592:             function() { return document.body.scrollTop; };
                   1593:     }
                   1594: }
                   1595: 
                   1596: GEOMETRY
                   1597: }
                   1598: 
                   1599: =pod
                   1600: 
1.648     raeburn  1601: =item * &viewport_size_js()
1.590     raeburn  1602: 
                   1603: 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. 
                   1604: 
                   1605: =cut
                   1606: 
                   1607: sub viewport_size_js {
                   1608:     my $geometry = &viewport_geometry_js();
                   1609:     return <<"DIMS";
                   1610: 
                   1611: $geometry
                   1612: 
                   1613: function getViewportDims(width,height) {
                   1614:     init_geometry();
                   1615:     width.value = Geometry.getViewportWidth();
                   1616:     height.value = Geometry.getViewportHeight();
                   1617:     return;
                   1618: }
                   1619: 
                   1620: DIMS
                   1621: }
                   1622: 
                   1623: =pod
                   1624: 
1.648     raeburn  1625: =item * &resize_textarea_js()
1.565     albertel 1626: 
                   1627: emits the needed javascript to resize a textarea to be as big as possible
                   1628: 
                   1629: creates a function resize_textrea that takes two IDs first should be
                   1630: the id of the element to resize, second should be the id of a div that
                   1631: surrounds everything that comes after the textarea, this routine needs
                   1632: to be attached to the <body> for the onload and onresize events.
                   1633: 
1.648     raeburn  1634: =back
1.565     albertel 1635: 
                   1636: =cut
                   1637: 
                   1638: sub resize_textarea_js {
1.590     raeburn  1639:     my $geometry = &viewport_geometry_js();
1.565     albertel 1640:     return <<"RESIZE";
                   1641:     <script type="text/javascript">
1.824     bisitz   1642: // <![CDATA[
1.590     raeburn  1643: $geometry
1.565     albertel 1644: 
1.588     albertel 1645: function getX(element) {
                   1646:     var x = 0;
                   1647:     while (element) {
                   1648: 	x += element.offsetLeft;
                   1649: 	element = element.offsetParent;
                   1650:     }
                   1651:     return x;
                   1652: }
                   1653: function getY(element) {
                   1654:     var y = 0;
                   1655:     while (element) {
                   1656: 	y += element.offsetTop;
                   1657: 	element = element.offsetParent;
                   1658:     }
                   1659:     return y;
                   1660: }
                   1661: 
                   1662: 
1.565     albertel 1663: function resize_textarea(textarea_id,bottom_id) {
                   1664:     init_geometry();
                   1665:     var textarea        = document.getElementById(textarea_id);
                   1666:     //alert(textarea);
                   1667: 
1.588     albertel 1668:     var textarea_top    = getY(textarea);
1.565     albertel 1669:     var textarea_height = textarea.offsetHeight;
                   1670:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1671:     var bottom_top      = getY(bottom);
1.565     albertel 1672:     var bottom_height   = bottom.offsetHeight;
                   1673:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1674:     var fudge           = 23;
1.565     albertel 1675:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1676:     if (new_height < 300) {
                   1677: 	new_height = 300;
                   1678:     }
                   1679:     textarea.style.height=new_height+'px';
                   1680: }
1.824     bisitz   1681: // ]]>
1.565     albertel 1682: </script>
                   1683: RESIZE
                   1684: 
                   1685: }
                   1686: 
                   1687: =pod
                   1688: 
1.256     matthew  1689: =head1 Excel and CSV file utility routines
                   1690: 
                   1691: =over 4
                   1692: 
                   1693: =cut
                   1694: 
                   1695: ###############################################################
                   1696: ###############################################################
                   1697: 
                   1698: =pod
                   1699: 
1.648     raeburn  1700: =item * &csv_translate($text) 
1.37      matthew  1701: 
1.185     www      1702: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1703: format.
                   1704: 
                   1705: =cut
                   1706: 
1.180     matthew  1707: ###############################################################
                   1708: ###############################################################
1.37      matthew  1709: sub csv_translate {
                   1710:     my $text = shift;
                   1711:     $text =~ s/\"/\"\"/g;
1.209     albertel 1712:     $text =~ s/\n/ /g;
1.37      matthew  1713:     return $text;
                   1714: }
1.180     matthew  1715: 
                   1716: ###############################################################
                   1717: ###############################################################
                   1718: 
                   1719: =pod
                   1720: 
1.648     raeburn  1721: =item * &define_excel_formats()
1.180     matthew  1722: 
                   1723: Define some commonly used Excel cell formats.
                   1724: 
                   1725: Currently supported formats:
                   1726: 
                   1727: =over 4
                   1728: 
                   1729: =item header
                   1730: 
                   1731: =item bold
                   1732: 
                   1733: =item h1
                   1734: 
                   1735: =item h2
                   1736: 
                   1737: =item h3
                   1738: 
1.256     matthew  1739: =item h4
                   1740: 
                   1741: =item i
                   1742: 
1.180     matthew  1743: =item date
                   1744: 
                   1745: =back
                   1746: 
                   1747: Inputs: $workbook
                   1748: 
                   1749: Returns: $format, a hash reference.
                   1750: 
1.1057    foxr     1751: 
1.180     matthew  1752: =cut
                   1753: 
                   1754: ###############################################################
                   1755: ###############################################################
                   1756: sub define_excel_formats {
                   1757:     my ($workbook) = @_;
                   1758:     my $format;
                   1759:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1760:                                                 bottom    => 1,
                   1761:                                                 align     => 'center');
                   1762:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1763:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1764:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1765:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1766:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1767:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1768:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1769:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1770:     return $format;
                   1771: }
                   1772: 
                   1773: ###############################################################
                   1774: ###############################################################
1.113     bowersj2 1775: 
                   1776: =pod
                   1777: 
1.648     raeburn  1778: =item * &create_workbook()
1.255     matthew  1779: 
                   1780: Create an Excel worksheet.  If it fails, output message on the
                   1781: request object and return undefs.
                   1782: 
                   1783: Inputs: Apache request object
                   1784: 
                   1785: Returns (undef) on failure, 
                   1786:     Excel worksheet object, scalar with filename, and formats 
                   1787:     from &Apache::loncommon::define_excel_formats on success
                   1788: 
                   1789: =cut
                   1790: 
                   1791: ###############################################################
                   1792: ###############################################################
                   1793: sub create_workbook {
                   1794:     my ($r) = @_;
                   1795:         #
                   1796:     # Create the excel spreadsheet
                   1797:     my $filename = '/prtspool/'.
1.258     albertel 1798:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1799:         time.'_'.rand(1000000000).'.xls';
                   1800:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1801:     if (! defined($workbook)) {
                   1802:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1803:         $r->print(
                   1804:             '<p class="LC_error">'
                   1805:            .&mt('Problems occurred in creating the new Excel file.')
                   1806:            .' '.&mt('This error has been logged.')
                   1807:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1808:            .'</p>'
                   1809:         );
1.255     matthew  1810:         return (undef);
                   1811:     }
                   1812:     #
1.1014    foxr     1813:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  1814:     #
                   1815:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1816:     return ($workbook,$filename,$format);
                   1817: }
                   1818: 
                   1819: ###############################################################
                   1820: ###############################################################
                   1821: 
                   1822: =pod
                   1823: 
1.648     raeburn  1824: =item * &create_text_file()
1.113     bowersj2 1825: 
1.542     raeburn  1826: Create a file to write to and eventually make available to the user.
1.256     matthew  1827: If file creation fails, outputs an error message on the request object and 
                   1828: return undefs.
1.113     bowersj2 1829: 
1.256     matthew  1830: Inputs: Apache request object, and file suffix
1.113     bowersj2 1831: 
1.256     matthew  1832: Returns (undef) on failure, 
                   1833:     Filehandle and filename on success.
1.113     bowersj2 1834: 
                   1835: =cut
                   1836: 
1.256     matthew  1837: ###############################################################
                   1838: ###############################################################
                   1839: sub create_text_file {
                   1840:     my ($r,$suffix) = @_;
                   1841:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1842:     my $fh;
                   1843:     my $filename = '/prtspool/'.
1.258     albertel 1844:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1845:         time.'_'.rand(1000000000).'.'.$suffix;
                   1846:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1847:     if (! defined($fh)) {
                   1848:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1849:         $r->print(
                   1850:             '<p class="LC_error">'
                   1851:            .&mt('Problems occurred in creating the output file.')
                   1852:            .' '.&mt('This error has been logged.')
                   1853:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1854:            .'</p>'
                   1855:         );
1.113     bowersj2 1856:     }
1.256     matthew  1857:     return ($fh,$filename)
1.113     bowersj2 1858: }
                   1859: 
                   1860: 
1.256     matthew  1861: =pod 
1.113     bowersj2 1862: 
                   1863: =back
                   1864: 
                   1865: =cut
1.37      matthew  1866: 
                   1867: ###############################################################
1.33      matthew  1868: ##        Home server <option> list generating code          ##
                   1869: ###############################################################
1.35      matthew  1870: 
1.169     www      1871: # ------------------------------------------
                   1872: 
                   1873: sub domain_select {
                   1874:     my ($name,$value,$multiple)=@_;
                   1875:     my %domains=map { 
1.514     albertel 1876: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1877:     } &Apache::lonnet::all_domains();
1.169     www      1878:     if ($multiple) {
                   1879: 	$domains{''}=&mt('Any domain');
1.550     albertel 1880: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1881: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1882:     } else {
1.550     albertel 1883: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1884: 	return &select_form($name,$value,\%domains);
1.169     www      1885:     }
                   1886: }
                   1887: 
1.282     albertel 1888: #-------------------------------------------
                   1889: 
                   1890: =pod
                   1891: 
1.519     raeburn  1892: =head1 Routines for form select boxes
                   1893: 
                   1894: =over 4
                   1895: 
1.648     raeburn  1896: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1897: 
                   1898: Returns a string containing a <select> element int multiple mode
                   1899: 
                   1900: 
                   1901: Args:
                   1902:   $name - name of the <select> element
1.506     raeburn  1903:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1904:   $size - number of rows long the select element is
1.283     albertel 1905:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1906:           (shown text should already have been &mt())
1.506     raeburn  1907:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1908: 
1.282     albertel 1909: =cut
                   1910: 
                   1911: #-------------------------------------------
1.169     www      1912: sub multiple_select_form {
1.284     albertel 1913:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1914:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1915:     my $output='';
1.191     matthew  1916:     if (! defined($size)) {
                   1917:         $size = 4;
1.283     albertel 1918:         if (scalar(keys(%$hash))<4) {
                   1919:             $size = scalar(keys(%$hash));
1.191     matthew  1920:         }
                   1921:     }
1.734     bisitz   1922:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1923:     my @order;
1.506     raeburn  1924:     if (ref($order) eq 'ARRAY')  {
                   1925:         @order = @{$order};
                   1926:     } else {
                   1927:         @order = sort(keys(%$hash));
1.501     banghart 1928:     }
                   1929:     if (exists($$hash{'select_form_order'})) {
                   1930:         @order = @{$$hash{'select_form_order'}};
                   1931:     }
                   1932:         
1.284     albertel 1933:     foreach my $key (@order) {
1.356     albertel 1934:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1935:         $output.='selected="selected" ' if ($selected{$key});
                   1936:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1937:     }
                   1938:     $output.="</select>\n";
                   1939:     return $output;
                   1940: }
                   1941: 
1.88      www      1942: #-------------------------------------------
                   1943: 
                   1944: =pod
                   1945: 
1.970     raeburn  1946: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      1947: 
                   1948: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  1949: allow a user to select options from a ref to a hash containing:
                   1950: option_name => displayed text. An optional $onchange can include
                   1951: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   1952: 
1.88      www      1953: See lonrights.pm for an example invocation and use.
                   1954: 
                   1955: =cut
                   1956: 
                   1957: #-------------------------------------------
                   1958: sub select_form {
1.970     raeburn  1959:     my ($def,$name,$hashref,$onchange) = @_;
                   1960:     return unless (ref($hashref) eq 'HASH');
                   1961:     if ($onchange) {
                   1962:         $onchange = ' onchange="'.$onchange.'"';
                   1963:     }
                   1964:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 1965:     my @keys;
1.970     raeburn  1966:     if (exists($hashref->{'select_form_order'})) {
                   1967: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 1968:     } else {
1.970     raeburn  1969: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 1970:     }
1.356     albertel 1971:     foreach my $key (@keys) {
                   1972:         $selectform.=
                   1973: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1974:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  1975:                 ">".$hashref->{$key}."</option>\n";
1.88      www      1976:     }
                   1977:     $selectform.="</select>";
                   1978:     return $selectform;
                   1979: }
                   1980: 
1.475     www      1981: # For display filters
                   1982: 
                   1983: sub display_filter {
                   1984:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1985:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1986:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1987: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1988: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1989: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1990:            &mt('Filter [_1]',
1.477     www      1991: 	   &select_form($env{'form.displayfilter'},
                   1992: 			'displayfilter',
1.970     raeburn  1993: 			{'currentfolder' => 'Current folder/page',
1.477     www      1994: 			 'containing' => 'Containing phrase',
1.970     raeburn  1995: 			 'none' => 'None'})).
1.714     bisitz   1996: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1997: }
                   1998: 
1.167     www      1999: sub gradeleveldescription {
                   2000:     my $gradelevel=shift;
                   2001:     my %gradelevels=(0 => 'Not specified',
                   2002: 		     1 => 'Grade 1',
                   2003: 		     2 => 'Grade 2',
                   2004: 		     3 => 'Grade 3',
                   2005: 		     4 => 'Grade 4',
                   2006: 		     5 => 'Grade 5',
                   2007: 		     6 => 'Grade 6',
                   2008: 		     7 => 'Grade 7',
                   2009: 		     8 => 'Grade 8',
                   2010: 		     9 => 'Grade 9',
                   2011: 		     10 => 'Grade 10',
                   2012: 		     11 => 'Grade 11',
                   2013: 		     12 => 'Grade 12',
                   2014: 		     13 => 'Grade 13',
                   2015: 		     14 => '100 Level',
                   2016: 		     15 => '200 Level',
                   2017: 		     16 => '300 Level',
                   2018: 		     17 => '400 Level',
                   2019: 		     18 => 'Graduate Level');
                   2020:     return &mt($gradelevels{$gradelevel});
                   2021: }
                   2022: 
1.163     www      2023: sub select_level_form {
                   2024:     my ($deflevel,$name)=@_;
                   2025:     unless ($deflevel) { $deflevel=0; }
1.167     www      2026:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2027:     for (my $i=0; $i<=18; $i++) {
                   2028:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2029:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2030:                 ">".&gradeleveldescription($i)."</option>\n";
                   2031:     }
                   2032:     $selectform.="</select>";
                   2033:     return $selectform;
1.163     www      2034: }
1.167     www      2035: 
1.35      matthew  2036: #-------------------------------------------
                   2037: 
1.45      matthew  2038: =pod
                   2039: 
1.910     raeburn  2040: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  2041: 
                   2042: Returns a string containing a <select name='$name' size='1'> form to 
                   2043: allow a user to select the domain to preform an operation in.  
                   2044: See loncreateuser.pm for an example invocation and use.
                   2045: 
1.90      www      2046: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2047: selected");
                   2048: 
1.743     raeburn  2049: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2050: 
1.910     raeburn  2051: 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.
                   2052: 
                   2053: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  2054: 
1.35      matthew  2055: =cut
                   2056: 
                   2057: #-------------------------------------------
1.34      matthew  2058: sub select_dom_form {
1.910     raeburn  2059:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  2060:     if ($onchange) {
1.874     raeburn  2061:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2062:     }
1.910     raeburn  2063:     my @domains;
                   2064:     if (ref($incdoms) eq 'ARRAY') {
                   2065:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2066:     } else {
                   2067:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2068:     }
1.90      www      2069:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  2070:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2071:     foreach my $dom (@domains) {
                   2072:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2073:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2074:         if ($showdomdesc) {
                   2075:             if ($dom ne '') {
                   2076:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2077:                 if ($domdesc ne '') {
                   2078:                     $selectdomain .= ' ('.$domdesc.')';
                   2079:                 }
                   2080:             } 
                   2081:         }
                   2082:         $selectdomain .= "</option>\n";
1.34      matthew  2083:     }
                   2084:     $selectdomain.="</select>";
                   2085:     return $selectdomain;
                   2086: }
                   2087: 
1.35      matthew  2088: #-------------------------------------------
                   2089: 
1.45      matthew  2090: =pod
                   2091: 
1.648     raeburn  2092: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2093: 
1.586     raeburn  2094: input: 4 arguments (two required, two optional) - 
                   2095:     $domain - domain of new user
                   2096:     $name - name of form element
                   2097:     $default - Value of 'default' causes a default item to be first 
                   2098:                             option, and selected by default. 
                   2099:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2100:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2101: output: returns 2 items: 
1.586     raeburn  2102: (a) form element which contains either:
                   2103:    (i) <select name="$name">
                   2104:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2105:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2106:        </select>
                   2107:        form item if there are multiple library servers in $domain, or
                   2108:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2109:        if there is only one library server in $domain.
                   2110: 
                   2111: (b) number of library servers found.
                   2112: 
                   2113: See loncreateuser.pm for example of use.
1.35      matthew  2114: 
                   2115: =cut
                   2116: 
                   2117: #-------------------------------------------
1.586     raeburn  2118: sub home_server_form_item {
                   2119:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2120:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2121:     my $result;
                   2122:     my $numlib = keys(%servers);
                   2123:     if ($numlib > 1) {
                   2124:         $result .= '<select name="'.$name.'" />'."\n";
                   2125:         if ($default) {
1.804     bisitz   2126:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2127:                        '</option>'."\n";
                   2128:         }
                   2129:         foreach my $hostid (sort(keys(%servers))) {
                   2130:             $result.= '<option value="'.$hostid.'">'.
                   2131: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2132:         }
                   2133:         $result .= '</select>'."\n";
                   2134:     } elsif ($numlib == 1) {
                   2135:         my $hostid;
                   2136:         foreach my $item (keys(%servers)) {
                   2137:             $hostid = $item;
                   2138:         }
                   2139:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2140:                    $hostid.'" />';
                   2141:                    if (!$hide) {
                   2142:                        $result .= $hostid.' '.$servers{$hostid};
                   2143:                    }
                   2144:                    $result .= "\n";
                   2145:     } elsif ($default) {
                   2146:         $result .= '<input type="hidden" name="'.$name.
                   2147:                    '" value="default" />';
                   2148:                    if (!$hide) {
                   2149:                        $result .= &mt('default');
                   2150:                    }
                   2151:                    $result .= "\n";
1.33      matthew  2152:     }
1.586     raeburn  2153:     return ($result,$numlib);
1.33      matthew  2154: }
1.112     bowersj2 2155: 
                   2156: =pod
                   2157: 
1.534     albertel 2158: =back 
                   2159: 
1.112     bowersj2 2160: =cut
1.87      matthew  2161: 
                   2162: ###############################################################
1.112     bowersj2 2163: ##                  Decoding User Agent                      ##
1.87      matthew  2164: ###############################################################
                   2165: 
                   2166: =pod
                   2167: 
1.112     bowersj2 2168: =head1 Decoding the User Agent
                   2169: 
                   2170: =over 4
                   2171: 
                   2172: =item * &decode_user_agent()
1.87      matthew  2173: 
                   2174: Inputs: $r
                   2175: 
                   2176: Outputs:
                   2177: 
                   2178: =over 4
                   2179: 
1.112     bowersj2 2180: =item * $httpbrowser
1.87      matthew  2181: 
1.112     bowersj2 2182: =item * $clientbrowser
1.87      matthew  2183: 
1.112     bowersj2 2184: =item * $clientversion
1.87      matthew  2185: 
1.112     bowersj2 2186: =item * $clientmathml
1.87      matthew  2187: 
1.112     bowersj2 2188: =item * $clientunicode
1.87      matthew  2189: 
1.112     bowersj2 2190: =item * $clientos
1.87      matthew  2191: 
                   2192: =back
                   2193: 
1.157     matthew  2194: =back 
                   2195: 
1.87      matthew  2196: =cut
                   2197: 
                   2198: ###############################################################
                   2199: ###############################################################
                   2200: sub decode_user_agent {
1.247     albertel 2201:     my ($r)=@_;
1.87      matthew  2202:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2203:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2204:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2205:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2206:     my $clientbrowser='unknown';
                   2207:     my $clientversion='0';
                   2208:     my $clientmathml='';
                   2209:     my $clientunicode='0';
                   2210:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2211:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2212: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2213: 	    $clientbrowser=$bname;
                   2214:             $httpbrowser=~/$vreg/i;
                   2215: 	    $clientversion=$1;
                   2216:             $clientmathml=($clientversion>=$minv);
                   2217:             $clientunicode=($clientversion>=$univ);
                   2218: 	}
                   2219:     }
                   2220:     my $clientos='unknown';
                   2221:     if (($httpbrowser=~/linux/i) ||
                   2222:         ($httpbrowser=~/unix/i) ||
                   2223:         ($httpbrowser=~/ux/i) ||
                   2224:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2225:     if (($httpbrowser=~/vax/i) ||
                   2226:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2227:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2228:     if (($httpbrowser=~/mac/i) ||
                   2229:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2230:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2231:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2232:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2233:             $clientunicode,$clientos,);
                   2234: }
                   2235: 
1.32      matthew  2236: ###############################################################
                   2237: ##    Authentication changing form generation subroutines    ##
                   2238: ###############################################################
                   2239: ##
                   2240: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2241: ## hash, and have reasonable default values.
                   2242: ##
                   2243: ##    formname = the name given in the <form> tag.
1.35      matthew  2244: #-------------------------------------------
                   2245: 
1.45      matthew  2246: =pod
                   2247: 
1.112     bowersj2 2248: =head1 Authentication Routines
                   2249: 
                   2250: =over 4
                   2251: 
1.648     raeburn  2252: =item * &authform_xxxxxx()
1.35      matthew  2253: 
                   2254: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2255: handle some of the conveniences required for authentication forms.  
                   2256: This is not an optimal method, but it works.  
                   2257: 
                   2258: =over 4
                   2259: 
1.112     bowersj2 2260: =item * authform_header
1.35      matthew  2261: 
1.112     bowersj2 2262: =item * authform_authorwarning
1.35      matthew  2263: 
1.112     bowersj2 2264: =item * authform_nochange
1.35      matthew  2265: 
1.112     bowersj2 2266: =item * authform_kerberos
1.35      matthew  2267: 
1.112     bowersj2 2268: =item * authform_internal
1.35      matthew  2269: 
1.112     bowersj2 2270: =item * authform_filesystem
1.35      matthew  2271: 
                   2272: =back
                   2273: 
1.648     raeburn  2274: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2275: 
1.35      matthew  2276: =cut
                   2277: 
                   2278: #-------------------------------------------
1.32      matthew  2279: sub authform_header{  
                   2280:     my %in = (
                   2281:         formname => 'cu',
1.80      albertel 2282:         kerb_def_dom => '',
1.32      matthew  2283:         @_,
                   2284:     );
                   2285:     $in{'formname'} = 'document.' . $in{'formname'};
                   2286:     my $result='';
1.80      albertel 2287: 
                   2288: #---------------------------------------------- Code for upper case translation
                   2289:     my $Javascript_toUpperCase;
                   2290:     unless ($in{kerb_def_dom}) {
                   2291:         $Javascript_toUpperCase =<<"END";
                   2292:         switch (choice) {
                   2293:            case 'krb': currentform.elements[choicearg].value =
                   2294:                currentform.elements[choicearg].value.toUpperCase();
                   2295:                break;
                   2296:            default:
                   2297:         }
                   2298: END
                   2299:     } else {
                   2300:         $Javascript_toUpperCase = "";
                   2301:     }
                   2302: 
1.165     raeburn  2303:     my $radioval = "'nochange'";
1.591     raeburn  2304:     if (defined($in{'curr_authtype'})) {
                   2305:         if ($in{'curr_authtype'} ne '') {
                   2306:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2307:         }
1.174     matthew  2308:     }
1.165     raeburn  2309:     my $argfield = 'null';
1.591     raeburn  2310:     if (defined($in{'mode'})) {
1.165     raeburn  2311:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2312:             if (defined($in{'curr_autharg'})) {
                   2313:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2314:                     $argfield = "'$in{'curr_autharg'}'";
                   2315:                 }
                   2316:             }
                   2317:         }
                   2318:     }
                   2319: 
1.32      matthew  2320:     $result.=<<"END";
                   2321: var current = new Object();
1.165     raeburn  2322: current.radiovalue = $radioval;
                   2323: current.argfield = $argfield;
1.32      matthew  2324: 
                   2325: function changed_radio(choice,currentform) {
                   2326:     var choicearg = choice + 'arg';
                   2327:     // If a radio button in changed, we need to change the argfield
                   2328:     if (current.radiovalue != choice) {
                   2329:         current.radiovalue = choice;
                   2330:         if (current.argfield != null) {
                   2331:             currentform.elements[current.argfield].value = '';
                   2332:         }
                   2333:         if (choice == 'nochange') {
                   2334:             current.argfield = null;
                   2335:         } else {
                   2336:             current.argfield = choicearg;
                   2337:             switch(choice) {
                   2338:                 case 'krb': 
                   2339:                     currentform.elements[current.argfield].value = 
                   2340:                         "$in{'kerb_def_dom'}";
                   2341:                 break;
                   2342:               default:
                   2343:                 break;
                   2344:             }
                   2345:         }
                   2346:     }
                   2347:     return;
                   2348: }
1.22      www      2349: 
1.32      matthew  2350: function changed_text(choice,currentform) {
                   2351:     var choicearg = choice + 'arg';
                   2352:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2353:         $Javascript_toUpperCase
1.32      matthew  2354:         // clear old field
                   2355:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2356:             currentform.elements[current.argfield].value = '';
                   2357:         }
                   2358:         current.argfield = choicearg;
                   2359:     }
                   2360:     set_auth_radio_buttons(choice,currentform);
                   2361:     return;
1.20      www      2362: }
1.32      matthew  2363: 
                   2364: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2365:     var numauthchoices = currentform.login.length;
                   2366:     if (typeof numauthchoices  == "undefined") {
                   2367:         return;
                   2368:     } 
1.32      matthew  2369:     var i=0;
1.986     raeburn  2370:     while (i < numauthchoices) {
1.32      matthew  2371:         if (currentform.login[i].value == newvalue) { break; }
                   2372:         i++;
                   2373:     }
1.986     raeburn  2374:     if (i == numauthchoices) {
1.32      matthew  2375:         return;
                   2376:     }
                   2377:     current.radiovalue = newvalue;
                   2378:     currentform.login[i].checked = true;
                   2379:     return;
                   2380: }
                   2381: END
                   2382:     return $result;
                   2383: }
                   2384: 
                   2385: sub authform_authorwarning{
                   2386:     my $result='';
1.144     matthew  2387:     $result='<i>'.
                   2388:         &mt('As a general rule, only authors or co-authors should be '.
                   2389:             'filesystem authenticated '.
                   2390:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2391:     return $result;
                   2392: }
                   2393: 
                   2394: sub authform_nochange{  
                   2395:     my %in = (
                   2396:               formname => 'document.cu',
                   2397:               kerb_def_dom => 'MSU.EDU',
                   2398:               @_,
                   2399:           );
1.586     raeburn  2400:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2401:     my $result;
                   2402:     if (keys(%can_assign) == 0) {
                   2403:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2404:     } else {
                   2405:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2406:                   '<input type="radio" name="login" value="nochange" '.
                   2407:                   'checked="checked" onclick="'.
1.281     albertel 2408:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2409: 	    '</label>';
1.586     raeburn  2410:     }
1.32      matthew  2411:     return $result;
                   2412: }
                   2413: 
1.591     raeburn  2414: sub authform_kerberos {
1.32      matthew  2415:     my %in = (
                   2416:               formname => 'document.cu',
                   2417:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2418:               kerb_def_auth => 'krb4',
1.32      matthew  2419:               @_,
                   2420:               );
1.586     raeburn  2421:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2422:         $autharg,$jscall);
                   2423:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2424:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2425:        $check5 = ' checked="checked"';
1.80      albertel 2426:     } else {
1.772     bisitz   2427:        $check4 = ' checked="checked"';
1.80      albertel 2428:     }
1.165     raeburn  2429:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2430:     if (defined($in{'curr_authtype'})) {
                   2431:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2432:             $krbcheck = ' checked="checked"';
1.623     raeburn  2433:             if (defined($in{'mode'})) {
                   2434:                 if ($in{'mode'} eq 'modifyuser') {
                   2435:                     $krbcheck = '';
                   2436:                 }
                   2437:             }
1.591     raeburn  2438:             if (defined($in{'curr_kerb_ver'})) {
                   2439:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2440:                     $check5 = ' checked="checked"';
1.591     raeburn  2441:                     $check4 = '';
                   2442:                 } else {
1.772     bisitz   2443:                     $check4 = ' checked="checked"';
1.591     raeburn  2444:                     $check5 = '';
                   2445:                 }
1.586     raeburn  2446:             }
1.591     raeburn  2447:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2448:                 $krbarg = $in{'curr_autharg'};
                   2449:             }
1.586     raeburn  2450:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2451:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2452:                     $result = 
                   2453:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2454:         $in{'curr_autharg'},$krbver);
                   2455:                 } else {
                   2456:                     $result =
                   2457:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2458:                 }
                   2459:                 return $result; 
                   2460:             }
                   2461:         }
                   2462:     } else {
                   2463:         if ($authnum == 1) {
1.784     bisitz   2464:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2465:         }
                   2466:     }
1.586     raeburn  2467:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2468:         return;
1.587     raeburn  2469:     } elsif ($authtype eq '') {
1.591     raeburn  2470:         if (defined($in{'mode'})) {
1.587     raeburn  2471:             if ($in{'mode'} eq 'modifycourse') {
                   2472:                 if ($authnum == 1) {
1.784     bisitz   2473:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2474:                 }
                   2475:             }
                   2476:         }
1.586     raeburn  2477:     }
                   2478:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2479:     if ($authtype eq '') {
                   2480:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2481:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2482:                     $krbcheck.' />';
                   2483:     }
                   2484:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2485:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2486:          $in{'curr_authtype'} eq 'krb5') ||
                   2487:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2488:          $in{'curr_authtype'} eq 'krb4')) {
                   2489:         $result .= &mt
1.144     matthew  2490:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2491:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2492:          '<label>'.$authtype,
1.281     albertel 2493:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2494:              'value="'.$krbarg.'" '.
1.144     matthew  2495:              'onchange="'.$jscall.'" />',
1.281     albertel 2496:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2497:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2498: 	 '</label>');
1.586     raeburn  2499:     } elsif ($can_assign{'krb4'}) {
                   2500:         $result .= &mt
                   2501:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2502:          '[_3] Version 4 [_4]',
                   2503:          '<label>'.$authtype,
                   2504:          '</label><input type="text" size="10" name="krbarg" '.
                   2505:              'value="'.$krbarg.'" '.
                   2506:              'onchange="'.$jscall.'" />',
                   2507:          '<label><input type="hidden" name="krbver" value="4" />',
                   2508:          '</label>');
                   2509:     } elsif ($can_assign{'krb5'}) {
                   2510:         $result .= &mt
                   2511:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2512:          '[_3] Version 5 [_4]',
                   2513:          '<label>'.$authtype,
                   2514:          '</label><input type="text" size="10" name="krbarg" '.
                   2515:              'value="'.$krbarg.'" '.
                   2516:              'onchange="'.$jscall.'" />',
                   2517:          '<label><input type="hidden" name="krbver" value="5" />',
                   2518:          '</label>');
                   2519:     }
1.32      matthew  2520:     return $result;
                   2521: }
                   2522: 
                   2523: sub authform_internal{  
1.586     raeburn  2524:     my %in = (
1.32      matthew  2525:                 formname => 'document.cu',
                   2526:                 kerb_def_dom => 'MSU.EDU',
                   2527:                 @_,
                   2528:                 );
1.586     raeburn  2529:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2530:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2531:     if (defined($in{'curr_authtype'})) {
                   2532:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2533:             if ($can_assign{'int'}) {
1.772     bisitz   2534:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2535:                 if (defined($in{'mode'})) {
                   2536:                     if ($in{'mode'} eq 'modifyuser') {
                   2537:                         $intcheck = '';
                   2538:                     }
                   2539:                 }
1.591     raeburn  2540:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2541:                     $intarg = $in{'curr_autharg'};
                   2542:                 }
                   2543:             } else {
                   2544:                 $result = &mt('Currently internally authenticated.');
                   2545:                 return $result;
1.165     raeburn  2546:             }
                   2547:         }
1.586     raeburn  2548:     } else {
                   2549:         if ($authnum == 1) {
1.784     bisitz   2550:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2551:         }
                   2552:     }
                   2553:     if (!$can_assign{'int'}) {
                   2554:         return;
1.587     raeburn  2555:     } elsif ($authtype eq '') {
1.591     raeburn  2556:         if (defined($in{'mode'})) {
1.587     raeburn  2557:             if ($in{'mode'} eq 'modifycourse') {
                   2558:                 if ($authnum == 1) {
1.784     bisitz   2559:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2560:                 }
                   2561:             }
                   2562:         }
1.165     raeburn  2563:     }
1.586     raeburn  2564:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2565:     if ($authtype eq '') {
                   2566:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2567:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2568:     }
1.605     bisitz   2569:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2570:                $intarg.'" onchange="'.$jscall.'" />';
                   2571:     $result = &mt
1.144     matthew  2572:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2573:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2574:     $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  2575:     return $result;
                   2576: }
                   2577: 
                   2578: sub authform_local{  
                   2579:     my %in = (
                   2580:               formname => 'document.cu',
                   2581:               kerb_def_dom => 'MSU.EDU',
                   2582:               @_,
                   2583:               );
1.586     raeburn  2584:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2585:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2586:     if (defined($in{'curr_authtype'})) {
                   2587:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2588:             if ($can_assign{'loc'}) {
1.772     bisitz   2589:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2590:                 if (defined($in{'mode'})) {
                   2591:                     if ($in{'mode'} eq 'modifyuser') {
                   2592:                         $loccheck = '';
                   2593:                     }
                   2594:                 }
1.591     raeburn  2595:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2596:                     $locarg = $in{'curr_autharg'};
                   2597:                 }
                   2598:             } else {
                   2599:                 $result = &mt('Currently using local (institutional) authentication.');
                   2600:                 return $result;
1.165     raeburn  2601:             }
                   2602:         }
1.586     raeburn  2603:     } else {
                   2604:         if ($authnum == 1) {
1.784     bisitz   2605:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2606:         }
                   2607:     }
                   2608:     if (!$can_assign{'loc'}) {
                   2609:         return;
1.587     raeburn  2610:     } elsif ($authtype eq '') {
1.591     raeburn  2611:         if (defined($in{'mode'})) {
1.587     raeburn  2612:             if ($in{'mode'} eq 'modifycourse') {
                   2613:                 if ($authnum == 1) {
1.784     bisitz   2614:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2615:                 }
                   2616:             }
                   2617:         }
1.165     raeburn  2618:     }
1.586     raeburn  2619:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2620:     if ($authtype eq '') {
                   2621:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2622:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2623:                     $jscall.'" />';
                   2624:     }
                   2625:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2626:                $locarg.'" onchange="'.$jscall.'" />';
                   2627:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2628:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2629:     return $result;
                   2630: }
                   2631: 
                   2632: sub authform_filesystem{  
                   2633:     my %in = (
                   2634:               formname => 'document.cu',
                   2635:               kerb_def_dom => 'MSU.EDU',
                   2636:               @_,
                   2637:               );
1.586     raeburn  2638:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2639:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2640:     if (defined($in{'curr_authtype'})) {
                   2641:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2642:             if ($can_assign{'fsys'}) {
1.772     bisitz   2643:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2644:                 if (defined($in{'mode'})) {
                   2645:                     if ($in{'mode'} eq 'modifyuser') {
                   2646:                         $fsyscheck = '';
                   2647:                     }
                   2648:                 }
1.586     raeburn  2649:             } else {
                   2650:                 $result = &mt('Currently Filesystem Authenticated.');
                   2651:                 return $result;
                   2652:             }           
                   2653:         }
                   2654:     } else {
                   2655:         if ($authnum == 1) {
1.784     bisitz   2656:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2657:         }
                   2658:     }
                   2659:     if (!$can_assign{'fsys'}) {
                   2660:         return;
1.587     raeburn  2661:     } elsif ($authtype eq '') {
1.591     raeburn  2662:         if (defined($in{'mode'})) {
1.587     raeburn  2663:             if ($in{'mode'} eq 'modifycourse') {
                   2664:                 if ($authnum == 1) {
1.784     bisitz   2665:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2666:                 }
                   2667:             }
                   2668:         }
1.586     raeburn  2669:     }
                   2670:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2671:     if ($authtype eq '') {
                   2672:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2673:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2674:                     $jscall.'" />';
                   2675:     }
                   2676:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2677:                ' onchange="'.$jscall.'" />';
                   2678:     $result = &mt
1.144     matthew  2679:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2680:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2681:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2682:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2683:                   'onchange="'.$jscall.'" />');
1.32      matthew  2684:     return $result;
                   2685: }
                   2686: 
1.586     raeburn  2687: sub get_assignable_auth {
                   2688:     my ($dom) = @_;
                   2689:     if ($dom eq '') {
                   2690:         $dom = $env{'request.role.domain'};
                   2691:     }
                   2692:     my %can_assign = (
                   2693:                           krb4 => 1,
                   2694:                           krb5 => 1,
                   2695:                           int  => 1,
                   2696:                           loc  => 1,
                   2697:                      );
                   2698:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2699:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2700:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2701:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2702:             my $context;
                   2703:             if ($env{'request.role'} =~ /^au/) {
                   2704:                 $context = 'author';
                   2705:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2706:                 $context = 'domain';
                   2707:             } elsif ($env{'request.course.id'}) {
                   2708:                 $context = 'course';
                   2709:             }
                   2710:             if ($context) {
                   2711:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2712:                    %can_assign = %{$authhash->{$context}}; 
                   2713:                 }
                   2714:             }
                   2715:         }
                   2716:     }
                   2717:     my $authnum = 0;
                   2718:     foreach my $key (keys(%can_assign)) {
                   2719:         if ($can_assign{$key}) {
                   2720:             $authnum ++;
                   2721:         }
                   2722:     }
                   2723:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2724:         $authnum --;
                   2725:     }
                   2726:     return ($authnum,%can_assign);
                   2727: }
                   2728: 
1.80      albertel 2729: ###############################################################
                   2730: ##    Get Kerberos Defaults for Domain                 ##
                   2731: ###############################################################
                   2732: ##
                   2733: ## Returns default kerberos version and an associated argument
                   2734: ## as listed in file domain.tab. If not listed, provides
                   2735: ## appropriate default domain and kerberos version.
                   2736: ##
                   2737: #-------------------------------------------
                   2738: 
                   2739: =pod
                   2740: 
1.648     raeburn  2741: =item * &get_kerberos_defaults()
1.80      albertel 2742: 
                   2743: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2744: version and domain. If not found, it defaults to version 4 and the 
                   2745: domain of the server.
1.80      albertel 2746: 
1.648     raeburn  2747: =over 4
                   2748: 
1.80      albertel 2749: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2750: 
1.648     raeburn  2751: =back
                   2752: 
                   2753: =back
                   2754: 
1.80      albertel 2755: =cut
                   2756: 
                   2757: #-------------------------------------------
                   2758: sub get_kerberos_defaults {
                   2759:     my $domain=shift;
1.641     raeburn  2760:     my ($krbdef,$krbdefdom);
                   2761:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2762:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2763:         $krbdef = $domdefaults{'auth_def'};
                   2764:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2765:     } else {
1.80      albertel 2766:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2767:         my $krbdefdom=$1;
                   2768:         $krbdefdom=~tr/a-z/A-Z/;
                   2769:         $krbdef = "krb4";
                   2770:     }
                   2771:     return ($krbdef,$krbdefdom);
                   2772: }
1.112     bowersj2 2773: 
1.32      matthew  2774: 
1.46      matthew  2775: ###############################################################
                   2776: ##                Thesaurus Functions                        ##
                   2777: ###############################################################
1.20      www      2778: 
1.46      matthew  2779: =pod
1.20      www      2780: 
1.112     bowersj2 2781: =head1 Thesaurus Functions
                   2782: 
                   2783: =over 4
                   2784: 
1.648     raeburn  2785: =item * &initialize_keywords()
1.46      matthew  2786: 
                   2787: Initializes the package variable %Keywords if it is empty.  Uses the
                   2788: package variable $thesaurus_db_file.
                   2789: 
                   2790: =cut
                   2791: 
                   2792: ###################################################
                   2793: 
                   2794: sub initialize_keywords {
                   2795:     return 1 if (scalar keys(%Keywords));
                   2796:     # If we are here, %Keywords is empty, so fill it up
                   2797:     #   Make sure the file we need exists...
                   2798:     if (! -e $thesaurus_db_file) {
                   2799:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2800:                                  " failed because it does not exist");
                   2801:         return 0;
                   2802:     }
                   2803:     #   Set up the hash as a database
                   2804:     my %thesaurus_db;
                   2805:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2806:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2807:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2808:                                  $thesaurus_db_file);
                   2809:         return 0;
                   2810:     } 
                   2811:     #  Get the average number of appearances of a word.
                   2812:     my $avecount = $thesaurus_db{'average.count'};
                   2813:     #  Put keywords (those that appear > average) into %Keywords
                   2814:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2815:         my ($count,undef) = split /:/,$data;
                   2816:         $Keywords{$word}++ if ($count > $avecount);
                   2817:     }
                   2818:     untie %thesaurus_db;
                   2819:     # Remove special values from %Keywords.
1.356     albertel 2820:     foreach my $value ('total.count','average.count') {
                   2821:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2822:   }
1.46      matthew  2823:     return 1;
                   2824: }
                   2825: 
                   2826: ###################################################
                   2827: 
                   2828: =pod
                   2829: 
1.648     raeburn  2830: =item * &keyword($word)
1.46      matthew  2831: 
                   2832: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2833: than the average number of times in the thesaurus database.  Calls 
                   2834: &initialize_keywords
                   2835: 
                   2836: =cut
                   2837: 
                   2838: ###################################################
1.20      www      2839: 
                   2840: sub keyword {
1.46      matthew  2841:     return if (!&initialize_keywords());
                   2842:     my $word=lc(shift());
                   2843:     $word=~s/\W//g;
                   2844:     return exists($Keywords{$word});
1.20      www      2845: }
1.46      matthew  2846: 
                   2847: ###############################################################
                   2848: 
                   2849: =pod 
1.20      www      2850: 
1.648     raeburn  2851: =item * &get_related_words()
1.46      matthew  2852: 
1.160     matthew  2853: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2854: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2855: will be returned.  The order of the words returned is determined by the
                   2856: database which holds them.
                   2857: 
                   2858: Uses global $thesaurus_db_file.
                   2859: 
1.1057    foxr     2860: 
1.46      matthew  2861: =cut
                   2862: 
                   2863: ###############################################################
                   2864: sub get_related_words {
                   2865:     my $keyword = shift;
                   2866:     my %thesaurus_db;
                   2867:     if (! -e $thesaurus_db_file) {
                   2868:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2869:                                  "failed because the file does not exist");
                   2870:         return ();
                   2871:     }
                   2872:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2873:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2874:         return ();
                   2875:     } 
                   2876:     my @Words=();
1.429     www      2877:     my $count=0;
1.46      matthew  2878:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2879: 	# The first element is the number of times
                   2880: 	# the word appears.  We do not need it now.
1.429     www      2881: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2882: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2883: 	my $threshold=$mostfrequentcount/10;
                   2884:         foreach my $possibleword (@RelatedWords) {
                   2885:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2886:             if ($wordcount>$threshold) {
                   2887: 		push(@Words,$word);
                   2888:                 $count++;
                   2889:                 if ($count>10) { last; }
                   2890: 	    }
1.20      www      2891:         }
                   2892:     }
1.46      matthew  2893:     untie %thesaurus_db;
                   2894:     return @Words;
1.14      harris41 2895: }
1.46      matthew  2896: 
1.112     bowersj2 2897: =pod
                   2898: 
                   2899: =back
                   2900: 
                   2901: =cut
1.61      www      2902: 
                   2903: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2904: =pod
                   2905: 
1.112     bowersj2 2906: =head1 User Name Functions
                   2907: 
                   2908: =over 4
                   2909: 
1.648     raeburn  2910: =item * &plainname($uname,$udom,$first)
1.81      albertel 2911: 
1.112     bowersj2 2912: Takes a users logon name and returns it as a string in
1.226     albertel 2913: "first middle last generation" form 
                   2914: if $first is set to 'lastname' then it returns it as
                   2915: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2916: 
                   2917: =cut
1.61      www      2918: 
1.295     www      2919: 
1.81      albertel 2920: ###############################################################
1.61      www      2921: sub plainname {
1.226     albertel 2922:     my ($uname,$udom,$first)=@_;
1.537     albertel 2923:     return if (!defined($uname) || !defined($udom));
1.295     www      2924:     my %names=&getnames($uname,$udom);
1.226     albertel 2925:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2926: 					  $names{'middlename'},
                   2927: 					  $names{'lastname'},
                   2928: 					  $names{'generation'},$first);
                   2929:     $name=~s/^\s+//;
1.62      www      2930:     $name=~s/\s+$//;
                   2931:     $name=~s/\s+/ /g;
1.353     albertel 2932:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2933:     return $name;
1.61      www      2934: }
1.66      www      2935: 
                   2936: # -------------------------------------------------------------------- Nickname
1.81      albertel 2937: =pod
                   2938: 
1.648     raeburn  2939: =item * &nickname($uname,$udom)
1.81      albertel 2940: 
                   2941: Gets a users name and returns it as a string as
                   2942: 
                   2943: "&quot;nickname&quot;"
1.66      www      2944: 
1.81      albertel 2945: if the user has a nickname or
                   2946: 
                   2947: "first middle last generation"
                   2948: 
                   2949: if the user does not
                   2950: 
                   2951: =cut
1.66      www      2952: 
                   2953: sub nickname {
                   2954:     my ($uname,$udom)=@_;
1.537     albertel 2955:     return if (!defined($uname) || !defined($udom));
1.295     www      2956:     my %names=&getnames($uname,$udom);
1.68      albertel 2957:     my $name=$names{'nickname'};
1.66      www      2958:     if ($name) {
                   2959:        $name='&quot;'.$name.'&quot;'; 
                   2960:     } else {
                   2961:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2962: 	     $names{'lastname'}.' '.$names{'generation'};
                   2963:        $name=~s/\s+$//;
                   2964:        $name=~s/\s+/ /g;
                   2965:     }
                   2966:     return $name;
                   2967: }
                   2968: 
1.295     www      2969: sub getnames {
                   2970:     my ($uname,$udom)=@_;
1.537     albertel 2971:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2972:     if ($udom eq 'public' && $uname eq 'public') {
                   2973: 	return ('lastname' => &mt('Public'));
                   2974:     }
1.295     www      2975:     my $id=$uname.':'.$udom;
                   2976:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2977:     if ($cached) {
                   2978: 	return %{$names};
                   2979:     } else {
                   2980: 	my %loadnames=&Apache::lonnet::get('environment',
                   2981:                     ['firstname','middlename','lastname','generation','nickname'],
                   2982: 					 $udom,$uname);
                   2983: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2984: 	return %loadnames;
                   2985:     }
                   2986: }
1.61      www      2987: 
1.542     raeburn  2988: # -------------------------------------------------------------------- getemails
1.648     raeburn  2989: 
1.542     raeburn  2990: =pod
                   2991: 
1.648     raeburn  2992: =item * &getemails($uname,$udom)
1.542     raeburn  2993: 
                   2994: Gets a user's email information and returns it as a hash with keys:
                   2995: notification, critnotification, permanentemail
                   2996: 
                   2997: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2998: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2999:  
1.648     raeburn  3000: 
1.542     raeburn  3001: =cut
                   3002: 
1.648     raeburn  3003: 
1.466     albertel 3004: sub getemails {
                   3005:     my ($uname,$udom)=@_;
                   3006:     if ($udom eq 'public' && $uname eq 'public') {
                   3007: 	return;
                   3008:     }
1.467     www      3009:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3010:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3011:     my $id=$uname.':'.$udom;
                   3012:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3013:     if ($cached) {
                   3014: 	return %{$names};
                   3015:     } else {
                   3016: 	my %loadnames=&Apache::lonnet::get('environment',
                   3017:                     			   ['notification','critnotification',
                   3018: 					    'permanentemail'],
                   3019: 					   $udom,$uname);
                   3020: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3021: 	return %loadnames;
                   3022:     }
                   3023: }
                   3024: 
1.551     albertel 3025: sub flush_email_cache {
                   3026:     my ($uname,$udom)=@_;
                   3027:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3028:     if (!$uname) { $uname=$env{'user.name'};   }
                   3029:     return if ($udom eq 'public' && $uname eq 'public');
                   3030:     my $id=$uname.':'.$udom;
                   3031:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3032: }
                   3033: 
1.728     raeburn  3034: # -------------------------------------------------------------------- getlangs
                   3035: 
                   3036: =pod
                   3037: 
                   3038: =item * &getlangs($uname,$udom)
                   3039: 
                   3040: Gets a user's language preference and returns it as a hash with key:
                   3041: language.
                   3042: 
                   3043: =cut
                   3044: 
                   3045: 
                   3046: sub getlangs {
                   3047:     my ($uname,$udom) = @_;
                   3048:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3049:     if (!$uname) { $uname=$env{'user.name'};   }
                   3050:     my $id=$uname.':'.$udom;
                   3051:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3052:     if ($cached) {
                   3053:         return %{$langs};
                   3054:     } else {
                   3055:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3056:                                            $udom,$uname);
                   3057:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3058:         return %loadlangs;
                   3059:     }
                   3060: }
                   3061: 
                   3062: sub flush_langs_cache {
                   3063:     my ($uname,$udom)=@_;
                   3064:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3065:     if (!$uname) { $uname=$env{'user.name'};   }
                   3066:     return if ($udom eq 'public' && $uname eq 'public');
                   3067:     my $id=$uname.':'.$udom;
                   3068:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3069: }
                   3070: 
1.61      www      3071: # ------------------------------------------------------------------ Screenname
1.81      albertel 3072: 
                   3073: =pod
                   3074: 
1.648     raeburn  3075: =item * &screenname($uname,$udom)
1.81      albertel 3076: 
                   3077: Gets a users screenname and returns it as a string
                   3078: 
                   3079: =cut
1.61      www      3080: 
                   3081: sub screenname {
                   3082:     my ($uname,$udom)=@_;
1.258     albertel 3083:     if ($uname eq $env{'user.name'} &&
                   3084: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3085:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3086:     return $names{'screenname'};
1.62      www      3087: }
                   3088: 
1.212     albertel 3089: 
1.802     bisitz   3090: # ------------------------------------------------------------- Confirm Wrapper
                   3091: =pod
                   3092: 
                   3093: =item confirmwrapper
                   3094: 
                   3095: Wrap messages about completion of operation in box
                   3096: 
                   3097: =cut
                   3098: 
                   3099: sub confirmwrapper {
                   3100:     my ($message)=@_;
                   3101:     if ($message) {
                   3102:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3103:                .$message."\n"
                   3104:                .'</div>'."\n";
                   3105:     } else {
                   3106:         return $message;
                   3107:     }
                   3108: }
                   3109: 
1.62      www      3110: # ------------------------------------------------------------- Message Wrapper
                   3111: 
                   3112: sub messagewrapper {
1.369     www      3113:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3114:     return 
1.441     albertel 3115:         '<a href="/adm/email?compose=individual&amp;'.
                   3116:         'recname='.$username.'&amp;recdom='.$domain.
                   3117: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3118:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3119: }
1.802     bisitz   3120: 
1.74      www      3121: # --------------------------------------------------------------- Notes Wrapper
                   3122: 
                   3123: sub noteswrapper {
                   3124:     my ($link,$un,$do)=@_;
                   3125:     return 
1.896     amueller 3126: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3127: }
1.802     bisitz   3128: 
1.62      www      3129: # ------------------------------------------------------------- Aboutme Wrapper
                   3130: 
                   3131: sub aboutmewrapper {
1.166     www      3132:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3133:     if (!defined($username)  && !defined($domain)) {
                   3134:         return;
                   3135:     }
1.892     amueller 3136:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3137: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3138: }
                   3139: 
                   3140: # ------------------------------------------------------------ Syllabus Wrapper
                   3141: 
                   3142: sub syllabuswrapper {
1.707     bisitz   3143:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3144:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3145: }
1.14      harris41 3146: 
1.802     bisitz   3147: # -----------------------------------------------------------------------------
                   3148: 
1.208     matthew  3149: sub track_student_link {
1.887     raeburn  3150:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3151:     my $link ="/adm/trackstudent?";
1.208     matthew  3152:     my $title = 'View recent activity';
                   3153:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3154:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3155:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3156:         $title .= ' of this student';
1.268     albertel 3157:     } 
1.208     matthew  3158:     if (defined($target) && $target !~ /^\s*$/) {
                   3159:         $target = qq{target="$target"};
                   3160:     } else {
                   3161:         $target = '';
                   3162:     }
1.268     albertel 3163:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3164:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3165:     $title = &mt($title);
                   3166:     $linktext = &mt($linktext);
1.448     albertel 3167:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3168: 	&help_open_topic('View_recent_activity');
1.208     matthew  3169: }
                   3170: 
1.781     raeburn  3171: sub slot_reservations_link {
                   3172:     my ($linktext,$sname,$sdom,$target) = @_;
                   3173:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3174:     my $title = 'View slot reservation history';
                   3175:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3176:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3177:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3178:         $title .= ' of this student';
                   3179:     }
                   3180:     if (defined($target) && $target !~ /^\s*$/) {
                   3181:         $target = qq{target="$target"};
                   3182:     } else {
                   3183:         $target = '';
                   3184:     }
                   3185:     $title = &mt($title);
                   3186:     $linktext = &mt($linktext);
                   3187:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3188: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3189: 
                   3190: }
                   3191: 
1.508     www      3192: # ===================================================== Display a student photo
                   3193: 
                   3194: 
1.509     albertel 3195: sub student_image_tag {
1.508     www      3196:     my ($domain,$user)=@_;
                   3197:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3198:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3199: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3200:     } else {
                   3201: 	return '';
                   3202:     }
                   3203: }
                   3204: 
1.112     bowersj2 3205: =pod
                   3206: 
                   3207: =back
                   3208: 
                   3209: =head1 Access .tab File Data
                   3210: 
                   3211: =over 4
                   3212: 
1.648     raeburn  3213: =item * &languageids() 
1.112     bowersj2 3214: 
                   3215: returns list of all language ids
                   3216: 
                   3217: =cut
                   3218: 
1.14      harris41 3219: sub languageids {
1.16      harris41 3220:     return sort(keys(%language));
1.14      harris41 3221: }
                   3222: 
1.112     bowersj2 3223: =pod
                   3224: 
1.648     raeburn  3225: =item * &languagedescription() 
1.112     bowersj2 3226: 
                   3227: returns description of a specified language id
                   3228: 
                   3229: =cut
                   3230: 
1.14      harris41 3231: sub languagedescription {
1.125     www      3232:     my $code=shift;
                   3233:     return  ($supported_language{$code}?'* ':'').
                   3234:             $language{$code}.
1.126     www      3235: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3236: }
                   3237: 
1.1048    foxr     3238: =pod
                   3239: 
                   3240: =item * &plainlanguagedescription
                   3241: 
                   3242: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3243: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3244: 
                   3245: =cut
                   3246: 
1.145     www      3247: sub plainlanguagedescription {
                   3248:     my $code=shift;
                   3249:     return $language{$code};
                   3250: }
                   3251: 
1.1048    foxr     3252: =pod
                   3253: 
                   3254: =item * &supportedlanguagecode
                   3255: 
                   3256: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3257: code.
                   3258: 
                   3259: =cut
                   3260: 
1.145     www      3261: sub supportedlanguagecode {
                   3262:     my $code=shift;
                   3263:     return $supported_language{$code};
1.97      www      3264: }
                   3265: 
1.112     bowersj2 3266: =pod
                   3267: 
1.1048    foxr     3268: =item * &latexlanguage()
                   3269: 
                   3270: Given a language key code returns the correspondnig language to use
                   3271: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3272: is no supported hyphenation for the language code.
                   3273: 
                   3274: =cut
                   3275: 
                   3276: sub latexlanguage {
                   3277:     my $code = shift;
                   3278:     return $latex_language{$code};
                   3279: }
                   3280: 
                   3281: =pod
                   3282: 
                   3283: =item * &latexhyphenation()
                   3284: 
                   3285: Same as above but what's supplied is the language as it might be stored
                   3286: in the metadata.
                   3287: 
                   3288: =cut
                   3289: 
                   3290: sub latexhyphenation {
                   3291:     my $key = shift;
                   3292:     return $latex_language_bykey{$key};
                   3293: }
                   3294: 
                   3295: =pod
                   3296: 
1.648     raeburn  3297: =item * &copyrightids() 
1.112     bowersj2 3298: 
                   3299: returns list of all copyrights
                   3300: 
                   3301: =cut
                   3302: 
                   3303: sub copyrightids {
                   3304:     return sort(keys(%cprtag));
                   3305: }
                   3306: 
                   3307: =pod
                   3308: 
1.648     raeburn  3309: =item * &copyrightdescription() 
1.112     bowersj2 3310: 
                   3311: returns description of a specified copyright id
                   3312: 
                   3313: =cut
                   3314: 
                   3315: sub copyrightdescription {
1.166     www      3316:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3317: }
1.197     matthew  3318: 
                   3319: =pod
                   3320: 
1.648     raeburn  3321: =item * &source_copyrightids() 
1.192     taceyjo1 3322: 
                   3323: returns list of all source copyrights
                   3324: 
                   3325: =cut
                   3326: 
                   3327: sub source_copyrightids {
                   3328:     return sort(keys(%scprtag));
                   3329: }
                   3330: 
                   3331: =pod
                   3332: 
1.648     raeburn  3333: =item * &source_copyrightdescription() 
1.192     taceyjo1 3334: 
                   3335: returns description of a specified source copyright id
                   3336: 
                   3337: =cut
                   3338: 
                   3339: sub source_copyrightdescription {
                   3340:     return &mt($scprtag{shift(@_)});
                   3341: }
1.112     bowersj2 3342: 
                   3343: =pod
                   3344: 
1.648     raeburn  3345: =item * &filecategories() 
1.112     bowersj2 3346: 
                   3347: returns list of all file categories
                   3348: 
                   3349: =cut
                   3350: 
                   3351: sub filecategories {
                   3352:     return sort(keys(%category_extensions));
                   3353: }
                   3354: 
                   3355: =pod
                   3356: 
1.648     raeburn  3357: =item * &filecategorytypes() 
1.112     bowersj2 3358: 
                   3359: returns list of file types belonging to a given file
                   3360: category
                   3361: 
                   3362: =cut
                   3363: 
                   3364: sub filecategorytypes {
1.356     albertel 3365:     my ($cat) = @_;
                   3366:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3367: }
                   3368: 
                   3369: =pod
                   3370: 
1.648     raeburn  3371: =item * &fileembstyle() 
1.112     bowersj2 3372: 
                   3373: returns embedding style for a specified file type
                   3374: 
                   3375: =cut
                   3376: 
                   3377: sub fileembstyle {
                   3378:     return $fe{lc(shift(@_))};
1.169     www      3379: }
                   3380: 
1.351     www      3381: sub filemimetype {
                   3382:     return $fm{lc(shift(@_))};
                   3383: }
                   3384: 
1.169     www      3385: 
                   3386: sub filecategoryselect {
                   3387:     my ($name,$value)=@_;
1.189     matthew  3388:     return &select_form($value,$name,
1.970     raeburn  3389:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3390: }
                   3391: 
                   3392: =pod
                   3393: 
1.648     raeburn  3394: =item * &filedescription() 
1.112     bowersj2 3395: 
                   3396: returns description for a specified file type
                   3397: 
                   3398: =cut
                   3399: 
                   3400: sub filedescription {
1.188     matthew  3401:     my $file_description = $fd{lc(shift())};
                   3402:     $file_description =~ s:([\[\]]):~$1:g;
                   3403:     return &mt($file_description);
1.112     bowersj2 3404: }
                   3405: 
                   3406: =pod
                   3407: 
1.648     raeburn  3408: =item * &filedescriptionex() 
1.112     bowersj2 3409: 
                   3410: returns description for a specified file type with
                   3411: extra formatting
                   3412: 
                   3413: =cut
                   3414: 
                   3415: sub filedescriptionex {
                   3416:     my $ex=shift;
1.188     matthew  3417:     my $file_description = $fd{lc($ex)};
                   3418:     $file_description =~ s:([\[\]]):~$1:g;
                   3419:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3420: }
                   3421: 
                   3422: # End of .tab access
                   3423: =pod
                   3424: 
                   3425: =back
                   3426: 
                   3427: =cut
                   3428: 
                   3429: # ------------------------------------------------------------------ File Types
                   3430: sub fileextensions {
                   3431:     return sort(keys(%fe));
                   3432: }
                   3433: 
1.97      www      3434: # ----------------------------------------------------------- Display Languages
                   3435: # returns a hash with all desired display languages
                   3436: #
                   3437: 
                   3438: sub display_languages {
                   3439:     my %languages=();
1.695     raeburn  3440:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3441: 	$languages{$lang}=1;
1.97      www      3442:     }
                   3443:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3444:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3445: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3446: 	    $languages{$lang}=1;
1.97      www      3447:         }
                   3448:     }
                   3449:     return %languages;
1.14      harris41 3450: }
                   3451: 
1.582     albertel 3452: sub languages {
                   3453:     my ($possible_langs) = @_;
1.695     raeburn  3454:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3455:     if (!ref($possible_langs)) {
                   3456: 	if( wantarray ) {
                   3457: 	    return @preferred_langs;
                   3458: 	} else {
                   3459: 	    return $preferred_langs[0];
                   3460: 	}
                   3461:     }
                   3462:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3463:     my @preferred_possibilities;
                   3464:     foreach my $preferred_lang (@preferred_langs) {
                   3465: 	if (exists($possibilities{$preferred_lang})) {
                   3466: 	    push(@preferred_possibilities, $preferred_lang);
                   3467: 	}
                   3468:     }
                   3469:     if( wantarray ) {
                   3470: 	return @preferred_possibilities;
                   3471:     }
                   3472:     return $preferred_possibilities[0];
                   3473: }
                   3474: 
1.742     raeburn  3475: sub user_lang {
                   3476:     my ($touname,$toudom,$fromcid) = @_;
                   3477:     my @userlangs;
                   3478:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3479:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3480:                     $env{'course.'.$fromcid.'.languages'}));
                   3481:     } else {
                   3482:         my %langhash = &getlangs($touname,$toudom);
                   3483:         if ($langhash{'languages'} ne '') {
                   3484:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3485:         } else {
                   3486:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3487:             if ($domdefs{'lang_def'} ne '') {
                   3488:                 @userlangs = ($domdefs{'lang_def'});
                   3489:             }
                   3490:         }
                   3491:     }
                   3492:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3493:     my $user_lh = Apache::localize->get_handle(@languages);
                   3494:     return $user_lh;
                   3495: }
                   3496: 
                   3497: 
1.112     bowersj2 3498: ###############################################################
                   3499: ##               Student Answer Attempts                     ##
                   3500: ###############################################################
                   3501: 
                   3502: =pod
                   3503: 
                   3504: =head1 Alternate Problem Views
                   3505: 
                   3506: =over 4
                   3507: 
1.648     raeburn  3508: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3509:     $getattempt, $regexp, $gradesub)
                   3510: 
                   3511: Return string with previous attempt on problem. Arguments:
                   3512: 
                   3513: =over 4
                   3514: 
                   3515: =item * $symb: Problem, including path
                   3516: 
                   3517: =item * $username: username of the desired student
                   3518: 
                   3519: =item * $domain: domain of the desired student
1.14      harris41 3520: 
1.112     bowersj2 3521: =item * $course: Course ID
1.14      harris41 3522: 
1.112     bowersj2 3523: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3524:     something
1.14      harris41 3525: 
1.112     bowersj2 3526: =item * $regexp: if string matches this regexp, the string will be
                   3527:     sent to $gradesub
1.14      harris41 3528: 
1.112     bowersj2 3529: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3530: 
1.112     bowersj2 3531: =back
1.14      harris41 3532: 
1.112     bowersj2 3533: The output string is a table containing all desired attempts, if any.
1.16      harris41 3534: 
1.112     bowersj2 3535: =cut
1.1       albertel 3536: 
                   3537: sub get_previous_attempt {
1.43      ng       3538:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3539:   my $prevattempts='';
1.43      ng       3540:   no strict 'refs';
1.1       albertel 3541:   if ($symb) {
1.3       albertel 3542:     my (%returnhash)=
                   3543:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3544:     if ($returnhash{'version'}) {
                   3545:       my %lasthash=();
                   3546:       my $version;
                   3547:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3548:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3549: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3550:         }
1.1       albertel 3551:       }
1.596     albertel 3552:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3553:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3554:       my (%typeparts,%lasthidden);
1.945     raeburn  3555:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3556:       foreach my $key (sort(keys(%lasthash))) {
                   3557: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3558: 	if ($#parts > 0) {
1.31      albertel 3559: 	  my $data=$parts[-1];
1.989     raeburn  3560:           next if ($data eq 'foilorder');
1.31      albertel 3561: 	  pop(@parts);
1.1010    www      3562:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  3563:           if ($data eq 'type') {
                   3564:               unless ($showsurv) {
                   3565:                   my $id = join(',',@parts);
                   3566:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3567:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3568:                       $lasthidden{$ign.'.'.$id} = 1;
                   3569:                   }
1.945     raeburn  3570:               }
1.1010    www      3571:           } 
1.31      albertel 3572: 	} else {
1.41      ng       3573: 	  if ($#parts == 0) {
                   3574: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3575: 	  } else {
                   3576: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3577: 	  }
1.31      albertel 3578: 	}
1.16      harris41 3579:       }
1.596     albertel 3580:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3581:       if ($getattempt eq '') {
                   3582: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3583:             my @hidden;
                   3584:             if (%typeparts) {
                   3585:                 foreach my $id (keys(%typeparts)) {
                   3586:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3587:                         push(@hidden,$id);
                   3588:                     }
                   3589:                 }
                   3590:             }
                   3591:             $prevattempts.=&start_data_table_row().
                   3592:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3593:             if (@hidden) {
                   3594:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3595:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3596:                     my $hide;
                   3597:                     foreach my $id (@hidden) {
                   3598:                         if ($key =~ /^\Q$id\E/) {
                   3599:                             $hide = 1;
                   3600:                             last;
                   3601:                         }
                   3602:                     }
                   3603:                     if ($hide) {
                   3604:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3605:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3606:                             my $value = &format_previous_attempt_value($key,
                   3607:                                              $returnhash{$version.':'.$key});
                   3608:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3609:                         } else {
                   3610:                             $prevattempts.='<td>&nbsp;</td>';
                   3611:                         }
                   3612:                     } else {
                   3613:                         if ($key =~ /\./) {
                   3614:                             my $value = &format_previous_attempt_value($key,
                   3615:                                               $returnhash{$version.':'.$key});
                   3616:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3617:                         } else {
                   3618:                             $prevattempts.='<td>&nbsp;</td>';
                   3619:                         }
                   3620:                     }
                   3621:                 }
                   3622:             } else {
                   3623: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3624:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3625: 		    my $value = &format_previous_attempt_value($key,
                   3626: 			            $returnhash{$version.':'.$key});
                   3627: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3628: 	        }
                   3629:             }
                   3630: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3631: 	 }
1.1       albertel 3632:       }
1.945     raeburn  3633:       my @currhidden = keys(%lasthidden);
1.596     albertel 3634:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3635:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3636:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  3637:           if (%typeparts) {
                   3638:               my $hidden;
                   3639:               foreach my $id (@currhidden) {
                   3640:                   if ($key =~ /^\Q$id\E/) {
                   3641:                       $hidden = 1;
                   3642:                       last;
                   3643:                   }
                   3644:               }
                   3645:               if ($hidden) {
                   3646:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3647:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3648:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3649:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3650:                           $value = &$gradesub($value);
                   3651:                       }
                   3652:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3653:                   } else {
                   3654:                       $prevattempts.='<td>&nbsp;</td>';
                   3655:                   }
                   3656:               } else {
                   3657:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3658:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3659:                       $value = &$gradesub($value);
                   3660:                   }
                   3661:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3662:               }
                   3663:           } else {
                   3664: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3665: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3666:                   $value = &$gradesub($value);
                   3667:               }
                   3668: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3669:           }
1.16      harris41 3670:       }
1.596     albertel 3671:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3672:     } else {
1.596     albertel 3673:       $prevattempts=
                   3674: 	  &start_data_table().&start_data_table_row().
                   3675: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3676: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3677:     }
                   3678:   } else {
1.596     albertel 3679:     $prevattempts=
                   3680: 	  &start_data_table().&start_data_table_row().
                   3681: 	  '<td>'.&mt('No data.').'</td>'.
                   3682: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3683:   }
1.10      albertel 3684: }
                   3685: 
1.581     albertel 3686: sub format_previous_attempt_value {
                   3687:     my ($key,$value) = @_;
1.1011    www      3688:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 3689: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3690:     } elsif (ref($value) eq 'ARRAY') {
                   3691: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  3692:     } elsif ($key =~ /answerstring$/) {
                   3693:         my %answers = &Apache::lonnet::str2hash($value);
                   3694:         my @anskeys = sort(keys(%answers));
                   3695:         if (@anskeys == 1) {
                   3696:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  3697:             if ($answer =~ m{\0}) {
                   3698:                 $answer =~ s{\0}{,}g;
1.988     raeburn  3699:             }
                   3700:             my $tag_internal_answer_name = 'INTERNAL';
                   3701:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   3702:                 $value = $answer; 
                   3703:             } else {
                   3704:                 $value = $anskeys[0].'='.$answer;
                   3705:             }
                   3706:         } else {
                   3707:             foreach my $ans (@anskeys) {
                   3708:                 my $answer = $answers{$ans};
1.1001    raeburn  3709:                 if ($answer =~ m{\0}) {
                   3710:                     $answer =~ s{\0}{,}g;
1.988     raeburn  3711:                 }
                   3712:                 $value .=  $ans.'='.$answer.'<br />';;
                   3713:             } 
                   3714:         }
1.581     albertel 3715:     } else {
                   3716: 	$value = &unescape($value);
                   3717:     }
                   3718:     return $value;
                   3719: }
                   3720: 
                   3721: 
1.107     albertel 3722: sub relative_to_absolute {
                   3723:     my ($url,$output)=@_;
                   3724:     my $parser=HTML::TokeParser->new(\$output);
                   3725:     my $token;
                   3726:     my $thisdir=$url;
                   3727:     my @rlinks=();
                   3728:     while ($token=$parser->get_token) {
                   3729: 	if ($token->[0] eq 'S') {
                   3730: 	    if ($token->[1] eq 'a') {
                   3731: 		if ($token->[2]->{'href'}) {
                   3732: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3733: 		}
                   3734: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3735: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3736: 	    } elsif ($token->[1] eq 'base') {
                   3737: 		$thisdir=$token->[2]->{'href'};
                   3738: 	    }
                   3739: 	}
                   3740:     }
                   3741:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3742:     foreach my $link (@rlinks) {
1.726     raeburn  3743: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3744: 		($link=~/^\//) ||
                   3745: 		($link=~/^javascript:/i) ||
                   3746: 		($link=~/^mailto:/i) ||
                   3747: 		($link=~/^\#/)) {
                   3748: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3749: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3750: 	}
                   3751:     }
                   3752: # -------------------------------------------------- Deal with Applet codebases
                   3753:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3754:     return $output;
                   3755: }
                   3756: 
1.112     bowersj2 3757: =pod
                   3758: 
1.648     raeburn  3759: =item * &get_student_view()
1.112     bowersj2 3760: 
                   3761: show a snapshot of what student was looking at
                   3762: 
                   3763: =cut
                   3764: 
1.10      albertel 3765: sub get_student_view {
1.186     albertel 3766:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3767:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3768:   my (%form);
1.10      albertel 3769:   my @elements=('symb','courseid','domain','username');
                   3770:   foreach my $element (@elements) {
1.186     albertel 3771:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3772:   }
1.186     albertel 3773:   if (defined($moreenv)) {
                   3774:       %form=(%form,%{$moreenv});
                   3775:   }
1.236     albertel 3776:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3777:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3778:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3779:   $userview=~s/\<body[^\>]*\>//gi;
                   3780:   $userview=~s/\<\/body\>//gi;
                   3781:   $userview=~s/\<html\>//gi;
                   3782:   $userview=~s/\<\/html\>//gi;
                   3783:   $userview=~s/\<head\>//gi;
                   3784:   $userview=~s/\<\/head\>//gi;
                   3785:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3786:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3787:   if (wantarray) {
                   3788:      return ($userview,$response);
                   3789:   } else {
                   3790:      return $userview;
                   3791:   }
                   3792: }
                   3793: 
                   3794: sub get_student_view_with_retries {
                   3795:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3796: 
                   3797:     my $ok = 0;                 # True if we got a good response.
                   3798:     my $content;
                   3799:     my $response;
                   3800: 
                   3801:     # Try to get the student_view done. within the retries count:
                   3802:     
                   3803:     do {
                   3804:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3805:          $ok      = $response->is_success;
                   3806:          if (!$ok) {
                   3807:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3808:          }
                   3809:          $retries--;
                   3810:     } while (!$ok && ($retries > 0));
                   3811:     
                   3812:     if (!$ok) {
                   3813:        $content = '';          # On error return an empty content.
                   3814:     }
1.651     www      3815:     if (wantarray) {
                   3816:        return ($content, $response);
                   3817:     } else {
                   3818:        return $content;
                   3819:     }
1.11      albertel 3820: }
                   3821: 
1.112     bowersj2 3822: =pod
                   3823: 
1.648     raeburn  3824: =item * &get_student_answers() 
1.112     bowersj2 3825: 
                   3826: show a snapshot of how student was answering problem
                   3827: 
                   3828: =cut
                   3829: 
1.11      albertel 3830: sub get_student_answers {
1.100     sakharuk 3831:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3832:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3833:   my (%moreenv);
1.11      albertel 3834:   my @elements=('symb','courseid','domain','username');
                   3835:   foreach my $element (@elements) {
1.186     albertel 3836:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3837:   }
1.186     albertel 3838:   $moreenv{'grade_target'}='answer';
                   3839:   %moreenv=(%form,%moreenv);
1.497     raeburn  3840:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3841:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3842:   return $userview;
1.1       albertel 3843: }
1.116     albertel 3844: 
                   3845: =pod
                   3846: 
                   3847: =item * &submlink()
                   3848: 
1.242     albertel 3849: Inputs: $text $uname $udom $symb $target
1.116     albertel 3850: 
                   3851: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3852: 
                   3853: =cut
                   3854: 
                   3855: ###############################################
                   3856: sub submlink {
1.242     albertel 3857:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3858:     if (!($uname && $udom)) {
                   3859: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3860: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3861: 	if (!$symb) { $symb=$cursymb; }
                   3862:     }
1.254     matthew  3863:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3864:     $symb=&escape($symb);
1.960     bisitz   3865:     if ($target) { $target=" target=\"$target\""; }
                   3866:     return
                   3867:         '<a href="/adm/grades?command=submission'.
                   3868:         '&amp;symb='.$symb.
                   3869:         '&amp;student='.$uname.
                   3870:         '&amp;userdom='.$udom.'"'.
                   3871:         $target.'>'.$text.'</a>';
1.242     albertel 3872: }
                   3873: ##############################################
                   3874: 
                   3875: =pod
                   3876: 
                   3877: =item * &pgrdlink()
                   3878: 
                   3879: Inputs: $text $uname $udom $symb $target
                   3880: 
                   3881: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3882: 
                   3883: =cut
                   3884: 
                   3885: ###############################################
                   3886: sub pgrdlink {
                   3887:     my $link=&submlink(@_);
                   3888:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3889:     return $link;
                   3890: }
                   3891: ##############################################
                   3892: 
                   3893: =pod
                   3894: 
                   3895: =item * &pprmlink()
                   3896: 
                   3897: Inputs: $text $uname $udom $symb $target
                   3898: 
                   3899: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3900: student and a specific resource
1.242     albertel 3901: 
                   3902: =cut
                   3903: 
                   3904: ###############################################
                   3905: sub pprmlink {
                   3906:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3907:     if (!($uname && $udom)) {
                   3908: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3909: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3910: 	if (!$symb) { $symb=$cursymb; }
                   3911:     }
1.254     matthew  3912:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3913:     $symb=&escape($symb);
1.242     albertel 3914:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3915:     return '<a href="/adm/parmset?command=set&amp;'.
                   3916: 	'symb='.$symb.'&amp;uname='.$uname.
                   3917: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3918: }
                   3919: ##############################################
1.37      matthew  3920: 
1.112     bowersj2 3921: =pod
                   3922: 
                   3923: =back
                   3924: 
                   3925: =cut
                   3926: 
1.37      matthew  3927: ###############################################
1.51      www      3928: 
                   3929: 
                   3930: sub timehash {
1.687     raeburn  3931:     my ($thistime) = @_;
                   3932:     my $timezone = &Apache::lonlocal::gettimezone();
                   3933:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3934:                      ->set_time_zone($timezone);
                   3935:     my $wday = $dt->day_of_week();
                   3936:     if ($wday == 7) { $wday = 0; }
                   3937:     return ( 'second' => $dt->second(),
                   3938:              'minute' => $dt->minute(),
                   3939:              'hour'   => $dt->hour(),
                   3940:              'day'     => $dt->day_of_month(),
                   3941:              'month'   => $dt->month(),
                   3942:              'year'    => $dt->year(),
                   3943:              'weekday' => $wday,
                   3944:              'dayyear' => $dt->day_of_year(),
                   3945:              'dlsav'   => $dt->is_dst() );
1.51      www      3946: }
                   3947: 
1.370     www      3948: sub utc_string {
                   3949:     my ($date)=@_;
1.371     www      3950:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3951: }
                   3952: 
1.51      www      3953: sub maketime {
                   3954:     my %th=@_;
1.687     raeburn  3955:     my ($epoch_time,$timezone,$dt);
                   3956:     $timezone = &Apache::lonlocal::gettimezone();
                   3957:     eval {
                   3958:         $dt = DateTime->new( year   => $th{'year'},
                   3959:                              month  => $th{'month'},
                   3960:                              day    => $th{'day'},
                   3961:                              hour   => $th{'hour'},
                   3962:                              minute => $th{'minute'},
                   3963:                              second => $th{'second'},
                   3964:                              time_zone => $timezone,
                   3965:                          );
                   3966:     };
                   3967:     if (!$@) {
                   3968:         $epoch_time = $dt->epoch;
                   3969:         if ($epoch_time) {
                   3970:             return $epoch_time;
                   3971:         }
                   3972:     }
1.51      www      3973:     return POSIX::mktime(
                   3974:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3975:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3976: }
                   3977: 
                   3978: #########################################
1.51      www      3979: 
                   3980: sub findallcourses {
1.482     raeburn  3981:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3982:     my %roles;
                   3983:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3984:     my %courses;
1.51      www      3985:     my $now=time;
1.482     raeburn  3986:     if (!defined($uname)) {
                   3987:         $uname = $env{'user.name'};
                   3988:     }
                   3989:     if (!defined($udom)) {
                   3990:         $udom = $env{'user.domain'};
                   3991:     }
                   3992:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.982     raeburn  3993:         my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   3994:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,
                   3995:                                               $extra);
1.482     raeburn  3996:         if (!%roles) {
                   3997:             %roles = (
                   3998:                        cc => 1,
1.907     raeburn  3999:                        co => 1,
1.482     raeburn  4000:                        in => 1,
                   4001:                        ep => 1,
                   4002:                        ta => 1,
                   4003:                        cr => 1,
                   4004:                        st => 1,
                   4005:              );
                   4006:         }
                   4007:         foreach my $entry (keys(%roleshash)) {
                   4008:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4009:             if ($trole =~ /^cr/) { 
                   4010:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4011:             } else {
                   4012:                 next if (!exists($roles{$trole}));
                   4013:             }
                   4014:             if ($tend) {
                   4015:                 next if ($tend < $now);
                   4016:             }
                   4017:             if ($tstart) {
                   4018:                 next if ($tstart > $now);
                   4019:             }
1.1058    raeburn  4020:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4021:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4022:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4023:             if ($secpart eq '') {
                   4024:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4025:                 $sec = 'none';
1.1058    raeburn  4026:                 $value .= $cnum.'/';
1.482     raeburn  4027:             } else {
                   4028:                 $cnum = $cnumpart;
                   4029:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4030:                 $value .= $cnum.'/'.$sec;
                   4031:             }
                   4032:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4033:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4034:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4035:                 }
                   4036:             } else {
                   4037:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4038:             }
1.482     raeburn  4039:         }
                   4040:     } else {
                   4041:         foreach my $key (keys(%env)) {
1.483     albertel 4042: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4043:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4044: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4045: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4046: 	        next if (%roles && !exists($roles{$role}));
                   4047: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4048:                 my $active=1;
                   4049:                 if ($starttime) {
                   4050: 		    if ($now<$starttime) { $active=0; }
                   4051:                 }
                   4052:                 if ($endtime) {
                   4053:                     if ($now>$endtime) { $active=0; }
                   4054:                 }
                   4055:                 if ($active) {
1.1058    raeburn  4056:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4057:                     if ($sec eq '') {
                   4058:                         $sec = 'none';
1.1058    raeburn  4059:                     } else {
                   4060:                         $value .= $sec;
                   4061:                     }
                   4062:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4063:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4064:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4065:                         }
                   4066:                     } else {
                   4067:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4068:                     }
1.474     raeburn  4069:                 }
                   4070:             }
1.51      www      4071:         }
                   4072:     }
1.474     raeburn  4073:     return %courses;
1.51      www      4074: }
1.37      matthew  4075: 
1.54      www      4076: ###############################################
1.474     raeburn  4077: 
                   4078: sub blockcheck {
1.1062    raeburn  4079:     my ($setters,$activity,$uname,$udom,$url) = @_;
1.490     raeburn  4080: 
                   4081:     if (!defined($udom)) {
                   4082:         $udom = $env{'user.domain'};
                   4083:     }
                   4084:     if (!defined($uname)) {
                   4085:         $uname = $env{'user.name'};
                   4086:     }
                   4087: 
                   4088:     # If uname and udom are for a course, check for blocks in the course.
                   4089: 
                   4090:     if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062    raeburn  4091:         my ($startblock,$endblock,$triggerblock) = 
                   4092:             &get_blocks($setters,$activity,$udom,$uname,$url);
                   4093:         return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4094:     }
1.474     raeburn  4095: 
1.502     raeburn  4096:     my $startblock = 0;
                   4097:     my $endblock = 0;
1.1062    raeburn  4098:     my $triggerblock = '';
1.482     raeburn  4099:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4100: 
1.490     raeburn  4101:     # If uname is for a user, and activity is course-specific, i.e.,
                   4102:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4103: 
1.490     raeburn  4104:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4105:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4106:         foreach my $key (keys(%live_courses)) {
                   4107:             if ($key ne $env{'request.course.id'}) {
                   4108:                 delete($live_courses{$key});
                   4109:             }
                   4110:         }
                   4111:     }
                   4112: 
                   4113:     my $otheruser = 0;
                   4114:     my %own_courses;
                   4115:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4116:         # Resource belongs to user other than current user.
                   4117:         $otheruser = 1;
                   4118:         # Gather courses for current user
                   4119:         %own_courses = 
                   4120:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4121:     }
                   4122: 
                   4123:     # Gather active course roles - course coordinator, instructor, 
                   4124:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4125: 
                   4126:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4127:         my ($cdom,$cnum);
                   4128:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4129:             $cdom = $env{'course.'.$course.'.domain'};
                   4130:             $cnum = $env{'course.'.$course.'.num'};
                   4131:         } else {
1.490     raeburn  4132:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4133:         }
                   4134:         my $no_ownblock = 0;
                   4135:         my $no_userblock = 0;
1.533     raeburn  4136:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4137:             # Check if current user has 'evb' priv for this
                   4138:             if (defined($own_courses{$course})) {
                   4139:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4140:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4141:                     if ($sec ne 'none') {
                   4142:                         $checkrole .= '/'.$sec;
                   4143:                     }
                   4144:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4145:                         $no_ownblock = 1;
                   4146:                         last;
                   4147:                     }
                   4148:                 }
                   4149:             }
                   4150:             # if they have 'evb' priv and are currently not playing student
                   4151:             next if (($no_ownblock) &&
                   4152:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4153:         }
1.474     raeburn  4154:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4155:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4156:             if ($sec ne 'none') {
1.482     raeburn  4157:                 $checkrole .= '/'.$sec;
1.474     raeburn  4158:             }
1.490     raeburn  4159:             if ($otheruser) {
                   4160:                 # Resource belongs to user other than current user.
                   4161:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4162:                 my (%allroles,%userroles);
                   4163:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4164:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4165:                         my ($trole,$tdom,$tnum,$tsec);
                   4166:                         if ($entry =~ /^cr/) {
                   4167:                             ($trole,$tdom,$tnum,$tsec) = 
                   4168:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4169:                         } else {
                   4170:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4171:                         }
                   4172:                         my ($spec,$area,$trest);
                   4173:                         $area = '/'.$tdom.'/'.$tnum;
                   4174:                         $trest = $tnum;
                   4175:                         if ($tsec ne '') {
                   4176:                             $area .= '/'.$tsec;
                   4177:                             $trest .= '/'.$tsec;
                   4178:                         }
                   4179:                         $spec = $trole.'.'.$area;
                   4180:                         if ($trole =~ /^cr/) {
                   4181:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4182:                                                               $tdom,$spec,$trest,$area);
                   4183:                         } else {
                   4184:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4185:                                                                 $tdom,$spec,$trest,$area);
                   4186:                         }
                   4187:                     }
                   4188:                     my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   4189:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4190:                         if ($1) {
                   4191:                             $no_userblock = 1;
                   4192:                             last;
                   4193:                         }
1.486     raeburn  4194:                     }
                   4195:                 }
1.490     raeburn  4196:             } else {
                   4197:                 # Resource belongs to current user
                   4198:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4199:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4200:                     $no_ownblock = 1;
                   4201:                     last;
                   4202:                 }
1.474     raeburn  4203:             }
                   4204:         }
                   4205:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4206:         next if (($no_ownblock) &&
1.491     albertel 4207:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4208:         next if ($no_userblock);
1.474     raeburn  4209: 
1.866     kalberla 4210:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4211:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4212:         
1.1062    raeburn  4213:         my ($start,$end,$trigger) = 
                   4214:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4215:         if (($start != 0) && 
                   4216:             (($startblock == 0) || ($startblock > $start))) {
                   4217:             $startblock = $start;
1.1062    raeburn  4218:             if ($trigger ne '') {
                   4219:                 $triggerblock = $trigger;
                   4220:             }
1.502     raeburn  4221:         }
                   4222:         if (($end != 0)  &&
                   4223:             (($endblock == 0) || ($endblock < $end))) {
                   4224:             $endblock = $end;
1.1062    raeburn  4225:             if ($trigger ne '') {
                   4226:                 $triggerblock = $trigger;
                   4227:             }
1.502     raeburn  4228:         }
1.490     raeburn  4229:     }
1.1062    raeburn  4230:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4231: }
                   4232: 
                   4233: sub get_blocks {
1.1062    raeburn  4234:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4235:     my $startblock = 0;
                   4236:     my $endblock = 0;
1.1062    raeburn  4237:     my $triggerblock = '';
1.490     raeburn  4238:     my $course = $cdom.'_'.$cnum;
                   4239:     $setters->{$course} = {};
                   4240:     $setters->{$course}{'staff'} = [];
                   4241:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4242:     $setters->{$course}{'triggers'} = [];
                   4243:     my (@blockers,%triggered);
                   4244:     my $now = time;
                   4245:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4246:     if ($activity eq 'docs') {
                   4247:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4248:         foreach my $block (@blockers) {
                   4249:             if ($block =~ /^firstaccess____(.+)$/) {
                   4250:                 my $item = $1;
                   4251:                 my $type = 'map';
                   4252:                 my $timersymb = $item;
                   4253:                 if ($item eq 'course') {
                   4254:                     $type = 'course';
                   4255:                 } elsif ($item =~ /___\d+___/) {
                   4256:                     $type = 'resource';
                   4257:                 } else {
                   4258:                     $timersymb = &Apache::lonnet::symbread($item);
                   4259:                 }
                   4260:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4261:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4262:                 $triggered{$block} = {
                   4263:                                        start => $start,
                   4264:                                        end   => $end,
                   4265:                                        type  => $type,
                   4266:                                      };
                   4267:             }
                   4268:         }
                   4269:     } else {
                   4270:         foreach my $block (keys(%commblocks)) {
                   4271:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4272:                 my ($start,$end) = ($1,$2);
                   4273:                 if ($start <= time && $end >= time) {
                   4274:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4275:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4276:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4277:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4278:                                     push(@blockers,$block);
                   4279:                                 }
                   4280:                             }
                   4281:                         }
                   4282:                     }
                   4283:                 }
                   4284:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4285:                 my $item = $1;
                   4286:                 my $timersymb = $item; 
                   4287:                 my $type = 'map';
                   4288:                 if ($item eq 'course') {
                   4289:                     $type = 'course';
                   4290:                 } elsif ($item =~ /___\d+___/) {
                   4291:                     $type = 'resource';
                   4292:                 } else {
                   4293:                     $timersymb = &Apache::lonnet::symbread($item);
                   4294:                 }
                   4295:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4296:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4297:                 if ($start && $end) {
                   4298:                     if (($start <= time) && ($end >= time)) {
                   4299:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4300:                             push(@blockers,$block);
                   4301:                             $triggered{$block} = {
                   4302:                                                    start => $start,
                   4303:                                                    end   => $end,
                   4304:                                                    type  => $type,
                   4305:                                                  };
                   4306:                         }
                   4307:                     }
1.490     raeburn  4308:                 }
1.1062    raeburn  4309:             }
                   4310:         }
                   4311:     }
                   4312:     foreach my $blocker (@blockers) {
                   4313:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4314:             &parse_block_record($commblocks{$blocker});
                   4315:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4316:         my ($start,$end,$triggertype);
                   4317:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4318:             ($start,$end) = ($1,$2);
                   4319:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4320:             $start = $triggered{$blocker}{'start'};
                   4321:             $end = $triggered{$blocker}{'end'};
                   4322:             $triggertype = $triggered{$blocker}{'type'};
                   4323:         }
                   4324:         if ($start) {
                   4325:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4326:             if ($triggertype) {
                   4327:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4328:             } else {
                   4329:                 push(@{$$setters{$course}{'triggers'}},0);
                   4330:             }
                   4331:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4332:                 $startblock = $start;
                   4333:                 if ($triggertype) {
                   4334:                     $triggerblock = $blocker;
1.474     raeburn  4335:                 }
                   4336:             }
1.1062    raeburn  4337:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4338:                $endblock = $end;
                   4339:                if ($triggertype) {
                   4340:                    $triggerblock = $blocker;
                   4341:                }
                   4342:             }
1.474     raeburn  4343:         }
                   4344:     }
1.1062    raeburn  4345:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4346: }
                   4347: 
                   4348: sub parse_block_record {
                   4349:     my ($record) = @_;
                   4350:     my ($setuname,$setudom,$title,$blocks);
                   4351:     if (ref($record) eq 'HASH') {
                   4352:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4353:         $title = &unescape($record->{'event'});
                   4354:         $blocks = $record->{'blocks'};
                   4355:     } else {
                   4356:         my @data = split(/:/,$record,3);
                   4357:         if (scalar(@data) eq 2) {
                   4358:             $title = $data[1];
                   4359:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4360:         } else {
                   4361:             ($setuname,$setudom,$title) = @data;
                   4362:         }
                   4363:         $blocks = { 'com' => 'on' };
                   4364:     }
                   4365:     return ($setuname,$setudom,$title,$blocks);
                   4366: }
                   4367: 
1.854     kalberla 4368: sub blocking_status {
1.1062    raeburn  4369:     my ($activity,$uname,$udom,$url) = @_;
1.1061    raeburn  4370:     my %setters;
1.890     droeschl 4371: 
1.1061    raeburn  4372: # check for active blocking
1.1062    raeburn  4373:     my ($startblock,$endblock,$triggerblock) = 
                   4374:         &blockcheck(\%setters,$activity,$uname,$udom,$url);
                   4375:     my $blocked = 0;
                   4376:     if ($startblock && $endblock) {
                   4377:         $blocked = 1;
                   4378:     }
1.890     droeschl 4379: 
1.1061    raeburn  4380: # caller just wants to know whether a block is active
                   4381:     if (!wantarray) { return $blocked; }
                   4382: 
                   4383: # build a link to a popup window containing the details
                   4384:     my $querystring  = "?activity=$activity";
                   4385: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062    raeburn  4386:     if ($activity eq 'port') {
                   4387:         $querystring .= "&amp;udom=$udom"      if $udom;
                   4388:         $querystring .= "&amp;uname=$uname"    if $uname;
                   4389:     } elsif ($activity eq 'docs') {
                   4390:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4391:     }
1.1061    raeburn  4392: 
                   4393:     my $output .= <<'END_MYBLOCK';
                   4394: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4395:     var options = "width=" + w + ",height=" + h + ",";
                   4396:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4397:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4398:     var newWin = window.open(url, wdwName, options);
                   4399:     newWin.focus();
                   4400: }
1.890     droeschl 4401: END_MYBLOCK
1.854     kalberla 4402: 
1.1061    raeburn  4403:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4404:   
1.1061    raeburn  4405:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  4406:     my $text = &mt('Communication Blocked');
                   4407:     if ($activity eq 'docs') {
                   4408:         $text = &mt('Content Access Blocked');
1.1063  ! raeburn  4409:     } elsif ($activity eq 'printout') {
        !          4410:         $text = &mt('Printing Blocked');
1.1062    raeburn  4411:     }
1.1061    raeburn  4412:     $output .= <<"END_BLOCK";
1.867     kalberla 4413: <div class='LC_comblock'>
1.869     kalberla 4414:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4415:   title='$text'>
                   4416:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4417:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4418:   title='$text'>$text</a>
1.867     kalberla 4419: </div>
                   4420: 
                   4421: END_BLOCK
1.474     raeburn  4422: 
1.1061    raeburn  4423:     return ($blocked, $output);
1.854     kalberla 4424: }
1.490     raeburn  4425: 
1.60      matthew  4426: ###############################################
                   4427: 
1.682     raeburn  4428: sub check_ip_acc {
                   4429:     my ($acc)=@_;
                   4430:     &Apache::lonxml::debug("acc is $acc");
                   4431:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4432:         return 1;
                   4433:     }
                   4434:     my $allowed=0;
                   4435:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4436: 
                   4437:     my $name;
                   4438:     foreach my $pattern (split(',',$acc)) {
                   4439:         $pattern =~ s/^\s*//;
                   4440:         $pattern =~ s/\s*$//;
                   4441:         if ($pattern =~ /\*$/) {
                   4442:             #35.8.*
                   4443:             $pattern=~s/\*//;
                   4444:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4445:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4446:             #35.8.3.[34-56]
                   4447:             my $low=$2;
                   4448:             my $high=$3;
                   4449:             $pattern=$1;
                   4450:             if ($ip =~ /^\Q$pattern\E/) {
                   4451:                 my $last=(split(/\./,$ip))[3];
                   4452:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4453:             }
                   4454:         } elsif ($pattern =~ /^\*/) {
                   4455:             #*.msu.edu
                   4456:             $pattern=~s/\*//;
                   4457:             if (!defined($name)) {
                   4458:                 use Socket;
                   4459:                 my $netaddr=inet_aton($ip);
                   4460:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4461:             }
                   4462:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4463:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4464:             #127.0.0.1
                   4465:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4466:         } else {
                   4467:             #some.name.com
                   4468:             if (!defined($name)) {
                   4469:                 use Socket;
                   4470:                 my $netaddr=inet_aton($ip);
                   4471:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4472:             }
                   4473:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4474:         }
                   4475:         if ($allowed) { last; }
                   4476:     }
                   4477:     return $allowed;
                   4478: }
                   4479: 
                   4480: ###############################################
                   4481: 
1.60      matthew  4482: =pod
                   4483: 
1.112     bowersj2 4484: =head1 Domain Template Functions
                   4485: 
                   4486: =over 4
                   4487: 
                   4488: =item * &determinedomain()
1.60      matthew  4489: 
                   4490: Inputs: $domain (usually will be undef)
                   4491: 
1.63      www      4492: Returns: Determines which domain should be used for designs
1.60      matthew  4493: 
                   4494: =cut
1.54      www      4495: 
1.60      matthew  4496: ###############################################
1.63      www      4497: sub determinedomain {
                   4498:     my $domain=shift;
1.531     albertel 4499:     if (! $domain) {
1.60      matthew  4500:         # Determine domain if we have not been given one
1.893     raeburn  4501:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4502:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4503:         if ($env{'request.role.domain'}) { 
                   4504:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4505:         }
                   4506:     }
1.63      www      4507:     return $domain;
                   4508: }
                   4509: ###############################################
1.517     raeburn  4510: 
1.518     albertel 4511: sub devalidate_domconfig_cache {
                   4512:     my ($udom)=@_;
                   4513:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4514: }
                   4515: 
                   4516: # ---------------------- Get domain configuration for a domain
                   4517: sub get_domainconf {
                   4518:     my ($udom) = @_;
                   4519:     my $cachetime=1800;
                   4520:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4521:     if (defined($cached)) { return %{$result}; }
                   4522: 
                   4523:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4524: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4525:     my (%designhash,%legacy);
1.518     albertel 4526:     if (keys(%domconfig) > 0) {
                   4527:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4528:             if (keys(%{$domconfig{'login'}})) {
                   4529:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4530:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4531:                         if ($key eq 'loginvia') {
                   4532:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4533:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4534:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4535:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4536:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4537:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4538:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4539: 
                   4540:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4541:                                             } else {
1.1013    raeburn  4542:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4543:                                             }
                   4544:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4545:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4546:                                             }
1.946     raeburn  4547:                                         }
                   4548:                                     }
                   4549:                                 }
                   4550:                             }
                   4551:                         } else {
                   4552:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4553:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4554:                                     $domconfig{'login'}{$key}{$img};
                   4555:                             }
1.699     raeburn  4556:                         }
                   4557:                     } else {
                   4558:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4559:                     }
1.632     raeburn  4560:                 }
                   4561:             } else {
                   4562:                 $legacy{'login'} = 1;
1.518     albertel 4563:             }
1.632     raeburn  4564:         } else {
                   4565:             $legacy{'login'} = 1;
1.518     albertel 4566:         }
                   4567:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4568:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4569:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4570:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4571:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4572:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4573:                         }
1.518     albertel 4574:                     }
                   4575:                 }
1.632     raeburn  4576:             } else {
                   4577:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4578:             }
1.632     raeburn  4579:         } else {
                   4580:             $legacy{'rolecolors'} = 1;
1.518     albertel 4581:         }
1.948     raeburn  4582:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4583:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4584:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4585:             }
                   4586:         }
1.632     raeburn  4587:         if (keys(%legacy) > 0) {
                   4588:             my %legacyhash = &get_legacy_domconf($udom);
                   4589:             foreach my $item (keys(%legacyhash)) {
                   4590:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4591:                     if ($legacy{'login'}) { 
                   4592:                         $designhash{$item} = $legacyhash{$item};
                   4593:                     }
                   4594:                 } else {
                   4595:                     if ($legacy{'rolecolors'}) {
                   4596:                         $designhash{$item} = $legacyhash{$item};
                   4597:                     }
1.518     albertel 4598:                 }
                   4599:             }
                   4600:         }
1.632     raeburn  4601:     } else {
                   4602:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4603:     }
                   4604:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4605: 				  $cachetime);
                   4606:     return %designhash;
                   4607: }
                   4608: 
1.632     raeburn  4609: sub get_legacy_domconf {
                   4610:     my ($udom) = @_;
                   4611:     my %legacyhash;
                   4612:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4613:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4614:     if (-e $designfile) {
                   4615:         if ( open (my $fh,"<$designfile") ) {
                   4616:             while (my $line = <$fh>) {
                   4617:                 next if ($line =~ /^\#/);
                   4618:                 chomp($line);
                   4619:                 my ($key,$val)=(split(/\=/,$line));
                   4620:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4621:             }
                   4622:             close($fh);
                   4623:         }
                   4624:     }
1.1026    raeburn  4625:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4626:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4627:     }
                   4628:     return %legacyhash;
                   4629: }
                   4630: 
1.63      www      4631: =pod
                   4632: 
1.112     bowersj2 4633: =item * &domainlogo()
1.63      www      4634: 
                   4635: Inputs: $domain (usually will be undef)
                   4636: 
                   4637: Returns: A link to a domain logo, if the domain logo exists.
                   4638: If the domain logo does not exist, a description of the domain.
                   4639: 
                   4640: =cut
1.112     bowersj2 4641: 
1.63      www      4642: ###############################################
                   4643: sub domainlogo {
1.517     raeburn  4644:     my $domain = &determinedomain(shift);
1.518     albertel 4645:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4646:     # See if there is a logo
                   4647:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4648:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4649:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4650: 	    if ($imgsrc =~ m{^/res/}) {
                   4651: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4652: 		&Apache::lonnet::repcopy($local_name);
                   4653: 	    }
                   4654: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4655:         } 
                   4656:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4657:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4658:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4659:     } else {
1.60      matthew  4660:         return '';
1.59      www      4661:     }
                   4662: }
1.63      www      4663: ##############################################
                   4664: 
                   4665: =pod
                   4666: 
1.112     bowersj2 4667: =item * &designparm()
1.63      www      4668: 
                   4669: Inputs: $which parameter; $domain (usually will be undef)
                   4670: 
                   4671: Returns: value of designparamter $which
                   4672: 
                   4673: =cut
1.112     bowersj2 4674: 
1.397     albertel 4675: 
1.400     albertel 4676: ##############################################
1.397     albertel 4677: sub designparm {
                   4678:     my ($which,$domain)=@_;
                   4679:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4680:         return $env{'environment.color.'.$which};
1.96      www      4681:     }
1.63      www      4682:     $domain=&determinedomain($domain);
1.1016    raeburn  4683:     my %domdesign;
                   4684:     unless ($domain eq 'public') {
                   4685:         %domdesign = &get_domainconf($domain);
                   4686:     }
1.520     raeburn  4687:     my $output;
1.517     raeburn  4688:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4689:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4690:     } else {
1.520     raeburn  4691:         $output = $defaultdesign{$which};
                   4692:     }
                   4693:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4694:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4695:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4696:             if ($output =~ m{^/res/}) {
                   4697:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4698:                 &Apache::lonnet::repcopy($local_name);
                   4699:             }
1.520     raeburn  4700:             $output = &lonhttpdurl($output);
                   4701:         }
1.63      www      4702:     }
1.520     raeburn  4703:     return $output;
1.63      www      4704: }
1.59      www      4705: 
1.822     bisitz   4706: ##############################################
                   4707: =pod
                   4708: 
1.832     bisitz   4709: =item * &authorspace()
                   4710: 
1.1028    raeburn  4711: Inputs: $url (usually will be undef).
1.832     bisitz   4712: 
1.1028    raeburn  4713: Returns: Path to Construction Space containing the resource or 
                   4714:          directory being viewed (or for which action is being taken). 
                   4715:          If $url is provided, and begins /priv/<domain>/<uname>
                   4716:          the path will be that portion of the $context argument.
                   4717:          Otherwise the path will be for the author space of the current
                   4718:          user when the current role is author, or for that of the 
                   4719:          co-author/assistant co-author space when the current role 
                   4720:          is co-author or assistant co-author.
1.832     bisitz   4721: 
                   4722: =cut
                   4723: 
                   4724: sub authorspace {
1.1028    raeburn  4725:     my ($url) = @_;
                   4726:     if ($url ne '') {
                   4727:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4728:            return $1;
                   4729:         }
                   4730:     }
1.832     bisitz   4731:     my $caname = '';
1.1024    www      4732:     my $cadom = '';
1.1028    raeburn  4733:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4734:         ($cadom,$caname) =
1.832     bisitz   4735:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4736:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4737:         $caname = $env{'user.name'};
1.1024    www      4738:         $cadom = $env{'user.domain'};
1.832     bisitz   4739:     }
1.1028    raeburn  4740:     if (($caname ne '') && ($cadom ne '')) {
                   4741:         return "/priv/$cadom/$caname/";
                   4742:     }
                   4743:     return;
1.832     bisitz   4744: }
                   4745: 
                   4746: ##############################################
                   4747: =pod
                   4748: 
1.822     bisitz   4749: =item * &head_subbox()
                   4750: 
                   4751: Inputs: $content (contains HTML code with page functions, etc.)
                   4752: 
                   4753: Returns: HTML div with $content
                   4754:          To be included in page header
                   4755: 
                   4756: =cut
                   4757: 
                   4758: sub head_subbox {
                   4759:     my ($content)=@_;
                   4760:     my $output =
1.993     raeburn  4761:         '<div class="LC_head_subbox">'
1.822     bisitz   4762:        .$content
                   4763:        .'</div>'
                   4764: }
                   4765: 
                   4766: ##############################################
                   4767: =pod
                   4768: 
                   4769: =item * &CSTR_pageheader()
                   4770: 
1.1026    raeburn  4771: Input: (optional) filename from which breadcrumb trail is built.
                   4772:        In most cases no input as needed, as $env{'request.filename'}
                   4773:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4774: 
                   4775: Returns: HTML div with CSTR path and recent box
                   4776:          To be included on Construction Space pages
                   4777: 
                   4778: =cut
                   4779: 
                   4780: sub CSTR_pageheader {
1.1026    raeburn  4781:     my ($trailfile) = @_;
                   4782:     if ($trailfile eq '') {
                   4783:         $trailfile = $env{'request.filename'};
                   4784:     }
                   4785: 
                   4786: # this is for resources; directories have customtitle, and crumbs
                   4787: # and select recent are created in lonpubdir.pm
                   4788: 
                   4789:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      4790:     my ($udom,$uname,$thisdisfn)=
1.1026    raeburn  4791:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
                   4792:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   4793:     $formaction =~ s{/+}{/}g;
1.822     bisitz   4794: 
                   4795:     my $parentpath = '';
                   4796:     my $lastitem = '';
                   4797:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4798:         $parentpath = $1;
                   4799:         $lastitem = $2;
                   4800:     } else {
                   4801:         $lastitem = $thisdisfn;
                   4802:     }
1.921     bisitz   4803: 
                   4804:     my $output =
1.822     bisitz   4805:          '<div>'
                   4806:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4807:         .'<b>'.&mt('Construction Space:').'</b> '
                   4808:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4809:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      4810:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   4811: 
                   4812:     if ($lastitem) {
                   4813:         $output .=
                   4814:              '<span class="LC_filename">'
                   4815:             .$lastitem
                   4816:             .'</span>';
                   4817:     }
                   4818:     $output .=
                   4819:          '<br />'
1.822     bisitz   4820:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4821:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4822:         .'</form>'
                   4823:         .&Apache::lonmenu::constspaceform()
                   4824:         .'</div>';
1.921     bisitz   4825: 
                   4826:     return $output;
1.822     bisitz   4827: }
                   4828: 
1.60      matthew  4829: ###############################################
                   4830: ###############################################
                   4831: 
                   4832: =pod
                   4833: 
1.112     bowersj2 4834: =back
                   4835: 
1.549     albertel 4836: =head1 HTML Helpers
1.112     bowersj2 4837: 
                   4838: =over 4
                   4839: 
                   4840: =item * &bodytag()
1.60      matthew  4841: 
                   4842: Returns a uniform header for LON-CAPA web pages.
                   4843: 
                   4844: Inputs: 
                   4845: 
1.112     bowersj2 4846: =over 4
                   4847: 
                   4848: =item * $title, A title to be displayed on the page.
                   4849: 
                   4850: =item * $function, the current role (can be undef).
                   4851: 
                   4852: =item * $addentries, extra parameters for the <body> tag.
                   4853: 
                   4854: =item * $bodyonly, if defined, only return the <body> tag.
                   4855: 
                   4856: =item * $domain, if defined, force a given domain.
                   4857: 
                   4858: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4859:             text interface only)
1.60      matthew  4860: 
1.814     bisitz   4861: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4862:                      navigational links
1.317     albertel 4863: 
1.338     albertel 4864: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4865: 
1.460     albertel 4866: =item * $args, optional argument valid values are
                   4867:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4868:             inherit_jsmath -> when creating popup window in a page,
                   4869:                               should it have jsmath forced on by the
                   4870:                               current page
1.460     albertel 4871: 
1.112     bowersj2 4872: =back
                   4873: 
1.60      matthew  4874: Returns: A uniform header for LON-CAPA web pages.  
                   4875: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4876: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4877: other decorations will be returned.
                   4878: 
                   4879: =cut
                   4880: 
1.54      www      4881: sub bodytag {
1.831     bisitz   4882:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4883:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4884: 
1.954     raeburn  4885:     my $public;
                   4886:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4887:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4888:         $public = 1;
                   4889:     }
1.460     albertel 4890:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4891: 
1.183     matthew  4892:     $function = &get_users_function() if (!$function);
1.339     albertel 4893:     my $img =    &designparm($function.'.img',$domain);
                   4894:     my $font =   &designparm($function.'.font',$domain);
                   4895:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4896: 
1.803     bisitz   4897:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4898: 		   'bgcolor' => $pgbg,
1.339     albertel 4899: 		   'text'    => $font,
                   4900:                    'alink'   => &designparm($function.'.alink',$domain),
                   4901: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4902: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4903:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4904: 
1.63      www      4905:  # role and realm
1.378     raeburn  4906:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4907:     if ($role  eq 'ca') {
1.479     albertel 4908:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4909:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4910:     } 
1.55      www      4911: # realm
1.258     albertel 4912:     if ($env{'request.course.id'}) {
1.378     raeburn  4913:         if ($env{'request.role'} !~ /^cr/) {
                   4914:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4915:         }
1.898     raeburn  4916:         if ($env{'request.course.sec'}) {
                   4917:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4918:         }   
1.359     albertel 4919: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4920:     } else {
                   4921:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4922:     }
1.433     albertel 4923: 
1.359     albertel 4924:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 4925: 
1.438     albertel 4926:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4927: 
1.101     www      4928: # construct main body tag
1.359     albertel 4929:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4930: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4931: 
1.530     albertel 4932:     if ($bodyonly) {
1.60      matthew  4933:         return $bodytag;
1.798     tempelho 4934:     } 
1.359     albertel 4935: 
1.410     albertel 4936:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  4937:     if ($public) {
1.433     albertel 4938: 	undef($role);
1.434     albertel 4939:     } else {
                   4940: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4941:     }
1.359     albertel 4942:     
1.762     bisitz   4943:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4944:     #
                   4945:     # Extra info if you are the DC
                   4946:     my $dc_info = '';
                   4947:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4948:                         $env{'course.'.$env{'request.course.id'}.
                   4949:                                  '.domain'}.'/'})) {
                   4950:         my $cid = $env{'request.course.id'};
1.917     raeburn  4951:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4952:         $dc_info =~ s/\s+$//;
1.359     albertel 4953:     }
                   4954: 
1.898     raeburn  4955:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4956:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4957: 
1.916     droeschl 4958:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4959:             return $bodytag; 
                   4960:         } 
1.903     droeschl 4961: 
                   4962:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4963: 
                   4964:         #    if ($env{'request.state'} eq 'construct') {
                   4965:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4966:         #    }
                   4967: 
1.359     albertel 4968: 
                   4969: 
1.916     droeschl 4970:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4971:              if ($dc_info) {
                   4972:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4973:              }
1.916     droeschl 4974:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4975:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4976:             return $bodytag;
                   4977:         }
1.894     droeschl 4978: 
1.927     raeburn  4979:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   4980:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4981:         }
1.916     droeschl 4982: 
1.903     droeschl 4983:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4984:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4985: 
1.903     droeschl 4986:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4987: 
1.917     raeburn  4988:         if ($dc_info) {
                   4989:             $dc_info = &dc_courseid_toggle($dc_info);
                   4990:         }
                   4991:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4992: 
1.903     droeschl 4993:         #don't show menus for public users
1.954     raeburn  4994:         if (!$public){
1.903     droeschl 4995:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4996:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  4997:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   4998:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 4999:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5000:                                 $args->{'bread_crumbs'});
                   5001:             } elsif ($forcereg) { 
                   5002:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   5003:             }
1.903     droeschl 5004:         }else{
                   5005:             # this is to seperate menu from content when there's no secondary
                   5006:             # menu. Especially needed for public accessible ressources.
                   5007:             $bodytag .= '<hr style="clear:both" />';
                   5008:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5009:         }
1.903     droeschl 5010: 
1.235     raeburn  5011:         return $bodytag;
1.182     matthew  5012: }
                   5013: 
1.917     raeburn  5014: sub dc_courseid_toggle {
                   5015:     my ($dc_info) = @_;
1.980     raeburn  5016:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.917     raeburn  5017:            '<a href="javascript:showCourseID();">'.
                   5018:            &mt('(More ...)').'</a></span>'.
                   5019:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5020: }
                   5021: 
1.330     albertel 5022: sub make_attr_string {
                   5023:     my ($register,$attr_ref) = @_;
                   5024: 
                   5025:     if ($attr_ref && !ref($attr_ref)) {
                   5026: 	die("addentries Must be a hash ref ".
                   5027: 	    join(':',caller(1))." ".
                   5028: 	    join(':',caller(0))." ");
                   5029:     }
                   5030: 
                   5031:     if ($register) {
1.339     albertel 5032: 	my ($on_load,$on_unload);
                   5033: 	foreach my $key (keys(%{$attr_ref})) {
                   5034: 	    if      (lc($key) eq 'onload') {
                   5035: 		$on_load.=$attr_ref->{$key}.';';
                   5036: 		delete($attr_ref->{$key});
                   5037: 
                   5038: 	    } elsif (lc($key) eq 'onunload') {
                   5039: 		$on_unload.=$attr_ref->{$key}.';';
                   5040: 		delete($attr_ref->{$key});
                   5041: 	    }
                   5042: 	}
1.953     droeschl 5043: 	$attr_ref->{'onload'}  = $on_load;
                   5044: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5045:     }
1.339     albertel 5046: 
1.330     albertel 5047:     my $attr_string;
                   5048:     foreach my $attr (keys(%$attr_ref)) {
                   5049: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5050:     }
                   5051:     return $attr_string;
                   5052: }
                   5053: 
                   5054: 
1.182     matthew  5055: ###############################################
1.251     albertel 5056: ###############################################
                   5057: 
                   5058: =pod
                   5059: 
                   5060: =item * &endbodytag()
                   5061: 
                   5062: Returns a uniform footer for LON-CAPA web pages.
                   5063: 
1.635     raeburn  5064: Inputs: 1 - optional reference to an args hash
                   5065: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5066: a 'Continue' link is not displayed if the page contains an
                   5067: internal redirect in the <head></head> section,
                   5068: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5069: 
                   5070: =cut
                   5071: 
                   5072: sub endbodytag {
1.635     raeburn  5073:     my ($args) = @_;
1.251     albertel 5074:     my $endbodytag='</body>';
1.269     albertel 5075:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5076:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5077:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5078: 	    $endbodytag=
                   5079: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5080: 	        &mt('Continue').'</a>'.
                   5081: 	        $endbodytag;
                   5082:         }
1.315     albertel 5083:     }
1.251     albertel 5084:     return $endbodytag;
                   5085: }
                   5086: 
1.352     albertel 5087: =pod
                   5088: 
                   5089: =item * &standard_css()
                   5090: 
                   5091: Returns a style sheet
                   5092: 
                   5093: Inputs: (all optional)
                   5094:             domain         -> force to color decorate a page for a specific
                   5095:                                domain
                   5096:             function       -> force usage of a specific rolish color scheme
                   5097:             bgcolor        -> override the default page bgcolor
                   5098: 
                   5099: =cut
                   5100: 
1.343     albertel 5101: sub standard_css {
1.345     albertel 5102:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5103:     $function  = &get_users_function() if (!$function);
                   5104:     my $img    = &designparm($function.'.img',   $domain);
                   5105:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5106:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5107:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5108: #second colour for later usage
1.345     albertel 5109:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5110:     my $pgbg_or_bgcolor =
                   5111: 	         $bgcolor ||
1.352     albertel 5112: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5113:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5114:     my $alink  = &designparm($function.'.alink', $domain);
                   5115:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5116:     my $link   = &designparm($function.'.link',  $domain);
                   5117: 
1.602     albertel 5118:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5119:     my $mono                 = 'monospace';
1.850     bisitz   5120:     my $data_table_head      = $sidebg;
                   5121:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5122:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5123:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5124:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5125:     my $mail_new             = '#FFBB77';
                   5126:     my $mail_new_hover       = '#DD9955';
                   5127:     my $mail_read            = '#BBBB77';
                   5128:     my $mail_read_hover      = '#999944';
                   5129:     my $mail_replied         = '#AAAA88';
                   5130:     my $mail_replied_hover   = '#888855';
                   5131:     my $mail_other           = '#99BBBB';
                   5132:     my $mail_other_hover     = '#669999';
1.391     albertel 5133:     my $table_header         = '#DDDDDD';
1.489     raeburn  5134:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5135:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5136:     my $button_hover         = '#BF2317';
1.392     albertel 5137: 
1.608     albertel 5138:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5139:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5140:                                              : '0 3px 0 4px';
1.448     albertel 5141: 
1.523     albertel 5142: 
1.343     albertel 5143:     return <<END;
1.947     droeschl 5144: 
                   5145: /* needed for iframe to allow 100% height in FF */
                   5146: body, html { 
                   5147:     margin: 0;
                   5148:     padding: 0 0.5%;
                   5149:     height: 99%; /* to avoid scrollbars */
                   5150: }
                   5151: 
1.795     www      5152: body {
1.911     bisitz   5153:   font-family: $sans;
                   5154:   line-height:130%;
                   5155:   font-size:0.83em;
                   5156:   color:$font;
1.795     www      5157: }
                   5158: 
1.959     onken    5159: a:focus,
                   5160: a:focus img {
1.795     www      5161:   color: red;
                   5162: }
1.698     harmsja  5163: 
1.911     bisitz   5164: form, .inline {
                   5165:   display: inline;
1.795     www      5166: }
1.721     harmsja  5167: 
1.795     www      5168: .LC_right {
1.911     bisitz   5169:   text-align:right;
1.795     www      5170: }
                   5171: 
                   5172: .LC_middle {
1.911     bisitz   5173:   vertical-align:middle;
1.795     www      5174: }
1.721     harmsja  5175: 
1.911     bisitz   5176: .LC_400Box {
                   5177:   width:400px;
                   5178: }
1.721     harmsja  5179: 
1.947     droeschl 5180: .LC_iframecontainer {
                   5181:     width: 98%;
                   5182:     margin: 0;
                   5183:     position: fixed;
                   5184:     top: 8.5em;
                   5185:     bottom: 0;
                   5186: }
                   5187: 
                   5188: .LC_iframecontainer iframe{
                   5189:     border: none;
                   5190:     width: 100%;
                   5191:     height: 100%;
                   5192: }
                   5193: 
1.778     bisitz   5194: .LC_filename {
                   5195:   font-family: $mono;
                   5196:   white-space:pre;
1.921     bisitz   5197:   font-size: 120%;
1.778     bisitz   5198: }
                   5199: 
                   5200: .LC_fileicon {
                   5201:   border: none;
                   5202:   height: 1.3em;
                   5203:   vertical-align: text-bottom;
                   5204:   margin-right: 0.3em;
                   5205:   text-decoration:none;
                   5206: }
                   5207: 
1.1008    www      5208: .LC_setting {
                   5209:   text-decoration:underline;
                   5210: }
                   5211: 
1.350     albertel 5212: .LC_error {
                   5213:   color: red;
                   5214:   font-size: larger;
                   5215: }
1.795     www      5216: 
1.457     albertel 5217: .LC_warning,
                   5218: .LC_diff_removed {
1.733     bisitz   5219:   color: red;
1.394     albertel 5220: }
1.532     albertel 5221: 
                   5222: .LC_info,
1.457     albertel 5223: .LC_success,
                   5224: .LC_diff_added {
1.350     albertel 5225:   color: green;
                   5226: }
1.795     www      5227: 
1.802     bisitz   5228: div.LC_confirm_box {
                   5229:   background-color: #FAFAFA;
                   5230:   border: 1px solid $lg_border_color;
                   5231:   margin-right: 0;
                   5232:   padding: 5px;
                   5233: }
                   5234: 
                   5235: div.LC_confirm_box .LC_error img,
                   5236: div.LC_confirm_box .LC_success img {
                   5237:   vertical-align: middle;
                   5238: }
                   5239: 
1.440     albertel 5240: .LC_icon {
1.771     droeschl 5241:   border: none;
1.790     droeschl 5242:   vertical-align: middle;
1.771     droeschl 5243: }
                   5244: 
1.543     albertel 5245: .LC_docs_spacer {
                   5246:   width: 25px;
                   5247:   height: 1px;
1.771     droeschl 5248:   border: none;
1.543     albertel 5249: }
1.346     albertel 5250: 
1.532     albertel 5251: .LC_internal_info {
1.735     bisitz   5252:   color: #999999;
1.532     albertel 5253: }
                   5254: 
1.794     www      5255: .LC_discussion {
1.1050    www      5256:   background: $data_table_dark;
1.911     bisitz   5257:   border: 1px solid black;
                   5258:   margin: 2px;
1.794     www      5259: }
                   5260: 
                   5261: .LC_disc_action_left {
1.1050    www      5262:   background: $sidebg;
1.911     bisitz   5263:   text-align: left;
1.1050    www      5264:   padding: 4px;
                   5265:   margin: 2px;
1.794     www      5266: }
                   5267: 
                   5268: .LC_disc_action_right {
1.1050    www      5269:   background: $sidebg;
1.911     bisitz   5270:   text-align: right;
1.1050    www      5271:   padding: 4px;
                   5272:   margin: 2px;
1.794     www      5273: }
                   5274: 
                   5275: .LC_disc_new_item {
1.911     bisitz   5276:   background: white;
                   5277:   border: 2px solid red;
1.1050    www      5278:   margin: 4px;
                   5279:   padding: 4px;
1.794     www      5280: }
                   5281: 
                   5282: .LC_disc_old_item {
1.911     bisitz   5283:   background: white;
1.1050    www      5284:   margin: 4px;
                   5285:   padding: 4px;
1.794     www      5286: }
                   5287: 
1.458     albertel 5288: table.LC_pastsubmission {
                   5289:   border: 1px solid black;
                   5290:   margin: 2px;
                   5291: }
                   5292: 
1.924     bisitz   5293: table#LC_menubuttons {
1.345     albertel 5294:   width: 100%;
                   5295:   background: $pgbg;
1.392     albertel 5296:   border: 2px;
1.402     albertel 5297:   border-collapse: separate;
1.803     bisitz   5298:   padding: 0;
1.345     albertel 5299: }
1.392     albertel 5300: 
1.801     tempelho 5301: table#LC_title_bar a {
                   5302:   color: $fontmenu;
                   5303: }
1.836     bisitz   5304: 
1.807     droeschl 5305: table#LC_title_bar {
1.819     tempelho 5306:   clear: both;
1.836     bisitz   5307:   display: none;
1.807     droeschl 5308: }
                   5309: 
1.795     www      5310: table#LC_title_bar,
1.933     droeschl 5311: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5312: table#LC_title_bar.LC_with_remote {
1.359     albertel 5313:   width: 100%;
1.392     albertel 5314:   border-color: $pgbg;
                   5315:   border-style: solid;
                   5316:   border-width: $border;
1.379     albertel 5317:   background: $pgbg;
1.801     tempelho 5318:   color: $fontmenu;
1.392     albertel 5319:   border-collapse: collapse;
1.803     bisitz   5320:   padding: 0;
1.819     tempelho 5321:   margin: 0;
1.359     albertel 5322: }
1.795     www      5323: 
1.933     droeschl 5324: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5325:     margin: 0;
                   5326:     padding: 0;
1.933     droeschl 5327:     position: relative;
                   5328:     list-style: none;
1.913     droeschl 5329: }
1.933     droeschl 5330: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5331:     display: inline;
                   5332: }
1.933     droeschl 5333: 
                   5334: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5335:     padding: 0;
1.933     droeschl 5336:     margin: 0;
                   5337:     float: left;
1.913     droeschl 5338: }
1.933     droeschl 5339: .LC_breadcrumb_tools_tools {
                   5340:     padding: 0;
                   5341:     margin: 0;
1.913     droeschl 5342:     float: right;
                   5343: }
                   5344: 
1.359     albertel 5345: table#LC_title_bar td {
                   5346:   background: $tabbg;
                   5347: }
1.795     www      5348: 
1.911     bisitz   5349: table#LC_menubuttons img {
1.803     bisitz   5350:   border: none;
1.346     albertel 5351: }
1.795     www      5352: 
1.842     droeschl 5353: .LC_breadcrumbs_component {
1.911     bisitz   5354:   float: right;
                   5355:   margin: 0 1em;
1.357     albertel 5356: }
1.842     droeschl 5357: .LC_breadcrumbs_component img {
1.911     bisitz   5358:   vertical-align: middle;
1.777     tempelho 5359: }
1.795     www      5360: 
1.383     albertel 5361: td.LC_table_cell_checkbox {
                   5362:   text-align: center;
                   5363: }
1.795     www      5364: 
                   5365: .LC_fontsize_small {
1.911     bisitz   5366:   font-size: 70%;
1.705     tempelho 5367: }
                   5368: 
1.844     bisitz   5369: #LC_breadcrumbs {
1.911     bisitz   5370:   clear:both;
                   5371:   background: $sidebg;
                   5372:   border-bottom: 1px solid $lg_border_color;
                   5373:   line-height: 2.5em;
1.933     droeschl 5374:   overflow: hidden;
1.911     bisitz   5375:   margin: 0;
                   5376:   padding: 0;
1.995     raeburn  5377:   text-align: left;
1.819     tempelho 5378: }
1.862     bisitz   5379: 
1.993     raeburn  5380: .LC_head_subbox {
1.911     bisitz   5381:   clear:both;
                   5382:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5383:   border: 1px solid $sidebg;
                   5384:   margin: 0 0 10px 0;      
1.966     bisitz   5385:   padding: 3px;
1.995     raeburn  5386:   text-align: left;
1.822     bisitz   5387: }
                   5388: 
1.795     www      5389: .LC_fontsize_medium {
1.911     bisitz   5390:   font-size: 85%;
1.705     tempelho 5391: }
                   5392: 
1.795     www      5393: .LC_fontsize_large {
1.911     bisitz   5394:   font-size: 120%;
1.705     tempelho 5395: }
                   5396: 
1.346     albertel 5397: .LC_menubuttons_inline_text {
                   5398:   color: $font;
1.698     harmsja  5399:   font-size: 90%;
1.701     harmsja  5400:   padding-left:3px;
1.346     albertel 5401: }
                   5402: 
1.934     droeschl 5403: .LC_menubuttons_inline_text img{
                   5404:   vertical-align: middle;
                   5405: }
                   5406: 
1.1051    www      5407: li.LC_menubuttons_inline_text img {
1.951     onken    5408:   cursor:pointer;
1.1002    droeschl 5409:   text-decoration: none;
1.951     onken    5410: }
                   5411: 
1.526     www      5412: .LC_menubuttons_link {
                   5413:   text-decoration: none;
                   5414: }
1.795     www      5415: 
1.522     albertel 5416: .LC_menubuttons_category {
1.521     www      5417:   color: $font;
1.526     www      5418:   background: $pgbg;
1.521     www      5419:   font-size: larger;
                   5420:   font-weight: bold;
                   5421: }
                   5422: 
1.346     albertel 5423: td.LC_menubuttons_text {
1.911     bisitz   5424:   color: $font;
1.346     albertel 5425: }
1.706     harmsja  5426: 
1.346     albertel 5427: .LC_current_location {
                   5428:   background: $tabbg;
                   5429: }
1.795     www      5430: 
1.938     bisitz   5431: table.LC_data_table {
1.347     albertel 5432:   border: 1px solid #000000;
1.402     albertel 5433:   border-collapse: separate;
1.426     albertel 5434:   border-spacing: 1px;
1.610     albertel 5435:   background: $pgbg;
1.347     albertel 5436: }
1.795     www      5437: 
1.422     albertel 5438: .LC_data_table_dense {
                   5439:   font-size: small;
                   5440: }
1.795     www      5441: 
1.507     raeburn  5442: table.LC_nested_outer {
                   5443:   border: 1px solid #000000;
1.589     raeburn  5444:   border-collapse: collapse;
1.803     bisitz   5445:   border-spacing: 0;
1.507     raeburn  5446:   width: 100%;
                   5447: }
1.795     www      5448: 
1.879     raeburn  5449: table.LC_innerpickbox,
1.507     raeburn  5450: table.LC_nested {
1.803     bisitz   5451:   border: none;
1.589     raeburn  5452:   border-collapse: collapse;
1.803     bisitz   5453:   border-spacing: 0;
1.507     raeburn  5454:   width: 100%;
                   5455: }
1.795     www      5456: 
1.911     bisitz   5457: table.LC_data_table tr th,
                   5458: table.LC_calendar tr th,
1.879     raeburn  5459: table.LC_prior_tries tr th,
                   5460: table.LC_innerpickbox tr th {
1.349     albertel 5461:   font-weight: bold;
                   5462:   background-color: $data_table_head;
1.801     tempelho 5463:   color:$fontmenu;
1.701     harmsja  5464:   font-size:90%;
1.347     albertel 5465: }
1.795     www      5466: 
1.879     raeburn  5467: table.LC_innerpickbox tr th,
                   5468: table.LC_innerpickbox tr td {
                   5469:   vertical-align: top;
                   5470: }
                   5471: 
1.711     raeburn  5472: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5473:   background-color: #CCCCCC;
1.711     raeburn  5474:   font-weight: bold;
                   5475:   text-align: left;
                   5476: }
1.795     www      5477: 
1.912     bisitz   5478: table.LC_data_table tr.LC_odd_row > td {
                   5479:   background-color: $data_table_light;
                   5480:   padding: 2px;
                   5481:   vertical-align: top;
                   5482: }
                   5483: 
1.809     bisitz   5484: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5485:   background-color: $data_table_light;
1.912     bisitz   5486:   vertical-align: top;
                   5487: }
                   5488: 
                   5489: table.LC_data_table tr.LC_even_row > td {
                   5490:   background-color: $data_table_dark;
1.425     albertel 5491:   padding: 2px;
1.900     bisitz   5492:   vertical-align: top;
1.347     albertel 5493: }
1.795     www      5494: 
1.809     bisitz   5495: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5496:   background-color: $data_table_dark;
1.900     bisitz   5497:   vertical-align: top;
1.347     albertel 5498: }
1.795     www      5499: 
1.425     albertel 5500: table.LC_data_table tr.LC_data_table_highlight td {
                   5501:   background-color: $data_table_darker;
                   5502: }
1.795     www      5503: 
1.639     raeburn  5504: table.LC_data_table tr td.LC_leftcol_header {
                   5505:   background-color: $data_table_head;
                   5506:   font-weight: bold;
                   5507: }
1.795     www      5508: 
1.451     albertel 5509: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5510: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5511:   font-weight: bold;
                   5512:   font-style: italic;
                   5513:   text-align: center;
                   5514:   padding: 8px;
1.347     albertel 5515: }
1.795     www      5516: 
1.940     bisitz   5517: table.LC_data_table tr.LC_empty_row td {
                   5518:   background-color: $sidebg;
                   5519: }
                   5520: 
                   5521: table.LC_nested tr.LC_empty_row td {
                   5522:   background-color: #FFFFFF;
                   5523: }
                   5524: 
1.890     droeschl 5525: table.LC_caption {
                   5526: }
                   5527: 
1.507     raeburn  5528: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5529:   padding: 4ex
                   5530: }
1.795     www      5531: 
1.507     raeburn  5532: table.LC_nested_outer tr th {
                   5533:   font-weight: bold;
1.801     tempelho 5534:   color:$fontmenu;
1.507     raeburn  5535:   background-color: $data_table_head;
1.701     harmsja  5536:   font-size: small;
1.507     raeburn  5537:   border-bottom: 1px solid #000000;
                   5538: }
1.795     www      5539: 
1.507     raeburn  5540: table.LC_nested_outer tr td.LC_subheader {
                   5541:   background-color: $data_table_head;
                   5542:   font-weight: bold;
                   5543:   font-size: small;
                   5544:   border-bottom: 1px solid #000000;
                   5545:   text-align: right;
1.451     albertel 5546: }
1.795     www      5547: 
1.507     raeburn  5548: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5549:   background-color: #CCCCCC;
1.451     albertel 5550:   font-weight: bold;
                   5551:   font-size: small;
1.507     raeburn  5552:   text-align: center;
                   5553: }
1.795     www      5554: 
1.589     raeburn  5555: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5556: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5557:   text-align: left;
1.451     albertel 5558: }
1.795     www      5559: 
1.507     raeburn  5560: table.LC_nested td {
1.735     bisitz   5561:   background-color: #FFFFFF;
1.451     albertel 5562:   font-size: small;
1.507     raeburn  5563: }
1.795     www      5564: 
1.507     raeburn  5565: table.LC_nested_outer tr th.LC_right_item,
                   5566: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5567: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5568: table.LC_nested tr td.LC_right_item {
1.451     albertel 5569:   text-align: right;
                   5570: }
                   5571: 
1.507     raeburn  5572: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5573:   background-color: #EEEEEE;
1.451     albertel 5574: }
                   5575: 
1.473     raeburn  5576: table.LC_createuser {
                   5577: }
                   5578: 
                   5579: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5580:   font-size: small;
1.473     raeburn  5581: }
                   5582: 
                   5583: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5584:   background-color: #CCCCCC;
1.473     raeburn  5585:   font-weight: bold;
                   5586:   text-align: center;
                   5587: }
                   5588: 
1.349     albertel 5589: table.LC_calendar {
                   5590:   border: 1px solid #000000;
                   5591:   border-collapse: collapse;
1.917     raeburn  5592:   width: 98%;
1.349     albertel 5593: }
1.795     www      5594: 
1.349     albertel 5595: table.LC_calendar_pickdate {
                   5596:   font-size: xx-small;
                   5597: }
1.795     www      5598: 
1.349     albertel 5599: table.LC_calendar tr td {
                   5600:   border: 1px solid #000000;
                   5601:   vertical-align: top;
1.917     raeburn  5602:   width: 14%;
1.349     albertel 5603: }
1.795     www      5604: 
1.349     albertel 5605: table.LC_calendar tr td.LC_calendar_day_empty {
                   5606:   background-color: $data_table_dark;
                   5607: }
1.795     www      5608: 
1.779     bisitz   5609: table.LC_calendar tr td.LC_calendar_day_current {
                   5610:   background-color: $data_table_highlight;
1.777     tempelho 5611: }
1.795     www      5612: 
1.938     bisitz   5613: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5614:   background-color: $mail_new;
                   5615: }
1.795     www      5616: 
1.938     bisitz   5617: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5618:   background-color: $mail_new_hover;
                   5619: }
1.795     www      5620: 
1.938     bisitz   5621: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5622:   background-color: $mail_read;
                   5623: }
1.795     www      5624: 
1.938     bisitz   5625: /*
                   5626: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5627:   background-color: $mail_read_hover;
                   5628: }
1.938     bisitz   5629: */
1.795     www      5630: 
1.938     bisitz   5631: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5632:   background-color: $mail_replied;
                   5633: }
1.795     www      5634: 
1.938     bisitz   5635: /*
                   5636: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5637:   background-color: $mail_replied_hover;
                   5638: }
1.938     bisitz   5639: */
1.795     www      5640: 
1.938     bisitz   5641: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5642:   background-color: $mail_other;
                   5643: }
1.795     www      5644: 
1.938     bisitz   5645: /*
                   5646: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5647:   background-color: $mail_other_hover;
                   5648: }
1.938     bisitz   5649: */
1.494     raeburn  5650: 
1.777     tempelho 5651: table.LC_data_table tr > td.LC_browser_file,
                   5652: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5653:   background: #AAEE77;
1.389     albertel 5654: }
1.795     www      5655: 
1.777     tempelho 5656: table.LC_data_table tr > td.LC_browser_file_locked,
                   5657: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5658:   background: #FFAA99;
1.387     albertel 5659: }
1.795     www      5660: 
1.777     tempelho 5661: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5662:   background: #888888;
1.779     bisitz   5663: }
1.795     www      5664: 
1.777     tempelho 5665: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5666: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5667:   background: #F8F866;
1.777     tempelho 5668: }
1.795     www      5669: 
1.696     bisitz   5670: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5671:   background: #E0E8FF;
1.387     albertel 5672: }
1.696     bisitz   5673: 
1.707     bisitz   5674: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5675:   /* background: #77FF77; */
1.707     bisitz   5676: }
1.795     www      5677: 
1.707     bisitz   5678: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5679:   border-right: 8px solid #FFFF77;
1.707     bisitz   5680: }
1.795     www      5681: 
1.707     bisitz   5682: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5683:   border-right: 8px solid #FFAA77;
1.707     bisitz   5684: }
1.795     www      5685: 
1.707     bisitz   5686: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5687:   border-right: 8px solid #FF7777;
1.707     bisitz   5688: }
1.795     www      5689: 
1.707     bisitz   5690: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5691:   border-right: 8px solid #AAFF77;
1.707     bisitz   5692: }
1.795     www      5693: 
1.707     bisitz   5694: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5695:   border-right: 8px solid #11CC55;
1.707     bisitz   5696: }
                   5697: 
1.388     albertel 5698: span.LC_current_location {
1.701     harmsja  5699:   font-size:larger;
1.388     albertel 5700:   background: $pgbg;
                   5701: }
1.387     albertel 5702: 
1.1029    www      5703: span.LC_current_nav_location {
                   5704:   font-weight:bold;
                   5705:   background: $sidebg;
                   5706: }
                   5707: 
1.395     albertel 5708: span.LC_parm_menu_item {
                   5709:   font-size: larger;
                   5710: }
1.795     www      5711: 
1.395     albertel 5712: span.LC_parm_scope_all {
                   5713:   color: red;
                   5714: }
1.795     www      5715: 
1.395     albertel 5716: span.LC_parm_scope_folder {
                   5717:   color: green;
                   5718: }
1.795     www      5719: 
1.395     albertel 5720: span.LC_parm_scope_resource {
                   5721:   color: orange;
                   5722: }
1.795     www      5723: 
1.395     albertel 5724: span.LC_parm_part {
                   5725:   color: blue;
                   5726: }
1.795     www      5727: 
1.911     bisitz   5728: span.LC_parm_folder,
                   5729: span.LC_parm_symb {
1.395     albertel 5730:   font-size: x-small;
                   5731:   font-family: $mono;
                   5732:   color: #AAAAAA;
                   5733: }
                   5734: 
1.977     bisitz   5735: ul.LC_parm_parmlist li {
                   5736:   display: inline-block;
                   5737:   padding: 0.3em 0.8em;
                   5738:   vertical-align: top;
                   5739:   width: 150px;
                   5740:   border-top:1px solid $lg_border_color;
                   5741: }
                   5742: 
1.795     www      5743: td.LC_parm_overview_level_menu,
                   5744: td.LC_parm_overview_map_menu,
                   5745: td.LC_parm_overview_parm_selectors,
                   5746: td.LC_parm_overview_restrictions  {
1.396     albertel 5747:   border: 1px solid black;
                   5748:   border-collapse: collapse;
                   5749: }
1.795     www      5750: 
1.396     albertel 5751: table.LC_parm_overview_restrictions td {
                   5752:   border-width: 1px 4px 1px 4px;
                   5753:   border-style: solid;
                   5754:   border-color: $pgbg;
                   5755:   text-align: center;
                   5756: }
1.795     www      5757: 
1.396     albertel 5758: table.LC_parm_overview_restrictions th {
                   5759:   background: $tabbg;
                   5760:   border-width: 1px 4px 1px 4px;
                   5761:   border-style: solid;
                   5762:   border-color: $pgbg;
                   5763: }
1.795     www      5764: 
1.398     albertel 5765: table#LC_helpmenu {
1.803     bisitz   5766:   border: none;
1.398     albertel 5767:   height: 55px;
1.803     bisitz   5768:   border-spacing: 0;
1.398     albertel 5769: }
                   5770: 
                   5771: table#LC_helpmenu fieldset legend {
                   5772:   font-size: larger;
                   5773: }
1.795     www      5774: 
1.397     albertel 5775: table#LC_helpmenu_links {
                   5776:   width: 100%;
                   5777:   border: 1px solid black;
                   5778:   background: $pgbg;
1.803     bisitz   5779:   padding: 0;
1.397     albertel 5780:   border-spacing: 1px;
                   5781: }
1.795     www      5782: 
1.397     albertel 5783: table#LC_helpmenu_links tr td {
                   5784:   padding: 1px;
                   5785:   background: $tabbg;
1.399     albertel 5786:   text-align: center;
                   5787:   font-weight: bold;
1.397     albertel 5788: }
1.396     albertel 5789: 
1.795     www      5790: table#LC_helpmenu_links a:link,
                   5791: table#LC_helpmenu_links a:visited,
1.397     albertel 5792: table#LC_helpmenu_links a:active {
                   5793:   text-decoration: none;
                   5794:   color: $font;
                   5795: }
1.795     www      5796: 
1.397     albertel 5797: table#LC_helpmenu_links a:hover {
                   5798:   text-decoration: underline;
                   5799:   color: $vlink;
                   5800: }
1.396     albertel 5801: 
1.417     albertel 5802: .LC_chrt_popup_exists {
                   5803:   border: 1px solid #339933;
                   5804:   margin: -1px;
                   5805: }
1.795     www      5806: 
1.417     albertel 5807: .LC_chrt_popup_up {
                   5808:   border: 1px solid yellow;
                   5809:   margin: -1px;
                   5810: }
1.795     www      5811: 
1.417     albertel 5812: .LC_chrt_popup {
                   5813:   border: 1px solid #8888FF;
                   5814:   background: #CCCCFF;
                   5815: }
1.795     www      5816: 
1.421     albertel 5817: table.LC_pick_box {
                   5818:   border-collapse: separate;
                   5819:   background: white;
                   5820:   border: 1px solid black;
                   5821:   border-spacing: 1px;
                   5822: }
1.795     www      5823: 
1.421     albertel 5824: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5825:   background: $sidebg;
1.421     albertel 5826:   font-weight: bold;
1.900     bisitz   5827:   text-align: left;
1.740     bisitz   5828:   vertical-align: top;
1.421     albertel 5829:   width: 184px;
                   5830:   padding: 8px;
                   5831: }
1.795     www      5832: 
1.579     raeburn  5833: table.LC_pick_box td.LC_pick_box_value {
                   5834:   text-align: left;
                   5835:   padding: 8px;
                   5836: }
1.795     www      5837: 
1.579     raeburn  5838: table.LC_pick_box td.LC_pick_box_select {
                   5839:   text-align: left;
                   5840:   padding: 8px;
                   5841: }
1.795     www      5842: 
1.424     albertel 5843: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5844:   padding: 0;
1.421     albertel 5845:   height: 1px;
                   5846:   background: black;
                   5847: }
1.795     www      5848: 
1.421     albertel 5849: table.LC_pick_box td.LC_pick_box_submit {
                   5850:   text-align: right;
                   5851: }
1.795     www      5852: 
1.579     raeburn  5853: table.LC_pick_box td.LC_evenrow_value {
                   5854:   text-align: left;
                   5855:   padding: 8px;
                   5856:   background-color: $data_table_light;
                   5857: }
1.795     www      5858: 
1.579     raeburn  5859: table.LC_pick_box td.LC_oddrow_value {
                   5860:   text-align: left;
                   5861:   padding: 8px;
                   5862:   background-color: $data_table_light;
                   5863: }
1.795     www      5864: 
1.579     raeburn  5865: span.LC_helpform_receipt_cat {
                   5866:   font-weight: bold;
                   5867: }
1.795     www      5868: 
1.424     albertel 5869: table.LC_group_priv_box {
                   5870:   background: white;
                   5871:   border: 1px solid black;
                   5872:   border-spacing: 1px;
                   5873: }
1.795     www      5874: 
1.424     albertel 5875: table.LC_group_priv_box td.LC_pick_box_title {
                   5876:   background: $tabbg;
                   5877:   font-weight: bold;
                   5878:   text-align: right;
                   5879:   width: 184px;
                   5880: }
1.795     www      5881: 
1.424     albertel 5882: table.LC_group_priv_box td.LC_groups_fixed {
                   5883:   background: $data_table_light;
                   5884:   text-align: center;
                   5885: }
1.795     www      5886: 
1.424     albertel 5887: table.LC_group_priv_box td.LC_groups_optional {
                   5888:   background: $data_table_dark;
                   5889:   text-align: center;
                   5890: }
1.795     www      5891: 
1.424     albertel 5892: table.LC_group_priv_box td.LC_groups_functionality {
                   5893:   background: $data_table_darker;
                   5894:   text-align: center;
                   5895:   font-weight: bold;
                   5896: }
1.795     www      5897: 
1.424     albertel 5898: table.LC_group_priv td {
                   5899:   text-align: left;
1.803     bisitz   5900:   padding: 0;
1.424     albertel 5901: }
                   5902: 
                   5903: .LC_navbuttons {
                   5904:   margin: 2ex 0ex 2ex 0ex;
                   5905: }
1.795     www      5906: 
1.423     albertel 5907: .LC_topic_bar {
                   5908:   font-weight: bold;
                   5909:   background: $tabbg;
1.918     wenzelju 5910:   margin: 1em 0em 1em 2em;
1.805     bisitz   5911:   padding: 3px;
1.918     wenzelju 5912:   font-size: 1.2em;
1.423     albertel 5913: }
1.795     www      5914: 
1.423     albertel 5915: .LC_topic_bar span {
1.918     wenzelju 5916:   left: 0.5em;
                   5917:   position: absolute;
1.423     albertel 5918:   vertical-align: middle;
1.918     wenzelju 5919:   font-size: 1.2em;
1.423     albertel 5920: }
1.795     www      5921: 
1.423     albertel 5922: table.LC_course_group_status {
                   5923:   margin: 20px;
                   5924: }
1.795     www      5925: 
1.423     albertel 5926: table.LC_status_selector td {
                   5927:   vertical-align: top;
                   5928:   text-align: center;
1.424     albertel 5929:   padding: 4px;
                   5930: }
1.795     www      5931: 
1.599     albertel 5932: div.LC_feedback_link {
1.616     albertel 5933:   clear: both;
1.829     kalberla 5934:   background: $sidebg;
1.779     bisitz   5935:   width: 100%;
1.829     kalberla 5936:   padding-bottom: 10px;
                   5937:   border: 1px $tabbg solid;
1.833     kalberla 5938:   height: 22px;
                   5939:   line-height: 22px;
                   5940:   padding-top: 5px;
                   5941: }
                   5942: 
                   5943: div.LC_feedback_link img {
                   5944:   height: 22px;
1.867     kalberla 5945:   vertical-align:middle;
1.829     kalberla 5946: }
                   5947: 
1.911     bisitz   5948: div.LC_feedback_link a {
1.829     kalberla 5949:   text-decoration: none;
1.489     raeburn  5950: }
1.795     www      5951: 
1.867     kalberla 5952: div.LC_comblock {
1.911     bisitz   5953:   display:inline;
1.867     kalberla 5954:   color:$font;
                   5955:   font-size:90%;
                   5956: }
                   5957: 
                   5958: div.LC_feedback_link div.LC_comblock {
                   5959:   padding-left:5px;
                   5960: }
                   5961: 
                   5962: div.LC_feedback_link div.LC_comblock a {
                   5963:   color:$font;
                   5964: }
                   5965: 
1.489     raeburn  5966: span.LC_feedback_link {
1.858     bisitz   5967:   /* background: $feedback_link_bg; */
1.599     albertel 5968:   font-size: larger;
                   5969: }
1.795     www      5970: 
1.599     albertel 5971: span.LC_message_link {
1.858     bisitz   5972:   /* background: $feedback_link_bg; */
1.599     albertel 5973:   font-size: larger;
                   5974:   position: absolute;
                   5975:   right: 1em;
1.489     raeburn  5976: }
1.421     albertel 5977: 
1.515     albertel 5978: table.LC_prior_tries {
1.524     albertel 5979:   border: 1px solid #000000;
                   5980:   border-collapse: separate;
                   5981:   border-spacing: 1px;
1.515     albertel 5982: }
1.523     albertel 5983: 
1.515     albertel 5984: table.LC_prior_tries td {
1.524     albertel 5985:   padding: 2px;
1.515     albertel 5986: }
1.523     albertel 5987: 
                   5988: .LC_answer_correct {
1.795     www      5989:   background: lightgreen;
                   5990:   color: darkgreen;
                   5991:   padding: 6px;
1.523     albertel 5992: }
1.795     www      5993: 
1.523     albertel 5994: .LC_answer_charged_try {
1.797     www      5995:   background: #FFAAAA;
1.795     www      5996:   color: darkred;
                   5997:   padding: 6px;
1.523     albertel 5998: }
1.795     www      5999: 
1.779     bisitz   6000: .LC_answer_not_charged_try,
1.523     albertel 6001: .LC_answer_no_grade,
                   6002: .LC_answer_late {
1.795     www      6003:   background: lightyellow;
1.523     albertel 6004:   color: black;
1.795     www      6005:   padding: 6px;
1.523     albertel 6006: }
1.795     www      6007: 
1.523     albertel 6008: .LC_answer_previous {
1.795     www      6009:   background: lightblue;
                   6010:   color: darkblue;
                   6011:   padding: 6px;
1.523     albertel 6012: }
1.795     www      6013: 
1.779     bisitz   6014: .LC_answer_no_message {
1.777     tempelho 6015:   background: #FFFFFF;
                   6016:   color: black;
1.795     www      6017:   padding: 6px;
1.779     bisitz   6018: }
1.795     www      6019: 
1.779     bisitz   6020: .LC_answer_unknown {
                   6021:   background: orange;
                   6022:   color: black;
1.795     www      6023:   padding: 6px;
1.777     tempelho 6024: }
1.795     www      6025: 
1.529     albertel 6026: span.LC_prior_numerical,
                   6027: span.LC_prior_string,
                   6028: span.LC_prior_custom,
                   6029: span.LC_prior_reaction,
                   6030: span.LC_prior_math {
1.925     bisitz   6031:   font-family: $mono;
1.523     albertel 6032:   white-space: pre;
                   6033: }
                   6034: 
1.525     albertel 6035: span.LC_prior_string {
1.925     bisitz   6036:   font-family: $mono;
1.525     albertel 6037:   white-space: pre;
                   6038: }
                   6039: 
1.523     albertel 6040: table.LC_prior_option {
                   6041:   width: 100%;
                   6042:   border-collapse: collapse;
                   6043: }
1.795     www      6044: 
1.911     bisitz   6045: table.LC_prior_rank,
1.795     www      6046: table.LC_prior_match {
1.528     albertel 6047:   border-collapse: collapse;
                   6048: }
1.795     www      6049: 
1.528     albertel 6050: table.LC_prior_option tr td,
                   6051: table.LC_prior_rank tr td,
                   6052: table.LC_prior_match tr td {
1.524     albertel 6053:   border: 1px solid #000000;
1.515     albertel 6054: }
                   6055: 
1.855     bisitz   6056: .LC_nobreak {
1.544     albertel 6057:   white-space: nowrap;
1.519     raeburn  6058: }
                   6059: 
1.576     raeburn  6060: span.LC_cusr_emph {
                   6061:   font-style: italic;
                   6062: }
                   6063: 
1.633     raeburn  6064: span.LC_cusr_subheading {
                   6065:   font-weight: normal;
                   6066:   font-size: 85%;
                   6067: }
                   6068: 
1.861     bisitz   6069: div.LC_docs_entry_move {
1.859     bisitz   6070:   border: 1px solid #BBBBBB;
1.545     albertel 6071:   background: #DDDDDD;
1.861     bisitz   6072:   width: 22px;
1.859     bisitz   6073:   padding: 1px;
                   6074:   margin: 0;
1.545     albertel 6075: }
                   6076: 
1.861     bisitz   6077: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6078: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6079:   background: #DDDDDD;
                   6080:   font-size: x-small;
                   6081: }
1.795     www      6082: 
1.861     bisitz   6083: .LC_docs_entry_parameter {
                   6084:   white-space: nowrap;
                   6085: }
                   6086: 
1.544     albertel 6087: .LC_docs_copy {
1.545     albertel 6088:   color: #000099;
1.544     albertel 6089: }
1.795     www      6090: 
1.544     albertel 6091: .LC_docs_cut {
1.545     albertel 6092:   color: #550044;
1.544     albertel 6093: }
1.795     www      6094: 
1.544     albertel 6095: .LC_docs_rename {
1.545     albertel 6096:   color: #009900;
1.544     albertel 6097: }
1.795     www      6098: 
1.544     albertel 6099: .LC_docs_remove {
1.545     albertel 6100:   color: #990000;
                   6101: }
                   6102: 
1.547     albertel 6103: .LC_docs_reinit_warn,
                   6104: .LC_docs_ext_edit {
                   6105:   font-size: x-small;
                   6106: }
                   6107: 
1.545     albertel 6108: table.LC_docs_adddocs td,
                   6109: table.LC_docs_adddocs th {
                   6110:   border: 1px solid #BBBBBB;
                   6111:   padding: 4px;
                   6112:   background: #DDDDDD;
1.543     albertel 6113: }
                   6114: 
1.584     albertel 6115: table.LC_sty_begin {
                   6116:   background: #BBFFBB;
                   6117: }
1.795     www      6118: 
1.584     albertel 6119: table.LC_sty_end {
                   6120:   background: #FFBBBB;
                   6121: }
                   6122: 
1.589     raeburn  6123: table.LC_double_column {
1.803     bisitz   6124:   border-width: 0;
1.589     raeburn  6125:   border-collapse: collapse;
                   6126:   width: 100%;
                   6127:   padding: 2px;
                   6128: }
                   6129: 
                   6130: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6131:   top: 2px;
1.589     raeburn  6132:   left: 2px;
                   6133:   width: 47%;
                   6134:   vertical-align: top;
                   6135: }
                   6136: 
                   6137: table.LC_double_column tr td.LC_right_col {
                   6138:   top: 2px;
1.779     bisitz   6139:   right: 2px;
1.589     raeburn  6140:   width: 47%;
                   6141:   vertical-align: top;
                   6142: }
                   6143: 
1.591     raeburn  6144: div.LC_left_float {
                   6145:   float: left;
                   6146:   padding-right: 5%;
1.597     albertel 6147:   padding-bottom: 4px;
1.591     raeburn  6148: }
                   6149: 
                   6150: div.LC_clear_float_header {
1.597     albertel 6151:   padding-bottom: 2px;
1.591     raeburn  6152: }
                   6153: 
                   6154: div.LC_clear_float_footer {
1.597     albertel 6155:   padding-top: 10px;
1.591     raeburn  6156:   clear: both;
                   6157: }
                   6158: 
1.597     albertel 6159: div.LC_grade_show_user {
1.941     bisitz   6160: /*  border-left: 5px solid $sidebg; */
                   6161:   border-top: 5px solid #000000;
                   6162:   margin: 50px 0 0 0;
1.936     bisitz   6163:   padding: 15px 0 5px 10px;
1.597     albertel 6164: }
1.795     www      6165: 
1.936     bisitz   6166: div.LC_grade_show_user_odd_row {
1.941     bisitz   6167: /*  border-left: 5px solid #000000; */
                   6168: }
                   6169: 
                   6170: div.LC_grade_show_user div.LC_Box {
                   6171:   margin-right: 50px;
1.597     albertel 6172: }
                   6173: 
                   6174: div.LC_grade_submissions,
                   6175: div.LC_grade_message_center,
1.936     bisitz   6176: div.LC_grade_info_links {
1.597     albertel 6177:   margin: 5px;
                   6178:   width: 99%;
                   6179:   background: #FFFFFF;
                   6180: }
1.795     www      6181: 
1.597     albertel 6182: div.LC_grade_submissions_header,
1.936     bisitz   6183: div.LC_grade_message_center_header {
1.705     tempelho 6184:   font-weight: bold;
                   6185:   font-size: large;
1.597     albertel 6186: }
1.795     www      6187: 
1.597     albertel 6188: div.LC_grade_submissions_body,
1.936     bisitz   6189: div.LC_grade_message_center_body {
1.597     albertel 6190:   border: 1px solid black;
                   6191:   width: 99%;
                   6192:   background: #FFFFFF;
                   6193: }
1.795     www      6194: 
1.613     albertel 6195: table.LC_scantron_action {
                   6196:   width: 100%;
                   6197: }
1.795     www      6198: 
1.613     albertel 6199: table.LC_scantron_action tr th {
1.698     harmsja  6200:   font-weight:bold;
                   6201:   font-style:normal;
1.613     albertel 6202: }
1.795     www      6203: 
1.779     bisitz   6204: .LC_edit_problem_header,
1.614     albertel 6205: div.LC_edit_problem_footer {
1.705     tempelho 6206:   font-weight: normal;
                   6207:   font-size:  medium;
1.602     albertel 6208:   margin: 2px;
1.1060    bisitz   6209:   background-color: $sidebg;
1.600     albertel 6210: }
1.795     www      6211: 
1.600     albertel 6212: div.LC_edit_problem_header,
1.602     albertel 6213: div.LC_edit_problem_header div,
1.614     albertel 6214: div.LC_edit_problem_footer,
                   6215: div.LC_edit_problem_footer div,
1.602     albertel 6216: div.LC_edit_problem_editxml_header,
                   6217: div.LC_edit_problem_editxml_header div {
1.600     albertel 6218:   margin-top: 5px;
                   6219: }
1.795     www      6220: 
1.600     albertel 6221: div.LC_edit_problem_header_title {
1.705     tempelho 6222:   font-weight: bold;
                   6223:   font-size: larger;
1.602     albertel 6224:   background: $tabbg;
                   6225:   padding: 3px;
1.1060    bisitz   6226:   margin: 0 0 5px 0;
1.602     albertel 6227: }
1.795     www      6228: 
1.602     albertel 6229: table.LC_edit_problem_header_title {
                   6230:   width: 100%;
1.600     albertel 6231:   background: $tabbg;
1.602     albertel 6232: }
                   6233: 
                   6234: div.LC_edit_problem_discards {
                   6235:   float: left;
                   6236:   padding-bottom: 5px;
                   6237: }
1.795     www      6238: 
1.602     albertel 6239: div.LC_edit_problem_saves {
                   6240:   float: right;
                   6241:   padding-bottom: 5px;
1.600     albertel 6242: }
1.795     www      6243: 
1.911     bisitz   6244: img.stift {
1.803     bisitz   6245:   border-width: 0;
                   6246:   vertical-align: middle;
1.677     riegler  6247: }
1.680     riegler  6248: 
1.923     bisitz   6249: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6250:   vertical-align: top;
1.777     tempelho 6251: }
1.795     www      6252: 
1.716     raeburn  6253: div.LC_createcourse {
1.911     bisitz   6254:   margin: 10px 10px 10px 10px;
1.716     raeburn  6255: }
                   6256: 
1.917     raeburn  6257: .LC_dccid {
                   6258:   margin: 0.2em 0 0 0;
                   6259:   padding: 0;
                   6260:   font-size: 90%;
                   6261:   display:none;
                   6262: }
                   6263: 
1.897     wenzelju 6264: ol.LC_primary_menu a:hover,
1.721     harmsja  6265: ol#LC_MenuBreadcrumbs a:hover,
                   6266: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6267: ul#LC_secondary_menu a:hover,
1.721     harmsja  6268: .LC_FormSectionClearButton input:hover
1.795     www      6269: ul.LC_TabContent   li:hover a {
1.952     onken    6270:   color:$button_hover;
1.911     bisitz   6271:   text-decoration:none;
1.693     droeschl 6272: }
                   6273: 
1.779     bisitz   6274: h1 {
1.911     bisitz   6275:   padding: 0;
                   6276:   line-height:130%;
1.693     droeschl 6277: }
1.698     harmsja  6278: 
1.911     bisitz   6279: h2,
                   6280: h3,
                   6281: h4,
                   6282: h5,
                   6283: h6 {
                   6284:   margin: 5px 0 5px 0;
                   6285:   padding: 0;
                   6286:   line-height:130%;
1.693     droeschl 6287: }
1.795     www      6288: 
                   6289: .LC_hcell {
1.911     bisitz   6290:   padding:3px 15px 3px 15px;
                   6291:   margin: 0;
                   6292:   background-color:$tabbg;
                   6293:   color:$fontmenu;
                   6294:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6295: }
1.795     www      6296: 
1.840     bisitz   6297: .LC_Box > .LC_hcell {
1.911     bisitz   6298:   margin: 0 -10px 10px -10px;
1.835     bisitz   6299: }
                   6300: 
1.721     harmsja  6301: .LC_noBorder {
1.911     bisitz   6302:   border: 0;
1.698     harmsja  6303: }
1.693     droeschl 6304: 
1.721     harmsja  6305: .LC_FormSectionClearButton input {
1.911     bisitz   6306:   background-color:transparent;
                   6307:   border: none;
                   6308:   cursor:pointer;
                   6309:   text-decoration:underline;
1.693     droeschl 6310: }
1.763     bisitz   6311: 
                   6312: .LC_help_open_topic {
1.911     bisitz   6313:   color: #FFFFFF;
                   6314:   background-color: #EEEEFF;
                   6315:   margin: 1px;
                   6316:   padding: 4px;
                   6317:   border: 1px solid #000033;
                   6318:   white-space: nowrap;
                   6319:   /* vertical-align: middle; */
1.759     neumanie 6320: }
1.693     droeschl 6321: 
1.911     bisitz   6322: dl,
                   6323: ul,
                   6324: div,
                   6325: fieldset {
                   6326:   margin: 10px 10px 10px 0;
                   6327:   /* overflow: hidden; */
1.693     droeschl 6328: }
1.795     www      6329: 
1.838     bisitz   6330: fieldset > legend {
1.911     bisitz   6331:   font-weight: bold;
                   6332:   padding: 0 5px 0 5px;
1.838     bisitz   6333: }
                   6334: 
1.813     bisitz   6335: #LC_nav_bar {
1.911     bisitz   6336:   float: left;
1.995     raeburn  6337:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6338:   margin: 0 0 2px 0;
1.807     droeschl 6339: }
                   6340: 
1.916     droeschl 6341: #LC_realm {
                   6342:   margin: 0.2em 0 0 0;
                   6343:   padding: 0;
                   6344:   font-weight: bold;
                   6345:   text-align: center;
1.995     raeburn  6346:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6347: }
                   6348: 
1.911     bisitz   6349: #LC_nav_bar em {
                   6350:   font-weight: bold;
                   6351:   font-style: normal;
1.807     droeschl 6352: }
                   6353: 
1.897     wenzelju 6354: ol.LC_primary_menu {
1.911     bisitz   6355:   float: right;
1.934     droeschl 6356:   margin: 0;
1.995     raeburn  6357:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6358: }
                   6359: 
1.852     droeschl 6360: ol#LC_PathBreadcrumbs {
1.911     bisitz   6361:   margin: 0;
1.693     droeschl 6362: }
                   6363: 
1.897     wenzelju 6364: ol.LC_primary_menu li {
1.911     bisitz   6365:   display: inline;
                   6366:   padding: 5px 5px 0 10px;
                   6367:   vertical-align: top;
1.693     droeschl 6368: }
                   6369: 
1.897     wenzelju 6370: ol.LC_primary_menu li img {
1.911     bisitz   6371:   vertical-align: bottom;
1.934     droeschl 6372:   height: 1.1em;
1.693     droeschl 6373: }
                   6374: 
1.897     wenzelju 6375: ol.LC_primary_menu a {
1.911     bisitz   6376:   color: RGB(80, 80, 80);
                   6377:   text-decoration: none;
1.693     droeschl 6378: }
1.795     www      6379: 
1.949     droeschl 6380: ol.LC_primary_menu a.LC_new_message {
                   6381:   font-weight:bold;
                   6382:   color: darkred;
                   6383: }
                   6384: 
1.975     raeburn  6385: ol.LC_docs_parameters {
                   6386:   margin-left: 0;
                   6387:   padding: 0;
                   6388:   list-style: none;
                   6389: }
                   6390: 
                   6391: ol.LC_docs_parameters li {
                   6392:   margin: 0;
                   6393:   padding-right: 20px;
                   6394:   display: inline;
                   6395: }
                   6396: 
1.976     raeburn  6397: ol.LC_docs_parameters li:before {
                   6398:   content: "\\002022 \\0020";
                   6399: }
                   6400: 
                   6401: li.LC_docs_parameters_title {
                   6402:   font-weight: bold;
                   6403: }
                   6404: 
                   6405: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6406:   content: "";
                   6407: }
                   6408: 
1.897     wenzelju 6409: ul#LC_secondary_menu {
1.911     bisitz   6410:   clear: both;
                   6411:   color: $fontmenu;
                   6412:   background: $tabbg;
                   6413:   list-style: none;
                   6414:   padding: 0;
                   6415:   margin: 0;
                   6416:   width: 100%;
1.995     raeburn  6417:   text-align: left;
1.808     droeschl 6418: }
                   6419: 
1.897     wenzelju 6420: ul#LC_secondary_menu li {
1.911     bisitz   6421:   font-weight: bold;
                   6422:   line-height: 1.8em;
                   6423:   padding: 0 0.8em;
                   6424:   border-right: 1px solid black;
                   6425:   display: inline;
                   6426:   vertical-align: middle;
1.807     droeschl 6427: }
                   6428: 
1.847     tempelho 6429: ul.LC_TabContent {
1.911     bisitz   6430:   display:block;
                   6431:   background: $sidebg;
                   6432:   border-bottom: solid 1px $lg_border_color;
                   6433:   list-style:none;
1.1020    raeburn  6434:   margin: -1px -10px 0 -10px;
1.911     bisitz   6435:   padding: 0;
1.693     droeschl 6436: }
                   6437: 
1.795     www      6438: ul.LC_TabContent li,
                   6439: ul.LC_TabContentBigger li {
1.911     bisitz   6440:   float:left;
1.741     harmsja  6441: }
1.795     www      6442: 
1.897     wenzelju 6443: ul#LC_secondary_menu li a {
1.911     bisitz   6444:   color: $fontmenu;
                   6445:   text-decoration: none;
1.693     droeschl 6446: }
1.795     www      6447: 
1.721     harmsja  6448: ul.LC_TabContent {
1.952     onken    6449:   min-height:20px;
1.721     harmsja  6450: }
1.795     www      6451: 
                   6452: ul.LC_TabContent li {
1.911     bisitz   6453:   vertical-align:middle;
1.959     onken    6454:   padding: 0 16px 0 10px;
1.911     bisitz   6455:   background-color:$tabbg;
                   6456:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6457:   border-left: solid 1px $font;
1.721     harmsja  6458: }
1.795     www      6459: 
1.847     tempelho 6460: ul.LC_TabContent .right {
1.911     bisitz   6461:   float:right;
1.847     tempelho 6462: }
                   6463: 
1.911     bisitz   6464: ul.LC_TabContent li a,
                   6465: ul.LC_TabContent li {
                   6466:   color:rgb(47,47,47);
                   6467:   text-decoration:none;
                   6468:   font-size:95%;
                   6469:   font-weight:bold;
1.952     onken    6470:   min-height:20px;
                   6471: }
                   6472: 
1.959     onken    6473: ul.LC_TabContent li a:hover,
                   6474: ul.LC_TabContent li a:focus {
1.952     onken    6475:   color: $button_hover;
1.959     onken    6476:   background:none;
                   6477:   outline:none;
1.952     onken    6478: }
                   6479: 
                   6480: ul.LC_TabContent li:hover {
                   6481:   color: $button_hover;
                   6482:   cursor:pointer;
1.721     harmsja  6483: }
1.795     www      6484: 
1.911     bisitz   6485: ul.LC_TabContent li.active {
1.952     onken    6486:   color: $font;
1.911     bisitz   6487:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6488:   border-bottom:solid 1px #FFFFFF;
                   6489:   cursor: default;
1.744     ehlerst  6490: }
1.795     www      6491: 
1.959     onken    6492: ul.LC_TabContent li.active a {
                   6493:   color:$font;
                   6494:   background:#FFFFFF;
                   6495:   outline: none;
                   6496: }
1.1047    raeburn  6497: 
                   6498: ul.LC_TabContent li.goback {
                   6499:   float: left;
                   6500:   border-left: none;
                   6501: }
                   6502: 
1.870     tempelho 6503: #maincoursedoc {
1.911     bisitz   6504:   clear:both;
1.870     tempelho 6505: }
                   6506: 
                   6507: ul.LC_TabContentBigger {
1.911     bisitz   6508:   display:block;
                   6509:   list-style:none;
                   6510:   padding: 0;
1.870     tempelho 6511: }
                   6512: 
1.795     www      6513: ul.LC_TabContentBigger li {
1.911     bisitz   6514:   vertical-align:bottom;
                   6515:   height: 30px;
                   6516:   font-size:110%;
                   6517:   font-weight:bold;
                   6518:   color: #737373;
1.841     tempelho 6519: }
                   6520: 
1.957     onken    6521: ul.LC_TabContentBigger li.active {
                   6522:   position: relative;
                   6523:   top: 1px;
                   6524: }
                   6525: 
1.870     tempelho 6526: ul.LC_TabContentBigger li a {
1.911     bisitz   6527:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6528:   height: 30px;
                   6529:   line-height: 30px;
                   6530:   text-align: center;
                   6531:   display: block;
                   6532:   text-decoration: none;
1.958     onken    6533:   outline: none;  
1.741     harmsja  6534: }
1.795     www      6535: 
1.870     tempelho 6536: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6537:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6538:   color:$font;
1.744     ehlerst  6539: }
1.795     www      6540: 
1.870     tempelho 6541: ul.LC_TabContentBigger li b {
1.911     bisitz   6542:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6543:   display: block;
                   6544:   float: left;
                   6545:   padding: 0 30px;
1.957     onken    6546:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6547: }
                   6548: 
1.956     onken    6549: ul.LC_TabContentBigger li:hover b {
                   6550:   color:$button_hover;
                   6551: }
                   6552: 
1.870     tempelho 6553: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6554:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6555:   color:$font;
1.957     onken    6556:   border: 0;
1.741     harmsja  6557: }
1.693     droeschl 6558: 
1.870     tempelho 6559: 
1.862     bisitz   6560: ul.LC_CourseBreadcrumbs {
                   6561:   background: $sidebg;
1.1020    raeburn  6562:   height: 2em;
1.862     bisitz   6563:   padding-left: 10px;
1.1020    raeburn  6564:   margin: 0;
1.862     bisitz   6565:   list-style-position: inside;
                   6566: }
                   6567: 
1.911     bisitz   6568: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6569: ol#LC_PathBreadcrumbs {
1.911     bisitz   6570:   padding-left: 10px;
                   6571:   margin: 0;
1.933     droeschl 6572:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6573: }
                   6574: 
1.911     bisitz   6575: ol#LC_MenuBreadcrumbs li,
                   6576: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6577: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6578:   display: inline;
1.933     droeschl 6579:   white-space: normal;  
1.693     droeschl 6580: }
                   6581: 
1.823     bisitz   6582: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6583: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6584:   text-decoration: none;
                   6585:   font-size:90%;
1.693     droeschl 6586: }
1.795     www      6587: 
1.969     droeschl 6588: ol#LC_MenuBreadcrumbs h1 {
                   6589:   display: inline;
                   6590:   font-size: 90%;
                   6591:   line-height: 2.5em;
                   6592:   margin: 0;
                   6593:   padding: 0;
                   6594: }
                   6595: 
1.795     www      6596: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6597:   text-decoration:none;
                   6598:   font-size:100%;
                   6599:   font-weight:bold;
1.693     droeschl 6600: }
1.795     www      6601: 
1.840     bisitz   6602: .LC_Box {
1.911     bisitz   6603:   border: solid 1px $lg_border_color;
                   6604:   padding: 0 10px 10px 10px;
1.746     neumanie 6605: }
1.795     www      6606: 
1.1020    raeburn  6607: .LC_DocsBox {
                   6608:   border: solid 1px $lg_border_color;
                   6609:   padding: 0 0 10px 10px;
                   6610: }
                   6611: 
1.795     www      6612: .LC_AboutMe_Image {
1.911     bisitz   6613:   float:left;
                   6614:   margin-right:10px;
1.747     neumanie 6615: }
1.795     www      6616: 
                   6617: .LC_Clear_AboutMe_Image {
1.911     bisitz   6618:   clear:left;
1.747     neumanie 6619: }
1.795     www      6620: 
1.721     harmsja  6621: dl.LC_ListStyleClean dt {
1.911     bisitz   6622:   padding-right: 5px;
                   6623:   display: table-header-group;
1.693     droeschl 6624: }
                   6625: 
1.721     harmsja  6626: dl.LC_ListStyleClean dd {
1.911     bisitz   6627:   display: table-row;
1.693     droeschl 6628: }
                   6629: 
1.721     harmsja  6630: .LC_ListStyleClean,
                   6631: .LC_ListStyleSimple,
                   6632: .LC_ListStyleNormal,
1.795     www      6633: .LC_ListStyleSpecial {
1.911     bisitz   6634:   /* display:block; */
                   6635:   list-style-position: inside;
                   6636:   list-style-type: none;
                   6637:   overflow: hidden;
                   6638:   padding: 0;
1.693     droeschl 6639: }
                   6640: 
1.721     harmsja  6641: .LC_ListStyleSimple li,
                   6642: .LC_ListStyleSimple dd,
                   6643: .LC_ListStyleNormal li,
                   6644: .LC_ListStyleNormal dd,
                   6645: .LC_ListStyleSpecial li,
1.795     www      6646: .LC_ListStyleSpecial dd {
1.911     bisitz   6647:   margin: 0;
                   6648:   padding: 5px 5px 5px 10px;
                   6649:   clear: both;
1.693     droeschl 6650: }
                   6651: 
1.721     harmsja  6652: .LC_ListStyleClean li,
                   6653: .LC_ListStyleClean dd {
1.911     bisitz   6654:   padding-top: 0;
                   6655:   padding-bottom: 0;
1.693     droeschl 6656: }
                   6657: 
1.721     harmsja  6658: .LC_ListStyleSimple dd,
1.795     www      6659: .LC_ListStyleSimple li {
1.911     bisitz   6660:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6661: }
                   6662: 
1.721     harmsja  6663: .LC_ListStyleSpecial li,
                   6664: .LC_ListStyleSpecial dd {
1.911     bisitz   6665:   list-style-type: none;
                   6666:   background-color: RGB(220, 220, 220);
                   6667:   margin-bottom: 4px;
1.693     droeschl 6668: }
                   6669: 
1.721     harmsja  6670: table.LC_SimpleTable {
1.911     bisitz   6671:   margin:5px;
                   6672:   border:solid 1px $lg_border_color;
1.795     www      6673: }
1.693     droeschl 6674: 
1.721     harmsja  6675: table.LC_SimpleTable tr {
1.911     bisitz   6676:   padding: 0;
                   6677:   border:solid 1px $lg_border_color;
1.693     droeschl 6678: }
1.795     www      6679: 
                   6680: table.LC_SimpleTable thead {
1.911     bisitz   6681:   background:rgb(220,220,220);
1.693     droeschl 6682: }
                   6683: 
1.721     harmsja  6684: div.LC_columnSection {
1.911     bisitz   6685:   display: block;
                   6686:   clear: both;
                   6687:   overflow: hidden;
                   6688:   margin: 0;
1.693     droeschl 6689: }
                   6690: 
1.721     harmsja  6691: div.LC_columnSection>* {
1.911     bisitz   6692:   float: left;
                   6693:   margin: 10px 20px 10px 0;
                   6694:   overflow:hidden;
1.693     droeschl 6695: }
1.721     harmsja  6696: 
1.795     www      6697: table em {
1.911     bisitz   6698:   font-weight: bold;
                   6699:   font-style: normal;
1.748     schulted 6700: }
1.795     www      6701: 
1.779     bisitz   6702: table.LC_tableBrowseRes,
1.795     www      6703: table.LC_tableOfContent {
1.911     bisitz   6704:   border:none;
                   6705:   border-spacing: 1px;
                   6706:   padding: 3px;
                   6707:   background-color: #FFFFFF;
                   6708:   font-size: 90%;
1.753     droeschl 6709: }
1.789     droeschl 6710: 
1.911     bisitz   6711: table.LC_tableOfContent {
                   6712:   border-collapse: collapse;
1.789     droeschl 6713: }
                   6714: 
1.771     droeschl 6715: table.LC_tableBrowseRes a,
1.768     schulted 6716: table.LC_tableOfContent a {
1.911     bisitz   6717:   background-color: transparent;
                   6718:   text-decoration: none;
1.753     droeschl 6719: }
                   6720: 
1.795     www      6721: table.LC_tableOfContent img {
1.911     bisitz   6722:   border: none;
                   6723:   height: 1.3em;
                   6724:   vertical-align: text-bottom;
                   6725:   margin-right: 0.3em;
1.753     droeschl 6726: }
1.757     schulted 6727: 
1.795     www      6728: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6729:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6730: }
                   6731: 
1.795     www      6732: a#LC_content_toolbar_everything {
1.911     bisitz   6733:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6734: }
                   6735: 
1.795     www      6736: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6737:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6738: }
                   6739: 
1.795     www      6740: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6741:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6742: }
                   6743: 
1.795     www      6744: a#LC_content_toolbar_changefolder {
1.911     bisitz   6745:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6746: }
                   6747: 
1.795     www      6748: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6749:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6750: }
                   6751: 
1.1043    raeburn  6752: a#LC_content_toolbar_edittoplevel {
                   6753:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6754: }
                   6755: 
1.795     www      6756: ul#LC_toolbar li a:hover {
1.911     bisitz   6757:   background-position: bottom center;
1.757     schulted 6758: }
                   6759: 
1.795     www      6760: ul#LC_toolbar {
1.911     bisitz   6761:   padding: 0;
                   6762:   margin: 2px;
                   6763:   list-style:none;
                   6764:   position:relative;
                   6765:   background-color:white;
1.757     schulted 6766: }
                   6767: 
1.795     www      6768: ul#LC_toolbar li {
1.911     bisitz   6769:   border:1px solid white;
                   6770:   padding: 0;
                   6771:   margin: 0;
                   6772:   float: left;
                   6773:   display:inline;
                   6774:   vertical-align:middle;
                   6775: }
1.757     schulted 6776: 
1.783     amueller 6777: 
1.795     www      6778: a.LC_toolbarItem {
1.911     bisitz   6779:   display:block;
                   6780:   padding: 0;
                   6781:   margin: 0;
                   6782:   height: 32px;
                   6783:   width: 32px;
                   6784:   color:white;
                   6785:   border: none;
                   6786:   background-repeat:no-repeat;
                   6787:   background-color:transparent;
1.757     schulted 6788: }
                   6789: 
1.915     droeschl 6790: ul.LC_funclist {
                   6791:     margin: 0;
                   6792:     padding: 0.5em 1em 0.5em 0;
                   6793: }
                   6794: 
1.933     droeschl 6795: ul.LC_funclist > li:first-child {
                   6796:     font-weight:bold; 
                   6797:     margin-left:0.8em;
                   6798: }
                   6799: 
1.915     droeschl 6800: ul.LC_funclist + ul.LC_funclist {
                   6801:     /* 
                   6802:        left border as a seperator if we have more than
                   6803:        one list 
                   6804:     */
                   6805:     border-left: 1px solid $sidebg;
                   6806:     /* 
                   6807:        this hides the left border behind the border of the 
                   6808:        outer box if element is wrapped to the next 'line' 
                   6809:     */
                   6810:     margin-left: -1px;
                   6811: }
                   6812: 
1.843     bisitz   6813: ul.LC_funclist li {
1.915     droeschl 6814:   display: inline;
1.782     bisitz   6815:   white-space: nowrap;
1.915     droeschl 6816:   margin: 0 0 0 25px;
                   6817:   line-height: 150%;
1.782     bisitz   6818: }
                   6819: 
1.974     wenzelju 6820: .LC_hidden {
                   6821:   display: none;
                   6822: }
                   6823: 
1.1030    www      6824: .LCmodal-overlay {
                   6825: 		position:fixed;
                   6826: 		top:0;
                   6827: 		right:0;
                   6828: 		bottom:0;
                   6829: 		left:0;
                   6830: 		height:100%;
                   6831: 		width:100%;
                   6832: 		margin:0;
                   6833: 		padding:0;
                   6834: 		background:#999;
                   6835: 		opacity:.75;
                   6836: 		filter: alpha(opacity=75);
                   6837: 		-moz-opacity: 0.75;
                   6838: 		z-index:101;
                   6839: }
                   6840: 
                   6841: * html .LCmodal-overlay {   
                   6842: 		position: absolute;
                   6843: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   6844: }
                   6845: 
                   6846: .LCmodal-window {
                   6847: 		position:fixed;
                   6848: 		top:50%;
                   6849: 		left:50%;
                   6850: 		margin:0;
                   6851: 		padding:0;
                   6852: 		z-index:102;
                   6853: 	}
                   6854: 
                   6855: * html .LCmodal-window {
                   6856: 		position:absolute;
                   6857: }
                   6858: 
                   6859: .LCclose-window {
                   6860: 		position:absolute;
                   6861: 		width:32px;
                   6862: 		height:32px;
                   6863: 		right:8px;
                   6864: 		top:8px;
                   6865: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   6866: 		text-indent:-99999px;
                   6867: 		overflow:hidden;
                   6868: 		cursor:pointer;
                   6869: }
                   6870: 
1.343     albertel 6871: END
                   6872: }
                   6873: 
1.306     albertel 6874: =pod
                   6875: 
                   6876: =item * &headtag()
                   6877: 
                   6878: Returns a uniform footer for LON-CAPA web pages.
                   6879: 
1.307     albertel 6880: Inputs: $title - optional title for the head
                   6881:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6882:         $args - optional arguments
1.319     albertel 6883:             force_register - if is true call registerurl so the remote is 
                   6884:                              informed
1.415     albertel 6885:             redirect       -> array ref of
                   6886:                                    1- seconds before redirect occurs
                   6887:                                    2- url to redirect to
                   6888:                                    3- whether the side effect should occur
1.315     albertel 6889:                            (side effect of setting 
                   6890:                                $env{'internal.head.redirect'} to the url 
                   6891:                                redirected too)
1.352     albertel 6892:             domain         -> force to color decorate a page for a specific
                   6893:                                domain
                   6894:             function       -> force usage of a specific rolish color scheme
                   6895:             bgcolor        -> override the default page bgcolor
1.460     albertel 6896:             no_auto_mt_title
                   6897:                            -> prevent &mt()ing the title arg
1.464     albertel 6898: 
1.306     albertel 6899: =cut
                   6900: 
                   6901: sub headtag {
1.313     albertel 6902:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6903:     
1.363     albertel 6904:     my $function = $args->{'function'} || &get_users_function();
                   6905:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6906:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6907:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6908: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6909: 		   #time(),
1.418     albertel 6910: 		   $env{'environment.color.timestamp'},
1.363     albertel 6911: 		   $function,$domain,$bgcolor);
                   6912: 
1.369     www      6913:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6914: 
1.308     albertel 6915:     my $result =
                   6916: 	'<head>'.
1.461     albertel 6917: 	&font_settings();
1.319     albertel 6918: 
1.461     albertel 6919:     if (!$args->{'frameset'}) {
                   6920: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6921:     }
1.962     droeschl 6922:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   6923:         $result .= Apache::lonxml::display_title();
1.319     albertel 6924:     }
1.436     albertel 6925:     if (!$args->{'no_nav_bar'} 
                   6926: 	&& !$args->{'only_body'}
                   6927: 	&& !$args->{'frameset'}) {
                   6928: 	$result .= &help_menu_js();
1.1032    www      6929:         $result.=&modal_window();
1.1038    www      6930:         $result.=&togglebox_script();
1.1034    www      6931:         $result.=&wishlist_window();
1.1041    www      6932:         $result.=&LCprogressbarUpdate_script();
1.1034    www      6933:     } else {
                   6934:         if ($args->{'add_modal'}) {
                   6935:            $result.=&modal_window();
                   6936:         }
                   6937:         if ($args->{'add_wishlist'}) {
                   6938:            $result.=&wishlist_window();
                   6939:         }
1.1038    www      6940:         if ($args->{'add_togglebox'}) {
                   6941:            $result.=&togglebox_script();
                   6942:         }
1.1041    www      6943:         if ($args->{'add_progressbar'}) {
                   6944:            $result.=&LCprogressbarUpdate_script();
                   6945:         }
1.436     albertel 6946:     }
1.314     albertel 6947:     if (ref($args->{'redirect'})) {
1.414     albertel 6948: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6949: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6950: 	if (!$inhibit_continue) {
                   6951: 	    $env{'internal.head.redirect'} = $url;
                   6952: 	}
1.313     albertel 6953: 	$result.=<<ADDMETA
                   6954: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6955: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6956: ADDMETA
                   6957:     }
1.306     albertel 6958:     if (!defined($title)) {
                   6959: 	$title = 'The LearningOnline Network with CAPA';
                   6960:     }
1.460     albertel 6961:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6962:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6963: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6964: 	.$head_extra;
1.962     droeschl 6965:     return $result.'</head>';
1.306     albertel 6966: }
                   6967: 
                   6968: =pod
                   6969: 
1.340     albertel 6970: =item * &font_settings()
                   6971: 
                   6972: Returns neccessary <meta> to set the proper encoding
                   6973: 
                   6974: Inputs: none
                   6975: 
                   6976: =cut
                   6977: 
                   6978: sub font_settings {
                   6979:     my $headerstring='';
1.647     www      6980:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6981: 	$headerstring.=
                   6982: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6983:     }
                   6984:     return $headerstring;
                   6985: }
                   6986: 
1.341     albertel 6987: =pod
                   6988: 
                   6989: =item * &xml_begin()
                   6990: 
                   6991: Returns the needed doctype and <html>
                   6992: 
                   6993: Inputs: none
                   6994: 
                   6995: =cut
                   6996: 
                   6997: sub xml_begin {
                   6998:     my $output='';
                   6999: 
                   7000:     if ($env{'browser.mathml'}) {
                   7001: 	$output='<?xml version="1.0"?>'
                   7002:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7003: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7004:             
                   7005: #	    .'<!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">] >'
                   7006: 	    .'<!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">'
                   7007:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7008: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   7009:     } else {
1.849     bisitz   7010: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   7011:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 7012:     }
                   7013:     return $output;
                   7014: }
1.340     albertel 7015: 
                   7016: =pod
                   7017: 
1.306     albertel 7018: =item * &start_page()
                   7019: 
                   7020: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7021: 
1.648     raeburn  7022: Inputs:
                   7023: 
                   7024: =over 4
                   7025: 
                   7026: $title - optional title for the page
                   7027: 
                   7028: $head_extra - optional extra HTML to incude inside the <head>
                   7029: 
                   7030: $args - additional optional args supported are:
                   7031: 
                   7032: =over 8
                   7033: 
                   7034:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7035:                                     arg on
1.814     bisitz   7036:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7037:              add_entries    -> additional attributes to add to the  <body>
                   7038:              domain         -> force to color decorate a page for a 
1.317     albertel 7039:                                     specific domain
1.648     raeburn  7040:              function       -> force usage of a specific rolish color
1.317     albertel 7041:                                     scheme
1.648     raeburn  7042:              redirect       -> see &headtag()
                   7043:              bgcolor        -> override the default page bg color
                   7044:              js_ready       -> return a string ready for being used in 
1.317     albertel 7045:                                     a javascript writeln
1.648     raeburn  7046:              html_encode    -> return a string ready for being used in 
1.320     albertel 7047:                                     a html attribute
1.648     raeburn  7048:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7049:                                     $forcereg arg
1.648     raeburn  7050:              frameset       -> if true will start with a <frameset>
1.330     albertel 7051:                                     rather than <body>
1.648     raeburn  7052:              skip_phases    -> hash ref of 
1.338     albertel 7053:                                     head -> skip the <html><head> generation
                   7054:                                     body -> skip all <body> generation
1.648     raeburn  7055:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7056:              inherit_jsmath -> when creating popup window in a page,
                   7057:                                     should it have jsmath forced on by the
                   7058:                                     current page
1.867     kalberla 7059:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7060:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 7061: 
1.648     raeburn  7062: =back
1.460     albertel 7063: 
1.648     raeburn  7064: =back
1.562     albertel 7065: 
1.306     albertel 7066: =cut
                   7067: 
                   7068: sub start_page {
1.309     albertel 7069:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7070:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7071: 
1.315     albertel 7072:     $env{'internal.start_page'}++;
1.338     albertel 7073:     my $result;
1.964     droeschl 7074: 
1.338     albertel 7075:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      7076:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 7077:     }
                   7078:     
                   7079:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7080: 	if ($args->{'frameset'}) {
                   7081: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7082: 						$args->{'add_entries'});
                   7083: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   7084:         } else {
                   7085:             $result .=
                   7086:                 &bodytag($title, 
                   7087:                          $args->{'function'},       $args->{'add_entries'},
                   7088:                          $args->{'only_body'},      $args->{'domain'},
                   7089:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 7090:                          $args->{'bgcolor'},        $args);
1.831     bisitz   7091:         }
1.330     albertel 7092:     }
1.338     albertel 7093: 
1.315     albertel 7094:     if ($args->{'js_ready'}) {
1.713     kaisler  7095: 		$result = &js_ready($result);
1.315     albertel 7096:     }
1.320     albertel 7097:     if ($args->{'html_encode'}) {
1.713     kaisler  7098: 		$result = &html_encode($result);
                   7099:     }
                   7100: 
1.813     bisitz   7101:     # Preparation for new and consistent functionlist at top of screen
                   7102:     # if ($args->{'functionlist'}) {
                   7103:     #            $result .= &build_functionlist();
                   7104:     #}
                   7105: 
1.964     droeschl 7106:     # Don't add anything more if only_body wanted or in const space
                   7107:     return $result if    $args->{'only_body'} 
                   7108:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   7109: 
                   7110:     #Breadcrumbs
1.758     kaisler  7111:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   7112: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   7113: 		#if any br links exists, add them to the breadcrumbs
                   7114: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   7115: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   7116: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   7117: 			}
                   7118: 		}
                   7119: 
                   7120: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   7121: 		if(exists($args->{'bread_crumbs_component'})){
                   7122: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   7123: 		}else{
                   7124: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   7125: 		}
1.320     albertel 7126:     }
1.315     albertel 7127:     return $result;
1.306     albertel 7128: }
                   7129: 
                   7130: sub end_page {
1.315     albertel 7131:     my ($args) = @_;
                   7132:     $env{'internal.end_page'}++;
1.330     albertel 7133:     my $result;
1.335     albertel 7134:     if ($args->{'discussion'}) {
                   7135: 	my ($target,$parser);
                   7136: 	if (ref($args->{'discussion'})) {
                   7137: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7138: 				$args->{'discussion'}{'parser'});
                   7139: 	}
                   7140: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7141:     }
1.330     albertel 7142:     if ($args->{'frameset'}) {
                   7143: 	$result .= '</frameset>';
                   7144:     } else {
1.635     raeburn  7145: 	$result .= &endbodytag($args);
1.330     albertel 7146:     }
                   7147:     $result .= "\n</html>";
                   7148: 
1.315     albertel 7149:     if ($args->{'js_ready'}) {
1.317     albertel 7150: 	$result = &js_ready($result);
1.315     albertel 7151:     }
1.335     albertel 7152: 
1.320     albertel 7153:     if ($args->{'html_encode'}) {
                   7154: 	$result = &html_encode($result);
                   7155:     }
1.335     albertel 7156: 
1.315     albertel 7157:     return $result;
                   7158: }
                   7159: 
1.1034    www      7160: sub wishlist_window {
                   7161:     return(<<'ENDWISHLIST');
1.1046    raeburn  7162: <script type="text/javascript">
1.1034    www      7163: // <![CDATA[
                   7164: // <!-- BEGIN LON-CAPA Internal
                   7165: function set_wishlistlink(title, path) {
                   7166:     if (!title) {
                   7167:         title = document.title;
                   7168:         title = title.replace(/^LON-CAPA /,'');
                   7169:     }
                   7170:     if (!path) {
                   7171:         path = location.pathname;
                   7172:     }
                   7173:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7174:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7175: }
                   7176: // END LON-CAPA Internal -->
                   7177: // ]]>
                   7178: </script>
                   7179: ENDWISHLIST
                   7180: }
                   7181: 
1.1030    www      7182: sub modal_window {
                   7183:     return(<<'ENDMODAL');
1.1046    raeburn  7184: <script type="text/javascript">
1.1030    www      7185: // <![CDATA[
                   7186: // <!-- BEGIN LON-CAPA Internal
                   7187: var modalWindow = {
                   7188: 	parent:"body",
                   7189: 	windowId:null,
                   7190: 	content:null,
                   7191: 	width:null,
                   7192: 	height:null,
                   7193: 	close:function()
                   7194: 	{
                   7195: 	        $(".LCmodal-window").remove();
                   7196: 	        $(".LCmodal-overlay").remove();
                   7197: 	},
                   7198: 	open:function()
                   7199: 	{
                   7200: 		var modal = "";
                   7201: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7202: 		modal += "<div id=\"" + this.windowId + "\" class=\"LCmodal-window\" style=\"width:" + this.width + "px; height:" + this.height + "px; margin-top:-" + (this.height / 2) + "px; margin-left:-" + (this.width / 2) + "px;\">";
                   7203: 		modal += this.content;
                   7204: 		modal += "</div>";	
                   7205: 
                   7206: 		$(this.parent).append(modal);
                   7207: 
                   7208: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7209: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7210: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7211: 	}
                   7212: };
1.1031    www      7213: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7214: 	{
                   7215: 		modalWindow.windowId = "myModal";
                   7216: 		modalWindow.width = width;
                   7217: 		modalWindow.height = height;
1.1031    www      7218: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7219: 		modalWindow.open();
                   7220: 	};	
                   7221: // END LON-CAPA Internal -->
                   7222: // ]]>
                   7223: </script>
                   7224: ENDMODAL
                   7225: }
                   7226: 
                   7227: sub modal_link {
1.1052    www      7228:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7229:     unless ($width) { $width=480; }
                   7230:     unless ($height) { $height=400; }
1.1031    www      7231:     unless ($scrolling) { $scrolling='yes'; }
1.1052    www      7232:     return '<a href="'.$link.'" target="'.$target.'" title="'.$title.'" onclick="openMyModal(\''.$link.'\','.$width.','.$height.',\''.$scrolling.'\'); return false;">'.
1.1031    www      7233:            $linktext.'</a>';
1.1030    www      7234: }
                   7235: 
1.1032    www      7236: sub modal_adhoc_script {
                   7237:     my ($funcname,$width,$height,$content)=@_;
                   7238:     return (<<ENDADHOC);
1.1046    raeburn  7239: <script type="text/javascript">
1.1032    www      7240: // <![CDATA[
                   7241:         var $funcname = function()
                   7242:         {
                   7243:                 modalWindow.windowId = "myModal";
                   7244:                 modalWindow.width = $width;
                   7245:                 modalWindow.height = $height;
                   7246:                 modalWindow.content = '$content';
                   7247:                 modalWindow.open();
                   7248:         };  
                   7249: // ]]>
                   7250: </script>
                   7251: ENDADHOC
                   7252: }
                   7253: 
1.1041    www      7254: sub modal_adhoc_inner {
                   7255:     my ($funcname,$width,$height,$content)=@_;
                   7256:     my $innerwidth=$width-20;
                   7257:     $content=&js_ready(
1.1042    www      7258:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7259:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7260:                     $content.
                   7261:                  &end_scrollbox().
                   7262:                &end_page()
                   7263:              );
                   7264:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7265: }
                   7266: 
                   7267: sub modal_adhoc_window {
                   7268:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7269:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7270:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7271: }
                   7272: 
                   7273: sub modal_adhoc_launch {
                   7274:     my ($funcname,$width,$height,$content)=@_;
                   7275:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7276: <script type="text/javascript">
                   7277: // <![CDATA[
                   7278: $funcname();
                   7279: // ]]>
                   7280: </script>
                   7281: ENDLAUNCH
                   7282: }
                   7283: 
                   7284: sub modal_adhoc_close {
                   7285:     return (<<ENDCLOSE);
                   7286: <script type="text/javascript">
                   7287: // <![CDATA[
                   7288: modalWindow.close();
                   7289: // ]]>
                   7290: </script>
                   7291: ENDCLOSE
                   7292: }
                   7293: 
1.1038    www      7294: sub togglebox_script {
                   7295:    return(<<ENDTOGGLE);
                   7296: <script type="text/javascript"> 
                   7297: // <![CDATA[
                   7298: function LCtoggleDisplay(id,hidetext,showtext) {
                   7299:    link = document.getElementById(id + "link").childNodes[0];
                   7300:    with (document.getElementById(id).style) {
                   7301:       if (display == "none" ) {
                   7302:           display = "inline";
                   7303:           link.nodeValue = hidetext;
                   7304:         } else {
                   7305:           display = "none";
                   7306:           link.nodeValue = showtext;
                   7307:        }
                   7308:    }
                   7309: }
                   7310: // ]]>
                   7311: </script>
                   7312: ENDTOGGLE
                   7313: }
                   7314: 
1.1039    www      7315: sub start_togglebox {
                   7316:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7317:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7318:     unless ($showtext) { $showtext=&mt('show'); }
                   7319:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7320:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7321:     return &start_data_table().
                   7322:            &start_data_table_header_row().
                   7323:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7324:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7325:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7326:            &end_data_table_header_row().
                   7327:            '<tr id="'.$id.'" style="display:none""><td>';
                   7328: }
                   7329: 
                   7330: sub end_togglebox {
                   7331:     return '</td></tr>'.&end_data_table();
                   7332: }
                   7333: 
1.1041    www      7334: sub LCprogressbar_script {
1.1045    www      7335:    my ($id)=@_;
1.1041    www      7336:    return(<<ENDPROGRESS);
                   7337: <script type="text/javascript">
                   7338: // <![CDATA[
1.1045    www      7339: \$('#progressbar$id').progressbar({
1.1041    www      7340:   value: 0,
                   7341:   change: function(event, ui) {
                   7342:     var newVal = \$(this).progressbar('option', 'value');
                   7343:     \$('.pblabel', this).text(LCprogressTxt);
                   7344:   }
                   7345: });
                   7346: // ]]>
                   7347: </script>
                   7348: ENDPROGRESS
                   7349: }
                   7350: 
                   7351: sub LCprogressbarUpdate_script {
                   7352:    return(<<ENDPROGRESSUPDATE);
                   7353: <style type="text/css">
                   7354: .ui-progressbar { position:relative; }
                   7355: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7356: </style>
                   7357: <script type="text/javascript">
                   7358: // <![CDATA[
1.1045    www      7359: var LCprogressTxt='---';
                   7360: 
                   7361: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7362:    LCprogressTxt=progresstext;
1.1045    www      7363:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7364: }
                   7365: // ]]>
                   7366: </script>
                   7367: ENDPROGRESSUPDATE
                   7368: }
                   7369: 
1.1042    www      7370: my $LClastpercent;
1.1045    www      7371: my $LCidcnt;
                   7372: my $LCcurrentid;
1.1042    www      7373: 
1.1041    www      7374: sub LCprogressbar {
1.1042    www      7375:     my ($r)=(@_);
                   7376:     $LClastpercent=0;
1.1045    www      7377:     $LCidcnt++;
                   7378:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7379:     my $starting=&mt('Starting');
                   7380:     my $content=(<<ENDPROGBAR);
                   7381: <p>
1.1045    www      7382:   <div id="progressbar$LCcurrentid">
1.1041    www      7383:     <span class="pblabel">$starting</span>
                   7384:   </div>
                   7385: </p>
                   7386: ENDPROGBAR
1.1045    www      7387:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7388: }
                   7389: 
                   7390: sub LCprogressbarUpdate {
1.1042    www      7391:     my ($r,$val,$text)=@_;
                   7392:     unless ($val) { 
                   7393:        if ($LClastpercent) {
                   7394:            $val=$LClastpercent;
                   7395:        } else {
                   7396:            $val=0;
                   7397:        }
                   7398:     }
1.1041    www      7399:     if ($val<0) { $val=0; }
                   7400:     if ($val>100) { $val=0; }
1.1042    www      7401:     $LClastpercent=$val;
1.1041    www      7402:     unless ($text) { $text=$val.'%'; }
                   7403:     $text=&js_ready($text);
1.1044    www      7404:     &r_print($r,<<ENDUPDATE);
1.1041    www      7405: <script type="text/javascript">
                   7406: // <![CDATA[
1.1045    www      7407: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7408: // ]]>
                   7409: </script>
                   7410: ENDUPDATE
1.1035    www      7411: }
                   7412: 
1.1042    www      7413: sub LCprogressbarClose {
                   7414:     my ($r)=@_;
                   7415:     $LClastpercent=0;
1.1044    www      7416:     &r_print($r,<<ENDCLOSE);
1.1042    www      7417: <script type="text/javascript">
                   7418: // <![CDATA[
1.1045    www      7419: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7420: // ]]>
                   7421: </script>
                   7422: ENDCLOSE
1.1044    www      7423: }
                   7424: 
                   7425: sub r_print {
                   7426:     my ($r,$to_print)=@_;
                   7427:     if ($r) {
                   7428:       $r->print($to_print);
                   7429:       $r->rflush();
                   7430:     } else {
                   7431:       print($to_print);
                   7432:     }
1.1042    www      7433: }
                   7434: 
1.320     albertel 7435: sub html_encode {
                   7436:     my ($result) = @_;
                   7437: 
1.322     albertel 7438:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7439:     
                   7440:     return $result;
                   7441: }
1.1044    www      7442: 
1.317     albertel 7443: sub js_ready {
                   7444:     my ($result) = @_;
                   7445: 
1.323     albertel 7446:     $result =~ s/[\n\r]/ /xmsg;
                   7447:     $result =~ s/\\/\\\\/xmsg;
                   7448:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7449:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7450:     
                   7451:     return $result;
                   7452: }
                   7453: 
1.315     albertel 7454: sub validate_page {
                   7455:     if (  exists($env{'internal.start_page'})
1.316     albertel 7456: 	  &&     $env{'internal.start_page'} > 1) {
                   7457: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7458: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7459: 				 $ENV{'request.filename'});
1.315     albertel 7460:     }
                   7461:     if (  exists($env{'internal.end_page'})
1.316     albertel 7462: 	  &&     $env{'internal.end_page'} > 1) {
                   7463: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7464: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7465: 				 $env{'request.filename'});
1.315     albertel 7466:     }
                   7467:     if (     exists($env{'internal.start_page'})
                   7468: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7469: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7470: 				 $env{'request.filename'});
1.315     albertel 7471:     }
                   7472:     if (   ! exists($env{'internal.start_page'})
                   7473: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7474: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7475: 				 $env{'request.filename'});
1.315     albertel 7476:     }
1.306     albertel 7477: }
1.315     albertel 7478: 
1.996     www      7479: 
                   7480: sub start_scrollbox {
1.1018    raeburn  7481:     my ($outerwidth,$width,$height,$id)=@_;
1.998     raeburn  7482:     unless ($outerwidth) { $outerwidth='520px'; }
                   7483:     unless ($width) { $width='500px'; }
                   7484:     unless ($height) { $height='200px'; }
1.1020    raeburn  7485:     my ($table_id,$div_id);
1.1018    raeburn  7486:     if ($id ne '') {
1.1020    raeburn  7487:         $table_id = " id='table_$id'";
                   7488:         $div_id = " id='div_$id'";
1.1018    raeburn  7489:     }
1.1020    raeburn  7490:     return "<table style='width: $outerwidth; border: 1px solid none;'$table_id><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'$div_id>";
1.996     www      7491: }
                   7492: 
                   7493: sub end_scrollbox {
1.1036    www      7494:     return '</div></td></tr></table>';
1.996     www      7495: }
                   7496: 
1.318     albertel 7497: sub simple_error_page {
                   7498:     my ($r,$title,$msg) = @_;
                   7499:     my $page =
                   7500: 	&Apache::loncommon::start_page($title).
                   7501: 	&mt($msg).
                   7502: 	&Apache::loncommon::end_page();
                   7503:     if (ref($r)) {
                   7504: 	$r->print($page);
1.327     albertel 7505: 	return;
1.318     albertel 7506:     }
                   7507:     return $page;
                   7508: }
1.347     albertel 7509: 
                   7510: {
1.610     albertel 7511:     my @row_count;
1.961     onken    7512: 
                   7513:     sub start_data_table_count {
                   7514:         unshift(@row_count, 0);
                   7515:         return;
                   7516:     }
                   7517: 
                   7518:     sub end_data_table_count {
                   7519:         shift(@row_count);
                   7520:         return;
                   7521:     }
                   7522: 
1.347     albertel 7523:     sub start_data_table {
1.1018    raeburn  7524: 	my ($add_class,$id) = @_;
1.422     albertel 7525: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7526:         my $table_id;
                   7527:         if (defined($id)) {
                   7528:             $table_id = ' id="'.$id.'"';
                   7529:         }
1.961     onken    7530: 	&start_data_table_count();
1.1018    raeburn  7531: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7532:     }
                   7533: 
                   7534:     sub end_data_table {
1.961     onken    7535: 	&end_data_table_count();
1.389     albertel 7536: 	return '</table>'."\n";;
1.347     albertel 7537:     }
                   7538: 
                   7539:     sub start_data_table_row {
1.974     wenzelju 7540: 	my ($add_class, $id) = @_;
1.610     albertel 7541: 	$row_count[0]++;
                   7542: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7543: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7544:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7545:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7546:     }
1.471     banghart 7547:     
                   7548:     sub continue_data_table_row {
1.974     wenzelju 7549: 	my ($add_class, $id) = @_;
1.610     albertel 7550: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7551: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7552:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7553:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7554:     }
1.347     albertel 7555: 
                   7556:     sub end_data_table_row {
1.389     albertel 7557: 	return '</tr>'."\n";;
1.347     albertel 7558:     }
1.367     www      7559: 
1.421     albertel 7560:     sub start_data_table_empty_row {
1.707     bisitz   7561: #	$row_count[0]++;
1.421     albertel 7562: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7563:     }
                   7564: 
                   7565:     sub end_data_table_empty_row {
                   7566: 	return '</tr>'."\n";;
                   7567:     }
                   7568: 
1.367     www      7569:     sub start_data_table_header_row {
1.389     albertel 7570: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7571:     }
                   7572: 
                   7573:     sub end_data_table_header_row {
1.389     albertel 7574: 	return '</tr>'."\n";;
1.367     www      7575:     }
1.890     droeschl 7576: 
                   7577:     sub data_table_caption {
                   7578:         my $caption = shift;
                   7579:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7580:     }
1.347     albertel 7581: }
                   7582: 
1.548     albertel 7583: =pod
                   7584: 
                   7585: =item * &inhibit_menu_check($arg)
                   7586: 
                   7587: Checks for a inhibitmenu state and generates output to preserve it
                   7588: 
                   7589: Inputs:         $arg - can be any of
                   7590:                      - undef - in which case the return value is a string 
                   7591:                                to add  into arguments list of a uri
                   7592:                      - 'input' - in which case the return value is a HTML
                   7593:                                  <form> <input> field of type hidden to
                   7594:                                  preserve the value
                   7595:                      - a url - in which case the return value is the url with
                   7596:                                the neccesary cgi args added to preserve the
                   7597:                                inhibitmenu state
                   7598:                      - a ref to a url - no return value, but the string is
                   7599:                                         updated to include the neccessary cgi
                   7600:                                         args to preserve the inhibitmenu state
                   7601: 
                   7602: =cut
                   7603: 
                   7604: sub inhibit_menu_check {
                   7605:     my ($arg) = @_;
                   7606:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7607:     if ($arg eq 'input') {
                   7608: 	if ($env{'form.inhibitmenu'}) {
                   7609: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7610: 	} else {
                   7611: 	    return
                   7612: 	}
                   7613:     }
                   7614:     if ($env{'form.inhibitmenu'}) {
                   7615: 	if (ref($arg)) {
                   7616: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7617: 	} elsif ($arg eq '') {
                   7618: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7619: 	} else {
                   7620: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7621: 	}
                   7622:     }
                   7623:     if (!ref($arg)) {
                   7624: 	return $arg;
                   7625:     }
                   7626: }
                   7627: 
1.251     albertel 7628: ###############################################
1.182     matthew  7629: 
                   7630: =pod
                   7631: 
1.549     albertel 7632: =back
                   7633: 
                   7634: =head1 User Information Routines
                   7635: 
                   7636: =over 4
                   7637: 
1.405     albertel 7638: =item * &get_users_function()
1.182     matthew  7639: 
                   7640: Used by &bodytag to determine the current users primary role.
                   7641: Returns either 'student','coordinator','admin', or 'author'.
                   7642: 
                   7643: =cut
                   7644: 
                   7645: ###############################################
                   7646: sub get_users_function {
1.815     tempelho 7647:     my $function = 'norole';
1.818     tempelho 7648:     if ($env{'request.role'}=~/^(st)/) {
                   7649:         $function='student';
                   7650:     }
1.907     raeburn  7651:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7652:         $function='coordinator';
                   7653:     }
1.258     albertel 7654:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7655:         $function='admin';
                   7656:     }
1.826     bisitz   7657:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7658:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7659:         $function='author';
                   7660:     }
                   7661:     return $function;
1.54      www      7662: }
1.99      www      7663: 
                   7664: ###############################################
                   7665: 
1.233     raeburn  7666: =pod
                   7667: 
1.821     raeburn  7668: =item * &show_course()
                   7669: 
                   7670: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7671: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7672: 
                   7673: Inputs:
                   7674: None
                   7675: 
                   7676: Outputs:
                   7677: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7678: 
                   7679: =cut
                   7680: 
                   7681: ###############################################
                   7682: sub show_course {
                   7683:     my $course = !$env{'user.adv'};
                   7684:     if (!$env{'user.adv'}) {
                   7685:         foreach my $env (keys(%env)) {
                   7686:             next if ($env !~ m/^user\.priv\./);
                   7687:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7688:                 $course = 0;
                   7689:                 last;
                   7690:             }
                   7691:         }
                   7692:     }
                   7693:     return $course;
                   7694: }
                   7695: 
                   7696: ###############################################
                   7697: 
                   7698: =pod
                   7699: 
1.542     raeburn  7700: =item * &check_user_status()
1.274     raeburn  7701: 
                   7702: Determines current status of supplied role for a
                   7703: specific user. Roles can be active, previous or future.
                   7704: 
                   7705: Inputs: 
                   7706: user's domain, user's username, course's domain,
1.375     raeburn  7707: course's number, optional section ID.
1.274     raeburn  7708: 
                   7709: Outputs:
                   7710: role status: active, previous or future. 
                   7711: 
                   7712: =cut
                   7713: 
                   7714: sub check_user_status {
1.412     raeburn  7715:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.982     raeburn  7716:     my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
                   7717:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra);
1.274     raeburn  7718:     my @uroles = keys %userinfo;
                   7719:     my $srchstr;
                   7720:     my $active_chk = 'none';
1.412     raeburn  7721:     my $now = time;
1.274     raeburn  7722:     if (@uroles > 0) {
1.908     raeburn  7723:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7724:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7725:         } else {
1.412     raeburn  7726:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7727:         }
                   7728:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7729:             my $role_end = 0;
                   7730:             my $role_start = 0;
                   7731:             $active_chk = 'active';
1.412     raeburn  7732:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7733:                 $role_end = $1;
                   7734:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7735:                     $role_start = $1;
1.274     raeburn  7736:                 }
                   7737:             }
                   7738:             if ($role_start > 0) {
1.412     raeburn  7739:                 if ($now < $role_start) {
1.274     raeburn  7740:                     $active_chk = 'future';
                   7741:                 }
                   7742:             }
                   7743:             if ($role_end > 0) {
1.412     raeburn  7744:                 if ($now > $role_end) {
1.274     raeburn  7745:                     $active_chk = 'previous';
                   7746:                 }
                   7747:             }
                   7748:         }
                   7749:     }
                   7750:     return $active_chk;
                   7751: }
                   7752: 
                   7753: ###############################################
                   7754: 
                   7755: =pod
                   7756: 
1.405     albertel 7757: =item * &get_sections()
1.233     raeburn  7758: 
                   7759: Determines all the sections for a course including
                   7760: sections with students and sections containing other roles.
1.419     raeburn  7761: Incoming parameters: 
                   7762: 
                   7763: 1. domain
                   7764: 2. course number 
                   7765: 3. reference to array containing roles for which sections should 
                   7766: be gathered (optional).
                   7767: 4. reference to array containing status types for which sections 
                   7768: should be gathered (optional).
                   7769: 
                   7770: If the third argument is undefined, sections are gathered for any role. 
                   7771: If the fourth argument is undefined, sections are gathered for any status.
                   7772: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7773:  
1.374     raeburn  7774: Returns section hash (keys are section IDs, values are
                   7775: number of users in each section), subject to the
1.419     raeburn  7776: optional roles filter, optional status filter 
1.233     raeburn  7777: 
                   7778: =cut
                   7779: 
                   7780: ###############################################
                   7781: sub get_sections {
1.419     raeburn  7782:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7783:     if (!defined($cdom) || !defined($cnum)) {
                   7784:         my $cid =  $env{'request.course.id'};
                   7785: 
                   7786: 	return if (!defined($cid));
                   7787: 
                   7788:         $cdom = $env{'course.'.$cid.'.domain'};
                   7789:         $cnum = $env{'course.'.$cid.'.num'};
                   7790:     }
                   7791: 
                   7792:     my %sectioncount;
1.419     raeburn  7793:     my $now = time;
1.240     albertel 7794: 
1.366     albertel 7795:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7796: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7797: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7798: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7799:         my $start_index = &Apache::loncoursedata::CL_START();
                   7800:         my $end_index = &Apache::loncoursedata::CL_END();
                   7801:         my $status;
1.366     albertel 7802: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7803: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7804: 				                     $data->[$status_index],
                   7805:                                                      $data->[$start_index],
                   7806:                                                      $data->[$end_index]);
                   7807:             if ($stu_status eq 'Active') {
                   7808:                 $status = 'active';
                   7809:             } elsif ($end < $now) {
                   7810:                 $status = 'previous';
                   7811:             } elsif ($start > $now) {
                   7812:                 $status = 'future';
                   7813:             } 
                   7814: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7815:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7816:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7817: 		    $sectioncount{$section}++;
                   7818:                 }
1.240     albertel 7819: 	    }
                   7820: 	}
                   7821:     }
                   7822:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7823:     foreach my $user (sort(keys(%courseroles))) {
                   7824: 	if ($user !~ /^(\w{2})/) { next; }
                   7825: 	my ($role) = ($user =~ /^(\w{2})/);
                   7826: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7827: 	my ($section,$status);
1.240     albertel 7828: 	if ($role eq 'cr' &&
                   7829: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7830: 	    $section=$1;
                   7831: 	}
                   7832: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7833: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7834:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7835:         if ($end == -1 && $start == -1) {
                   7836:             next; #deleted role
                   7837:         }
                   7838:         if (!defined($possible_status)) { 
                   7839:             $sectioncount{$section}++;
                   7840:         } else {
                   7841:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7842:                 $status = 'active';
                   7843:             } elsif ($end < $now) {
                   7844:                 $status = 'future';
                   7845:             } elsif ($start > $now) {
                   7846:                 $status = 'previous';
                   7847:             }
                   7848:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7849:                 $sectioncount{$section}++;
                   7850:             }
                   7851:         }
1.233     raeburn  7852:     }
1.366     albertel 7853:     return %sectioncount;
1.233     raeburn  7854: }
                   7855: 
1.274     raeburn  7856: ###############################################
1.294     raeburn  7857: 
                   7858: =pod
1.405     albertel 7859: 
                   7860: =item * &get_course_users()
                   7861: 
1.275     raeburn  7862: Retrieves usernames:domains for users in the specified course
                   7863: with specific role(s), and access status. 
                   7864: 
                   7865: Incoming parameters:
1.277     albertel 7866: 1. course domain
                   7867: 2. course number
                   7868: 3. access status: users must have - either active, 
1.275     raeburn  7869: previous, future, or all.
1.277     albertel 7870: 4. reference to array of permissible roles
1.288     raeburn  7871: 5. reference to array of section restrictions (optional)
                   7872: 6. reference to results object (hash of hashes).
                   7873: 7. reference to optional userdata hash
1.609     raeburn  7874: 8. reference to optional statushash
1.630     raeburn  7875: 9. flag if privileged users (except those set to unhide in
                   7876:    course settings) should be excluded    
1.609     raeburn  7877: Keys of top level results hash are roles.
1.275     raeburn  7878: Keys of inner hashes are username:domain, with 
                   7879: values set to access type.
1.288     raeburn  7880: Optional userdata hash returns an array with arguments in the 
                   7881: same order as loncoursedata::get_classlist() for student data.
                   7882: 
1.609     raeburn  7883: Optional statushash returns
                   7884: 
1.288     raeburn  7885: Entries for end, start, section and status are blank because
                   7886: of the possibility of multiple values for non-student roles.
                   7887: 
1.275     raeburn  7888: =cut
1.405     albertel 7889: 
1.275     raeburn  7890: ###############################################
1.405     albertel 7891: 
1.275     raeburn  7892: sub get_course_users {
1.630     raeburn  7893:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7894:     my %idx = ();
1.419     raeburn  7895:     my %seclists;
1.288     raeburn  7896: 
                   7897:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7898:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7899:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7900:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7901:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7902:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7903:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7904:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7905: 
1.290     albertel 7906:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7907:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7908:         my $now = time;
1.277     albertel 7909:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7910:             my $match = 0;
1.412     raeburn  7911:             my $secmatch = 0;
1.419     raeburn  7912:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7913:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7914:             if ($section eq '') {
                   7915:                 $section = 'none';
                   7916:             }
1.291     albertel 7917:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7918:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7919:                     $secmatch = 1;
                   7920:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7921:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7922:                         $secmatch = 1;
                   7923:                     }
                   7924:                 } else {  
1.419     raeburn  7925: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7926: 		        $secmatch = 1;
                   7927:                     }
1.290     albertel 7928: 		}
1.412     raeburn  7929:                 if (!$secmatch) {
                   7930:                     next;
                   7931:                 }
1.419     raeburn  7932:             }
1.275     raeburn  7933:             if (defined($$types{'active'})) {
1.288     raeburn  7934:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7935:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7936:                     $match = 1;
1.275     raeburn  7937:                 }
                   7938:             }
                   7939:             if (defined($$types{'previous'})) {
1.609     raeburn  7940:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7941:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7942:                     $match = 1;
1.275     raeburn  7943:                 }
                   7944:             }
                   7945:             if (defined($$types{'future'})) {
1.609     raeburn  7946:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7947:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7948:                     $match = 1;
1.275     raeburn  7949:                 }
                   7950:             }
1.609     raeburn  7951:             if ($match) {
                   7952:                 push(@{$seclists{$student}},$section);
                   7953:                 if (ref($userdata) eq 'HASH') {
                   7954:                     $$userdata{$student} = $$classlist{$student};
                   7955:                 }
                   7956:                 if (ref($statushash) eq 'HASH') {
                   7957:                     $statushash->{$student}{'st'}{$section} = $status;
                   7958:                 }
1.288     raeburn  7959:             }
1.275     raeburn  7960:         }
                   7961:     }
1.412     raeburn  7962:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7963:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7964:         my $now = time;
1.609     raeburn  7965:         my %displaystatus = ( previous => 'Expired',
                   7966:                               active   => 'Active',
                   7967:                               future   => 'Future',
                   7968:                             );
1.630     raeburn  7969:         my %nothide;
                   7970:         if ($hidepriv) {
                   7971:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7972:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7973:                 if ($user !~ /:/) {
                   7974:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7975:                 } else {
                   7976:                     $nothide{$user} = 1;
                   7977:                 }
                   7978:             }
                   7979:         }
1.439     raeburn  7980:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7981:             my $match = 0;
1.412     raeburn  7982:             my $secmatch = 0;
1.439     raeburn  7983:             my $status;
1.412     raeburn  7984:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7985:             $user =~ s/:$//;
1.439     raeburn  7986:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7987:             if ($end == -1 || $start == -1) {
                   7988:                 next;
                   7989:             }
                   7990:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7991:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7992:                 my ($uname,$udom) = split(/:/,$user);
                   7993:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7994:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7995:                         $secmatch = 1;
                   7996:                     } elsif ($usec eq '') {
1.420     albertel 7997:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7998:                             $secmatch = 1;
                   7999:                         }
                   8000:                     } else {
                   8001:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   8002:                             $secmatch = 1;
                   8003:                         }
                   8004:                     }
                   8005:                     if (!$secmatch) {
                   8006:                         next;
                   8007:                     }
1.288     raeburn  8008:                 }
1.419     raeburn  8009:                 if ($usec eq '') {
                   8010:                     $usec = 'none';
                   8011:                 }
1.275     raeburn  8012:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  8013:                     if ($hidepriv) {
                   8014:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   8015:                             (!$nothide{$uname.':'.$udom})) {
                   8016:                             next;
                   8017:                         }
                   8018:                     }
1.503     raeburn  8019:                     if ($end > 0 && $end < $now) {
1.439     raeburn  8020:                         $status = 'previous';
                   8021:                     } elsif ($start > $now) {
                   8022:                         $status = 'future';
                   8023:                     } else {
                   8024:                         $status = 'active';
                   8025:                     }
1.277     albertel 8026:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  8027:                         if ($status eq $type) {
1.420     albertel 8028:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  8029:                                 push(@{$$users{$role}{$user}},$type);
                   8030:                             }
1.288     raeburn  8031:                             $match = 1;
                   8032:                         }
                   8033:                     }
1.419     raeburn  8034:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   8035:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   8036: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   8037:                         }
1.420     albertel 8038:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  8039:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   8040:                         }
1.609     raeburn  8041:                         if (ref($statushash) eq 'HASH') {
                   8042:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   8043:                         }
1.275     raeburn  8044:                     }
                   8045:                 }
                   8046:             }
                   8047:         }
1.290     albertel 8048:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  8049:             if ((defined($cdom)) && (defined($cnum))) {
                   8050:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   8051:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   8052:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  8053:                     next if ($owner eq '');
                   8054:                     my ($ownername,$ownerdom);
                   8055:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   8056:                         $ownername = $1;
                   8057:                         $ownerdom = $2;
                   8058:                     } else {
                   8059:                         $ownername = $owner;
                   8060:                         $ownerdom = $cdom;
                   8061:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  8062:                     }
                   8063:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 8064:                     if (defined($userdata) && 
1.609     raeburn  8065: 			!exists($$userdata{$owner})) {
                   8066: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   8067:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   8068:                             push(@{$seclists{$owner}},'none');
                   8069:                         }
                   8070:                         if (ref($statushash) eq 'HASH') {
                   8071:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  8072:                         }
1.290     albertel 8073: 		    }
1.279     raeburn  8074:                 }
                   8075:             }
                   8076:         }
1.419     raeburn  8077:         foreach my $user (keys(%seclists)) {
                   8078:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   8079:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   8080:         }
1.275     raeburn  8081:     }
                   8082:     return;
                   8083: }
                   8084: 
1.288     raeburn  8085: sub get_user_info {
                   8086:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 8087:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   8088: 	&plainname($uname,$udom,'lastname');
1.291     albertel 8089:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  8090:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  8091:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   8092:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  8093:     return;
                   8094: }
1.275     raeburn  8095: 
1.472     raeburn  8096: ###############################################
                   8097: 
                   8098: =pod
                   8099: 
                   8100: =item * &get_user_quota()
                   8101: 
                   8102: Retrieves quota assigned for storage of portfolio files for a user  
                   8103: 
                   8104: Incoming parameters:
                   8105: 1. user's username
                   8106: 2. user's domain
                   8107: 
                   8108: Returns:
1.536     raeburn  8109: 1. Disk quota (in Mb) assigned to student.
                   8110: 2. (Optional) Type of setting: custom or default
                   8111:    (individually assigned or default for user's 
                   8112:    institutional status).
                   8113: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   8114:    or student - types as defined in localenroll::inst_usertypes 
                   8115:    for user's domain, which determines default quota for user.
                   8116: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  8117: 
                   8118: If a value has been stored in the user's environment, 
1.536     raeburn  8119: it will return that, otherwise it returns the maximal default
                   8120: defined for the user's instituional status(es) in the domain.
1.472     raeburn  8121: 
                   8122: =cut
                   8123: 
                   8124: ###############################################
                   8125: 
                   8126: 
                   8127: sub get_user_quota {
                   8128:     my ($uname,$udom) = @_;
1.536     raeburn  8129:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8130:     if (!defined($udom)) {
                   8131:         $udom = $env{'user.domain'};
                   8132:     }
                   8133:     if (!defined($uname)) {
                   8134:         $uname = $env{'user.name'};
                   8135:     }
                   8136:     if (($udom eq '' || $uname eq '') ||
                   8137:         ($udom eq 'public') && ($uname eq 'public')) {
                   8138:         $quota = 0;
1.536     raeburn  8139:         $quotatype = 'default';
                   8140:         $defquota = 0; 
1.472     raeburn  8141:     } else {
1.536     raeburn  8142:         my $inststatus;
1.472     raeburn  8143:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8144:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8145:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8146:         } else {
1.536     raeburn  8147:             my %userenv = 
                   8148:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8149:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8150:             my ($tmp) = keys(%userenv);
                   8151:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8152:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8153:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8154:             } else {
                   8155:                 undef(%userenv);
                   8156:             }
                   8157:         }
1.536     raeburn  8158:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8159:         if ($quota eq '') {
1.536     raeburn  8160:             $quota = $defquota;
                   8161:             $quotatype = 'default';
                   8162:         } else {
                   8163:             $quotatype = 'custom';
1.472     raeburn  8164:         }
                   8165:     }
1.536     raeburn  8166:     if (wantarray) {
                   8167:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8168:     } else {
                   8169:         return $quota;
                   8170:     }
1.472     raeburn  8171: }
                   8172: 
                   8173: ###############################################
                   8174: 
                   8175: =pod
                   8176: 
                   8177: =item * &default_quota()
                   8178: 
1.536     raeburn  8179: Retrieves default quota assigned for storage of user portfolio files,
                   8180: given an (optional) user's institutional status.
1.472     raeburn  8181: 
                   8182: Incoming parameters:
                   8183: 1. domain
1.536     raeburn  8184: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8185:    status types (e.g., faculty, staff, student etc.)
                   8186:    which apply to the user for whom the default is being retrieved.
                   8187:    If the institutional status string in undefined, the domain
                   8188:    default quota will be returned. 
1.472     raeburn  8189: 
                   8190: Returns:
                   8191: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8192: 2. (Optional) institutional type which determined the value of the
                   8193:    default quota.
1.472     raeburn  8194: 
                   8195: If a value has been stored in the domain's configuration db,
                   8196: it will return that, otherwise it returns 20 (for backwards 
                   8197: compatibility with domains which have not set up a configuration
                   8198: db file; the original statically defined portfolio quota was 20 Mb). 
                   8199: 
1.536     raeburn  8200: If the user's status includes multiple types (e.g., staff and student),
                   8201: the largest default quota which applies to the user determines the
                   8202: default quota returned.
                   8203: 
1.780     raeburn  8204: =back
                   8205: 
1.472     raeburn  8206: =cut
                   8207: 
                   8208: ###############################################
                   8209: 
                   8210: 
                   8211: sub default_quota {
1.536     raeburn  8212:     my ($udom,$inststatus) = @_;
                   8213:     my ($defquota,$settingstatus);
                   8214:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8215:                                             ['quotas'],$udom);
                   8216:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8217:         if ($inststatus ne '') {
1.765     raeburn  8218:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8219:             foreach my $item (@statuses) {
1.711     raeburn  8220:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8221:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8222:                         if ($defquota eq '') {
                   8223:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8224:                             $settingstatus = $item;
                   8225:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8226:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8227:                             $settingstatus = $item;
                   8228:                         }
                   8229:                     }
                   8230:                 } else {
                   8231:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8232:                         if ($defquota eq '') {
                   8233:                             $defquota = $quotahash{'quotas'}{$item};
                   8234:                             $settingstatus = $item;
                   8235:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8236:                             $defquota = $quotahash{'quotas'}{$item};
                   8237:                             $settingstatus = $item;
                   8238:                         }
1.536     raeburn  8239:                     }
                   8240:                 }
                   8241:             }
                   8242:         }
                   8243:         if ($defquota eq '') {
1.711     raeburn  8244:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8245:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8246:             } else {
                   8247:                 $defquota = $quotahash{'quotas'}{'default'};
                   8248:             }
1.536     raeburn  8249:             $settingstatus = 'default';
                   8250:         }
                   8251:     } else {
                   8252:         $settingstatus = 'default';
                   8253:         $defquota = 20;
                   8254:     }
                   8255:     if (wantarray) {
                   8256:         return ($defquota,$settingstatus);
1.472     raeburn  8257:     } else {
1.536     raeburn  8258:         return $defquota;
1.472     raeburn  8259:     }
                   8260: }
                   8261: 
1.384     raeburn  8262: sub get_secgrprole_info {
                   8263:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8264:     my %sections_count = &get_sections($cdom,$cnum);
                   8265:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8266:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8267:     my @groups = sort(keys(%curr_groups));
                   8268:     my $allroles = [];
                   8269:     my $rolehash;
                   8270:     my $accesshash = {
                   8271:                      active => 'Currently has access',
                   8272:                      future => 'Will have future access',
                   8273:                      previous => 'Previously had access',
                   8274:                   };
                   8275:     if ($needroles) {
                   8276:         $rolehash = {'all' => 'all'};
1.385     albertel 8277:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8278: 	if (&Apache::lonnet::error(%user_roles)) {
                   8279: 	    undef(%user_roles);
                   8280: 	}
                   8281:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8282:             my ($role)=split(/\:/,$item,2);
                   8283:             if ($role eq 'cr') { next; }
                   8284:             if ($role =~ /^cr/) {
                   8285:                 $$rolehash{$role} = (split('/',$role))[3];
                   8286:             } else {
                   8287:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8288:             }
                   8289:         }
                   8290:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8291:             push(@{$allroles},$key);
                   8292:         }
                   8293:         push (@{$allroles},'st');
                   8294:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8295:     }
                   8296:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8297: }
                   8298: 
1.555     raeburn  8299: sub user_picker {
1.994     raeburn  8300:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8301:     my $currdom = $dom;
                   8302:     my %curr_selected = (
                   8303:                         srchin => 'dom',
1.580     raeburn  8304:                         srchby => 'lastname',
1.555     raeburn  8305:                       );
                   8306:     my $srchterm;
1.625     raeburn  8307:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8308:         if ($srch->{'srchby'} ne '') {
                   8309:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8310:         }
                   8311:         if ($srch->{'srchin'} ne '') {
                   8312:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8313:         }
                   8314:         if ($srch->{'srchtype'} ne '') {
                   8315:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8316:         }
                   8317:         if ($srch->{'srchdomain'} ne '') {
                   8318:             $currdom = $srch->{'srchdomain'};
                   8319:         }
                   8320:         $srchterm = $srch->{'srchterm'};
                   8321:     }
                   8322:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8323:                     'usr'       => 'Search criteria',
1.563     raeburn  8324:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8325:                     'uname'     => 'username',
                   8326:                     'lastname'  => 'last name',
1.555     raeburn  8327:                     'lastfirst' => 'last name, first name',
1.558     albertel 8328:                     'crs'       => 'in this course',
1.576     raeburn  8329:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8330:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8331:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8332:                     'exact'     => 'is',
                   8333:                     'contains'  => 'contains',
1.569     raeburn  8334:                     'begins'    => 'begins with',
1.571     raeburn  8335:                     'youm'      => "You must include some text to search for.",
                   8336:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8337:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8338:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8339:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8340:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8341:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8342:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8343:                                        );
1.563     raeburn  8344:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8345:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8346: 
                   8347:     my @srchins = ('crs','dom','alc','instd');
                   8348: 
                   8349:     foreach my $option (@srchins) {
                   8350:         # FIXME 'alc' option unavailable until 
                   8351:         #       loncreateuser::print_user_query_page()
                   8352:         #       has been completed.
                   8353:         next if ($option eq 'alc');
1.880     raeburn  8354:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8355:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8356:         if ($curr_selected{'srchin'} eq $option) {
                   8357:             $srchinsel .= ' 
                   8358:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8359:         } else {
                   8360:             $srchinsel .= '
                   8361:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8362:         }
1.555     raeburn  8363:     }
1.563     raeburn  8364:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8365: 
                   8366:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8367:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8368:         if ($curr_selected{'srchby'} eq $option) {
                   8369:             $srchbysel .= '
                   8370:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8371:         } else {
                   8372:             $srchbysel .= '
                   8373:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8374:          }
                   8375:     }
                   8376:     $srchbysel .= "\n  </select>\n";
                   8377: 
                   8378:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8379:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8380:         if ($curr_selected{'srchtype'} eq $option) {
                   8381:             $srchtypesel .= '
                   8382:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8383:         } else {
                   8384:             $srchtypesel .= '
                   8385:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8386:         }
                   8387:     }
                   8388:     $srchtypesel .= "\n  </select>\n";
                   8389: 
1.558     albertel 8390:     my ($newuserscript,$new_user_create);
1.994     raeburn  8391:     my $context_dom = $env{'request.role.domain'};
                   8392:     if ($context eq 'requestcrs') {
                   8393:         if ($env{'form.coursedom'} ne '') { 
                   8394:             $context_dom = $env{'form.coursedom'};
                   8395:         }
                   8396:     }
1.556     raeburn  8397:     if ($forcenewuser) {
1.576     raeburn  8398:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8399:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8400:                 if ($cancreate) {
                   8401:                     $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>';
                   8402:                 } else {
1.799     bisitz   8403:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8404:                     my %usertypetext = (
                   8405:                         official   => 'institutional',
                   8406:                         unofficial => 'non-institutional',
                   8407:                     );
1.799     bisitz   8408:                     $new_user_create = '<p class="LC_warning">'
                   8409:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8410:                                       .' '
                   8411:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8412:                                           ,'<a href="'.$helplink.'">','</a>')
                   8413:                                       .'</p><br />';
1.627     raeburn  8414:                 }
1.576     raeburn  8415:             }
                   8416:         }
                   8417: 
1.556     raeburn  8418:         $newuserscript = <<"ENDSCRIPT";
                   8419: 
1.570     raeburn  8420: function setSearch(createnew,callingForm) {
1.556     raeburn  8421:     if (createnew == 1) {
1.570     raeburn  8422:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8423:             if (callingForm.srchby.options[i].value == 'uname') {
                   8424:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8425:             }
                   8426:         }
1.570     raeburn  8427:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8428:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8429: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8430:             }
                   8431:         }
1.570     raeburn  8432:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8433:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8434:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8435:             }
                   8436:         }
1.570     raeburn  8437:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8438:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8439:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8440:             }
                   8441:         }
                   8442:     }
                   8443: }
                   8444: ENDSCRIPT
1.558     albertel 8445: 
1.556     raeburn  8446:     }
                   8447: 
1.555     raeburn  8448:     my $output = <<"END_BLOCK";
1.556     raeburn  8449: <script type="text/javascript">
1.824     bisitz   8450: // <![CDATA[
1.570     raeburn  8451: function validateEntry(callingForm) {
1.558     albertel 8452: 
1.556     raeburn  8453:     var checkok = 1;
1.558     albertel 8454:     var srchin;
1.570     raeburn  8455:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8456: 	if ( callingForm.srchin[i].checked ) {
                   8457: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8458: 	}
                   8459:     }
                   8460: 
1.570     raeburn  8461:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8462:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8463:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8464:     var srchterm =  callingForm.srchterm.value;
                   8465:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8466:     var msg = "";
                   8467: 
                   8468:     if (srchterm == "") {
                   8469:         checkok = 0;
1.571     raeburn  8470:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8471:     }
                   8472: 
1.569     raeburn  8473:     if (srchtype== 'begins') {
                   8474:         if (srchterm.length < 2) {
                   8475:             checkok = 0;
1.571     raeburn  8476:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8477:         }
                   8478:     }
                   8479: 
1.556     raeburn  8480:     if (srchtype== 'contains') {
                   8481:         if (srchterm.length < 3) {
                   8482:             checkok = 0;
1.571     raeburn  8483:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8484:         }
                   8485:     }
                   8486:     if (srchin == 'instd') {
                   8487:         if (srchdomain == '') {
                   8488:             checkok = 0;
1.571     raeburn  8489:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8490:         }
                   8491:     }
                   8492:     if (srchin == 'dom') {
                   8493:         if (srchdomain == '') {
                   8494:             checkok = 0;
1.571     raeburn  8495:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8496:         }
                   8497:     }
                   8498:     if (srchby == 'lastfirst') {
                   8499:         if (srchterm.indexOf(",") == -1) {
                   8500:             checkok = 0;
1.571     raeburn  8501:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8502:         }
                   8503:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8504:             checkok = 0;
1.571     raeburn  8505:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8506:         }
                   8507:     }
                   8508:     if (checkok == 0) {
1.571     raeburn  8509:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8510:         return;
                   8511:     }
                   8512:     if (checkok == 1) {
1.570     raeburn  8513:         callingForm.submit();
1.556     raeburn  8514:     }
                   8515: }
                   8516: 
                   8517: $newuserscript
                   8518: 
1.824     bisitz   8519: // ]]>
1.556     raeburn  8520: </script>
1.558     albertel 8521: 
                   8522: $new_user_create
                   8523: 
1.555     raeburn  8524: END_BLOCK
1.558     albertel 8525: 
1.876     raeburn  8526:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8527:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8528:                $domform.
                   8529:                &Apache::lonhtmlcommon::row_closure().
                   8530:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8531:                $srchbysel.
                   8532:                $srchtypesel. 
                   8533:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8534:                $srchinsel.
                   8535:                &Apache::lonhtmlcommon::row_closure(1). 
                   8536:                &Apache::lonhtmlcommon::end_pick_box().
                   8537:                '<br />';
1.555     raeburn  8538:     return $output;
                   8539: }
                   8540: 
1.612     raeburn  8541: sub user_rule_check {
1.615     raeburn  8542:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8543:     my $response;
                   8544:     if (ref($usershash) eq 'HASH') {
                   8545:         foreach my $user (keys(%{$usershash})) {
                   8546:             my ($uname,$udom) = split(/:/,$user);
                   8547:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8548:             my ($id,$newuser);
1.612     raeburn  8549:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8550:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8551:                 $id = $usershash->{$user}->{'id'};
                   8552:             }
                   8553:             my $inst_response;
                   8554:             if (ref($checks) eq 'HASH') {
                   8555:                 if (defined($checks->{'username'})) {
1.615     raeburn  8556:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8557:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8558:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8559:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8560:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8561:                 }
1.615     raeburn  8562:             } else {
                   8563:                 ($inst_response,%{$inst_results->{$user}}) =
                   8564:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8565:                 return;
1.612     raeburn  8566:             }
1.615     raeburn  8567:             if (!$got_rules->{$udom}) {
1.612     raeburn  8568:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8569:                                                   ['usercreation'],$udom);
                   8570:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8571:                     foreach my $item ('username','id') {
1.612     raeburn  8572:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8573:                             $$curr_rules{$udom}{$item} = 
                   8574:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8575:                         }
                   8576:                     }
                   8577:                 }
1.615     raeburn  8578:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8579:             }
1.612     raeburn  8580:             foreach my $item (keys(%{$checks})) {
                   8581:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8582:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8583:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8584:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8585:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8586:                                 if ($rule_check{$rule}) {
                   8587:                                     $$rulematch{$user}{$item} = $rule;
                   8588:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8589:                                         if (ref($inst_results) eq 'HASH') {
                   8590:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8591:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8592:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8593:                                                 }
1.612     raeburn  8594:                                             }
                   8595:                                         }
1.615     raeburn  8596:                                     }
                   8597:                                     last;
1.585     raeburn  8598:                                 }
                   8599:                             }
                   8600:                         }
                   8601:                     }
                   8602:                 }
                   8603:             }
                   8604:         }
                   8605:     }
1.612     raeburn  8606:     return;
                   8607: }
                   8608: 
                   8609: sub user_rule_formats {
                   8610:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8611:     my %text = ( 
                   8612:                  'username' => 'Usernames',
                   8613:                  'id'       => 'IDs',
                   8614:                );
                   8615:     my $output;
                   8616:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8617:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8618:         if (@{$ruleorder} > 0) {
                   8619:             $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>';
                   8620:             foreach my $rule (@{$ruleorder}) {
                   8621:                 if (ref($curr_rules) eq 'ARRAY') {
                   8622:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8623:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8624:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8625:                                         $rules->{$rule}{'desc'}.'</li>';
                   8626:                         }
                   8627:                     }
                   8628:                 }
                   8629:             }
                   8630:             $output .= '</ul>';
                   8631:         }
                   8632:     }
                   8633:     return $output;
                   8634: }
                   8635: 
                   8636: sub instrule_disallow_msg {
1.615     raeburn  8637:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8638:     my $response;
                   8639:     my %text = (
                   8640:                   item   => 'username',
                   8641:                   items  => 'usernames',
                   8642:                   match  => 'matches',
                   8643:                   do     => 'does',
                   8644:                   action => 'a username',
                   8645:                   one    => 'one',
                   8646:                );
                   8647:     if ($count > 1) {
                   8648:         $text{'item'} = 'usernames';
                   8649:         $text{'match'} ='match';
                   8650:         $text{'do'} = 'do';
                   8651:         $text{'action'} = 'usernames',
                   8652:         $text{'one'} = 'ones';
                   8653:     }
                   8654:     if ($checkitem eq 'id') {
                   8655:         $text{'items'} = 'IDs';
                   8656:         $text{'item'} = 'ID';
                   8657:         $text{'action'} = 'an ID';
1.615     raeburn  8658:         if ($count > 1) {
                   8659:             $text{'item'} = 'IDs';
                   8660:             $text{'action'} = 'IDs';
                   8661:         }
1.612     raeburn  8662:     }
1.674     bisitz   8663:     $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  8664:     if ($mode eq 'upload') {
                   8665:         if ($checkitem eq 'username') {
                   8666:             $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'}.");
                   8667:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8668:             $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  8669:         }
1.669     raeburn  8670:     } elsif ($mode eq 'selfcreate') {
                   8671:         if ($checkitem eq 'id') {
                   8672:             $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.");
                   8673:         }
1.615     raeburn  8674:     } else {
                   8675:         if ($checkitem eq 'username') {
                   8676:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8677:         } elsif ($checkitem eq 'id') {
                   8678:             $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.");
                   8679:         }
1.612     raeburn  8680:     }
                   8681:     return $response;
1.585     raeburn  8682: }
                   8683: 
1.624     raeburn  8684: sub personal_data_fieldtitles {
                   8685:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8686:                         id => 'Student/Employee ID',
                   8687:                         permanentemail => 'E-mail address',
                   8688:                         lastname => 'Last Name',
                   8689:                         firstname => 'First Name',
                   8690:                         middlename => 'Middle Name',
                   8691:                         generation => 'Generation',
                   8692:                         gen => 'Generation',
1.765     raeburn  8693:                         inststatus => 'Affiliation',
1.624     raeburn  8694:                    );
                   8695:     return %fieldtitles;
                   8696: }
                   8697: 
1.642     raeburn  8698: sub sorted_inst_types {
                   8699:     my ($dom) = @_;
                   8700:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8701:     my $othertitle = &mt('All users');
                   8702:     if ($env{'request.course.id'}) {
1.668     raeburn  8703:         $othertitle  = &mt('Any users');
1.642     raeburn  8704:     }
                   8705:     my @types;
                   8706:     if (ref($order) eq 'ARRAY') {
                   8707:         @types = @{$order};
                   8708:     }
                   8709:     if (@types == 0) {
                   8710:         if (ref($usertypes) eq 'HASH') {
                   8711:             @types = sort(keys(%{$usertypes}));
                   8712:         }
                   8713:     }
                   8714:     if (keys(%{$usertypes}) > 0) {
                   8715:         $othertitle = &mt('Other users');
                   8716:     }
                   8717:     return ($othertitle,$usertypes,\@types);
                   8718: }
                   8719: 
1.645     raeburn  8720: sub get_institutional_codes {
                   8721:     my ($settings,$allcourses,$LC_code) = @_;
                   8722: # Get complete list of course sections to update
                   8723:     my @currsections = ();
                   8724:     my @currxlists = ();
                   8725:     my $coursecode = $$settings{'internal.coursecode'};
                   8726: 
                   8727:     if ($$settings{'internal.sectionnums'} ne '') {
                   8728:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8729:     }
                   8730: 
                   8731:     if ($$settings{'internal.crosslistings'} ne '') {
                   8732:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8733:     }
                   8734: 
                   8735:     if (@currxlists > 0) {
                   8736:         foreach (@currxlists) {
                   8737:             if (m/^([^:]+):(\w*)$/) {
                   8738:                 unless (grep/^$1$/,@{$allcourses}) {
                   8739:                     push @{$allcourses},$1;
                   8740:                     $$LC_code{$1} = $2;
                   8741:                 }
                   8742:             }
                   8743:         }
                   8744:     }
                   8745:  
                   8746:     if (@currsections > 0) {
                   8747:         foreach (@currsections) {
                   8748:             if (m/^(\w+):(\w*)$/) {
                   8749:                 my $sec = $coursecode.$1;
                   8750:                 my $lc_sec = $2;
                   8751:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8752:                     push @{$allcourses},$sec;
                   8753:                     $$LC_code{$sec} = $lc_sec;
                   8754:                 }
                   8755:             }
                   8756:         }
                   8757:     }
                   8758:     return;
                   8759: }
                   8760: 
1.971     raeburn  8761: sub get_standard_codeitems {
                   8762:     return ('Year','Semester','Department','Number','Section');
                   8763: }
                   8764: 
1.112     bowersj2 8765: =pod
                   8766: 
1.780     raeburn  8767: =head1 Slot Helpers
                   8768: 
                   8769: =over 4
                   8770: 
                   8771: =item * sorted_slots()
                   8772: 
1.1040    raeburn  8773: Sorts an array of slot names in order of an optional sort key,
                   8774: default sort is by slot start time (earliest first). 
1.780     raeburn  8775: 
                   8776: Inputs:
                   8777: 
                   8778: =over 4
                   8779: 
                   8780: slotsarr  - Reference to array of unsorted slot names.
                   8781: 
                   8782: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8783: 
1.1040    raeburn  8784: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   8785: 
1.549     albertel 8786: =back
                   8787: 
1.780     raeburn  8788: Returns:
                   8789: 
                   8790: =over 4
                   8791: 
1.1040    raeburn  8792: sorted   - An array of slot names sorted by a specified sort key 
                   8793:            (default sort key is start time of the slot).
1.780     raeburn  8794: 
                   8795: =back
                   8796: 
                   8797: =cut
                   8798: 
                   8799: 
                   8800: sub sorted_slots {
1.1040    raeburn  8801:     my ($slotsarr,$slots,$sortkey) = @_;
                   8802:     if ($sortkey eq '') {
                   8803:         $sortkey = 'starttime';
                   8804:     }
1.780     raeburn  8805:     my @sorted;
                   8806:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8807:         @sorted =
                   8808:             sort {
                   8809:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  8810:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  8811:                      }
                   8812:                      if (ref($slots->{$a})) { return -1;}
                   8813:                      if (ref($slots->{$b})) { return 1;}
                   8814:                      return 0;
                   8815:                  } @{$slotsarr};
                   8816:     }
                   8817:     return @sorted;
                   8818: }
                   8819: 
1.1040    raeburn  8820: =pod
                   8821: 
                   8822: =item * get_future_slots()
                   8823: 
                   8824: Inputs:
                   8825: 
                   8826: =over 4
                   8827: 
                   8828: cnum - course number
                   8829: 
                   8830: cdom - course domain
                   8831: 
                   8832: now - current UNIX time
                   8833: 
                   8834: symb - optional symb
                   8835: 
                   8836: =back
                   8837: 
                   8838: Returns:
                   8839: 
                   8840: =over 4
                   8841: 
                   8842: sorted_reservable - ref to array of student_schedulable slots currently 
                   8843:                     reservable, ordered by end date of reservation period.
                   8844: 
                   8845: reservable_now - ref to hash of student_schedulable slots currently
                   8846:                  reservable.
                   8847: 
                   8848:     Keys in inner hash are:
                   8849:     (a) symb: either blank or symb to which slot use is restricted.
                   8850:     (b) endreserve: end date of reservation period. 
                   8851: 
                   8852: sorted_future - ref to array of student_schedulable slots reservable in
                   8853:                 the future, ordered by start date of reservation period.
                   8854: 
                   8855: future_reservable - ref to hash of student_schedulable slots reservable
                   8856:                     in the future.
                   8857: 
                   8858:     Keys in inner hash are:
                   8859:     (a) symb: either blank or symb to which slot use is restricted.
                   8860:     (b) startreserve:  start date of reservation period.
                   8861: 
                   8862: =back
                   8863: 
                   8864: =cut
                   8865: 
                   8866: sub get_future_slots {
                   8867:     my ($cnum,$cdom,$now,$symb) = @_;
                   8868:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   8869:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   8870:     foreach my $slot (keys(%slots)) {
                   8871:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   8872:         if ($symb) {
                   8873:             next if (($slots{$slot}->{'symb'} ne '') && 
                   8874:                      ($slots{$slot}->{'symb'} ne $symb));
                   8875:         }
                   8876:         if (($slots{$slot}->{'starttime'} > $now) &&
                   8877:             ($slots{$slot}->{'endtime'} > $now)) {
                   8878:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   8879:                 my $userallowed = 0;
                   8880:                 if ($slots{$slot}->{'allowedsections'}) {
                   8881:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   8882:                     if (!defined($env{'request.role.sec'})
                   8883:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   8884:                         $userallowed=1;
                   8885:                     } else {
                   8886:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   8887:                             $userallowed=1;
                   8888:                         }
                   8889:                     }
                   8890:                     unless ($userallowed) {
                   8891:                         if (defined($env{'request.course.groups'})) {
                   8892:                             my @groups = split(/:/,$env{'request.course.groups'});
                   8893:                             foreach my $group (@groups) {
                   8894:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   8895:                                     $userallowed=1;
                   8896:                                     last;
                   8897:                                 }
                   8898:                             }
                   8899:                         }
                   8900:                     }
                   8901:                 }
                   8902:                 if ($slots{$slot}->{'allowedusers'}) {
                   8903:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   8904:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   8905:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   8906:                         $userallowed = 1;
                   8907:                     }
                   8908:                 }
                   8909:                 next unless($userallowed);
                   8910:             }
                   8911:             my $startreserve = $slots{$slot}->{'startreserve'};
                   8912:             my $endreserve = $slots{$slot}->{'endreserve'};
                   8913:             my $symb = $slots{$slot}->{'symb'};
                   8914:             if (($startreserve < $now) &&
                   8915:                 (!$endreserve || $endreserve > $now)) {
                   8916:                 my $lastres = $endreserve;
                   8917:                 if (!$lastres) {
                   8918:                     $lastres = $slots{$slot}->{'starttime'};
                   8919:                 }
                   8920:                 $reservable_now{$slot} = {
                   8921:                                            symb       => $symb,
                   8922:                                            endreserve => $lastres
                   8923:                                          };
                   8924:             } elsif (($startreserve > $now) &&
                   8925:                      (!$endreserve || $endreserve > $startreserve)) {
                   8926:                 $future_reservable{$slot} = {
                   8927:                                               symb         => $symb,
                   8928:                                               startreserve => $startreserve
                   8929:                                             };
                   8930:             }
                   8931:         }
                   8932:     }
                   8933:     my @unsorted_reservable = keys(%reservable_now);
                   8934:     if (@unsorted_reservable > 0) {
                   8935:         @sorted_reservable = 
                   8936:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   8937:     }
                   8938:     my @unsorted_future = keys(%future_reservable);
                   8939:     if (@unsorted_future > 0) {
                   8940:         @sorted_future =
                   8941:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   8942:     }
                   8943:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   8944: }
1.780     raeburn  8945: 
                   8946: =pod
                   8947: 
1.1057    foxr     8948: =back
                   8949: 
1.549     albertel 8950: =head1 HTTP Helpers
                   8951: 
                   8952: =over 4
                   8953: 
1.648     raeburn  8954: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8955: 
1.258     albertel 8956: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8957: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8958: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8959: 
                   8960: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8961: $possible_names is an ref to an array of form element names.  As an example:
                   8962: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8963: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8964: 
                   8965: =cut
1.1       albertel 8966: 
1.6       albertel 8967: sub get_unprocessed_cgi {
1.25      albertel 8968:   my ($query,$possible_names)= @_;
1.26      matthew  8969:   # $Apache::lonxml::debug=1;
1.356     albertel 8970:   foreach my $pair (split(/&/,$query)) {
                   8971:     my ($name, $value) = split(/=/,$pair);
1.369     www      8972:     $name = &unescape($name);
1.25      albertel 8973:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8974:       $value =~ tr/+/ /;
                   8975:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8976:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8977:     }
1.16      harris41 8978:   }
1.6       albertel 8979: }
                   8980: 
1.112     bowersj2 8981: =pod
                   8982: 
1.648     raeburn  8983: =item * &cacheheader() 
1.112     bowersj2 8984: 
                   8985: returns cache-controlling header code
                   8986: 
                   8987: =cut
                   8988: 
1.7       albertel 8989: sub cacheheader {
1.258     albertel 8990:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8991:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8992:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8993:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8994:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8995:     return $output;
1.7       albertel 8996: }
                   8997: 
1.112     bowersj2 8998: =pod
                   8999: 
1.648     raeburn  9000: =item * &no_cache($r) 
1.112     bowersj2 9001: 
                   9002: specifies header code to not have cache
                   9003: 
                   9004: =cut
                   9005: 
1.9       albertel 9006: sub no_cache {
1.216     albertel 9007:     my ($r) = @_;
                   9008:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 9009: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 9010:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   9011:     $r->no_cache(1);
                   9012:     $r->header_out("Expires" => $date);
                   9013:     $r->header_out("Pragma" => "no-cache");
1.123     www      9014: }
                   9015: 
                   9016: sub content_type {
1.181     albertel 9017:     my ($r,$type,$charset) = @_;
1.299     foxr     9018:     if ($r) {
                   9019: 	#  Note that printout.pl calls this with undef for $r.
                   9020: 	&no_cache($r);
                   9021:     }
1.258     albertel 9022:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 9023:     unless ($charset) {
                   9024: 	$charset=&Apache::lonlocal::current_encoding;
                   9025:     }
                   9026:     if ($charset) { $type.='; charset='.$charset; }
                   9027:     if ($r) {
                   9028: 	$r->content_type($type);
                   9029:     } else {
                   9030: 	print("Content-type: $type\n\n");
                   9031:     }
1.9       albertel 9032: }
1.25      albertel 9033: 
1.112     bowersj2 9034: =pod
                   9035: 
1.648     raeburn  9036: =item * &add_to_env($name,$value) 
1.112     bowersj2 9037: 
1.258     albertel 9038: adds $name to the %env hash with value
1.112     bowersj2 9039: $value, if $name already exists, the entry is converted to an array
                   9040: reference and $value is added to the array.
                   9041: 
                   9042: =cut
                   9043: 
1.25      albertel 9044: sub add_to_env {
                   9045:   my ($name,$value)=@_;
1.258     albertel 9046:   if (defined($env{$name})) {
                   9047:     if (ref($env{$name})) {
1.25      albertel 9048:       #already have multiple values
1.258     albertel 9049:       push(@{ $env{$name} },$value);
1.25      albertel 9050:     } else {
                   9051:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 9052:       my $first=$env{$name};
                   9053:       undef($env{$name});
                   9054:       push(@{ $env{$name} },$first,$value);
1.25      albertel 9055:     }
                   9056:   } else {
1.258     albertel 9057:     $env{$name}=$value;
1.25      albertel 9058:   }
1.31      albertel 9059: }
1.149     albertel 9060: 
                   9061: =pod
                   9062: 
1.648     raeburn  9063: =item * &get_env_multiple($name) 
1.149     albertel 9064: 
1.258     albertel 9065: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 9066: values may be defined and end up as an array ref.
                   9067: 
                   9068: returns an array of values
                   9069: 
                   9070: =cut
                   9071: 
                   9072: sub get_env_multiple {
                   9073:     my ($name) = @_;
                   9074:     my @values;
1.258     albertel 9075:     if (defined($env{$name})) {
1.149     albertel 9076:         # exists is it an array
1.258     albertel 9077:         if (ref($env{$name})) {
                   9078:             @values=@{ $env{$name} };
1.149     albertel 9079:         } else {
1.258     albertel 9080:             $values[0]=$env{$name};
1.149     albertel 9081:         }
                   9082:     }
                   9083:     return(@values);
                   9084: }
                   9085: 
1.660     raeburn  9086: sub ask_for_embedded_content {
                   9087:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.987     raeburn  9088:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges);
1.660     raeburn  9089:     my $num = 0;
1.987     raeburn  9090:     my $numremref = 0;
                   9091:     my $numinvalid = 0;
                   9092:     my $numpathchg = 0;
                   9093:     my $numexisting = 0;
                   9094:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath);
1.984     raeburn  9095:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9096:         my $current_path='/';
                   9097:         if ($env{'form.currentpath'}) {
                   9098:             $current_path = $env{'form.currentpath'};
                   9099:         }
                   9100:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   9101:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9102:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9103:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   9104:         } else {
                   9105:             $udom = $env{'user.domain'};
                   9106:             $uname = $env{'user.name'};
                   9107:             $url = '/userfiles/portfolio';
                   9108:         }
1.987     raeburn  9109:         $toplevel = $url.'/';
1.984     raeburn  9110:         $url .= $current_path;
                   9111:         $getpropath = 1;
1.987     raeburn  9112:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   9113:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      9114:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  9115:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  9116:         $toplevel = $url;
1.984     raeburn  9117:         if ($rest ne '') {
1.987     raeburn  9118:             $url .= $rest;
                   9119:         }
                   9120:     } elsif ($actionurl eq '/adm/coursedocs') {
                   9121:         if (ref($args) eq 'HASH') {
                   9122:            $url = $args->{'docs_url'};
                   9123:            $toplevel = $url;
                   9124:         }
                   9125:     }
                   9126:     my $now = time();
                   9127:     foreach my $embed_file (keys(%{$allfiles})) {
                   9128:         my $absolutepath;
                   9129:         if ($embed_file =~ m{^\w+://}) {
                   9130:             $newfiles{$embed_file} = 1;
                   9131:             $mapping{$embed_file} = $embed_file;
                   9132:         } else {
                   9133:             if ($embed_file =~ m{^/}) {
                   9134:                 $absolutepath = $embed_file;
                   9135:                 $embed_file =~ s{^(/+)}{};
                   9136:             }
                   9137:             if ($embed_file =~ m{/}) {
                   9138:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9139:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9140:                 my $item = $fname;
                   9141:                 if ($path ne '') {
                   9142:                     $item = $path.'/'.$fname;
                   9143:                     $subdependencies{$path}{$fname} = 1;
                   9144:                 } else {
                   9145:                     $dependencies{$item} = 1;
                   9146:                 }
                   9147:                 if ($absolutepath) {
                   9148:                     $mapping{$item} = $absolutepath;
                   9149:                 } else {
                   9150:                     $mapping{$item} = $embed_file;
                   9151:                 }
                   9152:             } else {
                   9153:                 $dependencies{$embed_file} = 1;
                   9154:                 if ($absolutepath) {
                   9155:                     $mapping{$embed_file} = $absolutepath;
                   9156:                 } else {
                   9157:                     $mapping{$embed_file} = $embed_file;
                   9158:                 }
                   9159:             }
1.984     raeburn  9160:         }
                   9161:     }
                   9162:     foreach my $path (keys(%subdependencies)) {
                   9163:         my %currsubfile;
                   9164:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9165:             my ($sublistref,$listerror) =
                   9166:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9167:             if (ref($sublistref) eq 'ARRAY') {
                   9168:                 foreach my $line (@{$sublistref}) {
                   9169:                     my ($file_name,$rest) = split(/\&/,$line,2);
                   9170:                     $currsubfile{$file_name} = 1;
                   9171:                 }
1.984     raeburn  9172:             }
1.987     raeburn  9173:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9174:             if (opendir(my $dir,$url.'/'.$path)) {
                   9175:                 my @subdir_list = grep(!/^\./,readdir($dir));
                   9176:                 map {$currsubfile{$_} = 1;} @subdir_list;
                   9177:             }
                   9178:         }
                   9179:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.987     raeburn  9180:             if ($currsubfile{$file}) {
                   9181:                 my $item = $path.'/'.$file;
                   9182:                 unless ($mapping{$item} eq $item) {
                   9183:                     $pathchanges{$item} = 1;
                   9184:                 }
                   9185:                 $existing{$item} = 1;
                   9186:                 $numexisting ++;
                   9187:             } else {
                   9188:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9189:             }
                   9190:         }
                   9191:     }
1.987     raeburn  9192:     my %currfile;
1.984     raeburn  9193:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9194:         my ($dirlistref,$listerror) =
                   9195:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9196:         if (ref($dirlistref) eq 'ARRAY') {
                   9197:             foreach my $line (@{$dirlistref}) {
                   9198:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9199:                 $currfile{$file_name} = 1;
                   9200:             }
1.984     raeburn  9201:         }
1.987     raeburn  9202:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9203:         if (opendir(my $dir,$url)) {
1.987     raeburn  9204:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9205:             map {$currfile{$_} = 1;} @dir_list;
                   9206:         }
                   9207:     }
                   9208:     foreach my $file (keys(%dependencies)) {
1.987     raeburn  9209:         if ($currfile{$file}) {
                   9210:             unless ($mapping{$file} eq $file) {
                   9211:                 $pathchanges{$file} = 1;
                   9212:             }
                   9213:             $existing{$file} = 1;
                   9214:             $numexisting ++;
                   9215:         } else {
1.984     raeburn  9216:             $newfiles{$file} = 1;
                   9217:         }
                   9218:     }
                   9219:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.660     raeburn  9220:         $upload_output .= &start_data_table_row().
1.987     raeburn  9221:                           '<td><span class="LC_filename">'.$embed_file.'</span>';
                   9222:         unless ($mapping{$embed_file} eq $embed_file) {
                   9223:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9224:         }
                   9225:         $upload_output .= '</td><td>';
1.660     raeburn  9226:         if ($args->{'ignore_remote_references'}
                   9227:             && $embed_file =~ m{^\w+://}) {
                   9228:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9229:             $numremref++;
1.660     raeburn  9230:         } elsif ($args->{'error_on_invalid_names'}
                   9231:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9232: 
1.987     raeburn  9233:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9234:             $numinvalid++;
1.660     raeburn  9235:         } else {
1.987     raeburn  9236:             $upload_output .= &embedded_file_element('upload_embedded',$num,
                   9237:                                                      $embed_file,\%mapping,
                   9238:                                                      $allfiles,$codebase);
                   9239:             $num++;
                   9240:         }
                   9241:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9242:     }
                   9243:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
                   9244:         $upload_output .= &start_data_table_row().
                   9245:                           '<td><span class="LC_filename">'.$embed_file.'</span></td>'.
                   9246:                           '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9247:                           &Apache::loncommon::end_data_table_row()."\n";
                   9248:     }
                   9249:     if ($upload_output) {
                   9250:         $upload_output = &start_data_table().
                   9251:                          $upload_output.
                   9252:                          &end_data_table()."\n";
                   9253:     }
                   9254:     my $applies = 0;
                   9255:     if ($numremref) {
                   9256:         $applies ++;
                   9257:     }
                   9258:     if ($numinvalid) {
                   9259:         $applies ++;
                   9260:     }
                   9261:     if ($numexisting) {
                   9262:         $applies ++;
                   9263:     }
                   9264:     if ($num) {
                   9265:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9266:                   ' method="post" enctype="multipart/form-data">'."\n".
                   9267:                   $state.
                   9268:                   '<h3>'.&mt('Upload embedded files').
                   9269:                   ':</h3>'.$upload_output.'<br />'."\n".
                   9270:                   '<input type ="hidden" name="number_embedded_items" value="'.
                   9271:                   $num.'" />'."\n";
                   9272:         if ($actionurl eq '') {
                   9273:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9274:         }
                   9275:     } elsif ($applies) {
                   9276:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9277:         if ($applies > 1) {
                   9278:             $output .=  
                   9279:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9280:             if ($numremref) {
                   9281:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9282:             }
                   9283:             if ($numinvalid) {
                   9284:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9285:             }
                   9286:             if ($numexisting) {
                   9287:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9288:             }
                   9289:             $output .= '</ul><br />';
                   9290:         } elsif ($numremref) {
                   9291:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9292:         } elsif ($numinvalid) {
                   9293:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9294:         } elsif ($numexisting) {
                   9295:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9296:         }
                   9297:         $output .= $upload_output.'<br />';
                   9298:     }
                   9299:     my ($pathchange_output,$chgcount);
                   9300:     $chgcount = $num;
                   9301:     if (keys(%pathchanges) > 0) {
                   9302:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
                   9303:             if ($num) {
                   9304:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9305:                                                   $embed_file,\%mapping,
                   9306:                                                   $allfiles,$codebase);
                   9307:             } else {
                   9308:                 $pathchange_output .= 
                   9309:                     &start_data_table_row().
                   9310:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9311:                     $chgcount.'" checked="checked" /></td>'.
                   9312:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9313:                     '<td>'.$embed_file.
                   9314:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
                   9315:                                            \%mapping,$allfiles,$codebase).
                   9316:                     '</td>'.&end_data_table_row();
1.660     raeburn  9317:             }
1.987     raeburn  9318:             $numpathchg ++;
                   9319:             $chgcount ++;
1.660     raeburn  9320:         }
                   9321:     }
1.984     raeburn  9322:     if ($num) {
1.987     raeburn  9323:         if ($numpathchg) {
                   9324:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9325:                        $numpathchg.'" />'."\n";
                   9326:         }
                   9327:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9328:             ($actionurl eq '/adm/imsimport')) {
                   9329:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9330:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9331:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
                   9332:         }
                   9333:         $output .=  '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n".
                   9334:                     &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n";
                   9335:     } elsif ($numpathchg) {
                   9336:         my %pathchange = ();
                   9337:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9338:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9339:             $output .= '<p>'.&mt('or').'</p>'; 
                   9340:         } 
                   9341:     }
                   9342:     return ($output,$num,$numpathchg);
                   9343: }
                   9344: 
                   9345: sub embedded_file_element {
                   9346:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_;
                   9347:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9348:                    (ref($codebase) eq 'HASH'));
                   9349:     my $output;
                   9350:     if ($context eq 'upload_embedded') {
                   9351:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9352:     }
                   9353:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9354:                &escape($embed_file).'" />';
                   9355:     unless (($context eq 'upload_embedded') && 
                   9356:             ($mapping->{$embed_file} eq $embed_file)) {
                   9357:         $output .='
                   9358:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9359:     }
                   9360:     my $attrib;
                   9361:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9362:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9363:     }
                   9364:     $output .=
                   9365:         "\n\t\t".
                   9366:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9367:         $attrib.'" />';
                   9368:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9369:         $output .=
                   9370:             "\n\t\t".
                   9371:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9372:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9373:     }
1.987     raeburn  9374:     return $output;
1.660     raeburn  9375: }
                   9376: 
1.661     raeburn  9377: sub upload_embedded {
                   9378:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9379:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9380:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9381:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9382:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9383:         my $orig_uploaded_filename =
                   9384:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9385:         foreach my $type ('orig','ref','attrib','codebase') {
                   9386:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9387:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9388:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9389:             }
                   9390:         }
1.661     raeburn  9391:         my ($path,$fname) =
                   9392:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9393:         # no path, whole string is fname
                   9394:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9395:         $fname = &Apache::lonnet::clean_filename($fname);
                   9396:         # See if there is anything left
                   9397:         next if ($fname eq '');
                   9398: 
                   9399:         # Check if file already exists as a file or directory.
                   9400:         my ($state,$msg);
                   9401:         if ($context eq 'portfolio') {
                   9402:             my $port_path = $dirpath;
                   9403:             if ($group ne '') {
                   9404:                 $port_path = "groups/$group/$port_path";
                   9405:             }
1.987     raeburn  9406:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9407:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9408:                                               $dir_root,$port_path,$disk_quota,
                   9409:                                               $current_disk_usage,$uname,$udom);
                   9410:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9411:                 || $state eq 'file_locked') {
1.661     raeburn  9412:                 $output .= $msg;
                   9413:                 next;
                   9414:             }
                   9415:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9416:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9417:             if ($state eq 'exists') {
                   9418:                 $output .= $msg;
                   9419:                 next;
                   9420:             }
                   9421:         }
                   9422:         # Check if extension is valid
                   9423:         if (($fname =~ /\.(\w+)$/) &&
                   9424:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9425:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661     raeburn  9426:             next;
                   9427:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9428:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9429:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9430:             next;
                   9431:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9432:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661     raeburn  9433:             next;
                   9434:         }
                   9435: 
                   9436:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9437:         if ($context eq 'portfolio') {
1.984     raeburn  9438:             my $result;
                   9439:             if ($state eq 'existingfile') {
                   9440:                 $result=
                   9441:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9442:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9443:             } else {
1.984     raeburn  9444:                 $result=
                   9445:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9446:                                                     $dirpath.
                   9447:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9448:                 if ($result !~ m|^/uploaded/|) {
                   9449:                     $output .= '<span class="LC_error">'
                   9450:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9451:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9452:                                .'</span><br />';
                   9453:                     next;
                   9454:                 } else {
1.987     raeburn  9455:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9456:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9457:                 }
1.661     raeburn  9458:             }
1.987     raeburn  9459:         } elsif ($context eq 'coursedoc') {
                   9460:             my $result =
                   9461:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9462:                                                 $dirpath.'/'.$path);
                   9463:             if ($result !~ m|^/uploaded/|) {
                   9464:                 $output .= '<span class="LC_error">'
                   9465:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9466:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9467:                            .'</span><br />';
                   9468:                     next;
                   9469:             } else {
                   9470:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9471:                            $path.$fname.'</span>').'<br />';
                   9472:             }
1.661     raeburn  9473:         } else {
                   9474: # Save the file
                   9475:             my $target = $env{'form.embedded_item_'.$i};
                   9476:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9477:             my $dest = $fullpath.$fname;
                   9478:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9479:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9480:             my $count;
                   9481:             my $filepath = $dir_root;
1.1027    raeburn  9482:             foreach my $subdir (@parts) {
                   9483:                 $filepath .= "/$subdir";
                   9484:                 if (!-e $filepath) {
1.661     raeburn  9485:                     mkdir($filepath,0770);
                   9486:                 }
                   9487:             }
                   9488:             my $fh;
                   9489:             if (!open($fh,'>'.$dest)) {
                   9490:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9491:                 $output .= '<span class="LC_error">'.
                   9492:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9493:                            '</span><br />';
                   9494:             } else {
                   9495:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9496:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9497:                     $output .= '<span class="LC_error">'.
                   9498:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   9499:                               '</span><br />';
                   9500:                 } else {
1.987     raeburn  9501:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9502:                                $url.'</span>').'<br />';
                   9503:                     unless ($context eq 'testbank') {
                   9504:                         $footer .= &mt('View embedded file: [_1]',
                   9505:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9506:                     }
                   9507:                 }
                   9508:                 close($fh);
                   9509:             }
                   9510:         }
                   9511:         if ($env{'form.embedded_ref_'.$i}) {
                   9512:             $pathchange{$i} = 1;
                   9513:         }
                   9514:     }
                   9515:     if ($output) {
                   9516:         $output = '<p>'.$output.'</p>';
                   9517:     }
                   9518:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9519:     $returnflag = 'ok';
                   9520:     if (keys(%pathchange) > 0) {
                   9521:         if ($context eq 'portfolio') {
                   9522:             $output .= '<p>'.&mt('or').'</p>';
                   9523:         } elsif ($context eq 'testbank') {
1.988     raeburn  9524:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  9525:             $returnflag = 'modify_orightml';
                   9526:         }
                   9527:     }
                   9528:     return ($output.$footer,$returnflag);
                   9529: }
                   9530: 
                   9531: sub modify_html_form {
                   9532:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   9533:     my $end = 0;
                   9534:     my $modifyform;
                   9535:     if ($context eq 'upload_embedded') {
                   9536:         return unless (ref($pathchange) eq 'HASH');
                   9537:         if ($env{'form.number_embedded_items'}) {
                   9538:             $end += $env{'form.number_embedded_items'};
                   9539:         }
                   9540:         if ($env{'form.number_pathchange_items'}) {
                   9541:             $end += $env{'form.number_pathchange_items'};
                   9542:         }
                   9543:         if ($end) {
                   9544:             for (my $i=0; $i<$end; $i++) {
                   9545:                 if ($i < $env{'form.number_embedded_items'}) {
                   9546:                     next unless($pathchange->{$i});
                   9547:                 }
                   9548:                 $modifyform .=
                   9549:                     &start_data_table_row().
                   9550:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   9551:                     'checked="checked" /></td>'.
                   9552:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   9553:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   9554:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   9555:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   9556:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   9557:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   9558:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   9559:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   9560:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   9561:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   9562:                     &end_data_table_row();
                   9563:             } 
                   9564:         }
                   9565:     } else {
                   9566:         $modifyform = $pathchgtable;
                   9567:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   9568:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   9569:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9570:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   9571:         }
                   9572:     }
                   9573:     if ($modifyform) {
                   9574:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   9575:                '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
                   9576:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   9577:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   9578:                '</ol></p>'."\n".'<p>'.
                   9579:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   9580:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   9581:                &start_data_table()."\n".
                   9582:                &start_data_table_header_row().
                   9583:                '<th>'.&mt('Change?').'</th>'.
                   9584:                '<th>'.&mt('Current reference').'</th>'.
                   9585:                '<th>'.&mt('Required reference').'</th>'.
                   9586:                &end_data_table_header_row()."\n".
                   9587:                $modifyform.
                   9588:                &end_data_table().'<br />'."\n".$hiddenstate.
                   9589:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   9590:                '</form>'."\n";
                   9591:     }
                   9592:     return;
                   9593: }
                   9594: 
                   9595: sub modify_html_refs {
                   9596:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   9597:     my $container;
                   9598:     if ($context eq 'portfolio') {
                   9599:         $container = $env{'form.container'};
                   9600:     } elsif ($context eq 'coursedoc') {
                   9601:         $container = $env{'form.primaryurl'};
                   9602:     } else {
1.1027    raeburn  9603:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  9604:     }
                   9605:     my (%allfiles,%codebase,$output,$content);
                   9606:     my @changes = &get_env_multiple('form.namechange');
                   9607:     return unless (@changes > 0);
                   9608:     if (($context eq 'portfolio') || ($context eq 'coursedoc')) {
                   9609:         return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/});
                   9610:         $content = &Apache::lonnet::getfile($container);
                   9611:         return if ($content eq '-1');
                   9612:     } else {
                   9613:         return unless ($container =~ /^\Q$dir_root\E/); 
                   9614:         if (open(my $fh,"<$container")) {
                   9615:             $content = join('', <$fh>);
                   9616:             close($fh);
                   9617:         } else {
                   9618:             return;
                   9619:         }
                   9620:     }
                   9621:     my ($count,$codebasecount) = (0,0);
                   9622:     my $mm = new File::MMagic;
                   9623:     my $mime_type = $mm->checktype_contents($content);
                   9624:     if ($mime_type eq 'text/html') {
                   9625:         my $parse_result = 
                   9626:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   9627:                                                     \%codebase,\$content);
                   9628:         if ($parse_result eq 'ok') {
                   9629:             foreach my $i (@changes) {
                   9630:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   9631:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   9632:                 if ($allfiles{$ref}) {
                   9633:                     my $newname =  $orig;
                   9634:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  9635:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  9636:                     if ($attrib_regexp =~ /:/) {
                   9637:                         $attrib_regexp =~ s/\:/|/g;
                   9638:                     }
                   9639:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   9640:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   9641:                         $count += $numchg;
                   9642:                     }
                   9643:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  9644:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  9645:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   9646:                         $codebasecount ++;
                   9647:                     }
                   9648:                 }
                   9649:             }
                   9650:             if ($count || $codebasecount) {
                   9651:                 my $saveresult;
                   9652:                 if ($context eq 'portfolio' || $context eq 'coursedoc') {
                   9653:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   9654:                     if ($url eq $container) {
                   9655:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   9656:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9657:                                             $count,'<span class="LC_filename">'.
                   9658:                                             $fname.'</span>').'</p>'; 
                   9659:                     } else {
                   9660:                          $output = '<p class="LC_error">'.
                   9661:                                    &mt('Error: update failed for: [_1].',
                   9662:                                    '<span class="LC_filename">'.
                   9663:                                    $container.'</span>').'</p>';
                   9664:                     }
                   9665:                 } else {
                   9666:                     if (open(my $fh,">$container")) {
                   9667:                         print $fh $content;
                   9668:                         close($fh);
                   9669:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   9670:                                   $count,'<span class="LC_filename">'.
                   9671:                                   $container.'</span>').'</p>';
1.661     raeburn  9672:                     } else {
1.987     raeburn  9673:                          $output = '<p class="LC_error">'.
                   9674:                                    &mt('Error: could not update [_1].',
                   9675:                                    '<span class="LC_filename">'.
                   9676:                                    $container.'</span>').'</p>';
1.661     raeburn  9677:                     }
                   9678:                 }
                   9679:             }
1.987     raeburn  9680:         } else {
                   9681:             &logthis('Failed to parse '.$container.
                   9682:                      ' to modify references: '.$parse_result);
1.661     raeburn  9683:         }
                   9684:     }
                   9685:     return $output;
                   9686: }
                   9687: 
                   9688: sub check_for_existing {
                   9689:     my ($path,$fname,$element) = @_;
                   9690:     my ($state,$msg);
                   9691:     if (-d $path.'/'.$fname) {
                   9692:         $state = 'exists';
                   9693:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9694:     } elsif (-e $path.'/'.$fname) {
                   9695:         $state = 'exists';
                   9696:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   9697:     }
                   9698:     if ($state eq 'exists') {
                   9699:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   9700:     }
                   9701:     return ($state,$msg);
                   9702: }
                   9703: 
                   9704: sub check_for_upload {
                   9705:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   9706:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  9707:     my $filesize = length($env{'form.'.$element});
                   9708:     if (!$filesize) {
                   9709:         my $msg = '<span class="LC_error">'.
                   9710:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   9711:                       '<span class="LC_filename">'.$fname.'</span>',
                   9712:                       $filesize).'<br />'.
1.1007    raeburn  9713:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  9714:                   '</span>';
                   9715:         return ('zero_bytes',$msg);
                   9716:     }
                   9717:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  9718:     my $getpropath = 1;
1.1021    raeburn  9719:     my ($dirlistref,$listerror) =
                   9720:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  9721:     my $found_file = 0;
                   9722:     my $locked_file = 0;
1.991     raeburn  9723:     my @lockers;
                   9724:     my $navmap;
                   9725:     if ($env{'request.course.id'}) {
                   9726:         $navmap = Apache::lonnavmaps::navmap->new();
                   9727:     }
1.1021    raeburn  9728:     if (ref($dirlistref) eq 'ARRAY') {
                   9729:         foreach my $line (@{$dirlistref}) {
                   9730:             my ($file_name,$rest)=split(/\&/,$line,2);
                   9731:             if ($file_name eq $fname){
                   9732:                 $file_name = $path.$file_name;
                   9733:                 if ($group ne '') {
                   9734:                     $file_name = $group.$file_name;
                   9735:                 }
                   9736:                 $found_file = 1;
                   9737:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   9738:                     foreach my $lock (@lockers) {
                   9739:                         if (ref($lock) eq 'ARRAY') {
                   9740:                             my ($symb,$crsid) = @{$lock};
                   9741:                             if ($crsid eq $env{'request.course.id'}) {
                   9742:                                 if (ref($navmap)) {
                   9743:                                     my $res = $navmap->getBySymb($symb);
                   9744:                                     foreach my $part (@{$res->parts()}) { 
                   9745:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   9746:                                         unless (($slot_status == $res->RESERVED) ||
                   9747:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   9748:                                             $locked_file = 1;
                   9749:                                         }
1.991     raeburn  9750:                                     }
1.1021    raeburn  9751:                                 } else {
                   9752:                                     $locked_file = 1;
1.991     raeburn  9753:                                 }
                   9754:                             } else {
                   9755:                                 $locked_file = 1;
                   9756:                             }
                   9757:                         }
1.1021    raeburn  9758:                    }
                   9759:                 } else {
                   9760:                     my @info = split(/\&/,$rest);
                   9761:                     my $currsize = $info[6]/1000;
                   9762:                     if ($currsize < $filesize) {
                   9763:                         my $extra = $filesize - $currsize;
                   9764:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   9765:                             my $msg = '<span class="LC_error">'.
                   9766:                                       &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
                   9767:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   9768:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   9769:                                                    $disk_quota,$current_disk_usage);
                   9770:                             return ('will_exceed_quota',$msg);
                   9771:                         }
1.984     raeburn  9772:                     }
                   9773:                 }
1.661     raeburn  9774:             }
                   9775:         }
                   9776:     }
                   9777:     if (($current_disk_usage + $filesize) > $disk_quota){
                   9778:         my $msg = '<span class="LC_error">'.
                   9779:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   9780:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   9781:         return ('will_exceed_quota',$msg);
                   9782:     } elsif ($found_file) {
                   9783:         if ($locked_file) {
                   9784:             my $msg = '<span class="LC_error">';
                   9785:             $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>');
                   9786:             $msg .= '</span><br />';
                   9787:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   9788:             return ('file_locked',$msg);
                   9789:         } else {
                   9790:             my $msg = '<span class="LC_error">';
1.984     raeburn  9791:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661     raeburn  9792:             $msg .= '</span>';
1.984     raeburn  9793:             return ('existingfile',$msg);
1.661     raeburn  9794:         }
                   9795:     }
                   9796: }
                   9797: 
1.987     raeburn  9798: sub check_for_traversal {
                   9799:     my ($path,$url,$toplevel) = @_;
                   9800:     my @parts=split(/\//,$path);
                   9801:     my $cleanpath;
                   9802:     my $fullpath = $url;
                   9803:     for (my $i=0;$i<@parts;$i++) {
                   9804:         next if ($parts[$i] eq '.');
                   9805:         if ($parts[$i] eq '..') {
                   9806:             $fullpath =~ s{([^/]+/)$}{};
                   9807:         } else {
                   9808:             $fullpath .= $parts[$i].'/';
                   9809:         }
                   9810:     }
                   9811:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   9812:         $cleanpath = $1;
                   9813:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   9814:         my $curr_toprel = $1;
                   9815:         my @parts = split(/\//,$curr_toprel);
                   9816:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   9817:         my @urlparts = split(/\//,$url_toprel);
                   9818:         my $doubledots;
                   9819:         my $startdiff = -1;
                   9820:         for (my $i=0; $i<@urlparts; $i++) {
                   9821:             if ($startdiff == -1) {
                   9822:                 unless ($urlparts[$i] eq $parts[$i]) {
                   9823:                     $startdiff = $i;
                   9824:                     $doubledots .= '../';
                   9825:                 }
                   9826:             } else {
                   9827:                 $doubledots .= '../';
                   9828:             }
                   9829:         }
                   9830:         if ($startdiff > -1) {
                   9831:             $cleanpath = $doubledots;
                   9832:             for (my $i=$startdiff; $i<@parts; $i++) {
                   9833:                 $cleanpath .= $parts[$i].'/';
                   9834:             }
                   9835:         }
                   9836:     }
                   9837:     $cleanpath =~ s{(/)$}{};
                   9838:     return $cleanpath;
                   9839: }
1.31      albertel 9840: 
1.1053    raeburn  9841: sub is_archive_file {
                   9842:     my ($mimetype) = @_;
                   9843:     if (($mimetype eq 'application/octet-stream') ||
                   9844:         ($mimetype eq 'application/x-stuffit') ||
                   9845:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   9846:         return 1;
                   9847:     }
                   9848:     return;
                   9849: }
                   9850: 
                   9851: sub decompress_form {
                   9852:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements) = @_;
                   9853:     my %lt = &Apache::lonlocal::texthash (
                   9854:         this => 'This file is an archive file.',
                   9855:         youm => 'You may wish to extract its contents.',
                   9856:         camt => 'Extraction of contents is recommended for Camtasia zip files.',
                   9857:         perm => 'Permanently remove archive file after extraction of contents?',
                   9858:         extr => 'Extract contents',
                   9859:         yes  => 'Yes',
                   9860:         no   => 'No',
                   9861:     );
                   9862:     my $output = '<p>'.$lt{'this'}.' '.$lt{'youm'}.'<br />';
                   9863:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   9864:         $output .= $lt{'camt'};
                   9865:     }
                   9866:     $output .= '</p>';
                   9867:     $output .= <<"START";
                   9868: <div id="uploadfileresult">
                   9869:   <form name="uploaded_decompress" action="$action" method="post">
                   9870:   <input type="hidden" name="archiveurl" value="$archiveurl" />
                   9871: START
                   9872:     if (ref($hiddenelements) eq 'HASH') {
                   9873:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   9874:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   9875:         }
                   9876:     }
                   9877:     $output .= <<"END";
                   9878: <span class="LC_nobreak">$lt{'perm'}&nbsp;
                   9879: <label><input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}</label>&nbsp;&nbsp;
                   9880: <label><input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label></span><br />
                   9881: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   9882: </form>
                   9883: $noextract
                   9884: </div>
                   9885: END
                   9886:     return $output;
                   9887: }
                   9888: 
                   9889: sub decompress_uploaded_file {
                   9890:     my ($file,$dir) = @_;
                   9891:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   9892:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   9893:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   9894:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   9895:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   9896:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   9897:     my $decompressed = $env{'cgi.decompressed'};
                   9898:     &Apache::lonnet::delenv('cgi.file');
                   9899:     &Apache::lonnet::delenv('cgi.dir');
                   9900:     &Apache::lonnet::delenv('cgi.decompressed');
                   9901:     return ($decompressed,$result);
                   9902: }
                   9903: 
1.1055    raeburn  9904: sub process_decompression {
                   9905:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   9906:     my ($dir,$error,$warning,$output);
                   9907:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
                   9908:         $error = &mt('File name not a supported archive file type.').
                   9909:                  '<br />'.&mt('File name should end with one of: [_1].',
                   9910:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   9911:     } else {
                   9912:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   9913:         if ($docuhome eq 'no_host') {
                   9914:             $error = &mt('Could not determine home server for course.');
                   9915:         } else {
                   9916:             my @ids=&Apache::lonnet::current_machine_ids();
                   9917:             my $currdir = "$dir_root/$destination";
                   9918:             my ($currdirlistref,$currlisterror) =
                   9919:                 &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   9920:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   9921:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   9922:                        "$dir_root/$destination";
                   9923:             } else {
                   9924:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   9925:                        "$dir_root/$docudom/$docuname/$destination";
                   9926:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   9927:                     $error = &mt('Archive file not found.');
                   9928:                 }
                   9929:             }
                   9930:             if ($dir eq '') {
                   9931:                 $error = &mt('Directory containing archive file unavailable.');
                   9932:             } elsif (!$error) {
                   9933:                 my ($decompressed,$display) = &decompress_uploaded_file($file,$dir);
                   9934:                 if ($decompressed eq 'ok') {
                   9935:                     $output = &mt('Files extracted successfully from archive.').'<br />';
                   9936:                     my ($warning,$result,@contents);
                   9937:                     my ($newdirlistref,$newlisterror) =
                   9938:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   9939:                                                  $docuname,1);
                   9940:                     my (%is_dir,%changes,@newitems);
                   9941:                     my $dirptr = 16384;
                   9942:                     if (ref($currdirlistref) eq 'ARRAY') {
                   9943:                         my @curritems;
                   9944:                         foreach my $dir_line (@{$currdirlistref}) {
                   9945:                             my ($item,$rest)=split(/\&/,$dir_line,2);
                   9946:                             unless ($item =~ /\.+$/) {
                   9947:                                 push(@curritems,$item);
                   9948:                             }
                   9949:                         }
                   9950:                         if (ref($newdirlistref) eq 'ARRAY') {
                   9951:                             foreach my $dir_line (@{$newdirlistref}) {
                   9952:                                 my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,4);
                   9953:                                 unless ($item =~ /^\.+$/) {
                   9954:                                     if ($dirptr&$testdir) {
                   9955:                                         $is_dir{$item} = 1;
                   9956:                                     }
                   9957:                                     push(@newitems,$item);
                   9958:                                 }
                   9959:                             }
                   9960:                             my @diffs = &compare_arrays(\@curritems,\@newitems);
                   9961:                             if (@diffs > 0) {
                   9962:                                foreach my $item (@diffs) {
                   9963:                                    $changes{$item} = 1;
                   9964:                                }
                   9965:                             }
                   9966:                         }
                   9967:                     } elsif (ref($newdirlistref) eq 'ARRAY') {
                   9968:                         foreach my $dir_line (@{$newdirlistref}) {
                   9969:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   9970:                             unless ($item =~ /\.+$/) {
                   9971:                                 push(@newitems,$item);
                   9972:                                 if ($dirptr&$testdir) {
                   9973:                                     $is_dir{$item} = 1;
                   9974:                                 }
                   9975:                                 $changes{$item} = 1;
                   9976:                             }
                   9977:                         }
                   9978:                     }
                   9979:                     if (keys(%changes) > 0) {
                   9980:                         foreach my $item (sort(@newitems)) {
                   9981:                             if ($changes{$item}) {
                   9982:                                 push(@contents,$item);
                   9983:                             }
                   9984:                         }
                   9985:                     }
                   9986:                     if (@contents > 0) {
1.1056    raeburn  9987:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  9988:                         my $wantform = 1;
                   9989:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   9990:                                                                 $currdir,\%is_dir,
                   9991:                                                                 \%children,\%parent,
1.1056    raeburn  9992:                                                                 \@contents,\%dirorder,
                   9993:                                                                 \%titles,$wantform);
1.1055    raeburn  9994:                         if ($datatable ne '') {
                   9995:                             $output .= &archive_options_form('decompressed',$datatable,
                   9996:                                                              $count,$hiddenelem);
1.1056    raeburn  9997:                             my $startcount = 4;
1.1055    raeburn  9998:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  9999:                                                            \%titles,\%children);
1.1055    raeburn  10000:                         }
                   10001:                     } else {
                   10002:                         $warning = &mt('No new items extracted from archive file.');
                   10003:                     }
                   10004:                 } else {
                   10005:                     $output = $display;
                   10006:                     $error = &mt('An error occurred during extraction from the archive file.');
                   10007:                 }
                   10008:             }
                   10009:         }
                   10010:     }
                   10011:     if ($error) {
                   10012:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10013:                    $error.'</p>'."\n";
                   10014:     }
                   10015:     if ($warning) {
                   10016:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10017:     }
                   10018:     return $output;
                   10019: }
                   10020: 
                   10021: sub get_extracted {
1.1056    raeburn  10022:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   10023:         $titles,$wantform) = @_;
1.1055    raeburn  10024:     my $count = 0;
                   10025:     my $depth = 0;
                   10026:     my $datatable;
1.1056    raeburn  10027:     my @hierarchy;
1.1055    raeburn  10028:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  10029:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   10030:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  10031:     foreach my $item (@{$contents}) {
                   10032:         $count ++;
1.1056    raeburn  10033:         @{$dirorder->{$count}} = @hierarchy;
                   10034:         $titles->{$count} = $item;
1.1055    raeburn  10035:         &archive_hierarchy($depth,$count,$parent,$children);
                   10036:         if ($wantform) {
                   10037:             $datatable .= &archive_row($is_dir->{$item},$item,
                   10038:                                        $currdir,$depth,$count);
                   10039:         }
                   10040:         if ($is_dir->{$item}) {
                   10041:             $depth ++;
1.1056    raeburn  10042:             push(@hierarchy,$count);
                   10043:             $parent->{$depth} = $count;
1.1055    raeburn  10044:             $datatable .=
                   10045:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  10046:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   10047:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  10048:             $depth --;
1.1056    raeburn  10049:             pop(@hierarchy);
1.1055    raeburn  10050:         }
                   10051:     }
                   10052:     return ($count,$datatable);
                   10053: }
                   10054: 
                   10055: sub recurse_extracted_archive {
1.1056    raeburn  10056:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   10057:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  10058:     my $result='';
1.1056    raeburn  10059:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   10060:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   10061:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  10062:         return $result;
                   10063:     }
                   10064:     my $dirptr = 16384;
                   10065:     my ($newdirlistref,$newlisterror) =
                   10066:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   10067:     if (ref($newdirlistref) eq 'ARRAY') {
                   10068:         foreach my $dir_line (@{$newdirlistref}) {
                   10069:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   10070:             unless ($item =~ /^\.+$/) {
                   10071:                 $$count ++;
1.1056    raeburn  10072:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   10073:                 $titles->{$$count} = $item;
1.1055    raeburn  10074:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  10075: 
1.1055    raeburn  10076:                 my $is_dir;
                   10077:                 if ($dirptr&$testdir) {
                   10078:                     $is_dir = 1;
                   10079:                 }
                   10080:                 if ($wantform) {
                   10081:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   10082:                 }
                   10083:                 if ($is_dir) {
                   10084:                     $$depth ++;
1.1056    raeburn  10085:                     push(@{$hierarchy},$$count);
                   10086:                     $parent->{$$depth} = $$count;
1.1055    raeburn  10087:                     $result .=
                   10088:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   10089:                                                    $docuname,$depth,$count,
1.1056    raeburn  10090:                                                    $hierarchy,$dirorder,$children,
                   10091:                                                    $parent,$titles,$wantform);
1.1055    raeburn  10092:                     $$depth --;
1.1056    raeburn  10093:                     pop(@{$hierarchy});
1.1055    raeburn  10094:                 }
                   10095:             }
                   10096:         }
                   10097:     }
                   10098:     return $result;
                   10099: }
                   10100: 
                   10101: sub archive_hierarchy {
                   10102:     my ($depth,$count,$parent,$children) =@_;
                   10103:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   10104:         if (exists($parent->{$depth})) {
                   10105:              $children->{$parent->{$depth}} .= $count.':';
                   10106:         }
                   10107:     }
                   10108:     return;
                   10109: }
                   10110: 
                   10111: sub archive_row {
                   10112:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   10113:     my ($name) = ($item =~ m{([^/]+)$});
                   10114:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  10115:                                        'display'    => 'Add as file',
1.1055    raeburn  10116:                                        'dependency' => 'Include as dependency',
                   10117:                                        'discard'    => 'Discard',
                   10118:                                       );
                   10119:     if ($is_dir) {
1.1059    raeburn  10120:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  10121:     }
1.1056    raeburn  10122:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   10123:     my $offset = 0;
1.1055    raeburn  10124:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  10125:         $offset ++;
1.1055    raeburn  10126:         $output .= '<td><span class="LC_nobreak">'.
                   10127:                    '<label><input type="radio" name="archive_'.$count.
                   10128:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   10129:         my $text = $choices{$action};
                   10130:         if ($is_dir) {
                   10131:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   10132:             if ($action eq 'display') {
1.1059    raeburn  10133:                 $text = &mt('Add as folder');
1.1055    raeburn  10134:             }
1.1056    raeburn  10135:         } else {
                   10136:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   10137: 
                   10138:         }
                   10139:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   10140:         if ($action eq 'dependency') {
                   10141:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   10142:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   10143:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   10144:                        '<option value=""></option>'."\n".
                   10145:                        '</select>'."\n".
                   10146:                        '</div>';
1.1059    raeburn  10147:         } elsif ($action eq 'display') {
                   10148:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   10149:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   10150:                        '</div>';
1.1055    raeburn  10151:         }
1.1056    raeburn  10152:         $output .= '</td>';
1.1055    raeburn  10153:     }
                   10154:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   10155:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   10156:     for (my $i=0; $i<$depth; $i++) {
                   10157:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   10158:     }
                   10159:     if ($is_dir) {
                   10160:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   10161:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   10162:     } else {
                   10163:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   10164:     }
                   10165:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   10166:                &end_data_table_row();
                   10167:     return $output;
                   10168: }
                   10169: 
                   10170: sub archive_options_form {
                   10171:     my ($form,$output,$count,$hiddenelem) = @_;
                   10172:     return '<form name="'.$form.'" method="post" action="">'."\n".
                   10173:            '<input type="hidden" name="phase" value="decompress_cleanup" />'."\n".
                   10174:                     '<p>'.
                   10175:                     &mt('How should each item be incorporated in the course?').
                   10176:                     '</p>'.
                   10177:                     '<div class="LC_columnSection"><fieldset>'.
                   10178:                     '<legend>'.&mt('Content actions for all').'</legend>'.
1.1059    raeburn  10179:                     '<input type="button" value="'.&mt('Add as folder/file').'" '.
1.1055    raeburn  10180:                     'onclick="javascript:checkAll(document.'.$form.",'display'".')" />'.
1.1059    raeburn  10181:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Include as dependency for a displayed file').'"'.
1.1055    raeburn  10182:                     ' onclick="javascript:checkAll(document.'.$form.",'dependency'".')" />'.
                   10183:                     '&nbsp;&nbsp;<input type="button" value="'.&mt('Discard').'"'.
                   10184:                     ' onclick="javascript:checkAll(document.'.$form.",'discard'".')" />'.
                   10185:                      '</fieldset></div>'.
                   10186:            &start_data_table()."\n".
                   10187:            $output."\n".
                   10188:            &end_data_table()."\n".
                   10189:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   10190:            $hiddenelem.
                   10191:            '<br /><input type="submit" name="archive_submit" value="'.&mt('Save').'" />'.
                   10192:            '</form>';
                   10193: }
                   10194: 
                   10195: sub archive_javascript {
1.1056    raeburn  10196:     my ($startcount,$numitems,$titles,$children) = @_;
                   10197:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  10198:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  10199:     my $scripttag = <<START;
                   10200: <script type="text/javascript">
                   10201: // <![CDATA[
                   10202: 
                   10203: function checkAll(form,prefix) {
                   10204:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   10205:     for (var i=0; i < form.elements.length; i++) {
                   10206:         var id = form.elements[i].id;
                   10207:         if ((id != '') && (id != undefined)) {
                   10208:             if (idstr.test(id)) {
                   10209:                 if (form.elements[i].type == 'radio') {
                   10210:                     form.elements[i].checked = true;
1.1056    raeburn  10211:                     var nostart = i-$startcount;
1.1059    raeburn  10212:                     var offset = nostart%7;
                   10213:                     var count = (nostart-offset)/7;    
1.1056    raeburn  10214:                     dependencyCheck(form,count,offset);
1.1055    raeburn  10215:                 }
                   10216:             }
                   10217:         }
                   10218:     }
                   10219: }
                   10220: 
                   10221: function propagateCheck(form,count) {
                   10222:     if (count > 0) {
1.1059    raeburn  10223:         var startelement = $startcount + ((count-1) * 7);
                   10224:         for (var j=1; j<6; j++) {
                   10225:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  10226:                 var item = startelement + j; 
                   10227:                 if (form.elements[item].type == 'radio') {
                   10228:                     if (form.elements[item].checked) {
                   10229:                         containerCheck(form,count,j);
                   10230:                         break;
                   10231:                     }
1.1055    raeburn  10232:                 }
                   10233:             }
                   10234:         }
                   10235:     }
                   10236: }
                   10237: 
                   10238: numitems = $numitems
1.1056    raeburn  10239: var titles = new Array(numitems);
                   10240: var parents = new Array(numitems);
1.1055    raeburn  10241: for (var i=0; i<numitems; i++) {
1.1056    raeburn  10242:     parents[i] = new Array;
1.1055    raeburn  10243: }
1.1059    raeburn  10244: var maintitle = '$maintitle';
1.1055    raeburn  10245: 
                   10246: START
                   10247: 
1.1056    raeburn  10248:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   10249:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  10250:         for (my $i=0; $i<@contents; $i ++) {
                   10251:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   10252:         }
                   10253:     }
                   10254: 
1.1056    raeburn  10255:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   10256:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   10257:     }
                   10258: 
1.1055    raeburn  10259:     $scripttag .= <<END;
                   10260: 
                   10261: function containerCheck(form,count,offset) {
                   10262:     if (count > 0) {
1.1056    raeburn  10263:         dependencyCheck(form,count,offset);
1.1059    raeburn  10264:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  10265:         form.elements[item].checked = true;
                   10266:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10267:             if (parents[count].length > 0) {
                   10268:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  10269:                     containerCheck(form,parents[count][j],offset);
                   10270:                 }
                   10271:             }
                   10272:         }
                   10273:     }
                   10274: }
                   10275: 
                   10276: function dependencyCheck(form,count,offset) {
                   10277:     if (count > 0) {
1.1059    raeburn  10278:         var chosen = (offset+$startcount)+7*(count-1);
                   10279:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  10280:         var currtype = form.elements[depitem].type;
                   10281:         if (form.elements[chosen].value == 'dependency') {
                   10282:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   10283:             form.elements[depitem].options.length = 0;
                   10284:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10285:             for (var i=1; i<count; i++) {
1.1059    raeburn  10286:                 var startelement = $startcount + (i-1) * 7;
                   10287:                 for (var j=1; j<6; j++) {
                   10288:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  10289:                         var item = startelement + j;
                   10290:                         if (form.elements[item].type == 'radio') {
                   10291:                             if (form.elements[item].checked) {
                   10292:                                 if (form.elements[item].value == 'display') {
                   10293:                                     var n = form.elements[depitem].options.length;
                   10294:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   10295:                                 }
                   10296:                             }
                   10297:                         }
                   10298:                     }
                   10299:                 }
                   10300:             }
                   10301:         } else {
                   10302:             document.getElementById('arc_depon_'+count).style.display='none';
                   10303:             form.elements[depitem].options.length = 0;
                   10304:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10305:         }
1.1059    raeburn  10306:         titleCheck(form,count,offset);
1.1056    raeburn  10307:     }
                   10308: }
                   10309: 
                   10310: function propagateSelect(form,count,offset) {
                   10311:     if (count > 0) {
1.1059    raeburn  10312:         var item = (2+offset+$startcount)+7*(count-1);
1.1056    raeburn  10313:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   10314:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10315:             if (parents[count].length > 0) {
                   10316:                 for (var j=0; j<parents[count].length; j++) {
                   10317:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  10318:                 }
                   10319:             }
                   10320:         }
                   10321:     }
                   10322: }
1.1056    raeburn  10323: 
                   10324: function containerSelect(form,count,offset,picked) {
                   10325:     if (count > 0) {
1.1059    raeburn  10326:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  10327:         if (form.elements[item].type == 'radio') {
                   10328:             if (form.elements[item].value == 'dependency') {
                   10329:                 if (form.elements[item+1].type == 'select-one') {
                   10330:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   10331:                         if (form.elements[item+1].options[i].value == picked) {
                   10332:                             form.elements[item+1].selectedIndex = i;
                   10333:                             break;
                   10334:                         }
                   10335:                     }
                   10336:                 }
                   10337:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10338:                     if (parents[count].length > 0) {
                   10339:                         for (var j=0; j<parents[count].length; j++) {
                   10340:                             containerSelect(form,parents[count][j],offset,picked);
                   10341:                         }
                   10342:                     }
                   10343:                 }
                   10344:             }
                   10345:         }
                   10346:     }
                   10347: }
                   10348: 
1.1059    raeburn  10349: function titleCheck(form,count,offset) {
                   10350:     if (count > 0) {
                   10351:         var chosen = (offset+$startcount)+7*(count-1);
                   10352:         var depitem = $startcount + ((count-1) * 7) + 2;
                   10353:         var currtype = form.elements[depitem].type;
                   10354:         if (form.elements[chosen].value == 'display') {
                   10355:             document.getElementById('arc_title_'+count).style.display='block';
                   10356:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   10357:                 document.getElementById('archive_title_'+count).value=maintitle;
                   10358:             }
                   10359:         } else {
                   10360:             document.getElementById('arc_title_'+count).style.display='none';
                   10361:             if (currtype == 'text') { 
                   10362:                 document.getElementById('archive_title_'+count).value='';
                   10363:             }
                   10364:         }
                   10365:     }
                   10366:     return;
                   10367: }
                   10368: 
1.1055    raeburn  10369: // ]]>
                   10370: </script>
                   10371: END
                   10372:     return $scripttag;
                   10373: }
                   10374: 
                   10375: sub process_extracted_files {
                   10376:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
                   10377:     my $numitems = $env{'form.archive_count'};
                   10378:     return unless ($numitems);
                   10379:     my @ids=&Apache::lonnet::current_machine_ids();
                   10380:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
                   10381:         %folders,%containers,%mapinner);
                   10382:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10383:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10384:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   10385:         $pathtocheck = "$dir_root/$destination";
                   10386:         $dir = $dir_root;
                   10387:         $ishome = 1;
                   10388:     } else {
                   10389:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   10390:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   10391:         $dir = "$dir_root/$docudom/$docuname";    
                   10392:     }
                   10393:     my $currdir = "$dir_root/$destination";
                   10394:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   10395:     if ($env{'form.folderpath'}) {
                   10396:         my @items = split('&',$env{'form.folderpath'});
                   10397:         $folders{'0'} = $items[-2];
                   10398:         $containers{'0'}='sequence';
                   10399:     } elsif ($env{'form.pagepath'}) {
                   10400:         my @items = split('&',$env{'form.pagepath'});
                   10401:         $folders{'0'} = $items[-2];
                   10402:         $containers{'0'}='page';
                   10403:     }
                   10404:     my @archdirs = &get_env_multiple('form.archive_directory');
                   10405:     if ($numitems) {
                   10406:         for (my $i=1; $i<=$numitems; $i++) {
                   10407:             my $path = $env{'form.archive_content_'.$i};
                   10408:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   10409:                 my $item = $1;
                   10410:                 $toplevelitems{$item} = $i;
                   10411:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   10412:                     $is_dir{$item} = 1;
                   10413:                 }
                   10414:             }
                   10415:         }
                   10416:     }
1.1056    raeburn  10417:     my ($output,%children,%parent,%titles,%dirorder);
1.1055    raeburn  10418:     if (keys(%toplevelitems) > 0) {
                   10419:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  10420:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   10421:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  10422:     }
1.1056    raeburn  10423:     my (%referrer,%orphaned,%todelete,%newdest,%newseqid);
1.1055    raeburn  10424:     if ($numitems) {
                   10425:         for (my $i=1; $i<=$numitems; $i++) {
                   10426:             my $path = $env{'form.archive_content_'.$i};
                   10427:             if ($path =~ /^\Q$pathtocheck\E/) {
                   10428:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   10429:                     if ($prefix ne '' && $path ne '') {
                   10430:                         if (-e $prefix.$path) {
                   10431:                             $todelete{$prefix.$path} = 1;
                   10432:                         }
                   10433:                     }
                   10434:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  10435:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  10436:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  10437:                     $docstitle = $env{'form.archive_title_'.$i};
                   10438:                     if ($docstitle eq '') {
                   10439:                         $docstitle = $title;
                   10440:                     }
1.1055    raeburn  10441:                     $outer = 0;
1.1056    raeburn  10442:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   10443:                         if (@{$dirorder{$i}} > 0) {
                   10444:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  10445:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   10446:                                     $outer = $item;
                   10447:                                     last;
                   10448:                                 }
                   10449:                             }
                   10450:                         }
                   10451:                     }
                   10452:                     my ($errtext,$fatal) = 
                   10453:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   10454:                                                '/'.$folders{$outer}.'.'.
                   10455:                                                $containers{$outer});
                   10456:                     next if ($fatal);
                   10457:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   10458:                         if ($context eq 'coursedocs') {
1.1056    raeburn  10459:                             $mapinner{$i} = time;
1.1055    raeburn  10460:                             $folders{$i} = 'default_'.$mapinner{$i};
                   10461:                             $containers{$i} = 'sequence';
                   10462:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10463:                                       $folders{$i}.'.'.$containers{$i};
                   10464:                             my $newidx = &LONCAPA::map::getresidx();
                   10465:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  10466:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  10467:                             push(@LONCAPA::map::order,$newidx);
                   10468:                             my ($outtext,$errtext) =
                   10469:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10470:                                                         $docuname.'/'.$folders{$outer}.
                   10471:                                                         '.'.$containers{$outer},1);
1.1056    raeburn  10472:                             $newseqid{$i} = $newidx;
1.1055    raeburn  10473:                         }
                   10474:                     } else {
                   10475:                         if ($context eq 'coursedocs') {
                   10476:                             my $newidx=&LONCAPA::map::getresidx();
                   10477:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   10478:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   10479:                                       $title;
                   10480:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   10481:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   10482:                             }
                   10483:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10484:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   10485:                             }
                   10486:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   10487:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  10488:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1055    raeburn  10489:                             }
                   10490:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  10491:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  10492:                             push(@LONCAPA::map::order, $newidx);
                   10493:                             my ($outtext,$errtext)=
                   10494:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   10495:                                                         $docuname.'/'.$folders{$outer}.
                   10496:                                                         '.'.$containers{$outer},1);
                   10497:                         }
                   10498:                     }
                   10499:                 } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056    raeburn  10500:                     my ($title) = ($path =~ m{/([^/]+)$});
                   10501:                     $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   10502:                     if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   10503:                         if (ref($dirorder{$i}) eq 'ARRAY') {
                   10504:                             my ($itemidx,$fullpath);
                   10505:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10506:                                 if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   10507:                                     my $container = $dirorder{$referrer{$i}}->[-1];
                   10508:                                     for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   10509:                                         if ($dirorder{$i}->[$j] eq $container) {
                   10510:                                             $itemidx = $j;
                   10511:                                         }
                   10512:                                     }
                   10513:                                 }
                   10514:                             }
                   10515:                             if ($itemidx ne '') {
                   10516:                                 if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   10517:                                     if ($mapinner{$referrer{$i}}) {
                   10518:                                         $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   10519:                                         for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10520:                                             if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10521:                                                 unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10522:                                                     $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10523:                                                     if (!-e $fullpath) {
                   10524:                                                         mkdir($fullpath,0755);
                   10525:                                                     }
                   10526:                                                 }
                   10527:                                             } else {
                   10528:                                                 last;
                   10529:                                             }
                   10530:                                         }
                   10531:                                     }
                   10532:                                 } elsif ($newdest{$referrer{$i}}) {
                   10533:                                     $fullpath = $newdest{$referrer{$i}};
                   10534:                                     for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   10535:                                         if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   10536:                                             $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   10537:                                             last;
                   10538:                                         } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   10539:                                             unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   10540:                                                 $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   10541:                                                 if (!-e $fullpath) {
                   10542:                                                     mkdir($fullpath,0755);
                   10543:                                                 }
                   10544:                                             }
                   10545:                                         } else {
                   10546:                                             last;
                   10547:                                         }
                   10548:                                     }
                   10549:                                 }
                   10550:                                 if ($fullpath ne '') {
                   10551:                                     system("mv $prefix$path $fullpath/$title");
                   10552:                                 }
1.1055    raeburn  10553:                             }
                   10554:                         }
1.1056    raeburn  10555:                     } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   10556:                         $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   10557:                                         $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  10558:                     }
                   10559:                 }
                   10560:             } else {
                   10561:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   10562:             }
                   10563:         }
                   10564:         if (keys(%todelete)) {
                   10565:             foreach my $key (keys(%todelete)) {
                   10566:                 unlink($key);
                   10567:                 unless ($ishome) {
                   10568:                     #FIXME Need to notify homeserver to delete files.
                   10569:                 }
                   10570:             }
                   10571:         }
                   10572:     } else {
                   10573:         $warning = &mt('No items found in archive.');
                   10574:     }
                   10575:     if ($error) {
                   10576:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10577:                    $error.'</p>'."\n";
                   10578:     }
                   10579:     if ($warning) {
                   10580:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10581:     }
                   10582:     return $output;
                   10583: }
                   10584: 
1.41      ng       10585: =pod
1.45      matthew  10586: 
1.1015    raeburn  10587: =item * &get_turnedin_filepath()
                   10588: 
                   10589: Determines path in a user's portfolio file for storage of files uploaded
                   10590: to a specific essayresponse or dropbox item.
                   10591: 
                   10592: Inputs: 3 required + 1 optional.
                   10593: $symb is symb for resource, $uname and $udom are for current user (required).
                   10594: $caller is optional (can be "submission", if routine is called when storing
                   10595: an upoaded file when "Submit Answer" button was pressed).
                   10596: 
                   10597: Returns array containing $path and $multiresp. 
                   10598: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   10599: than one file upload item.  Callers of routine should append partid as a 
                   10600: subdirectory to $path in cases where $multiresp is 1.
                   10601: 
                   10602: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   10603: 
                   10604: =cut
                   10605: 
                   10606: sub get_turnedin_filepath {
                   10607:     my ($symb,$uname,$udom,$caller) = @_;
                   10608:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   10609:     my $turnindir;
                   10610:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   10611:     $turnindir = $userhash{'turnindir'};
                   10612:     my ($path,$multiresp);
                   10613:     if ($turnindir eq '') {
                   10614:         if ($caller eq 'submission') {
                   10615:             $turnindir = &mt('turned in');
                   10616:             $turnindir =~ s/\W+/_/g;
                   10617:             my %newhash = (
                   10618:                             'turnindir' => $turnindir,
                   10619:                           );
                   10620:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   10621:         }
                   10622:     }
                   10623:     if ($turnindir ne '') {
                   10624:         $path = '/'.$turnindir.'/';
                   10625:         my ($multipart,$turnin,@pathitems);
                   10626:         my $navmap = Apache::lonnavmaps::navmap->new();
                   10627:         if (defined($navmap)) {
                   10628:             my $mapres = $navmap->getResourceByUrl($map);
                   10629:             if (ref($mapres)) {
                   10630:                 my $pcslist = $mapres->map_hierarchy();
                   10631:                 if ($pcslist ne '') {
                   10632:                     foreach my $pc (split(/,/,$pcslist)) {
                   10633:                         my $res = $navmap->getByMapPc($pc);
                   10634:                         if (ref($res)) {
                   10635:                             my $title = $res->compTitle();
                   10636:                             $title =~ s/\W+/_/g;
                   10637:                             if ($title ne '') {
                   10638:                                 push(@pathitems,$title);
                   10639:                             }
                   10640:                         }
                   10641:                     }
                   10642:                 }
                   10643:                 my $maptitle = $mapres->compTitle();
                   10644:                 $maptitle =~ s/\W+/_/g;
                   10645:                 if ($maptitle ne '') {
                   10646:                     push(@pathitems,$maptitle);
                   10647:                 }
                   10648:                 unless ($env{'request.state'} eq 'construct') {
                   10649:                     my $res = $navmap->getBySymb($symb);
                   10650:                     if (ref($res)) {
                   10651:                         my $partlist = $res->parts();
                   10652:                         my $totaluploads = 0;
                   10653:                         if (ref($partlist) eq 'ARRAY') {
                   10654:                             foreach my $part (@{$partlist}) {
                   10655:                                 my @types = $res->responseType($part);
                   10656:                                 my @ids = $res->responseIds($part);
                   10657:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   10658:                                     if ($types[$i] eq 'essay') {
                   10659:                                         my $partid = $part.'_'.$ids[$i];
                   10660:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   10661:                                             $totaluploads ++;
                   10662:                                         }
                   10663:                                     }
                   10664:                                 }
                   10665:                             }
                   10666:                             if ($totaluploads > 1) {
                   10667:                                 $multiresp = 1;
                   10668:                             }
                   10669:                         }
                   10670:                     }
                   10671:                 }
                   10672:             } else {
                   10673:                 return;
                   10674:             }
                   10675:         } else {
                   10676:             return;
                   10677:         }
                   10678:         my $restitle=&Apache::lonnet::gettitle($symb);
                   10679:         $restitle =~ s/\W+/_/g;
                   10680:         if ($restitle eq '') {
                   10681:             $restitle = ($resurl =~ m{/[^/]+$});
                   10682:             if ($restitle eq '') {
                   10683:                 $restitle = time;
                   10684:             }
                   10685:         }
                   10686:         push(@pathitems,$restitle);
                   10687:         $path .= join('/',@pathitems);
                   10688:     }
                   10689:     return ($path,$multiresp);
                   10690: }
                   10691: 
                   10692: =pod
                   10693: 
1.464     albertel 10694: =back
1.41      ng       10695: 
1.112     bowersj2 10696: =head1 CSV Upload/Handling functions
1.38      albertel 10697: 
1.41      ng       10698: =over 4
                   10699: 
1.648     raeburn  10700: =item * &upfile_store($r)
1.41      ng       10701: 
                   10702: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 10703: needs $env{'form.upfile'}
1.41      ng       10704: returns $datatoken to be put into hidden field
                   10705: 
                   10706: =cut
1.31      albertel 10707: 
                   10708: sub upfile_store {
                   10709:     my $r=shift;
1.258     albertel 10710:     $env{'form.upfile'}=~s/\r/\n/gs;
                   10711:     $env{'form.upfile'}=~s/\f/\n/gs;
                   10712:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   10713:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 10714: 
1.258     albertel 10715:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   10716: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 10717:     {
1.158     raeburn  10718:         my $datafile = $r->dir_config('lonDaemons').
                   10719:                            '/tmp/'.$datatoken.'.tmp';
                   10720:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 10721:             print $fh $env{'form.upfile'};
1.158     raeburn  10722:             close($fh);
                   10723:         }
1.31      albertel 10724:     }
                   10725:     return $datatoken;
                   10726: }
                   10727: 
1.56      matthew  10728: =pod
                   10729: 
1.648     raeburn  10730: =item * &load_tmp_file($r)
1.41      ng       10731: 
                   10732: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 10733: needs $env{'form.datatoken'},
                   10734: sets $env{'form.upfile'} to the contents of the file
1.41      ng       10735: 
                   10736: =cut
1.31      albertel 10737: 
                   10738: sub load_tmp_file {
                   10739:     my $r=shift;
                   10740:     my @studentdata=();
                   10741:     {
1.158     raeburn  10742:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 10743:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  10744:         if ( open(my $fh,"<$studentfile") ) {
                   10745:             @studentdata=<$fh>;
                   10746:             close($fh);
                   10747:         }
1.31      albertel 10748:     }
1.258     albertel 10749:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 10750: }
                   10751: 
1.56      matthew  10752: =pod
                   10753: 
1.648     raeburn  10754: =item * &upfile_record_sep()
1.41      ng       10755: 
                   10756: Separate uploaded file into records
                   10757: returns array of records,
1.258     albertel 10758: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       10759: 
                   10760: =cut
1.31      albertel 10761: 
                   10762: sub upfile_record_sep {
1.258     albertel 10763:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 10764:     } else {
1.248     albertel 10765: 	my @records;
1.258     albertel 10766: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 10767: 	    if ($line=~/^\s*$/) { next; }
                   10768: 	    push(@records,$line);
                   10769: 	}
                   10770: 	return @records;
1.31      albertel 10771:     }
                   10772: }
                   10773: 
1.56      matthew  10774: =pod
                   10775: 
1.648     raeburn  10776: =item * &record_sep($record)
1.41      ng       10777: 
1.258     albertel 10778: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       10779: 
                   10780: =cut
                   10781: 
1.263     www      10782: sub takeleft {
                   10783:     my $index=shift;
                   10784:     return substr('0000'.$index,-4,4);
                   10785: }
                   10786: 
1.31      albertel 10787: sub record_sep {
                   10788:     my $record=shift;
                   10789:     my %components=();
1.258     albertel 10790:     if ($env{'form.upfiletype'} eq 'xml') {
                   10791:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 10792:         my $i=0;
1.356     albertel 10793:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 10794:             $field=~s/^(\"|\')//;
                   10795:             $field=~s/(\"|\')$//;
1.263     www      10796:             $components{&takeleft($i)}=$field;
1.31      albertel 10797:             $i++;
                   10798:         }
1.258     albertel 10799:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 10800:         my $i=0;
1.356     albertel 10801:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 10802:             $field=~s/^(\"|\')//;
                   10803:             $field=~s/(\"|\')$//;
1.263     www      10804:             $components{&takeleft($i)}=$field;
1.31      albertel 10805:             $i++;
                   10806:         }
                   10807:     } else {
1.561     www      10808:         my $separator=',';
1.480     banghart 10809:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      10810:             $separator=';';
1.480     banghart 10811:         }
1.31      albertel 10812:         my $i=0;
1.561     www      10813: # the character we are looking for to indicate the end of a quote or a record 
                   10814:         my $looking_for=$separator;
                   10815: # do not add the characters to the fields
                   10816:         my $ignore=0;
                   10817: # we just encountered a separator (or the beginning of the record)
                   10818:         my $just_found_separator=1;
                   10819: # store the field we are working on here
                   10820:         my $field='';
                   10821: # work our way through all characters in record
                   10822:         foreach my $character ($record=~/(.)/g) {
                   10823:             if ($character eq $looking_for) {
                   10824:                if ($character ne $separator) {
                   10825: # Found the end of a quote, again looking for separator
                   10826:                   $looking_for=$separator;
                   10827:                   $ignore=1;
                   10828:                } else {
                   10829: # Found a separator, store away what we got
                   10830:                   $components{&takeleft($i)}=$field;
                   10831: 	          $i++;
                   10832:                   $just_found_separator=1;
                   10833:                   $ignore=0;
                   10834:                   $field='';
                   10835:                }
                   10836:                next;
                   10837:             }
                   10838: # single or double quotation marks after a separator indicate beginning of a quote
                   10839: # we are now looking for the end of the quote and need to ignore separators
                   10840:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   10841:                $looking_for=$character;
                   10842:                next;
                   10843:             }
                   10844: # ignore would be true after we reached the end of a quote
                   10845:             if ($ignore) { next; }
                   10846:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   10847:             $field.=$character;
                   10848:             $just_found_separator=0; 
1.31      albertel 10849:         }
1.561     www      10850: # catch the very last entry, since we never encountered the separator
                   10851:         $components{&takeleft($i)}=$field;
1.31      albertel 10852:     }
                   10853:     return %components;
                   10854: }
                   10855: 
1.144     matthew  10856: ######################################################
                   10857: ######################################################
                   10858: 
1.56      matthew  10859: =pod
                   10860: 
1.648     raeburn  10861: =item * &upfile_select_html()
1.41      ng       10862: 
1.144     matthew  10863: Return HTML code to select a file from the users machine and specify 
                   10864: the file type.
1.41      ng       10865: 
                   10866: =cut
                   10867: 
1.144     matthew  10868: ######################################################
                   10869: ######################################################
1.31      albertel 10870: sub upfile_select_html {
1.144     matthew  10871:     my %Types = (
                   10872:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 10873:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  10874:                  space => &mt('Space separated'),
                   10875:                  tab   => &mt('Tabulator separated'),
                   10876: #                 xml   => &mt('HTML/XML'),
                   10877:                  );
                   10878:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  10879:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  10880:     foreach my $type (sort(keys(%Types))) {
                   10881:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   10882:     }
                   10883:     $Str .= "</select>\n";
                   10884:     return $Str;
1.31      albertel 10885: }
                   10886: 
1.301     albertel 10887: sub get_samples {
                   10888:     my ($records,$toget) = @_;
                   10889:     my @samples=({});
                   10890:     my $got=0;
                   10891:     foreach my $rec (@$records) {
                   10892: 	my %temp = &record_sep($rec);
                   10893: 	if (! grep(/\S/, values(%temp))) { next; }
                   10894: 	if (%temp) {
                   10895: 	    $samples[$got]=\%temp;
                   10896: 	    $got++;
                   10897: 	    if ($got == $toget) { last; }
                   10898: 	}
                   10899:     }
                   10900:     return \@samples;
                   10901: }
                   10902: 
1.144     matthew  10903: ######################################################
                   10904: ######################################################
                   10905: 
1.56      matthew  10906: =pod
                   10907: 
1.648     raeburn  10908: =item * &csv_print_samples($r,$records)
1.41      ng       10909: 
                   10910: Prints a table of sample values from each column uploaded $r is an
                   10911: Apache Request ref, $records is an arrayref from
                   10912: &Apache::loncommon::upfile_record_sep
                   10913: 
                   10914: =cut
                   10915: 
1.144     matthew  10916: ######################################################
                   10917: ######################################################
1.31      albertel 10918: sub csv_print_samples {
                   10919:     my ($r,$records) = @_;
1.662     bisitz   10920:     my $samples = &get_samples($records,5);
1.301     albertel 10921: 
1.594     raeburn  10922:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   10923:               &start_data_table_header_row());
1.356     albertel 10924:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   10925:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  10926:     $r->print(&end_data_table_header_row());
1.301     albertel 10927:     foreach my $hash (@$samples) {
1.594     raeburn  10928: 	$r->print(&start_data_table_row());
1.356     albertel 10929: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 10930: 	    $r->print('<td>');
1.356     albertel 10931: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 10932: 	    $r->print('</td>');
                   10933: 	}
1.594     raeburn  10934: 	$r->print(&end_data_table_row());
1.31      albertel 10935:     }
1.594     raeburn  10936:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 10937: }
                   10938: 
1.144     matthew  10939: ######################################################
                   10940: ######################################################
                   10941: 
1.56      matthew  10942: =pod
                   10943: 
1.648     raeburn  10944: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       10945: 
                   10946: Prints a table to create associations between values and table columns.
1.144     matthew  10947: 
1.41      ng       10948: $r is an Apache Request ref,
                   10949: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  10950: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       10951: 
                   10952: =cut
                   10953: 
1.144     matthew  10954: ######################################################
                   10955: ######################################################
1.31      albertel 10956: sub csv_print_select_table {
                   10957:     my ($r,$records,$d) = @_;
1.301     albertel 10958:     my $i=0;
                   10959:     my $samples = &get_samples($records,1);
1.144     matthew  10960:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  10961: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  10962:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  10963:               '<th>'.&mt('Column').'</th>'.
                   10964:               &end_data_table_header_row()."\n");
1.356     albertel 10965:     foreach my $array_ref (@$d) {
                   10966: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  10967: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 10968: 
1.875     bisitz   10969: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  10970: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 10971: 	$r->print('<option value="none"></option>');
1.356     albertel 10972: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   10973: 	    $r->print('<option value="'.$sample.'"'.
                   10974:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   10975:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 10976: 	}
1.594     raeburn  10977: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 10978: 	$i++;
                   10979:     }
1.594     raeburn  10980:     $r->print(&end_data_table());
1.31      albertel 10981:     $i--;
                   10982:     return $i;
                   10983: }
1.56      matthew  10984: 
1.144     matthew  10985: ######################################################
                   10986: ######################################################
                   10987: 
1.56      matthew  10988: =pod
1.31      albertel 10989: 
1.648     raeburn  10990: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       10991: 
                   10992: Prints a table of sample values from the upload and can make associate samples to internal names.
                   10993: 
                   10994: $r is an Apache Request ref,
                   10995: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   10996: $d is an array of 2 element arrays (internal name, displayed name)
                   10997: 
                   10998: =cut
                   10999: 
1.144     matthew  11000: ######################################################
                   11001: ######################################################
1.31      albertel 11002: sub csv_samples_select_table {
                   11003:     my ($r,$records,$d) = @_;
                   11004:     my $i=0;
1.144     matthew  11005:     #
1.662     bisitz   11006:     my $max_samples = 5;
                   11007:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  11008:     $r->print(&start_data_table().
                   11009:               &start_data_table_header_row().'<th>'.
                   11010:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   11011:               &end_data_table_header_row());
1.301     albertel 11012: 
                   11013:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  11014: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  11015: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 11016: 	foreach my $option (@$d) {
                   11017: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  11018: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 11019:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  11020:                       $display.'</option>');
1.31      albertel 11021: 	}
                   11022: 	$r->print('</select></td><td>');
1.662     bisitz   11023: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 11024: 	    if (defined($samples->[$line]{$key})) { 
                   11025: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   11026: 	    }
                   11027: 	}
1.594     raeburn  11028: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 11029: 	$i++;
                   11030:     }
1.594     raeburn  11031:     $r->print(&end_data_table());
1.31      albertel 11032:     $i--;
                   11033:     return($i);
1.115     matthew  11034: }
                   11035: 
1.144     matthew  11036: ######################################################
                   11037: ######################################################
                   11038: 
1.115     matthew  11039: =pod
                   11040: 
1.648     raeburn  11041: =item * &clean_excel_name($name)
1.115     matthew  11042: 
                   11043: Returns a replacement for $name which does not contain any illegal characters.
                   11044: 
                   11045: =cut
                   11046: 
1.144     matthew  11047: ######################################################
                   11048: ######################################################
1.115     matthew  11049: sub clean_excel_name {
                   11050:     my ($name) = @_;
                   11051:     $name =~ s/[:\*\?\/\\]//g;
                   11052:     if (length($name) > 31) {
                   11053:         $name = substr($name,0,31);
                   11054:     }
                   11055:     return $name;
1.25      albertel 11056: }
1.84      albertel 11057: 
1.85      albertel 11058: =pod
                   11059: 
1.648     raeburn  11060: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 11061: 
                   11062: Returns either 1 or undef
                   11063: 
                   11064: 1 if the part is to be hidden, undef if it is to be shown
                   11065: 
                   11066: Arguments are:
                   11067: 
                   11068: $id the id of the part to be checked
                   11069: $symb, optional the symb of the resource to check
                   11070: $udom, optional the domain of the user to check for
                   11071: $uname, optional the username of the user to check for
                   11072: 
                   11073: =cut
1.84      albertel 11074: 
                   11075: sub check_if_partid_hidden {
                   11076:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 11077:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 11078: 					 $symb,$udom,$uname);
1.141     albertel 11079:     my $truth=1;
                   11080:     #if the string starts with !, then the list is the list to show not hide
                   11081:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 11082:     my @hiddenlist=split(/,/,$hiddenparts);
                   11083:     foreach my $checkid (@hiddenlist) {
1.141     albertel 11084: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 11085:     }
1.141     albertel 11086:     return !$truth;
1.84      albertel 11087: }
1.127     matthew  11088: 
1.138     matthew  11089: 
                   11090: ############################################################
                   11091: ############################################################
                   11092: 
                   11093: =pod
                   11094: 
1.157     matthew  11095: =back 
                   11096: 
1.138     matthew  11097: =head1 cgi-bin script and graphing routines
                   11098: 
1.157     matthew  11099: =over 4
                   11100: 
1.648     raeburn  11101: =item * &get_cgi_id()
1.138     matthew  11102: 
                   11103: Inputs: none
                   11104: 
                   11105: Returns an id which can be used to pass environment variables
                   11106: to various cgi-bin scripts.  These environment variables will
                   11107: be removed from the users environment after a given time by
                   11108: the routine &Apache::lonnet::transfer_profile_to_env.
                   11109: 
                   11110: =cut
                   11111: 
                   11112: ############################################################
                   11113: ############################################################
1.152     albertel 11114: my $uniq=0;
1.136     matthew  11115: sub get_cgi_id {
1.154     albertel 11116:     $uniq=($uniq+1)%100000;
1.280     albertel 11117:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  11118: }
                   11119: 
1.127     matthew  11120: ############################################################
                   11121: ############################################################
                   11122: 
                   11123: =pod
                   11124: 
1.648     raeburn  11125: =item * &DrawBarGraph()
1.127     matthew  11126: 
1.138     matthew  11127: Facilitates the plotting of data in a (stacked) bar graph.
                   11128: Puts plot definition data into the users environment in order for 
                   11129: graph.png to plot it.  Returns an <img> tag for the plot.
                   11130: The bars on the plot are labeled '1','2',...,'n'.
                   11131: 
                   11132: Inputs:
                   11133: 
                   11134: =over 4
                   11135: 
                   11136: =item $Title: string, the title of the plot
                   11137: 
                   11138: =item $xlabel: string, text describing the X-axis of the plot
                   11139: 
                   11140: =item $ylabel: string, text describing the Y-axis of the plot
                   11141: 
                   11142: =item $Max: scalar, the maximum Y value to use in the plot
                   11143: If $Max is < any data point, the graph will not be rendered.
                   11144: 
1.140     matthew  11145: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  11146: they are plotted.  If undefined, default values will be used.
                   11147: 
1.178     matthew  11148: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   11149: 
1.138     matthew  11150: =item @Values: An array of array references.  Each array reference holds data
                   11151: to be plotted in a stacked bar chart.
                   11152: 
1.239     matthew  11153: =item If the final element of @Values is a hash reference the key/value
                   11154: pairs will be added to the graph definition.
                   11155: 
1.138     matthew  11156: =back
                   11157: 
                   11158: Returns:
                   11159: 
                   11160: An <img> tag which references graph.png and the appropriate identifying
                   11161: information for the plot.
                   11162: 
1.127     matthew  11163: =cut
                   11164: 
                   11165: ############################################################
                   11166: ############################################################
1.134     matthew  11167: sub DrawBarGraph {
1.178     matthew  11168:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  11169:     #
                   11170:     if (! defined($colors)) {
                   11171:         $colors = ['#33ff00', 
                   11172:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   11173:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   11174:                   ]; 
                   11175:     }
1.228     matthew  11176:     my $extra_settings = {};
                   11177:     if (ref($Values[-1]) eq 'HASH') {
                   11178:         $extra_settings = pop(@Values);
                   11179:     }
1.127     matthew  11180:     #
1.136     matthew  11181:     my $identifier = &get_cgi_id();
                   11182:     my $id = 'cgi.'.$identifier;        
1.129     matthew  11183:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  11184:         return '';
                   11185:     }
1.225     matthew  11186:     #
                   11187:     my @Labels;
                   11188:     if (defined($labels)) {
                   11189:         @Labels = @$labels;
                   11190:     } else {
                   11191:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   11192:             push (@Labels,$i+1);
                   11193:         }
                   11194:     }
                   11195:     #
1.129     matthew  11196:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  11197:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  11198:     my %ValuesHash;
                   11199:     my $NumSets=1;
                   11200:     foreach my $array (@Values) {
                   11201:         next if (! ref($array));
1.136     matthew  11202:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  11203:             join(',',@$array);
1.129     matthew  11204:     }
1.127     matthew  11205:     #
1.136     matthew  11206:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  11207:     if ($NumBars < 3) {
                   11208:         $width = 120+$NumBars*32;
1.220     matthew  11209:         $xskip = 1;
1.225     matthew  11210:         $bar_width = 30;
                   11211:     } elsif ($NumBars < 5) {
                   11212:         $width = 120+$NumBars*20;
                   11213:         $xskip = 1;
                   11214:         $bar_width = 20;
1.220     matthew  11215:     } elsif ($NumBars < 10) {
1.136     matthew  11216:         $width = 120+$NumBars*15;
                   11217:         $xskip = 1;
                   11218:         $bar_width = 15;
                   11219:     } elsif ($NumBars <= 25) {
                   11220:         $width = 120+$NumBars*11;
                   11221:         $xskip = 5;
                   11222:         $bar_width = 8;
                   11223:     } elsif ($NumBars <= 50) {
                   11224:         $width = 120+$NumBars*8;
                   11225:         $xskip = 5;
                   11226:         $bar_width = 4;
                   11227:     } else {
                   11228:         $width = 120+$NumBars*8;
                   11229:         $xskip = 5;
                   11230:         $bar_width = 4;
                   11231:     }
                   11232:     #
1.137     matthew  11233:     $Max = 1 if ($Max < 1);
                   11234:     if ( int($Max) < $Max ) {
                   11235:         $Max++;
                   11236:         $Max = int($Max);
                   11237:     }
1.127     matthew  11238:     $Title  = '' if (! defined($Title));
                   11239:     $xlabel = '' if (! defined($xlabel));
                   11240:     $ylabel = '' if (! defined($ylabel));
1.369     www      11241:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   11242:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   11243:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  11244:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  11245:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   11246:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   11247:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   11248:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11249:     $ValuesHash{$id.'.height'}   = $height;
                   11250:     $ValuesHash{$id.'.width'}    = $width;
                   11251:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   11252:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   11253:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  11254:     #
1.228     matthew  11255:     # Deal with other parameters
                   11256:     while (my ($key,$value) = each(%$extra_settings)) {
                   11257:         $ValuesHash{$id.'.'.$key} = $value;
                   11258:     }
                   11259:     #
1.646     raeburn  11260:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  11261:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11262: }
                   11263: 
                   11264: ############################################################
                   11265: ############################################################
                   11266: 
                   11267: =pod
                   11268: 
1.648     raeburn  11269: =item * &DrawXYGraph()
1.137     matthew  11270: 
1.138     matthew  11271: Facilitates the plotting of data in an XY graph.
                   11272: Puts plot definition data into the users environment in order for 
                   11273: graph.png to plot it.  Returns an <img> tag for the plot.
                   11274: 
                   11275: Inputs:
                   11276: 
                   11277: =over 4
                   11278: 
                   11279: =item $Title: string, the title of the plot
                   11280: 
                   11281: =item $xlabel: string, text describing the X-axis of the plot
                   11282: 
                   11283: =item $ylabel: string, text describing the Y-axis of the plot
                   11284: 
                   11285: =item $Max: scalar, the maximum Y value to use in the plot
                   11286: If $Max is < any data point, the graph will not be rendered.
                   11287: 
                   11288: =item $colors: Array ref containing the hex color codes for the data to be 
                   11289: plotted in.  If undefined, default values will be used.
                   11290: 
                   11291: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11292: 
                   11293: =item $Ydata: Array ref containing Array refs.  
1.185     www      11294: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  11295: 
                   11296: =item %Values: hash indicating or overriding any default values which are 
                   11297: passed to graph.png.  
                   11298: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11299: 
                   11300: =back
                   11301: 
                   11302: Returns:
                   11303: 
                   11304: An <img> tag which references graph.png and the appropriate identifying
                   11305: information for the plot.
                   11306: 
1.137     matthew  11307: =cut
                   11308: 
                   11309: ############################################################
                   11310: ############################################################
                   11311: sub DrawXYGraph {
                   11312:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   11313:     #
                   11314:     # Create the identifier for the graph
                   11315:     my $identifier = &get_cgi_id();
                   11316:     my $id = 'cgi.'.$identifier;
                   11317:     #
                   11318:     $Title  = '' if (! defined($Title));
                   11319:     $xlabel = '' if (! defined($xlabel));
                   11320:     $ylabel = '' if (! defined($ylabel));
                   11321:     my %ValuesHash = 
                   11322:         (
1.369     www      11323:          $id.'.title'  => &escape($Title),
                   11324:          $id.'.xlabel' => &escape($xlabel),
                   11325:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  11326:          $id.'.y_max_value'=> $Max,
                   11327:          $id.'.labels'     => join(',',@$Xlabels),
                   11328:          $id.'.PlotType'   => 'XY',
                   11329:          );
                   11330:     #
                   11331:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11332:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11333:     }
                   11334:     #
                   11335:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   11336:         return '';
                   11337:     }
                   11338:     my $NumSets=1;
1.138     matthew  11339:     foreach my $array (@{$Ydata}){
1.137     matthew  11340:         next if (! ref($array));
                   11341:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   11342:     }
1.138     matthew  11343:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  11344:     #
                   11345:     # Deal with other parameters
                   11346:     while (my ($key,$value) = each(%Values)) {
                   11347:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  11348:     }
                   11349:     #
1.646     raeburn  11350:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  11351:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   11352: }
                   11353: 
                   11354: ############################################################
                   11355: ############################################################
                   11356: 
                   11357: =pod
                   11358: 
1.648     raeburn  11359: =item * &DrawXYYGraph()
1.138     matthew  11360: 
                   11361: Facilitates the plotting of data in an XY graph with two Y axes.
                   11362: Puts plot definition data into the users environment in order for 
                   11363: graph.png to plot it.  Returns an <img> tag for the plot.
                   11364: 
                   11365: Inputs:
                   11366: 
                   11367: =over 4
                   11368: 
                   11369: =item $Title: string, the title of the plot
                   11370: 
                   11371: =item $xlabel: string, text describing the X-axis of the plot
                   11372: 
                   11373: =item $ylabel: string, text describing the Y-axis of the plot
                   11374: 
                   11375: =item $colors: Array ref containing the hex color codes for the data to be 
                   11376: plotted in.  If undefined, default values will be used.
                   11377: 
                   11378: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   11379: 
                   11380: =item $Ydata1: The first data set
                   11381: 
                   11382: =item $Min1: The minimum value of the left Y-axis
                   11383: 
                   11384: =item $Max1: The maximum value of the left Y-axis
                   11385: 
                   11386: =item $Ydata2: The second data set
                   11387: 
                   11388: =item $Min2: The minimum value of the right Y-axis
                   11389: 
                   11390: =item $Max2: The maximum value of the left Y-axis
                   11391: 
                   11392: =item %Values: hash indicating or overriding any default values which are 
                   11393: passed to graph.png.  
                   11394: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   11395: 
                   11396: =back
                   11397: 
                   11398: Returns:
                   11399: 
                   11400: An <img> tag which references graph.png and the appropriate identifying
                   11401: information for the plot.
1.136     matthew  11402: 
                   11403: =cut
                   11404: 
                   11405: ############################################################
                   11406: ############################################################
1.137     matthew  11407: sub DrawXYYGraph {
                   11408:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   11409:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  11410:     #
                   11411:     # Create the identifier for the graph
                   11412:     my $identifier = &get_cgi_id();
                   11413:     my $id = 'cgi.'.$identifier;
                   11414:     #
                   11415:     $Title  = '' if (! defined($Title));
                   11416:     $xlabel = '' if (! defined($xlabel));
                   11417:     $ylabel = '' if (! defined($ylabel));
                   11418:     my %ValuesHash = 
                   11419:         (
1.369     www      11420:          $id.'.title'  => &escape($Title),
                   11421:          $id.'.xlabel' => &escape($xlabel),
                   11422:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  11423:          $id.'.labels' => join(',',@$Xlabels),
                   11424:          $id.'.PlotType' => 'XY',
                   11425:          $id.'.NumSets' => 2,
1.137     matthew  11426:          $id.'.two_axes' => 1,
                   11427:          $id.'.y1_max_value' => $Max1,
                   11428:          $id.'.y1_min_value' => $Min1,
                   11429:          $id.'.y2_max_value' => $Max2,
                   11430:          $id.'.y2_min_value' => $Min2,
1.136     matthew  11431:          );
                   11432:     #
1.137     matthew  11433:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   11434:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   11435:     }
                   11436:     #
                   11437:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   11438:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  11439:         return '';
                   11440:     }
                   11441:     my $NumSets=1;
1.137     matthew  11442:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  11443:         next if (! ref($array));
                   11444:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  11445:     }
                   11446:     #
                   11447:     # Deal with other parameters
                   11448:     while (my ($key,$value) = each(%Values)) {
                   11449:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  11450:     }
                   11451:     #
1.646     raeburn  11452:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 11453:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  11454: }
                   11455: 
                   11456: ############################################################
                   11457: ############################################################
                   11458: 
                   11459: =pod
                   11460: 
1.157     matthew  11461: =back 
                   11462: 
1.139     matthew  11463: =head1 Statistics helper routines?  
                   11464: 
                   11465: Bad place for them but what the hell.
                   11466: 
1.157     matthew  11467: =over 4
                   11468: 
1.648     raeburn  11469: =item * &chartlink()
1.139     matthew  11470: 
                   11471: Returns a link to the chart for a specific student.  
                   11472: 
                   11473: Inputs:
                   11474: 
                   11475: =over 4
                   11476: 
                   11477: =item $linktext: The text of the link
                   11478: 
                   11479: =item $sname: The students username
                   11480: 
                   11481: =item $sdomain: The students domain
                   11482: 
                   11483: =back
                   11484: 
1.157     matthew  11485: =back
                   11486: 
1.139     matthew  11487: =cut
                   11488: 
                   11489: ############################################################
                   11490: ############################################################
                   11491: sub chartlink {
                   11492:     my ($linktext, $sname, $sdomain) = @_;
                   11493:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      11494:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 11495:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  11496:        '">'.$linktext.'</a>';
1.153     matthew  11497: }
                   11498: 
                   11499: #######################################################
                   11500: #######################################################
                   11501: 
                   11502: =pod
                   11503: 
                   11504: =head1 Course Environment Routines
1.157     matthew  11505: 
                   11506: =over 4
1.153     matthew  11507: 
1.648     raeburn  11508: =item * &restore_course_settings()
1.153     matthew  11509: 
1.648     raeburn  11510: =item * &store_course_settings()
1.153     matthew  11511: 
                   11512: Restores/Store indicated form parameters from the course environment.
                   11513: Will not overwrite existing values of the form parameters.
                   11514: 
                   11515: Inputs: 
                   11516: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   11517: 
                   11518: a hash ref describing the data to be stored.  For example:
                   11519:    
                   11520: %Save_Parameters = ('Status' => 'scalar',
                   11521:     'chartoutputmode' => 'scalar',
                   11522:     'chartoutputdata' => 'scalar',
                   11523:     'Section' => 'array',
1.373     raeburn  11524:     'Group' => 'array',
1.153     matthew  11525:     'StudentData' => 'array',
                   11526:     'Maps' => 'array');
                   11527: 
                   11528: Returns: both routines return nothing
                   11529: 
1.631     raeburn  11530: =back
                   11531: 
1.153     matthew  11532: =cut
                   11533: 
                   11534: #######################################################
                   11535: #######################################################
                   11536: sub store_course_settings {
1.496     albertel 11537:     return &store_settings($env{'request.course.id'},@_);
                   11538: }
                   11539: 
                   11540: sub store_settings {
1.153     matthew  11541:     # save to the environment
                   11542:     # appenv the same items, just to be safe
1.300     albertel 11543:     my $udom  = $env{'user.domain'};
                   11544:     my $uname = $env{'user.name'};
1.496     albertel 11545:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11546:     my %SaveHash;
                   11547:     my %AppHash;
                   11548:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 11549:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 11550:         my $envname = 'environment.'.$basename;
1.258     albertel 11551:         if (exists($env{'form.'.$setting})) {
1.153     matthew  11552:             # Save this value away
                   11553:             if ($type eq 'scalar' &&
1.258     albertel 11554:                 (! exists($env{$envname}) || 
                   11555:                  $env{$envname} ne $env{'form.'.$setting})) {
                   11556:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   11557:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  11558:             } elsif ($type eq 'array') {
                   11559:                 my $stored_form;
1.258     albertel 11560:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  11561:                     $stored_form = join(',',
                   11562:                                         map {
1.369     www      11563:                                             &escape($_);
1.258     albertel 11564:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  11565:                 } else {
                   11566:                     $stored_form = 
1.369     www      11567:                         &escape($env{'form.'.$setting});
1.153     matthew  11568:                 }
                   11569:                 # Determine if the array contents are the same.
1.258     albertel 11570:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  11571:                     $SaveHash{$basename} = $stored_form;
                   11572:                     $AppHash{$envname}   = $stored_form;
                   11573:                 }
                   11574:             }
                   11575:         }
                   11576:     }
                   11577:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 11578:                                           $udom,$uname);
1.153     matthew  11579:     if ($put_result !~ /^(ok|delayed)/) {
                   11580:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   11581:                                  'got error:'.$put_result);
                   11582:     }
                   11583:     # Make sure these settings stick around in this session, too
1.646     raeburn  11584:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  11585:     return;
                   11586: }
                   11587: 
                   11588: sub restore_course_settings {
1.499     albertel 11589:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 11590: }
                   11591: 
                   11592: sub restore_settings {
                   11593:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  11594:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 11595:         next if (exists($env{'form.'.$setting}));
1.496     albertel 11596:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  11597:             '.'.$setting;
1.258     albertel 11598:         if (exists($env{$envname})) {
1.153     matthew  11599:             if ($type eq 'scalar') {
1.258     albertel 11600:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  11601:             } elsif ($type eq 'array') {
1.258     albertel 11602:                 $env{'form.'.$setting} = [ 
1.153     matthew  11603:                                            map { 
1.369     www      11604:                                                &unescape($_); 
1.258     albertel 11605:                                            } split(',',$env{$envname})
1.153     matthew  11606:                                            ];
                   11607:             }
                   11608:         }
                   11609:     }
1.127     matthew  11610: }
                   11611: 
1.618     raeburn  11612: #######################################################
                   11613: #######################################################
                   11614: 
                   11615: =pod
                   11616: 
                   11617: =head1 Domain E-mail Routines  
                   11618: 
                   11619: =over 4
                   11620: 
1.648     raeburn  11621: =item * &build_recipient_list()
1.618     raeburn  11622: 
1.884     raeburn  11623: Build recipient lists for five types of e-mail:
1.766     raeburn  11624: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  11625: (d) Help requests, (e) Course requests needing approval,  generated by
                   11626: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   11627: loncoursequeueadmin.pm respectively.
1.618     raeburn  11628: 
                   11629: Inputs:
1.619     raeburn  11630: defmail (scalar - email address of default recipient), 
1.618     raeburn  11631: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  11632: defdom (domain for which to retrieve configuration settings),
                   11633: origmail (scalar - email address of recipient from loncapa.conf, 
                   11634: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  11635: 
1.655     raeburn  11636: Returns: comma separated list of addresses to which to send e-mail.
                   11637: 
                   11638: =back
1.618     raeburn  11639: 
                   11640: =cut
                   11641: 
                   11642: ############################################################
                   11643: ############################################################
                   11644: sub build_recipient_list {
1.619     raeburn  11645:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  11646:     my @recipients;
                   11647:     my $otheremails;
                   11648:     my %domconfig =
                   11649:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   11650:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  11651:         if (exists($domconfig{'contacts'}{$mailing})) {
                   11652:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   11653:                 my @contacts = ('adminemail','supportemail');
                   11654:                 foreach my $item (@contacts) {
                   11655:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   11656:                         my $addr = $domconfig{'contacts'}{$item}; 
                   11657:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11658:                             push(@recipients,$addr);
                   11659:                         }
1.619     raeburn  11660:                     }
1.766     raeburn  11661:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  11662:                 }
                   11663:             }
1.766     raeburn  11664:         } elsif ($origmail ne '') {
                   11665:             push(@recipients,$origmail);
1.618     raeburn  11666:         }
1.619     raeburn  11667:     } elsif ($origmail ne '') {
                   11668:         push(@recipients,$origmail);
1.618     raeburn  11669:     }
1.688     raeburn  11670:     if (defined($defmail)) {
                   11671:         if ($defmail ne '') {
                   11672:             push(@recipients,$defmail);
                   11673:         }
1.618     raeburn  11674:     }
                   11675:     if ($otheremails) {
1.619     raeburn  11676:         my @others;
                   11677:         if ($otheremails =~ /,/) {
                   11678:             @others = split(/,/,$otheremails);
1.618     raeburn  11679:         } else {
1.619     raeburn  11680:             push(@others,$otheremails);
                   11681:         }
                   11682:         foreach my $addr (@others) {
                   11683:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   11684:                 push(@recipients,$addr);
                   11685:             }
1.618     raeburn  11686:         }
                   11687:     }
1.619     raeburn  11688:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  11689:     return $recipientlist;
                   11690: }
                   11691: 
1.127     matthew  11692: ############################################################
                   11693: ############################################################
1.154     albertel 11694: 
1.655     raeburn  11695: =pod
                   11696: 
                   11697: =head1 Course Catalog Routines
                   11698: 
                   11699: =over 4
                   11700: 
                   11701: =item * &gather_categories()
                   11702: 
                   11703: Converts category definitions - keys of categories hash stored in  
                   11704: coursecategories in configuration.db on the primary library server in a 
                   11705: domain - to an array.  Also generates javascript and idx hash used to 
                   11706: generate Domain Coordinator interface for editing Course Categories.
                   11707: 
                   11708: Inputs:
1.663     raeburn  11709: 
1.655     raeburn  11710: categories (reference to hash of category definitions).
1.663     raeburn  11711: 
1.655     raeburn  11712: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11713:       categories and subcategories).
1.663     raeburn  11714: 
1.655     raeburn  11715: idx (reference to hash of counters used in Domain Coordinator interface for 
                   11716:       editing Course Categories).
1.663     raeburn  11717: 
1.655     raeburn  11718: jsarray (reference to array of categories used to create Javascript arrays for
                   11719:          Domain Coordinator interface for editing Course Categories).
                   11720: 
                   11721: Returns: nothing
                   11722: 
                   11723: Side effects: populates cats, idx and jsarray. 
                   11724: 
                   11725: =cut
                   11726: 
                   11727: sub gather_categories {
                   11728:     my ($categories,$cats,$idx,$jsarray) = @_;
                   11729:     my %counters;
                   11730:     my $num = 0;
                   11731:     foreach my $item (keys(%{$categories})) {
                   11732:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   11733:         if ($container eq '' && $depth == 0) {
                   11734:             $cats->[$depth][$categories->{$item}] = $cat;
                   11735:         } else {
                   11736:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   11737:         }
                   11738:         my ($escitem,$tail) = split(/:/,$item,2);
                   11739:         if ($counters{$tail} eq '') {
                   11740:             $counters{$tail} = $num;
                   11741:             $num ++;
                   11742:         }
                   11743:         if (ref($idx) eq 'HASH') {
                   11744:             $idx->{$item} = $counters{$tail};
                   11745:         }
                   11746:         if (ref($jsarray) eq 'ARRAY') {
                   11747:             push(@{$jsarray->[$counters{$tail}]},$item);
                   11748:         }
                   11749:     }
                   11750:     return;
                   11751: }
                   11752: 
                   11753: =pod
                   11754: 
                   11755: =item * &extract_categories()
                   11756: 
                   11757: Used to generate breadcrumb trails for course categories.
                   11758: 
                   11759: Inputs:
1.663     raeburn  11760: 
1.655     raeburn  11761: categories (reference to hash of category definitions).
1.663     raeburn  11762: 
1.655     raeburn  11763: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11764:       categories and subcategories).
1.663     raeburn  11765: 
1.655     raeburn  11766: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  11767: 
1.655     raeburn  11768: allitems (reference to hash - key is category key 
                   11769:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11770: 
1.655     raeburn  11771: idx (reference to hash of counters used in Domain Coordinator interface for
                   11772:       editing Course Categories).
1.663     raeburn  11773: 
1.655     raeburn  11774: jsarray (reference to array of categories used to create Javascript arrays for
                   11775:          Domain Coordinator interface for editing Course Categories).
                   11776: 
1.665     raeburn  11777: subcats (reference to hash of arrays containing all subcategories within each 
                   11778:          category, -recursive)
                   11779: 
1.655     raeburn  11780: Returns: nothing
                   11781: 
                   11782: Side effects: populates trails and allitems hash references.
                   11783: 
                   11784: =cut
                   11785: 
                   11786: sub extract_categories {
1.665     raeburn  11787:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  11788:     if (ref($categories) eq 'HASH') {
                   11789:         &gather_categories($categories,$cats,$idx,$jsarray);
                   11790:         if (ref($cats->[0]) eq 'ARRAY') {
                   11791:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   11792:                 my $name = $cats->[0][$i];
                   11793:                 my $item = &escape($name).'::0';
                   11794:                 my $trailstr;
                   11795:                 if ($name eq 'instcode') {
                   11796:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  11797:                 } elsif ($name eq 'communities') {
                   11798:                     $trailstr = &mt('Communities');
1.655     raeburn  11799:                 } else {
                   11800:                     $trailstr = $name;
                   11801:                 }
                   11802:                 if ($allitems->{$item} eq '') {
                   11803:                     push(@{$trails},$trailstr);
                   11804:                     $allitems->{$item} = scalar(@{$trails})-1;
                   11805:                 }
                   11806:                 my @parents = ($name);
                   11807:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   11808:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   11809:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  11810:                         if (ref($subcats) eq 'HASH') {
                   11811:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   11812:                         }
                   11813:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   11814:                     }
                   11815:                 } else {
                   11816:                     if (ref($subcats) eq 'HASH') {
                   11817:                         $subcats->{$item} = [];
1.655     raeburn  11818:                     }
                   11819:                 }
                   11820:             }
                   11821:         }
                   11822:     }
                   11823:     return;
                   11824: }
                   11825: 
                   11826: =pod
                   11827: 
                   11828: =item *&recurse_categories()
                   11829: 
                   11830: Recursively used to generate breadcrumb trails for course categories.
                   11831: 
                   11832: Inputs:
1.663     raeburn  11833: 
1.655     raeburn  11834: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   11835:       categories and subcategories).
1.663     raeburn  11836: 
1.655     raeburn  11837: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  11838: 
                   11839: category (current course category, for which breadcrumb trail is being generated).
                   11840: 
                   11841: trails (reference to array of breadcrumb trails for each category).
                   11842: 
1.655     raeburn  11843: allitems (reference to hash - key is category key
                   11844:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  11845: 
1.655     raeburn  11846: parents (array containing containers directories for current category, 
                   11847:          back to top level). 
                   11848: 
                   11849: Returns: nothing
                   11850: 
                   11851: Side effects: populates trails and allitems hash references
                   11852: 
                   11853: =cut
                   11854: 
                   11855: sub recurse_categories {
1.665     raeburn  11856:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  11857:     my $shallower = $depth - 1;
                   11858:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   11859:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   11860:             my $name = $cats->[$depth]{$category}[$k];
                   11861:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11862:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11863:             if ($allitems->{$item} eq '') {
                   11864:                 push(@{$trails},$trailstr);
                   11865:                 $allitems->{$item} = scalar(@{$trails})-1;
                   11866:             }
                   11867:             my $deeper = $depth+1;
                   11868:             push(@{$parents},$category);
1.665     raeburn  11869:             if (ref($subcats) eq 'HASH') {
                   11870:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   11871:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   11872:                     my $higher;
                   11873:                     if ($j > 0) {
                   11874:                         $higher = &escape($parents->[$j]).':'.
                   11875:                                   &escape($parents->[$j-1]).':'.$j;
                   11876:                     } else {
                   11877:                         $higher = &escape($parents->[$j]).'::'.$j;
                   11878:                     }
                   11879:                     push(@{$subcats->{$higher}},$subcat);
                   11880:                 }
                   11881:             }
                   11882:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   11883:                                 $subcats);
1.655     raeburn  11884:             pop(@{$parents});
                   11885:         }
                   11886:     } else {
                   11887:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   11888:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   11889:         if ($allitems->{$item} eq '') {
                   11890:             push(@{$trails},$trailstr);
                   11891:             $allitems->{$item} = scalar(@{$trails})-1;
                   11892:         }
                   11893:     }
                   11894:     return;
                   11895: }
                   11896: 
1.663     raeburn  11897: =pod
                   11898: 
                   11899: =item *&assign_categories_table()
                   11900: 
                   11901: Create a datatable for display of hierarchical categories in a domain,
                   11902: with checkboxes to allow a course to be categorized. 
                   11903: 
                   11904: Inputs:
                   11905: 
                   11906: cathash - reference to hash of categories defined for the domain (from
                   11907:           configuration.db)
                   11908: 
                   11909: currcat - scalar with an & separated list of categories assigned to a course. 
                   11910: 
1.919     raeburn  11911: type    - scalar contains course type (Course or Community).
                   11912: 
1.663     raeburn  11913: Returns: $output (markup to be displayed) 
                   11914: 
                   11915: =cut
                   11916: 
                   11917: sub assign_categories_table {
1.919     raeburn  11918:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  11919:     my $output;
                   11920:     if (ref($cathash) eq 'HASH') {
                   11921:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   11922:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   11923:         $maxdepth = scalar(@cats);
                   11924:         if (@cats > 0) {
                   11925:             my $itemcount = 0;
                   11926:             if (ref($cats[0]) eq 'ARRAY') {
                   11927:                 my @currcategories;
                   11928:                 if ($currcat ne '') {
                   11929:                     @currcategories = split('&',$currcat);
                   11930:                 }
1.919     raeburn  11931:                 my $table;
1.663     raeburn  11932:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   11933:                     my $parent = $cats[0][$i];
1.919     raeburn  11934:                     next if ($parent eq 'instcode');
                   11935:                     if ($type eq 'Community') {
                   11936:                         next unless ($parent eq 'communities');
                   11937:                     } else {
                   11938:                         next if ($parent eq 'communities');
                   11939:                     }
1.663     raeburn  11940:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   11941:                     my $item = &escape($parent).'::0';
                   11942:                     my $checked = '';
                   11943:                     if (@currcategories > 0) {
                   11944:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   11945:                             $checked = ' checked="checked"';
1.663     raeburn  11946:                         }
                   11947:                     }
1.919     raeburn  11948:                     my $parent_title = $parent;
                   11949:                     if ($parent eq 'communities') {
                   11950:                         $parent_title = &mt('Communities');
                   11951:                     }
                   11952:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   11953:                               '<input type="checkbox" name="usecategory" value="'.
                   11954:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   11955:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  11956:                     my $depth = 1;
                   11957:                     push(@path,$parent);
1.919     raeburn  11958:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  11959:                     pop(@path);
1.919     raeburn  11960:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  11961:                     $itemcount ++;
                   11962:                 }
1.919     raeburn  11963:                 if ($itemcount) {
                   11964:                     $output = &Apache::loncommon::start_data_table().
                   11965:                               $table.
                   11966:                               &Apache::loncommon::end_data_table();
                   11967:                 }
1.663     raeburn  11968:             }
                   11969:         }
                   11970:     }
                   11971:     return $output;
                   11972: }
                   11973: 
                   11974: =pod
                   11975: 
                   11976: =item *&assign_category_rows()
                   11977: 
                   11978: Create a datatable row for display of nested categories in a domain,
                   11979: with checkboxes to allow a course to be categorized,called recursively.
                   11980: 
                   11981: Inputs:
                   11982: 
                   11983: itemcount - track row number for alternating colors
                   11984: 
                   11985: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   11986:       categories and subcategories.
                   11987: 
                   11988: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   11989: 
                   11990: parent - parent of current category item
                   11991: 
                   11992: path - Array containing all categories back up through the hierarchy from the
                   11993:        current category to the top level.
                   11994: 
                   11995: currcategories - reference to array of current categories assigned to the course
                   11996: 
                   11997: Returns: $output (markup to be displayed).
                   11998: 
                   11999: =cut
                   12000: 
                   12001: sub assign_category_rows {
                   12002:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   12003:     my ($text,$name,$item,$chgstr);
                   12004:     if (ref($cats) eq 'ARRAY') {
                   12005:         my $maxdepth = scalar(@{$cats});
                   12006:         if (ref($cats->[$depth]) eq 'HASH') {
                   12007:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   12008:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   12009:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12010:                 $text .= '<td><table class="LC_datatable">';
                   12011:                 for (my $j=0; $j<$numchildren; $j++) {
                   12012:                     $name = $cats->[$depth]{$parent}[$j];
                   12013:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   12014:                     my $deeper = $depth+1;
                   12015:                     my $checked = '';
                   12016:                     if (ref($currcategories) eq 'ARRAY') {
                   12017:                         if (@{$currcategories} > 0) {
                   12018:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   12019:                                 $checked = ' checked="checked"';
1.663     raeburn  12020:                             }
                   12021:                         }
                   12022:                     }
1.664     raeburn  12023:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   12024:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  12025:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   12026:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   12027:                              '</td><td>';
1.663     raeburn  12028:                     if (ref($path) eq 'ARRAY') {
                   12029:                         push(@{$path},$name);
                   12030:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   12031:                         pop(@{$path});
                   12032:                     }
                   12033:                     $text .= '</td></tr>';
                   12034:                 }
                   12035:                 $text .= '</table></td>';
                   12036:             }
                   12037:         }
                   12038:     }
                   12039:     return $text;
                   12040: }
                   12041: 
1.655     raeburn  12042: ############################################################
                   12043: ############################################################
                   12044: 
                   12045: 
1.443     albertel 12046: sub commit_customrole {
1.664     raeburn  12047:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  12048:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 12049:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   12050:                          ($end?', ending '.localtime($end):'').': <b>'.
                   12051:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  12052:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 12053:                  '</b><br />';
                   12054:     return $output;
                   12055: }
                   12056: 
                   12057: sub commit_standardrole {
1.541     raeburn  12058:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   12059:     my ($output,$logmsg,$linefeed);
                   12060:     if ($context eq 'auto') {
                   12061:         $linefeed = "\n";
                   12062:     } else {
                   12063:         $linefeed = "<br />\n";
                   12064:     }  
1.443     albertel 12065:     if ($three eq 'st') {
1.541     raeburn  12066:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   12067:                                          $one,$two,$sec,$context);
                   12068:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  12069:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   12070:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 12071:         } else {
1.541     raeburn  12072:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 12073:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12074:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   12075:             if ($context eq 'auto') {
                   12076:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   12077:             } else {
                   12078:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   12079:                &mt('Add to classlist').': <b>ok</b>';
                   12080:             }
                   12081:             $output .= $linefeed;
1.443     albertel 12082:         }
                   12083:     } else {
                   12084:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   12085:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12086:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  12087:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  12088:         if ($context eq 'auto') {
                   12089:             $output .= $result.$linefeed;
                   12090:         } else {
                   12091:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   12092:         }
1.443     albertel 12093:     }
                   12094:     return $output;
                   12095: }
                   12096: 
                   12097: sub commit_studentrole {
1.541     raeburn  12098:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  12099:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  12100:     if ($context eq 'auto') {
                   12101:         $linefeed = "\n";
                   12102:     } else {
                   12103:         $linefeed = '<br />'."\n";
                   12104:     }
1.443     albertel 12105:     if (defined($one) && defined($two)) {
                   12106:         my $cid=$one.'_'.$two;
                   12107:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   12108:         my $secchange = 0;
                   12109:         my $expire_role_result;
                   12110:         my $modify_section_result;
1.628     raeburn  12111:         if ($oldsec ne '-1') { 
                   12112:             if ($oldsec ne $sec) {
1.443     albertel 12113:                 $secchange = 1;
1.628     raeburn  12114:                 my $now = time;
1.443     albertel 12115:                 my $uurl='/'.$cid;
                   12116:                 $uurl=~s/\_/\//g;
                   12117:                 if ($oldsec) {
                   12118:                     $uurl.='/'.$oldsec;
                   12119:                 }
1.626     raeburn  12120:                 $oldsecurl = $uurl;
1.628     raeburn  12121:                 $expire_role_result = 
1.652     raeburn  12122:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  12123:                 if ($env{'request.course.sec'} ne '') { 
                   12124:                     if ($expire_role_result eq 'refused') {
                   12125:                         my @roles = ('st');
                   12126:                         my @statuses = ('previous');
                   12127:                         my @roledoms = ($one);
                   12128:                         my $withsec = 1;
                   12129:                         my %roleshash = 
                   12130:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   12131:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   12132:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   12133:                             my ($oldstart,$oldend) = 
                   12134:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   12135:                             if ($oldend > 0 && $oldend <= $now) {
                   12136:                                 $expire_role_result = 'ok';
                   12137:                             }
                   12138:                         }
                   12139:                     }
                   12140:                 }
1.443     albertel 12141:                 $result = $expire_role_result;
                   12142:             }
                   12143:         }
                   12144:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  12145:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 12146:             if ($modify_section_result =~ /^ok/) {
                   12147:                 if ($secchange == 1) {
1.628     raeburn  12148:                     if ($sec eq '') {
                   12149:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   12150:                     } else {
                   12151:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   12152:                     }
1.443     albertel 12153:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  12154:                     if ($sec eq '') {
                   12155:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   12156:                     } else {
                   12157:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12158:                     }
1.443     albertel 12159:                 } else {
1.628     raeburn  12160:                     if ($sec eq '') {
                   12161:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   12162:                     } else {
                   12163:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   12164:                     }
1.443     albertel 12165:                 }
                   12166:             } else {
1.628     raeburn  12167:                 if ($secchange) {       
                   12168:                     $$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;
                   12169:                 } else {
                   12170:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   12171:                 }
1.443     albertel 12172:             }
                   12173:             $result = $modify_section_result;
                   12174:         } elsif ($secchange == 1) {
1.628     raeburn  12175:             if ($oldsec eq '') {
                   12176:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   12177:             } else {
                   12178:                 $$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;
                   12179:             }
1.626     raeburn  12180:             if ($expire_role_result eq 'refused') {
                   12181:                 my $newsecurl = '/'.$cid;
                   12182:                 $newsecurl =~ s/\_/\//g;
                   12183:                 if ($sec ne '') {
                   12184:                     $newsecurl.='/'.$sec;
                   12185:                 }
                   12186:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   12187:                     if ($sec eq '') {
                   12188:                         $$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;
                   12189:                     } else {
                   12190:                         $$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;
                   12191:                     }
                   12192:                 }
                   12193:             }
1.443     albertel 12194:         }
                   12195:     } else {
1.626     raeburn  12196:         $$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 12197:         $result = "error: incomplete course id\n";
                   12198:     }
                   12199:     return $result;
                   12200: }
                   12201: 
                   12202: ############################################################
                   12203: ############################################################
                   12204: 
1.566     albertel 12205: sub check_clone {
1.578     raeburn  12206:     my ($args,$linefeed) = @_;
1.566     albertel 12207:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   12208:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   12209:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   12210:     my $clonemsg;
                   12211:     my $can_clone = 0;
1.944     raeburn  12212:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  12213:     if ($lctype ne 'community') {
                   12214:         $lctype = 'course';
                   12215:     }
1.566     albertel 12216:     if ($clonehome eq 'no_host') {
1.944     raeburn  12217:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12218:             $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'});
                   12219:         } else {
                   12220:             $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'});
                   12221:         }     
1.566     albertel 12222:     } else {
                   12223: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  12224:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12225:             if ($clonedesc{'type'} ne 'Community') {
                   12226:                  $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'});
                   12227:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12228:             }
                   12229:         }
1.882     raeburn  12230: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   12231:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 12232: 	    $can_clone = 1;
                   12233: 	} else {
                   12234: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   12235: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   12236: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  12237:             if (grep(/^\*$/,@cloners)) {
                   12238:                 $can_clone = 1;
                   12239:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   12240:                 $can_clone = 1;
                   12241:             } else {
1.908     raeburn  12242:                 my $ccrole = 'cc';
1.944     raeburn  12243:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12244:                     $ccrole = 'co';
                   12245:                 }
1.578     raeburn  12246: 	        my %roleshash =
                   12247: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   12248: 					 $args->{'ccdomain'},
1.908     raeburn  12249:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  12250: 					 [$args->{'clonedomain'}]);
1.908     raeburn  12251: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  12252:                     $can_clone = 1;
                   12253:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   12254:                     $can_clone = 1;
                   12255:                 } else {
1.944     raeburn  12256:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  12257:                         $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'});
                   12258:                     } else {
                   12259:                         $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'});
                   12260:                     }
1.578     raeburn  12261: 	        }
1.566     albertel 12262: 	    }
1.578     raeburn  12263:         }
1.566     albertel 12264:     }
                   12265:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12266: }
                   12267: 
1.444     albertel 12268: sub construct_course {
1.885     raeburn  12269:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 12270:     my $outcome;
1.541     raeburn  12271:     my $linefeed =  '<br />'."\n";
                   12272:     if ($context eq 'auto') {
                   12273:         $linefeed = "\n";
                   12274:     }
1.566     albertel 12275: 
                   12276: #
                   12277: # Are we cloning?
                   12278: #
                   12279:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   12280:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  12281: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 12282: 	if ($context ne 'auto') {
1.578     raeburn  12283:             if ($clonemsg ne '') {
                   12284: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   12285:             }
1.566     albertel 12286: 	}
                   12287: 	$outcome .= $clonemsg.$linefeed;
                   12288: 
                   12289:         if (!$can_clone) {
                   12290: 	    return (0,$outcome);
                   12291: 	}
                   12292:     }
                   12293: 
1.444     albertel 12294: #
                   12295: # Open course
                   12296: #
                   12297:     my $crstype = lc($args->{'crstype'});
                   12298:     my %cenv=();
                   12299:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   12300:                                              $args->{'cdescr'},
                   12301:                                              $args->{'curl'},
                   12302:                                              $args->{'course_home'},
                   12303:                                              $args->{'nonstandard'},
                   12304:                                              $args->{'crscode'},
                   12305:                                              $args->{'ccuname'}.':'.
                   12306:                                              $args->{'ccdomain'},
1.882     raeburn  12307:                                              $args->{'crstype'},
1.885     raeburn  12308:                                              $cnum,$context,$category);
1.444     albertel 12309: 
                   12310:     # Note: The testing routines depend on this being output; see 
                   12311:     # Utils::Course. This needs to at least be output as a comment
                   12312:     # if anyone ever decides to not show this, and Utils::Course::new
                   12313:     # will need to be suitably modified.
1.541     raeburn  12314:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  12315:     if ($$courseid =~ /^error:/) {
                   12316:         return (0,$outcome);
                   12317:     }
                   12318: 
1.444     albertel 12319: #
                   12320: # Check if created correctly
                   12321: #
1.479     albertel 12322:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 12323:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  12324:     if ($crsuhome eq 'no_host') {
                   12325:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   12326:         return (0,$outcome);
                   12327:     }
1.541     raeburn  12328:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 12329: 
1.444     albertel 12330: #
1.566     albertel 12331: # Do the cloning
                   12332: #   
                   12333:     if ($can_clone && $cloneid) {
                   12334: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   12335: 	if ($context ne 'auto') {
                   12336: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   12337: 	}
                   12338: 	$outcome .= $clonemsg.$linefeed;
                   12339: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 12340: # Copy all files
1.637     www      12341: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 12342: # Restore URL
1.566     albertel 12343: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 12344: # Restore title
1.566     albertel 12345: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  12346: # Restore creation date, creator and creation context.
                   12347:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   12348:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   12349:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 12350: # Mark as cloned
1.566     albertel 12351: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      12352: # Need to clone grading mode
                   12353:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   12354:         $cenv{'grading'}=$newenv{'grading'};
                   12355: # Do not clone these environment entries
                   12356:         &Apache::lonnet::del('environment',
                   12357:                   ['default_enrollment_start_date',
                   12358:                    'default_enrollment_end_date',
                   12359:                    'question.email',
                   12360:                    'policy.email',
                   12361:                    'comment.email',
                   12362:                    'pch.users.denied',
1.725     raeburn  12363:                    'plc.users.denied',
                   12364:                    'hidefromcat',
                   12365:                    'categories'],
1.638     www      12366:                    $$crsudom,$$crsunum);
1.444     albertel 12367:     }
1.566     albertel 12368: 
1.444     albertel 12369: #
                   12370: # Set environment (will override cloned, if existing)
                   12371: #
                   12372:     my @sections = ();
                   12373:     my @xlists = ();
                   12374:     if ($args->{'crstype'}) {
                   12375:         $cenv{'type'}=$args->{'crstype'};
                   12376:     }
                   12377:     if ($args->{'crsid'}) {
                   12378:         $cenv{'courseid'}=$args->{'crsid'};
                   12379:     }
                   12380:     if ($args->{'crscode'}) {
                   12381:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   12382:     }
                   12383:     if ($args->{'crsquota'} ne '') {
                   12384:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   12385:     } else {
                   12386:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   12387:     }
                   12388:     if ($args->{'ccuname'}) {
                   12389:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   12390:                                         ':'.$args->{'ccdomain'};
                   12391:     } else {
                   12392:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   12393:     }
                   12394:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   12395:     if ($args->{'crssections'}) {
                   12396:         $cenv{'internal.sectionnums'} = '';
                   12397:         if ($args->{'crssections'} =~ m/,/) {
                   12398:             @sections = split/,/,$args->{'crssections'};
                   12399:         } else {
                   12400:             $sections[0] = $args->{'crssections'};
                   12401:         }
                   12402:         if (@sections > 0) {
                   12403:             foreach my $item (@sections) {
                   12404:                 my ($sec,$gp) = split/:/,$item;
                   12405:                 my $class = $args->{'crscode'}.$sec;
                   12406:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   12407:                 $cenv{'internal.sectionnums'} .= $item.',';
                   12408:                 unless ($addcheck eq 'ok') {
                   12409:                     push @badclasses, $class;
                   12410:                 }
                   12411:             }
                   12412:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   12413:         }
                   12414:     }
                   12415: # do not hide course coordinator from staff listing, 
                   12416: # even if privileged
                   12417:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12418: # add crosslistings
                   12419:     if ($args->{'crsxlist'}) {
                   12420:         $cenv{'internal.crosslistings'}='';
                   12421:         if ($args->{'crsxlist'} =~ m/,/) {
                   12422:             @xlists = split/,/,$args->{'crsxlist'};
                   12423:         } else {
                   12424:             $xlists[0] = $args->{'crsxlist'};
                   12425:         }
                   12426:         if (@xlists > 0) {
                   12427:             foreach my $item (@xlists) {
                   12428:                 my ($xl,$gp) = split/:/,$item;
                   12429:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   12430:                 $cenv{'internal.crosslistings'} .= $item.',';
                   12431:                 unless ($addcheck eq 'ok') {
                   12432:                     push @badclasses, $xl;
                   12433:                 }
                   12434:             }
                   12435:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   12436:         }
                   12437:     }
                   12438:     if ($args->{'autoadds'}) {
                   12439:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   12440:     }
                   12441:     if ($args->{'autodrops'}) {
                   12442:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   12443:     }
                   12444: # check for notification of enrollment changes
                   12445:     my @notified = ();
                   12446:     if ($args->{'notify_owner'}) {
                   12447:         if ($args->{'ccuname'} ne '') {
                   12448:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   12449:         }
                   12450:     }
                   12451:     if ($args->{'notify_dc'}) {
                   12452:         if ($uname ne '') { 
1.630     raeburn  12453:             push(@notified,$uname.':'.$udom);
1.444     albertel 12454:         }
                   12455:     }
                   12456:     if (@notified > 0) {
                   12457:         my $notifylist;
                   12458:         if (@notified > 1) {
                   12459:             $notifylist = join(',',@notified);
                   12460:         } else {
                   12461:             $notifylist = $notified[0];
                   12462:         }
                   12463:         $cenv{'internal.notifylist'} = $notifylist;
                   12464:     }
                   12465:     if (@badclasses > 0) {
                   12466:         my %lt=&Apache::lonlocal::texthash(
                   12467:                 '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',
                   12468:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   12469:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   12470:         );
1.541     raeburn  12471:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   12472:                            ' ('.$lt{'adby'}.')';
                   12473:         if ($context eq 'auto') {
                   12474:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 12475:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  12476:             foreach my $item (@badclasses) {
                   12477:                 if ($context eq 'auto') {
                   12478:                     $outcome .= " - $item\n";
                   12479:                 } else {
                   12480:                     $outcome .= "<li>$item</li>\n";
                   12481:                 }
                   12482:             }
                   12483:             if ($context eq 'auto') {
                   12484:                 $outcome .= $linefeed;
                   12485:             } else {
1.566     albertel 12486:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  12487:             }
                   12488:         } 
1.444     albertel 12489:     }
                   12490:     if ($args->{'no_end_date'}) {
                   12491:         $args->{'endaccess'} = 0;
                   12492:     }
                   12493:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   12494:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   12495:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   12496:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   12497:     if ($args->{'showphotos'}) {
                   12498:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   12499:     }
                   12500:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   12501:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   12502:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   12503:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  12504:             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'); 
                   12505:             if ($context eq 'auto') {
                   12506:                 $outcome .= $krb_msg;
                   12507:             } else {
1.566     albertel 12508:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  12509:             }
                   12510:             $outcome .= $linefeed;
1.444     albertel 12511:         }
                   12512:     }
                   12513:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   12514:        if ($args->{'setpolicy'}) {
                   12515:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12516:        }
                   12517:        if ($args->{'setcontent'}) {
                   12518:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   12519:        }
                   12520:     }
                   12521:     if ($args->{'reshome'}) {
                   12522: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   12523: 	$cenv{'reshome'}=~s/\/+$/\//;
                   12524:     }
                   12525: #
                   12526: # course has keyed access
                   12527: #
                   12528:     if ($args->{'setkeys'}) {
                   12529:        $cenv{'keyaccess'}='yes';
                   12530:     }
                   12531: # if specified, key authority is not course, but user
                   12532: # only active if keyaccess is yes
                   12533:     if ($args->{'keyauth'}) {
1.487     albertel 12534: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   12535: 	$user = &LONCAPA::clean_username($user);
                   12536: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     12537: 	if ($user ne '' && $domain ne '') {
1.487     albertel 12538: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 12539: 	}
                   12540:     }
                   12541: 
                   12542:     if ($args->{'disresdis'}) {
                   12543:         $cenv{'pch.roles.denied'}='st';
                   12544:     }
                   12545:     if ($args->{'disablechat'}) {
                   12546:         $cenv{'plc.roles.denied'}='st';
                   12547:     }
                   12548: 
                   12549:     # Record we've not yet viewed the Course Initialization Helper for this 
                   12550:     # course
                   12551:     $cenv{'course.helper.not.run'} = 1;
                   12552:     #
                   12553:     # Use new Randomseed
                   12554:     #
                   12555:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   12556:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   12557:     #
                   12558:     # The encryption code and receipt prefix for this course
                   12559:     #
                   12560:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   12561:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   12562:     #
                   12563:     # By default, use standard grading
                   12564:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   12565: 
1.541     raeburn  12566:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   12567:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12568: #
                   12569: # Open all assignments
                   12570: #
                   12571:     if ($args->{'openall'}) {
                   12572:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   12573:        my %storecontent = ($storeunder         => time,
                   12574:                            $storeunder.'.type' => 'date_start');
                   12575:        
                   12576:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  12577:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 12578:    }
                   12579: #
                   12580: # Set first page
                   12581: #
                   12582:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   12583: 	    || ($cloneid)) {
1.445     albertel 12584: 	use LONCAPA::map;
1.444     albertel 12585: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 12586: 
                   12587: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   12588:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   12589: 
1.444     albertel 12590:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   12591:         my $title; my $url;
                   12592:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   12593: 	    $title=&mt('Syllabus');
1.444     albertel 12594:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   12595:         } else {
1.963     raeburn  12596:             $title=&mt('Table of Contents');
1.444     albertel 12597:             $url='/adm/navmaps';
                   12598:         }
1.445     albertel 12599: 
                   12600:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   12601: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   12602: 
                   12603: 	if ($errtext) { $fatal=2; }
1.541     raeburn  12604:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 12605:     }
1.566     albertel 12606: 
                   12607:     return (1,$outcome);
1.444     albertel 12608: }
                   12609: 
                   12610: ############################################################
                   12611: ############################################################
                   12612: 
1.953     droeschl 12613: #SD
                   12614: # only Community and Course, or anything else?
1.378     raeburn  12615: sub course_type {
                   12616:     my ($cid) = @_;
                   12617:     if (!defined($cid)) {
                   12618:         $cid = $env{'request.course.id'};
                   12619:     }
1.404     albertel 12620:     if (defined($env{'course.'.$cid.'.type'})) {
                   12621:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  12622:     } else {
                   12623:         return 'Course';
1.377     raeburn  12624:     }
                   12625: }
1.156     albertel 12626: 
1.406     raeburn  12627: sub group_term {
                   12628:     my $crstype = &course_type();
                   12629:     my %names = (
                   12630:                   'Course' => 'group',
1.865     raeburn  12631:                   'Community' => 'group',
1.406     raeburn  12632:                 );
                   12633:     return $names{$crstype};
                   12634: }
                   12635: 
1.902     raeburn  12636: sub course_types {
                   12637:     my @types = ('official','unofficial','community');
                   12638:     my %typename = (
                   12639:                          official   => 'Official course',
                   12640:                          unofficial => 'Unofficial course',
                   12641:                          community  => 'Community',
                   12642:                    );
                   12643:     return (\@types,\%typename);
                   12644: }
                   12645: 
1.156     albertel 12646: sub icon {
                   12647:     my ($file)=@_;
1.505     albertel 12648:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 12649:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 12650:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 12651:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   12652: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   12653: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12654: 	            $curfext.".gif") {
                   12655: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   12656: 		$curfext.".gif";
                   12657: 	}
                   12658:     }
1.249     albertel 12659:     return &lonhttpdurl($iconname);
1.154     albertel 12660: } 
1.84      albertel 12661: 
1.575     albertel 12662: sub lonhttpdurl {
1.692     www      12663: #
                   12664: # Had been used for "small fry" static images on separate port 8080.
                   12665: # Modify here if lightweight http functionality desired again.
                   12666: # Currently eliminated due to increasing firewall issues.
                   12667: #
1.575     albertel 12668:     my ($url)=@_;
1.692     www      12669:     return $url;
1.215     albertel 12670: }
                   12671: 
1.213     albertel 12672: sub connection_aborted {
                   12673:     my ($r)=@_;
                   12674:     $r->print(" ");$r->rflush();
                   12675:     my $c = $r->connection;
                   12676:     return $c->aborted();
                   12677: }
                   12678: 
1.221     foxr     12679: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     12680: #    strings as 'strings'.
                   12681: sub escape_single {
1.221     foxr     12682:     my ($input) = @_;
1.223     albertel 12683:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     12684:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   12685:     return $input;
                   12686: }
1.223     albertel 12687: 
1.222     foxr     12688: #  Same as escape_single, but escape's "'s  This 
                   12689: #  can be used for  "strings"
                   12690: sub escape_double {
                   12691:     my ($input) = @_;
                   12692:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   12693:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   12694:     return $input;
                   12695: }
1.223     albertel 12696:  
1.222     foxr     12697: #   Escapes the last element of a full URL.
                   12698: sub escape_url {
                   12699:     my ($url)   = @_;
1.238     raeburn  12700:     my @urlslices = split(/\//, $url,-1);
1.369     www      12701:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 12702:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     12703: }
1.462     albertel 12704: 
1.820     raeburn  12705: sub compare_arrays {
                   12706:     my ($arrayref1,$arrayref2) = @_;
                   12707:     my (@difference,%count);
                   12708:     @difference = ();
                   12709:     %count = ();
                   12710:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   12711:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   12712:         foreach my $element (keys(%count)) {
                   12713:             if ($count{$element} == 1) {
                   12714:                 push(@difference,$element);
                   12715:             }
                   12716:         }
                   12717:     }
                   12718:     return @difference;
                   12719: }
                   12720: 
1.817     bisitz   12721: # -------------------------------------------------------- Initialize user login
1.462     albertel 12722: sub init_user_environment {
1.463     albertel 12723:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 12724:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   12725: 
                   12726:     my $public=($username eq 'public' && $domain eq 'public');
                   12727: 
                   12728: # See if old ID present, if so, remove
                   12729: 
1.1062    raeburn  12730:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 12731:     my $now=time;
                   12732: 
                   12733:     if ($public) {
                   12734: 	my $max_public=100;
                   12735: 	my $oldest;
                   12736: 	my $oldest_time=0;
                   12737: 	for(my $next=1;$next<=$max_public;$next++) {
                   12738: 	    if (-e $lonids."/publicuser_$next.id") {
                   12739: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   12740: 		if ($mtime<$oldest_time || !$oldest_time) {
                   12741: 		    $oldest_time=$mtime;
                   12742: 		    $oldest=$next;
                   12743: 		}
                   12744: 	    } else {
                   12745: 		$cookie="publicuser_$next";
                   12746: 		last;
                   12747: 	    }
                   12748: 	}
                   12749: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   12750:     } else {
1.463     albertel 12751: 	# if this isn't a robot, kill any existing non-robot sessions
                   12752: 	if (!$args->{'robot'}) {
                   12753: 	    opendir(DIR,$lonids);
                   12754: 	    while ($filename=readdir(DIR)) {
                   12755: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   12756: 		    unlink($lonids.'/'.$filename);
                   12757: 		}
1.462     albertel 12758: 	    }
1.463     albertel 12759: 	    closedir(DIR);
1.462     albertel 12760: 	}
                   12761: # Give them a new cookie
1.463     albertel 12762: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      12763: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 12764: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 12765:     
                   12766: # Initialize roles
                   12767: 
1.1062    raeburn  12768: 	($userroles,$firstaccenv,$timerintenv) = 
                   12769:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 12770:     }
                   12771: # ------------------------------------ Check browser type and MathML capability
                   12772: 
                   12773:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   12774:         $clientunicode,$clientos) = &decode_user_agent($r);
                   12775: 
                   12776: # ------------------------------------------------------------- Get environment
                   12777: 
                   12778:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   12779:     my ($tmp) = keys(%userenv);
                   12780:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   12781:     } else {
                   12782: 	undef(%userenv);
                   12783:     }
                   12784:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   12785: 	$form->{'interface'}=$userenv{'interface'};
                   12786:     }
                   12787:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   12788: 
                   12789: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   12790:     foreach my $option ('interface','localpath','localres') {
                   12791:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 12792:     }
                   12793: # --------------------------------------------------------- Write first profile
                   12794: 
                   12795:     {
                   12796: 	my %initial_env = 
                   12797: 	    ("user.name"          => $username,
                   12798: 	     "user.domain"        => $domain,
                   12799: 	     "user.home"          => $authhost,
                   12800: 	     "browser.type"       => $clientbrowser,
                   12801: 	     "browser.version"    => $clientversion,
                   12802: 	     "browser.mathml"     => $clientmathml,
                   12803: 	     "browser.unicode"    => $clientunicode,
                   12804: 	     "browser.os"         => $clientos,
                   12805: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   12806: 	     "request.course.fn"  => '',
                   12807: 	     "request.course.uri" => '',
                   12808: 	     "request.course.sec" => '',
                   12809: 	     "request.role"       => 'cm',
                   12810: 	     "request.role.adv"   => $env{'user.adv'},
                   12811: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   12812: 
                   12813:         if ($form->{'localpath'}) {
                   12814: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   12815: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   12816:         }
                   12817: 	
                   12818: 	if ($form->{'interface'}) {
                   12819: 	    $form->{'interface'}=~s/\W//gs;
                   12820: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   12821: 	    $env{'browser.interface'}=$form->{'interface'};
                   12822: 	}
                   12823: 
1.981     raeburn  12824:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  12825:         my %domdef;
                   12826:         unless ($domain eq 'public') {
                   12827:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   12828:         }
1.980     raeburn  12829: 
1.724     raeburn  12830:         foreach my $tool ('aboutme','blog','portfolio') {
                   12831:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  12832:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   12833:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  12834:         }
                   12835: 
1.864     raeburn  12836:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  12837:             $userenv{'canrequest.'.$crstype} =
                   12838:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  12839:                                                   'reload','requestcourses',
                   12840:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  12841:         }
                   12842: 
1.462     albertel 12843: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  12844: 
1.462     albertel 12845: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   12846: 		 &GDBM_WRCREAT(),0640)) {
                   12847: 	    &_add_to_env(\%disk_env,\%initial_env);
                   12848: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   12849: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  12850:             if (ref($firstaccenv) eq 'HASH') {
                   12851:                 &_add_to_env(\%disk_env,$firstaccenv);
                   12852:             }
                   12853:             if (ref($timerintenv) eq 'HASH') {
                   12854:                 &_add_to_env(\%disk_env,$timerintenv);
                   12855:             }
1.463     albertel 12856: 	    if (ref($args->{'extra_env'})) {
                   12857: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   12858: 	    }
1.462     albertel 12859: 	    untie(%disk_env);
                   12860: 	} else {
1.705     tempelho 12861: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   12862: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 12863: 	    return 'error: '.$!;
                   12864: 	}
                   12865:     }
                   12866:     $env{'request.role'}='cm';
                   12867:     $env{'request.role.adv'}=$env{'user.adv'};
                   12868:     $env{'browser.type'}=$clientbrowser;
                   12869: 
                   12870:     return $cookie;
                   12871: 
                   12872: }
                   12873: 
                   12874: sub _add_to_env {
                   12875:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  12876:     if (ref($env_data) eq 'HASH') {
                   12877:         while (my ($key,$value) = each(%$env_data)) {
                   12878: 	    $idf->{$prefix.$key} = $value;
                   12879: 	    $env{$prefix.$key}   = $value;
                   12880:         }
1.462     albertel 12881:     }
                   12882: }
                   12883: 
1.685     tempelho 12884: # --- Get the symbolic name of a problem and the url
                   12885: sub get_symb {
                   12886:     my ($request,$silent) = @_;
1.726     raeburn  12887:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 12888:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   12889:     if ($symb eq '') {
                   12890:         if (!$silent) {
                   12891:             $request->print("Unable to handle ambiguous references:$url:.");
                   12892:             return ();
                   12893:         }
                   12894:     }
                   12895:     &Apache::lonenc::check_decrypt(\$symb);
                   12896:     return ($symb);
                   12897: }
                   12898: 
                   12899: # --------------------------------------------------------------Get annotation
                   12900: 
                   12901: sub get_annotation {
                   12902:     my ($symb,$enc) = @_;
                   12903: 
                   12904:     my $key = $symb;
                   12905:     if (!$enc) {
                   12906:         $key =
                   12907:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   12908:     }
                   12909:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   12910:     return $annotation{$key};
                   12911: }
                   12912: 
                   12913: sub clean_symb {
1.731     raeburn  12914:     my ($symb,$delete_enc) = @_;
1.685     tempelho 12915: 
                   12916:     &Apache::lonenc::check_decrypt(\$symb);
                   12917:     my $enc = $env{'request.enc'};
1.731     raeburn  12918:     if ($delete_enc) {
1.730     raeburn  12919:         delete($env{'request.enc'});
                   12920:     }
1.685     tempelho 12921: 
                   12922:     return ($symb,$enc);
                   12923: }
1.462     albertel 12924: 
1.990     raeburn  12925: sub build_release_hashes {
                   12926:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   12927:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   12928:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   12929:                   (ref($randomizetry) eq 'HASH'));
                   12930:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   12931:         my ($item,$name,$value) = split(/:/,$key);
                   12932:         if ($item eq 'parameter') {
                   12933:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   12934:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   12935:                     push(@{$checkparms->{$name}},$value);
                   12936:                 }
                   12937:             } else {
                   12938:                 push(@{$checkparms->{$name}},$value);
                   12939:             }
                   12940:         } elsif ($item eq 'resourcetag') {
                   12941:             if ($name eq 'responsetype') {
                   12942:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   12943:             }
                   12944:         } elsif ($item eq 'course') {
                   12945:             if ($name eq 'crstype') {
                   12946:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   12947:             }
                   12948:         }
                   12949:     }
                   12950:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   12951:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   12952:     return;
                   12953: }
                   12954: 
1.41      ng       12955: =pod
                   12956: 
                   12957: =back
                   12958: 
1.112     bowersj2 12959: =cut
1.41      ng       12960: 
1.112     bowersj2 12961: 1;
                   12962: __END__;
1.41      ng       12963: 

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