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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1075.2.9! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.8 2012/06/04 15:05:32 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.1072    raeburn  1377:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" />\\n<frame name="bodyframe" src="$details_link" />\\n$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 {
1.1074    raeburn  1984:     my ($context) = @_;
1.475     www      1985:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1986:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  1987:     my $phraseinput = 'hidden';
                   1988:     my $includeinput = 'hidden';
                   1989:     my ($checked,$includetypestext);
                   1990:     if ($env{'form.displayfilter'} eq 'containing') {
                   1991:         $phraseinput = 'text'; 
                   1992:         if ($context eq 'parmslog') {
                   1993:             $includeinput = 'checkbox';
                   1994:             if ($env{'form.includetypes'}) {
                   1995:                 $checked = ' checked="checked"';
                   1996:             }
                   1997:             $includetypestext = &mt('Include parameter types');
                   1998:         }
                   1999:     } else {
                   2000:         $includetypestext = '&nbsp;';
                   2001:     }
                   2002:     my ($additional,$secondid,$thirdid);
                   2003:     if ($context eq 'parmslog') {
                   2004:         $additional = 
                   2005:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2006:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2007:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2008:             '</label>';
                   2009:         $secondid = 'includetypes';
                   2010:         $thirdid = 'includetypestext';
                   2011:     }
                   2012:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2013:                                                     '$secondid','$thirdid')";
                   2014:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2015: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2016: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2017: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2018:            &mt('Filter: [_1]',
1.477     www      2019: 	   &select_form($env{'form.displayfilter'},
                   2020: 			'displayfilter',
1.970     raeburn  2021: 			{'currentfolder' => 'Current folder/page',
1.477     www      2022: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2023: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2024: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2025:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2026:                          '" />'.$additional;
                   2027: }
                   2028: 
                   2029: sub display_filter_js {
                   2030:     my $includetext = &mt('Include parameter types');
                   2031:     return <<"ENDJS";
                   2032:   
                   2033: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2034:     var firstType = 'hidden';
                   2035:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2036:         firstType = 'text';
                   2037:     }
                   2038:     firstObject = document.getElementById(firstid);
                   2039:     if (typeof(firstObject) == 'object') {
                   2040:         if (firstObject.type != firstType) {
                   2041:             changeInputType(firstObject,firstType);
                   2042:         }
                   2043:     }
                   2044:     if (context == 'parmslog') {
                   2045:         var secondType = 'hidden';
                   2046:         if (firstType == 'text') {
                   2047:             secondType = 'checkbox';
                   2048:         }
                   2049:         secondObject = document.getElementById(secondid);  
                   2050:         if (typeof(secondObject) == 'object') {
                   2051:             if (secondObject.type != secondType) {
                   2052:                 changeInputType(secondObject,secondType);
                   2053:             }
                   2054:         }
                   2055:         var textItem = document.getElementById(thirdid);
                   2056:         var currtext = textItem.innerHTML;
                   2057:         var newtext;
                   2058:         if (firstType == 'text') {
                   2059:             newtext = '$includetext';
                   2060:         } else {
                   2061:             newtext = '&nbsp;';
                   2062:         }
                   2063:         if (currtext != newtext) {
                   2064:             textItem.innerHTML = newtext;
                   2065:         }
                   2066:     }
                   2067:     return;
                   2068: }
                   2069: 
                   2070: function changeInputType(oldObject,newType) {
                   2071:     var newObject = document.createElement('input');
                   2072:     newObject.type = newType;
                   2073:     if (oldObject.size) {
                   2074:         newObject.size = oldObject.size;
                   2075:     }
                   2076:     if (oldObject.value) {
                   2077:         newObject.value = oldObject.value;
                   2078:     }
                   2079:     if (oldObject.name) {
                   2080:         newObject.name = oldObject.name;
                   2081:     }
                   2082:     if (oldObject.id) {
                   2083:         newObject.id = oldObject.id;
                   2084:     }
                   2085:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2086:     return;
                   2087: }
                   2088: 
                   2089: ENDJS
1.475     www      2090: }
                   2091: 
1.167     www      2092: sub gradeleveldescription {
                   2093:     my $gradelevel=shift;
                   2094:     my %gradelevels=(0 => 'Not specified',
                   2095: 		     1 => 'Grade 1',
                   2096: 		     2 => 'Grade 2',
                   2097: 		     3 => 'Grade 3',
                   2098: 		     4 => 'Grade 4',
                   2099: 		     5 => 'Grade 5',
                   2100: 		     6 => 'Grade 6',
                   2101: 		     7 => 'Grade 7',
                   2102: 		     8 => 'Grade 8',
                   2103: 		     9 => 'Grade 9',
                   2104: 		     10 => 'Grade 10',
                   2105: 		     11 => 'Grade 11',
                   2106: 		     12 => 'Grade 12',
                   2107: 		     13 => 'Grade 13',
                   2108: 		     14 => '100 Level',
                   2109: 		     15 => '200 Level',
                   2110: 		     16 => '300 Level',
                   2111: 		     17 => '400 Level',
                   2112: 		     18 => 'Graduate Level');
                   2113:     return &mt($gradelevels{$gradelevel});
                   2114: }
                   2115: 
1.163     www      2116: sub select_level_form {
                   2117:     my ($deflevel,$name)=@_;
                   2118:     unless ($deflevel) { $deflevel=0; }
1.167     www      2119:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2120:     for (my $i=0; $i<=18; $i++) {
                   2121:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2122:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2123:                 ">".&gradeleveldescription($i)."</option>\n";
                   2124:     }
                   2125:     $selectform.="</select>";
                   2126:     return $selectform;
1.163     www      2127: }
1.167     www      2128: 
1.35      matthew  2129: #-------------------------------------------
                   2130: 
1.45      matthew  2131: =pod
                   2132: 
1.910     raeburn  2133: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  2134: 
                   2135: Returns a string containing a <select name='$name' size='1'> form to 
                   2136: allow a user to select the domain to preform an operation in.  
                   2137: See loncreateuser.pm for an example invocation and use.
                   2138: 
1.90      www      2139: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2140: selected");
                   2141: 
1.743     raeburn  2142: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2143: 
1.910     raeburn  2144: 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.
                   2145: 
                   2146: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  2147: 
1.35      matthew  2148: =cut
                   2149: 
                   2150: #-------------------------------------------
1.34      matthew  2151: sub select_dom_form {
1.910     raeburn  2152:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  2153:     if ($onchange) {
1.874     raeburn  2154:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2155:     }
1.910     raeburn  2156:     my @domains;
                   2157:     if (ref($incdoms) eq 'ARRAY') {
                   2158:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2159:     } else {
                   2160:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2161:     }
1.90      www      2162:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  2163:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2164:     foreach my $dom (@domains) {
                   2165:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2166:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2167:         if ($showdomdesc) {
                   2168:             if ($dom ne '') {
                   2169:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2170:                 if ($domdesc ne '') {
                   2171:                     $selectdomain .= ' ('.$domdesc.')';
                   2172:                 }
                   2173:             } 
                   2174:         }
                   2175:         $selectdomain .= "</option>\n";
1.34      matthew  2176:     }
                   2177:     $selectdomain.="</select>";
                   2178:     return $selectdomain;
                   2179: }
                   2180: 
1.35      matthew  2181: #-------------------------------------------
                   2182: 
1.45      matthew  2183: =pod
                   2184: 
1.648     raeburn  2185: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2186: 
1.586     raeburn  2187: input: 4 arguments (two required, two optional) - 
                   2188:     $domain - domain of new user
                   2189:     $name - name of form element
                   2190:     $default - Value of 'default' causes a default item to be first 
                   2191:                             option, and selected by default. 
                   2192:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2193:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2194: output: returns 2 items: 
1.586     raeburn  2195: (a) form element which contains either:
                   2196:    (i) <select name="$name">
                   2197:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2198:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2199:        </select>
                   2200:        form item if there are multiple library servers in $domain, or
                   2201:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2202:        if there is only one library server in $domain.
                   2203: 
                   2204: (b) number of library servers found.
                   2205: 
                   2206: See loncreateuser.pm for example of use.
1.35      matthew  2207: 
                   2208: =cut
                   2209: 
                   2210: #-------------------------------------------
1.586     raeburn  2211: sub home_server_form_item {
                   2212:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2213:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2214:     my $result;
                   2215:     my $numlib = keys(%servers);
                   2216:     if ($numlib > 1) {
                   2217:         $result .= '<select name="'.$name.'" />'."\n";
                   2218:         if ($default) {
1.804     bisitz   2219:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2220:                        '</option>'."\n";
                   2221:         }
                   2222:         foreach my $hostid (sort(keys(%servers))) {
                   2223:             $result.= '<option value="'.$hostid.'">'.
                   2224: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2225:         }
                   2226:         $result .= '</select>'."\n";
                   2227:     } elsif ($numlib == 1) {
                   2228:         my $hostid;
                   2229:         foreach my $item (keys(%servers)) {
                   2230:             $hostid = $item;
                   2231:         }
                   2232:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2233:                    $hostid.'" />';
                   2234:                    if (!$hide) {
                   2235:                        $result .= $hostid.' '.$servers{$hostid};
                   2236:                    }
                   2237:                    $result .= "\n";
                   2238:     } elsif ($default) {
                   2239:         $result .= '<input type="hidden" name="'.$name.
                   2240:                    '" value="default" />';
                   2241:                    if (!$hide) {
                   2242:                        $result .= &mt('default');
                   2243:                    }
                   2244:                    $result .= "\n";
1.33      matthew  2245:     }
1.586     raeburn  2246:     return ($result,$numlib);
1.33      matthew  2247: }
1.112     bowersj2 2248: 
                   2249: =pod
                   2250: 
1.534     albertel 2251: =back 
                   2252: 
1.112     bowersj2 2253: =cut
1.87      matthew  2254: 
                   2255: ###############################################################
1.112     bowersj2 2256: ##                  Decoding User Agent                      ##
1.87      matthew  2257: ###############################################################
                   2258: 
                   2259: =pod
                   2260: 
1.112     bowersj2 2261: =head1 Decoding the User Agent
                   2262: 
                   2263: =over 4
                   2264: 
                   2265: =item * &decode_user_agent()
1.87      matthew  2266: 
                   2267: Inputs: $r
                   2268: 
                   2269: Outputs:
                   2270: 
                   2271: =over 4
                   2272: 
1.112     bowersj2 2273: =item * $httpbrowser
1.87      matthew  2274: 
1.112     bowersj2 2275: =item * $clientbrowser
1.87      matthew  2276: 
1.112     bowersj2 2277: =item * $clientversion
1.87      matthew  2278: 
1.112     bowersj2 2279: =item * $clientmathml
1.87      matthew  2280: 
1.112     bowersj2 2281: =item * $clientunicode
1.87      matthew  2282: 
1.112     bowersj2 2283: =item * $clientos
1.87      matthew  2284: 
                   2285: =back
                   2286: 
1.157     matthew  2287: =back 
                   2288: 
1.87      matthew  2289: =cut
                   2290: 
                   2291: ###############################################################
                   2292: ###############################################################
                   2293: sub decode_user_agent {
1.247     albertel 2294:     my ($r)=@_;
1.87      matthew  2295:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2296:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2297:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2298:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2299:     my $clientbrowser='unknown';
                   2300:     my $clientversion='0';
                   2301:     my $clientmathml='';
                   2302:     my $clientunicode='0';
                   2303:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2304:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2305: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2306: 	    $clientbrowser=$bname;
                   2307:             $httpbrowser=~/$vreg/i;
                   2308: 	    $clientversion=$1;
                   2309:             $clientmathml=($clientversion>=$minv);
                   2310:             $clientunicode=($clientversion>=$univ);
                   2311: 	}
                   2312:     }
                   2313:     my $clientos='unknown';
                   2314:     if (($httpbrowser=~/linux/i) ||
                   2315:         ($httpbrowser=~/unix/i) ||
                   2316:         ($httpbrowser=~/ux/i) ||
                   2317:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2318:     if (($httpbrowser=~/vax/i) ||
                   2319:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2320:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2321:     if (($httpbrowser=~/mac/i) ||
                   2322:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2323:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2324:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2325:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2326:             $clientunicode,$clientos,);
                   2327: }
                   2328: 
1.32      matthew  2329: ###############################################################
                   2330: ##    Authentication changing form generation subroutines    ##
                   2331: ###############################################################
                   2332: ##
                   2333: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2334: ## hash, and have reasonable default values.
                   2335: ##
                   2336: ##    formname = the name given in the <form> tag.
1.35      matthew  2337: #-------------------------------------------
                   2338: 
1.45      matthew  2339: =pod
                   2340: 
1.112     bowersj2 2341: =head1 Authentication Routines
                   2342: 
                   2343: =over 4
                   2344: 
1.648     raeburn  2345: =item * &authform_xxxxxx()
1.35      matthew  2346: 
                   2347: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2348: handle some of the conveniences required for authentication forms.  
                   2349: This is not an optimal method, but it works.  
                   2350: 
                   2351: =over 4
                   2352: 
1.112     bowersj2 2353: =item * authform_header
1.35      matthew  2354: 
1.112     bowersj2 2355: =item * authform_authorwarning
1.35      matthew  2356: 
1.112     bowersj2 2357: =item * authform_nochange
1.35      matthew  2358: 
1.112     bowersj2 2359: =item * authform_kerberos
1.35      matthew  2360: 
1.112     bowersj2 2361: =item * authform_internal
1.35      matthew  2362: 
1.112     bowersj2 2363: =item * authform_filesystem
1.35      matthew  2364: 
                   2365: =back
                   2366: 
1.648     raeburn  2367: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2368: 
1.35      matthew  2369: =cut
                   2370: 
                   2371: #-------------------------------------------
1.32      matthew  2372: sub authform_header{  
                   2373:     my %in = (
                   2374:         formname => 'cu',
1.80      albertel 2375:         kerb_def_dom => '',
1.32      matthew  2376:         @_,
                   2377:     );
                   2378:     $in{'formname'} = 'document.' . $in{'formname'};
                   2379:     my $result='';
1.80      albertel 2380: 
                   2381: #---------------------------------------------- Code for upper case translation
                   2382:     my $Javascript_toUpperCase;
                   2383:     unless ($in{kerb_def_dom}) {
                   2384:         $Javascript_toUpperCase =<<"END";
                   2385:         switch (choice) {
                   2386:            case 'krb': currentform.elements[choicearg].value =
                   2387:                currentform.elements[choicearg].value.toUpperCase();
                   2388:                break;
                   2389:            default:
                   2390:         }
                   2391: END
                   2392:     } else {
                   2393:         $Javascript_toUpperCase = "";
                   2394:     }
                   2395: 
1.165     raeburn  2396:     my $radioval = "'nochange'";
1.591     raeburn  2397:     if (defined($in{'curr_authtype'})) {
                   2398:         if ($in{'curr_authtype'} ne '') {
                   2399:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2400:         }
1.174     matthew  2401:     }
1.165     raeburn  2402:     my $argfield = 'null';
1.591     raeburn  2403:     if (defined($in{'mode'})) {
1.165     raeburn  2404:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2405:             if (defined($in{'curr_autharg'})) {
                   2406:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2407:                     $argfield = "'$in{'curr_autharg'}'";
                   2408:                 }
                   2409:             }
                   2410:         }
                   2411:     }
                   2412: 
1.32      matthew  2413:     $result.=<<"END";
                   2414: var current = new Object();
1.165     raeburn  2415: current.radiovalue = $radioval;
                   2416: current.argfield = $argfield;
1.32      matthew  2417: 
                   2418: function changed_radio(choice,currentform) {
                   2419:     var choicearg = choice + 'arg';
                   2420:     // If a radio button in changed, we need to change the argfield
                   2421:     if (current.radiovalue != choice) {
                   2422:         current.radiovalue = choice;
                   2423:         if (current.argfield != null) {
                   2424:             currentform.elements[current.argfield].value = '';
                   2425:         }
                   2426:         if (choice == 'nochange') {
                   2427:             current.argfield = null;
                   2428:         } else {
                   2429:             current.argfield = choicearg;
                   2430:             switch(choice) {
                   2431:                 case 'krb': 
                   2432:                     currentform.elements[current.argfield].value = 
                   2433:                         "$in{'kerb_def_dom'}";
                   2434:                 break;
                   2435:               default:
                   2436:                 break;
                   2437:             }
                   2438:         }
                   2439:     }
                   2440:     return;
                   2441: }
1.22      www      2442: 
1.32      matthew  2443: function changed_text(choice,currentform) {
                   2444:     var choicearg = choice + 'arg';
                   2445:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2446:         $Javascript_toUpperCase
1.32      matthew  2447:         // clear old field
                   2448:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2449:             currentform.elements[current.argfield].value = '';
                   2450:         }
                   2451:         current.argfield = choicearg;
                   2452:     }
                   2453:     set_auth_radio_buttons(choice,currentform);
                   2454:     return;
1.20      www      2455: }
1.32      matthew  2456: 
                   2457: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2458:     var numauthchoices = currentform.login.length;
                   2459:     if (typeof numauthchoices  == "undefined") {
                   2460:         return;
                   2461:     } 
1.32      matthew  2462:     var i=0;
1.986     raeburn  2463:     while (i < numauthchoices) {
1.32      matthew  2464:         if (currentform.login[i].value == newvalue) { break; }
                   2465:         i++;
                   2466:     }
1.986     raeburn  2467:     if (i == numauthchoices) {
1.32      matthew  2468:         return;
                   2469:     }
                   2470:     current.radiovalue = newvalue;
                   2471:     currentform.login[i].checked = true;
                   2472:     return;
                   2473: }
                   2474: END
                   2475:     return $result;
                   2476: }
                   2477: 
                   2478: sub authform_authorwarning{
                   2479:     my $result='';
1.144     matthew  2480:     $result='<i>'.
                   2481:         &mt('As a general rule, only authors or co-authors should be '.
                   2482:             'filesystem authenticated '.
                   2483:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2484:     return $result;
                   2485: }
                   2486: 
                   2487: sub authform_nochange{  
                   2488:     my %in = (
                   2489:               formname => 'document.cu',
                   2490:               kerb_def_dom => 'MSU.EDU',
                   2491:               @_,
                   2492:           );
1.586     raeburn  2493:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2494:     my $result;
                   2495:     if (keys(%can_assign) == 0) {
                   2496:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2497:     } else {
                   2498:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2499:                   '<input type="radio" name="login" value="nochange" '.
                   2500:                   'checked="checked" onclick="'.
1.281     albertel 2501:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2502: 	    '</label>';
1.586     raeburn  2503:     }
1.32      matthew  2504:     return $result;
                   2505: }
                   2506: 
1.591     raeburn  2507: sub authform_kerberos {
1.32      matthew  2508:     my %in = (
                   2509:               formname => 'document.cu',
                   2510:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2511:               kerb_def_auth => 'krb4',
1.32      matthew  2512:               @_,
                   2513:               );
1.586     raeburn  2514:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2515:         $autharg,$jscall);
                   2516:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2517:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2518:        $check5 = ' checked="checked"';
1.80      albertel 2519:     } else {
1.772     bisitz   2520:        $check4 = ' checked="checked"';
1.80      albertel 2521:     }
1.165     raeburn  2522:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2523:     if (defined($in{'curr_authtype'})) {
                   2524:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2525:             $krbcheck = ' checked="checked"';
1.623     raeburn  2526:             if (defined($in{'mode'})) {
                   2527:                 if ($in{'mode'} eq 'modifyuser') {
                   2528:                     $krbcheck = '';
                   2529:                 }
                   2530:             }
1.591     raeburn  2531:             if (defined($in{'curr_kerb_ver'})) {
                   2532:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2533:                     $check5 = ' checked="checked"';
1.591     raeburn  2534:                     $check4 = '';
                   2535:                 } else {
1.772     bisitz   2536:                     $check4 = ' checked="checked"';
1.591     raeburn  2537:                     $check5 = '';
                   2538:                 }
1.586     raeburn  2539:             }
1.591     raeburn  2540:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2541:                 $krbarg = $in{'curr_autharg'};
                   2542:             }
1.586     raeburn  2543:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2544:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2545:                     $result = 
                   2546:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2547:         $in{'curr_autharg'},$krbver);
                   2548:                 } else {
                   2549:                     $result =
                   2550:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2551:                 }
                   2552:                 return $result; 
                   2553:             }
                   2554:         }
                   2555:     } else {
                   2556:         if ($authnum == 1) {
1.784     bisitz   2557:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2558:         }
                   2559:     }
1.586     raeburn  2560:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2561:         return;
1.587     raeburn  2562:     } elsif ($authtype eq '') {
1.591     raeburn  2563:         if (defined($in{'mode'})) {
1.587     raeburn  2564:             if ($in{'mode'} eq 'modifycourse') {
                   2565:                 if ($authnum == 1) {
1.784     bisitz   2566:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2567:                 }
                   2568:             }
                   2569:         }
1.586     raeburn  2570:     }
                   2571:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2572:     if ($authtype eq '') {
                   2573:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2574:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2575:                     $krbcheck.' />';
                   2576:     }
                   2577:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2578:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2579:          $in{'curr_authtype'} eq 'krb5') ||
                   2580:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2581:          $in{'curr_authtype'} eq 'krb4')) {
                   2582:         $result .= &mt
1.144     matthew  2583:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2584:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2585:          '<label>'.$authtype,
1.281     albertel 2586:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2587:              'value="'.$krbarg.'" '.
1.144     matthew  2588:              'onchange="'.$jscall.'" />',
1.281     albertel 2589:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2590:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2591: 	 '</label>');
1.586     raeburn  2592:     } elsif ($can_assign{'krb4'}) {
                   2593:         $result .= &mt
                   2594:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2595:          '[_3] Version 4 [_4]',
                   2596:          '<label>'.$authtype,
                   2597:          '</label><input type="text" size="10" name="krbarg" '.
                   2598:              'value="'.$krbarg.'" '.
                   2599:              'onchange="'.$jscall.'" />',
                   2600:          '<label><input type="hidden" name="krbver" value="4" />',
                   2601:          '</label>');
                   2602:     } elsif ($can_assign{'krb5'}) {
                   2603:         $result .= &mt
                   2604:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2605:          '[_3] Version 5 [_4]',
                   2606:          '<label>'.$authtype,
                   2607:          '</label><input type="text" size="10" name="krbarg" '.
                   2608:              'value="'.$krbarg.'" '.
                   2609:              'onchange="'.$jscall.'" />',
                   2610:          '<label><input type="hidden" name="krbver" value="5" />',
                   2611:          '</label>');
                   2612:     }
1.32      matthew  2613:     return $result;
                   2614: }
                   2615: 
                   2616: sub authform_internal{  
1.586     raeburn  2617:     my %in = (
1.32      matthew  2618:                 formname => 'document.cu',
                   2619:                 kerb_def_dom => 'MSU.EDU',
                   2620:                 @_,
                   2621:                 );
1.586     raeburn  2622:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2623:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2624:     if (defined($in{'curr_authtype'})) {
                   2625:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2626:             if ($can_assign{'int'}) {
1.772     bisitz   2627:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2628:                 if (defined($in{'mode'})) {
                   2629:                     if ($in{'mode'} eq 'modifyuser') {
                   2630:                         $intcheck = '';
                   2631:                     }
                   2632:                 }
1.591     raeburn  2633:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2634:                     $intarg = $in{'curr_autharg'};
                   2635:                 }
                   2636:             } else {
                   2637:                 $result = &mt('Currently internally authenticated.');
                   2638:                 return $result;
1.165     raeburn  2639:             }
                   2640:         }
1.586     raeburn  2641:     } else {
                   2642:         if ($authnum == 1) {
1.784     bisitz   2643:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2644:         }
                   2645:     }
                   2646:     if (!$can_assign{'int'}) {
                   2647:         return;
1.587     raeburn  2648:     } elsif ($authtype eq '') {
1.591     raeburn  2649:         if (defined($in{'mode'})) {
1.587     raeburn  2650:             if ($in{'mode'} eq 'modifycourse') {
                   2651:                 if ($authnum == 1) {
1.784     bisitz   2652:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2653:                 }
                   2654:             }
                   2655:         }
1.165     raeburn  2656:     }
1.586     raeburn  2657:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2658:     if ($authtype eq '') {
                   2659:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2660:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2661:     }
1.605     bisitz   2662:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2663:                $intarg.'" onchange="'.$jscall.'" />';
                   2664:     $result = &mt
1.144     matthew  2665:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2666:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2667:     $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  2668:     return $result;
                   2669: }
                   2670: 
                   2671: sub authform_local{  
                   2672:     my %in = (
                   2673:               formname => 'document.cu',
                   2674:               kerb_def_dom => 'MSU.EDU',
                   2675:               @_,
                   2676:               );
1.586     raeburn  2677:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2678:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2679:     if (defined($in{'curr_authtype'})) {
                   2680:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2681:             if ($can_assign{'loc'}) {
1.772     bisitz   2682:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2683:                 if (defined($in{'mode'})) {
                   2684:                     if ($in{'mode'} eq 'modifyuser') {
                   2685:                         $loccheck = '';
                   2686:                     }
                   2687:                 }
1.591     raeburn  2688:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2689:                     $locarg = $in{'curr_autharg'};
                   2690:                 }
                   2691:             } else {
                   2692:                 $result = &mt('Currently using local (institutional) authentication.');
                   2693:                 return $result;
1.165     raeburn  2694:             }
                   2695:         }
1.586     raeburn  2696:     } else {
                   2697:         if ($authnum == 1) {
1.784     bisitz   2698:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2699:         }
                   2700:     }
                   2701:     if (!$can_assign{'loc'}) {
                   2702:         return;
1.587     raeburn  2703:     } elsif ($authtype eq '') {
1.591     raeburn  2704:         if (defined($in{'mode'})) {
1.587     raeburn  2705:             if ($in{'mode'} eq 'modifycourse') {
                   2706:                 if ($authnum == 1) {
1.784     bisitz   2707:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2708:                 }
                   2709:             }
                   2710:         }
1.165     raeburn  2711:     }
1.586     raeburn  2712:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2713:     if ($authtype eq '') {
                   2714:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2715:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2716:                     $jscall.'" />';
                   2717:     }
                   2718:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2719:                $locarg.'" onchange="'.$jscall.'" />';
                   2720:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2721:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2722:     return $result;
                   2723: }
                   2724: 
                   2725: sub authform_filesystem{  
                   2726:     my %in = (
                   2727:               formname => 'document.cu',
                   2728:               kerb_def_dom => 'MSU.EDU',
                   2729:               @_,
                   2730:               );
1.586     raeburn  2731:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2732:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2733:     if (defined($in{'curr_authtype'})) {
                   2734:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2735:             if ($can_assign{'fsys'}) {
1.772     bisitz   2736:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2737:                 if (defined($in{'mode'})) {
                   2738:                     if ($in{'mode'} eq 'modifyuser') {
                   2739:                         $fsyscheck = '';
                   2740:                     }
                   2741:                 }
1.586     raeburn  2742:             } else {
                   2743:                 $result = &mt('Currently Filesystem Authenticated.');
                   2744:                 return $result;
                   2745:             }           
                   2746:         }
                   2747:     } else {
                   2748:         if ($authnum == 1) {
1.784     bisitz   2749:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2750:         }
                   2751:     }
                   2752:     if (!$can_assign{'fsys'}) {
                   2753:         return;
1.587     raeburn  2754:     } elsif ($authtype eq '') {
1.591     raeburn  2755:         if (defined($in{'mode'})) {
1.587     raeburn  2756:             if ($in{'mode'} eq 'modifycourse') {
                   2757:                 if ($authnum == 1) {
1.784     bisitz   2758:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2759:                 }
                   2760:             }
                   2761:         }
1.586     raeburn  2762:     }
                   2763:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2764:     if ($authtype eq '') {
                   2765:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2766:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2767:                     $jscall.'" />';
                   2768:     }
                   2769:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2770:                ' onchange="'.$jscall.'" />';
                   2771:     $result = &mt
1.144     matthew  2772:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2773:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2774:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2775:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2776:                   'onchange="'.$jscall.'" />');
1.32      matthew  2777:     return $result;
                   2778: }
                   2779: 
1.586     raeburn  2780: sub get_assignable_auth {
                   2781:     my ($dom) = @_;
                   2782:     if ($dom eq '') {
                   2783:         $dom = $env{'request.role.domain'};
                   2784:     }
                   2785:     my %can_assign = (
                   2786:                           krb4 => 1,
                   2787:                           krb5 => 1,
                   2788:                           int  => 1,
                   2789:                           loc  => 1,
                   2790:                      );
                   2791:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2792:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2793:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2794:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2795:             my $context;
                   2796:             if ($env{'request.role'} =~ /^au/) {
                   2797:                 $context = 'author';
                   2798:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2799:                 $context = 'domain';
                   2800:             } elsif ($env{'request.course.id'}) {
                   2801:                 $context = 'course';
                   2802:             }
                   2803:             if ($context) {
                   2804:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2805:                    %can_assign = %{$authhash->{$context}}; 
                   2806:                 }
                   2807:             }
                   2808:         }
                   2809:     }
                   2810:     my $authnum = 0;
                   2811:     foreach my $key (keys(%can_assign)) {
                   2812:         if ($can_assign{$key}) {
                   2813:             $authnum ++;
                   2814:         }
                   2815:     }
                   2816:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2817:         $authnum --;
                   2818:     }
                   2819:     return ($authnum,%can_assign);
                   2820: }
                   2821: 
1.80      albertel 2822: ###############################################################
                   2823: ##    Get Kerberos Defaults for Domain                 ##
                   2824: ###############################################################
                   2825: ##
                   2826: ## Returns default kerberos version and an associated argument
                   2827: ## as listed in file domain.tab. If not listed, provides
                   2828: ## appropriate default domain and kerberos version.
                   2829: ##
                   2830: #-------------------------------------------
                   2831: 
                   2832: =pod
                   2833: 
1.648     raeburn  2834: =item * &get_kerberos_defaults()
1.80      albertel 2835: 
                   2836: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2837: version and domain. If not found, it defaults to version 4 and the 
                   2838: domain of the server.
1.80      albertel 2839: 
1.648     raeburn  2840: =over 4
                   2841: 
1.80      albertel 2842: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2843: 
1.648     raeburn  2844: =back
                   2845: 
                   2846: =back
                   2847: 
1.80      albertel 2848: =cut
                   2849: 
                   2850: #-------------------------------------------
                   2851: sub get_kerberos_defaults {
                   2852:     my $domain=shift;
1.641     raeburn  2853:     my ($krbdef,$krbdefdom);
                   2854:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2855:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2856:         $krbdef = $domdefaults{'auth_def'};
                   2857:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2858:     } else {
1.80      albertel 2859:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2860:         my $krbdefdom=$1;
                   2861:         $krbdefdom=~tr/a-z/A-Z/;
                   2862:         $krbdef = "krb4";
                   2863:     }
                   2864:     return ($krbdef,$krbdefdom);
                   2865: }
1.112     bowersj2 2866: 
1.32      matthew  2867: 
1.46      matthew  2868: ###############################################################
                   2869: ##                Thesaurus Functions                        ##
                   2870: ###############################################################
1.20      www      2871: 
1.46      matthew  2872: =pod
1.20      www      2873: 
1.112     bowersj2 2874: =head1 Thesaurus Functions
                   2875: 
                   2876: =over 4
                   2877: 
1.648     raeburn  2878: =item * &initialize_keywords()
1.46      matthew  2879: 
                   2880: Initializes the package variable %Keywords if it is empty.  Uses the
                   2881: package variable $thesaurus_db_file.
                   2882: 
                   2883: =cut
                   2884: 
                   2885: ###################################################
                   2886: 
                   2887: sub initialize_keywords {
                   2888:     return 1 if (scalar keys(%Keywords));
                   2889:     # If we are here, %Keywords is empty, so fill it up
                   2890:     #   Make sure the file we need exists...
                   2891:     if (! -e $thesaurus_db_file) {
                   2892:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2893:                                  " failed because it does not exist");
                   2894:         return 0;
                   2895:     }
                   2896:     #   Set up the hash as a database
                   2897:     my %thesaurus_db;
                   2898:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2899:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2900:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2901:                                  $thesaurus_db_file);
                   2902:         return 0;
                   2903:     } 
                   2904:     #  Get the average number of appearances of a word.
                   2905:     my $avecount = $thesaurus_db{'average.count'};
                   2906:     #  Put keywords (those that appear > average) into %Keywords
                   2907:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2908:         my ($count,undef) = split /:/,$data;
                   2909:         $Keywords{$word}++ if ($count > $avecount);
                   2910:     }
                   2911:     untie %thesaurus_db;
                   2912:     # Remove special values from %Keywords.
1.356     albertel 2913:     foreach my $value ('total.count','average.count') {
                   2914:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2915:   }
1.46      matthew  2916:     return 1;
                   2917: }
                   2918: 
                   2919: ###################################################
                   2920: 
                   2921: =pod
                   2922: 
1.648     raeburn  2923: =item * &keyword($word)
1.46      matthew  2924: 
                   2925: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2926: than the average number of times in the thesaurus database.  Calls 
                   2927: &initialize_keywords
                   2928: 
                   2929: =cut
                   2930: 
                   2931: ###################################################
1.20      www      2932: 
                   2933: sub keyword {
1.46      matthew  2934:     return if (!&initialize_keywords());
                   2935:     my $word=lc(shift());
                   2936:     $word=~s/\W//g;
                   2937:     return exists($Keywords{$word});
1.20      www      2938: }
1.46      matthew  2939: 
                   2940: ###############################################################
                   2941: 
                   2942: =pod 
1.20      www      2943: 
1.648     raeburn  2944: =item * &get_related_words()
1.46      matthew  2945: 
1.160     matthew  2946: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2947: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2948: will be returned.  The order of the words returned is determined by the
                   2949: database which holds them.
                   2950: 
                   2951: Uses global $thesaurus_db_file.
                   2952: 
1.1057    foxr     2953: 
1.46      matthew  2954: =cut
                   2955: 
                   2956: ###############################################################
                   2957: sub get_related_words {
                   2958:     my $keyword = shift;
                   2959:     my %thesaurus_db;
                   2960:     if (! -e $thesaurus_db_file) {
                   2961:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2962:                                  "failed because the file does not exist");
                   2963:         return ();
                   2964:     }
                   2965:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2966:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2967:         return ();
                   2968:     } 
                   2969:     my @Words=();
1.429     www      2970:     my $count=0;
1.46      matthew  2971:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2972: 	# The first element is the number of times
                   2973: 	# the word appears.  We do not need it now.
1.429     www      2974: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2975: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2976: 	my $threshold=$mostfrequentcount/10;
                   2977:         foreach my $possibleword (@RelatedWords) {
                   2978:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2979:             if ($wordcount>$threshold) {
                   2980: 		push(@Words,$word);
                   2981:                 $count++;
                   2982:                 if ($count>10) { last; }
                   2983: 	    }
1.20      www      2984:         }
                   2985:     }
1.46      matthew  2986:     untie %thesaurus_db;
                   2987:     return @Words;
1.14      harris41 2988: }
1.46      matthew  2989: 
1.112     bowersj2 2990: =pod
                   2991: 
                   2992: =back
                   2993: 
                   2994: =cut
1.61      www      2995: 
                   2996: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2997: =pod
                   2998: 
1.112     bowersj2 2999: =head1 User Name Functions
                   3000: 
                   3001: =over 4
                   3002: 
1.648     raeburn  3003: =item * &plainname($uname,$udom,$first)
1.81      albertel 3004: 
1.112     bowersj2 3005: Takes a users logon name and returns it as a string in
1.226     albertel 3006: "first middle last generation" form 
                   3007: if $first is set to 'lastname' then it returns it as
                   3008: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3009: 
                   3010: =cut
1.61      www      3011: 
1.295     www      3012: 
1.81      albertel 3013: ###############################################################
1.61      www      3014: sub plainname {
1.226     albertel 3015:     my ($uname,$udom,$first)=@_;
1.537     albertel 3016:     return if (!defined($uname) || !defined($udom));
1.295     www      3017:     my %names=&getnames($uname,$udom);
1.226     albertel 3018:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3019: 					  $names{'middlename'},
                   3020: 					  $names{'lastname'},
                   3021: 					  $names{'generation'},$first);
                   3022:     $name=~s/^\s+//;
1.62      www      3023:     $name=~s/\s+$//;
                   3024:     $name=~s/\s+/ /g;
1.353     albertel 3025:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3026:     return $name;
1.61      www      3027: }
1.66      www      3028: 
                   3029: # -------------------------------------------------------------------- Nickname
1.81      albertel 3030: =pod
                   3031: 
1.648     raeburn  3032: =item * &nickname($uname,$udom)
1.81      albertel 3033: 
                   3034: Gets a users name and returns it as a string as
                   3035: 
                   3036: "&quot;nickname&quot;"
1.66      www      3037: 
1.81      albertel 3038: if the user has a nickname or
                   3039: 
                   3040: "first middle last generation"
                   3041: 
                   3042: if the user does not
                   3043: 
                   3044: =cut
1.66      www      3045: 
                   3046: sub nickname {
                   3047:     my ($uname,$udom)=@_;
1.537     albertel 3048:     return if (!defined($uname) || !defined($udom));
1.295     www      3049:     my %names=&getnames($uname,$udom);
1.68      albertel 3050:     my $name=$names{'nickname'};
1.66      www      3051:     if ($name) {
                   3052:        $name='&quot;'.$name.'&quot;'; 
                   3053:     } else {
                   3054:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3055: 	     $names{'lastname'}.' '.$names{'generation'};
                   3056:        $name=~s/\s+$//;
                   3057:        $name=~s/\s+/ /g;
                   3058:     }
                   3059:     return $name;
                   3060: }
                   3061: 
1.295     www      3062: sub getnames {
                   3063:     my ($uname,$udom)=@_;
1.537     albertel 3064:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3065:     if ($udom eq 'public' && $uname eq 'public') {
                   3066: 	return ('lastname' => &mt('Public'));
                   3067:     }
1.295     www      3068:     my $id=$uname.':'.$udom;
                   3069:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3070:     if ($cached) {
                   3071: 	return %{$names};
                   3072:     } else {
                   3073: 	my %loadnames=&Apache::lonnet::get('environment',
                   3074:                     ['firstname','middlename','lastname','generation','nickname'],
                   3075: 					 $udom,$uname);
                   3076: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3077: 	return %loadnames;
                   3078:     }
                   3079: }
1.61      www      3080: 
1.542     raeburn  3081: # -------------------------------------------------------------------- getemails
1.648     raeburn  3082: 
1.542     raeburn  3083: =pod
                   3084: 
1.648     raeburn  3085: =item * &getemails($uname,$udom)
1.542     raeburn  3086: 
                   3087: Gets a user's email information and returns it as a hash with keys:
                   3088: notification, critnotification, permanentemail
                   3089: 
                   3090: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3091: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3092:  
1.648     raeburn  3093: 
1.542     raeburn  3094: =cut
                   3095: 
1.648     raeburn  3096: 
1.466     albertel 3097: sub getemails {
                   3098:     my ($uname,$udom)=@_;
                   3099:     if ($udom eq 'public' && $uname eq 'public') {
                   3100: 	return;
                   3101:     }
1.467     www      3102:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3103:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3104:     my $id=$uname.':'.$udom;
                   3105:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3106:     if ($cached) {
                   3107: 	return %{$names};
                   3108:     } else {
                   3109: 	my %loadnames=&Apache::lonnet::get('environment',
                   3110:                     			   ['notification','critnotification',
                   3111: 					    'permanentemail'],
                   3112: 					   $udom,$uname);
                   3113: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3114: 	return %loadnames;
                   3115:     }
                   3116: }
                   3117: 
1.551     albertel 3118: sub flush_email_cache {
                   3119:     my ($uname,$udom)=@_;
                   3120:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3121:     if (!$uname) { $uname=$env{'user.name'};   }
                   3122:     return if ($udom eq 'public' && $uname eq 'public');
                   3123:     my $id=$uname.':'.$udom;
                   3124:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3125: }
                   3126: 
1.728     raeburn  3127: # -------------------------------------------------------------------- getlangs
                   3128: 
                   3129: =pod
                   3130: 
                   3131: =item * &getlangs($uname,$udom)
                   3132: 
                   3133: Gets a user's language preference and returns it as a hash with key:
                   3134: language.
                   3135: 
                   3136: =cut
                   3137: 
                   3138: 
                   3139: sub getlangs {
                   3140:     my ($uname,$udom) = @_;
                   3141:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3142:     if (!$uname) { $uname=$env{'user.name'};   }
                   3143:     my $id=$uname.':'.$udom;
                   3144:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3145:     if ($cached) {
                   3146:         return %{$langs};
                   3147:     } else {
                   3148:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3149:                                            $udom,$uname);
                   3150:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3151:         return %loadlangs;
                   3152:     }
                   3153: }
                   3154: 
                   3155: sub flush_langs_cache {
                   3156:     my ($uname,$udom)=@_;
                   3157:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3158:     if (!$uname) { $uname=$env{'user.name'};   }
                   3159:     return if ($udom eq 'public' && $uname eq 'public');
                   3160:     my $id=$uname.':'.$udom;
                   3161:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3162: }
                   3163: 
1.61      www      3164: # ------------------------------------------------------------------ Screenname
1.81      albertel 3165: 
                   3166: =pod
                   3167: 
1.648     raeburn  3168: =item * &screenname($uname,$udom)
1.81      albertel 3169: 
                   3170: Gets a users screenname and returns it as a string
                   3171: 
                   3172: =cut
1.61      www      3173: 
                   3174: sub screenname {
                   3175:     my ($uname,$udom)=@_;
1.258     albertel 3176:     if ($uname eq $env{'user.name'} &&
                   3177: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3178:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3179:     return $names{'screenname'};
1.62      www      3180: }
                   3181: 
1.212     albertel 3182: 
1.802     bisitz   3183: # ------------------------------------------------------------- Confirm Wrapper
                   3184: =pod
                   3185: 
                   3186: =item confirmwrapper
                   3187: 
                   3188: Wrap messages about completion of operation in box
                   3189: 
                   3190: =cut
                   3191: 
                   3192: sub confirmwrapper {
                   3193:     my ($message)=@_;
                   3194:     if ($message) {
                   3195:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3196:                .$message."\n"
                   3197:                .'</div>'."\n";
                   3198:     } else {
                   3199:         return $message;
                   3200:     }
                   3201: }
                   3202: 
1.62      www      3203: # ------------------------------------------------------------- Message Wrapper
                   3204: 
                   3205: sub messagewrapper {
1.369     www      3206:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3207:     return 
1.441     albertel 3208:         '<a href="/adm/email?compose=individual&amp;'.
                   3209:         'recname='.$username.'&amp;recdom='.$domain.
                   3210: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3211:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3212: }
1.802     bisitz   3213: 
1.74      www      3214: # --------------------------------------------------------------- Notes Wrapper
                   3215: 
                   3216: sub noteswrapper {
                   3217:     my ($link,$un,$do)=@_;
                   3218:     return 
1.896     amueller 3219: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3220: }
1.802     bisitz   3221: 
1.62      www      3222: # ------------------------------------------------------------- Aboutme Wrapper
                   3223: 
                   3224: sub aboutmewrapper {
1.1070    raeburn  3225:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3226:     if (!defined($username)  && !defined($domain)) {
                   3227:         return;
                   3228:     }
1.892     amueller 3229:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.1070    raeburn  3230: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3231: }
                   3232: 
                   3233: # ------------------------------------------------------------ Syllabus Wrapper
                   3234: 
                   3235: sub syllabuswrapper {
1.707     bisitz   3236:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3237:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3238: }
1.14      harris41 3239: 
1.802     bisitz   3240: # -----------------------------------------------------------------------------
                   3241: 
1.208     matthew  3242: sub track_student_link {
1.887     raeburn  3243:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3244:     my $link ="/adm/trackstudent?";
1.208     matthew  3245:     my $title = 'View recent activity';
                   3246:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3247:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3248:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3249:         $title .= ' of this student';
1.268     albertel 3250:     } 
1.208     matthew  3251:     if (defined($target) && $target !~ /^\s*$/) {
                   3252:         $target = qq{target="$target"};
                   3253:     } else {
                   3254:         $target = '';
                   3255:     }
1.268     albertel 3256:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3257:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3258:     $title = &mt($title);
                   3259:     $linktext = &mt($linktext);
1.448     albertel 3260:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3261: 	&help_open_topic('View_recent_activity');
1.208     matthew  3262: }
                   3263: 
1.781     raeburn  3264: sub slot_reservations_link {
                   3265:     my ($linktext,$sname,$sdom,$target) = @_;
                   3266:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3267:     my $title = 'View slot reservation history';
                   3268:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3269:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3270:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3271:         $title .= ' of this student';
                   3272:     }
                   3273:     if (defined($target) && $target !~ /^\s*$/) {
                   3274:         $target = qq{target="$target"};
                   3275:     } else {
                   3276:         $target = '';
                   3277:     }
                   3278:     $title = &mt($title);
                   3279:     $linktext = &mt($linktext);
                   3280:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3281: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3282: 
                   3283: }
                   3284: 
1.508     www      3285: # ===================================================== Display a student photo
                   3286: 
                   3287: 
1.509     albertel 3288: sub student_image_tag {
1.508     www      3289:     my ($domain,$user)=@_;
                   3290:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3291:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3292: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3293:     } else {
                   3294: 	return '';
                   3295:     }
                   3296: }
                   3297: 
1.112     bowersj2 3298: =pod
                   3299: 
                   3300: =back
                   3301: 
                   3302: =head1 Access .tab File Data
                   3303: 
                   3304: =over 4
                   3305: 
1.648     raeburn  3306: =item * &languageids() 
1.112     bowersj2 3307: 
                   3308: returns list of all language ids
                   3309: 
                   3310: =cut
                   3311: 
1.14      harris41 3312: sub languageids {
1.16      harris41 3313:     return sort(keys(%language));
1.14      harris41 3314: }
                   3315: 
1.112     bowersj2 3316: =pod
                   3317: 
1.648     raeburn  3318: =item * &languagedescription() 
1.112     bowersj2 3319: 
                   3320: returns description of a specified language id
                   3321: 
                   3322: =cut
                   3323: 
1.14      harris41 3324: sub languagedescription {
1.125     www      3325:     my $code=shift;
                   3326:     return  ($supported_language{$code}?'* ':'').
                   3327:             $language{$code}.
1.126     www      3328: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3329: }
                   3330: 
1.1048    foxr     3331: =pod
                   3332: 
                   3333: =item * &plainlanguagedescription
                   3334: 
                   3335: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3336: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3337: 
                   3338: =cut
                   3339: 
1.145     www      3340: sub plainlanguagedescription {
                   3341:     my $code=shift;
                   3342:     return $language{$code};
                   3343: }
                   3344: 
1.1048    foxr     3345: =pod
                   3346: 
                   3347: =item * &supportedlanguagecode
                   3348: 
                   3349: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3350: code.
                   3351: 
                   3352: =cut
                   3353: 
1.145     www      3354: sub supportedlanguagecode {
                   3355:     my $code=shift;
                   3356:     return $supported_language{$code};
1.97      www      3357: }
                   3358: 
1.112     bowersj2 3359: =pod
                   3360: 
1.1048    foxr     3361: =item * &latexlanguage()
                   3362: 
                   3363: Given a language key code returns the correspondnig language to use
                   3364: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3365: is no supported hyphenation for the language code.
                   3366: 
                   3367: =cut
                   3368: 
                   3369: sub latexlanguage {
                   3370:     my $code = shift;
                   3371:     return $latex_language{$code};
                   3372: }
                   3373: 
                   3374: =pod
                   3375: 
                   3376: =item * &latexhyphenation()
                   3377: 
                   3378: Same as above but what's supplied is the language as it might be stored
                   3379: in the metadata.
                   3380: 
                   3381: =cut
                   3382: 
                   3383: sub latexhyphenation {
                   3384:     my $key = shift;
                   3385:     return $latex_language_bykey{$key};
                   3386: }
                   3387: 
                   3388: =pod
                   3389: 
1.648     raeburn  3390: =item * &copyrightids() 
1.112     bowersj2 3391: 
                   3392: returns list of all copyrights
                   3393: 
                   3394: =cut
                   3395: 
                   3396: sub copyrightids {
                   3397:     return sort(keys(%cprtag));
                   3398: }
                   3399: 
                   3400: =pod
                   3401: 
1.648     raeburn  3402: =item * &copyrightdescription() 
1.112     bowersj2 3403: 
                   3404: returns description of a specified copyright id
                   3405: 
                   3406: =cut
                   3407: 
                   3408: sub copyrightdescription {
1.166     www      3409:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3410: }
1.197     matthew  3411: 
                   3412: =pod
                   3413: 
1.648     raeburn  3414: =item * &source_copyrightids() 
1.192     taceyjo1 3415: 
                   3416: returns list of all source copyrights
                   3417: 
                   3418: =cut
                   3419: 
                   3420: sub source_copyrightids {
                   3421:     return sort(keys(%scprtag));
                   3422: }
                   3423: 
                   3424: =pod
                   3425: 
1.648     raeburn  3426: =item * &source_copyrightdescription() 
1.192     taceyjo1 3427: 
                   3428: returns description of a specified source copyright id
                   3429: 
                   3430: =cut
                   3431: 
                   3432: sub source_copyrightdescription {
                   3433:     return &mt($scprtag{shift(@_)});
                   3434: }
1.112     bowersj2 3435: 
                   3436: =pod
                   3437: 
1.648     raeburn  3438: =item * &filecategories() 
1.112     bowersj2 3439: 
                   3440: returns list of all file categories
                   3441: 
                   3442: =cut
                   3443: 
                   3444: sub filecategories {
                   3445:     return sort(keys(%category_extensions));
                   3446: }
                   3447: 
                   3448: =pod
                   3449: 
1.648     raeburn  3450: =item * &filecategorytypes() 
1.112     bowersj2 3451: 
                   3452: returns list of file types belonging to a given file
                   3453: category
                   3454: 
                   3455: =cut
                   3456: 
                   3457: sub filecategorytypes {
1.356     albertel 3458:     my ($cat) = @_;
                   3459:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3460: }
                   3461: 
                   3462: =pod
                   3463: 
1.648     raeburn  3464: =item * &fileembstyle() 
1.112     bowersj2 3465: 
                   3466: returns embedding style for a specified file type
                   3467: 
                   3468: =cut
                   3469: 
                   3470: sub fileembstyle {
                   3471:     return $fe{lc(shift(@_))};
1.169     www      3472: }
                   3473: 
1.351     www      3474: sub filemimetype {
                   3475:     return $fm{lc(shift(@_))};
                   3476: }
                   3477: 
1.169     www      3478: 
                   3479: sub filecategoryselect {
                   3480:     my ($name,$value)=@_;
1.189     matthew  3481:     return &select_form($value,$name,
1.970     raeburn  3482:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3483: }
                   3484: 
                   3485: =pod
                   3486: 
1.648     raeburn  3487: =item * &filedescription() 
1.112     bowersj2 3488: 
                   3489: returns description for a specified file type
                   3490: 
                   3491: =cut
                   3492: 
                   3493: sub filedescription {
1.188     matthew  3494:     my $file_description = $fd{lc(shift())};
                   3495:     $file_description =~ s:([\[\]]):~$1:g;
                   3496:     return &mt($file_description);
1.112     bowersj2 3497: }
                   3498: 
                   3499: =pod
                   3500: 
1.648     raeburn  3501: =item * &filedescriptionex() 
1.112     bowersj2 3502: 
                   3503: returns description for a specified file type with
                   3504: extra formatting
                   3505: 
                   3506: =cut
                   3507: 
                   3508: sub filedescriptionex {
                   3509:     my $ex=shift;
1.188     matthew  3510:     my $file_description = $fd{lc($ex)};
                   3511:     $file_description =~ s:([\[\]]):~$1:g;
                   3512:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3513: }
                   3514: 
                   3515: # End of .tab access
                   3516: =pod
                   3517: 
                   3518: =back
                   3519: 
                   3520: =cut
                   3521: 
                   3522: # ------------------------------------------------------------------ File Types
                   3523: sub fileextensions {
                   3524:     return sort(keys(%fe));
                   3525: }
                   3526: 
1.97      www      3527: # ----------------------------------------------------------- Display Languages
                   3528: # returns a hash with all desired display languages
                   3529: #
                   3530: 
                   3531: sub display_languages {
                   3532:     my %languages=();
1.695     raeburn  3533:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3534: 	$languages{$lang}=1;
1.97      www      3535:     }
                   3536:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3537:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3538: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3539: 	    $languages{$lang}=1;
1.97      www      3540:         }
                   3541:     }
                   3542:     return %languages;
1.14      harris41 3543: }
                   3544: 
1.582     albertel 3545: sub languages {
                   3546:     my ($possible_langs) = @_;
1.695     raeburn  3547:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3548:     if (!ref($possible_langs)) {
                   3549: 	if( wantarray ) {
                   3550: 	    return @preferred_langs;
                   3551: 	} else {
                   3552: 	    return $preferred_langs[0];
                   3553: 	}
                   3554:     }
                   3555:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3556:     my @preferred_possibilities;
                   3557:     foreach my $preferred_lang (@preferred_langs) {
                   3558: 	if (exists($possibilities{$preferred_lang})) {
                   3559: 	    push(@preferred_possibilities, $preferred_lang);
                   3560: 	}
                   3561:     }
                   3562:     if( wantarray ) {
                   3563: 	return @preferred_possibilities;
                   3564:     }
                   3565:     return $preferred_possibilities[0];
                   3566: }
                   3567: 
1.742     raeburn  3568: sub user_lang {
                   3569:     my ($touname,$toudom,$fromcid) = @_;
                   3570:     my @userlangs;
                   3571:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3572:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3573:                     $env{'course.'.$fromcid.'.languages'}));
                   3574:     } else {
                   3575:         my %langhash = &getlangs($touname,$toudom);
                   3576:         if ($langhash{'languages'} ne '') {
                   3577:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3578:         } else {
                   3579:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3580:             if ($domdefs{'lang_def'} ne '') {
                   3581:                 @userlangs = ($domdefs{'lang_def'});
                   3582:             }
                   3583:         }
                   3584:     }
                   3585:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3586:     my $user_lh = Apache::localize->get_handle(@languages);
                   3587:     return $user_lh;
                   3588: }
                   3589: 
                   3590: 
1.112     bowersj2 3591: ###############################################################
                   3592: ##               Student Answer Attempts                     ##
                   3593: ###############################################################
                   3594: 
                   3595: =pod
                   3596: 
                   3597: =head1 Alternate Problem Views
                   3598: 
                   3599: =over 4
                   3600: 
1.648     raeburn  3601: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3602:     $getattempt, $regexp, $gradesub)
                   3603: 
                   3604: Return string with previous attempt on problem. Arguments:
                   3605: 
                   3606: =over 4
                   3607: 
                   3608: =item * $symb: Problem, including path
                   3609: 
                   3610: =item * $username: username of the desired student
                   3611: 
                   3612: =item * $domain: domain of the desired student
1.14      harris41 3613: 
1.112     bowersj2 3614: =item * $course: Course ID
1.14      harris41 3615: 
1.112     bowersj2 3616: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3617:     something
1.14      harris41 3618: 
1.112     bowersj2 3619: =item * $regexp: if string matches this regexp, the string will be
                   3620:     sent to $gradesub
1.14      harris41 3621: 
1.112     bowersj2 3622: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3623: 
1.112     bowersj2 3624: =back
1.14      harris41 3625: 
1.112     bowersj2 3626: The output string is a table containing all desired attempts, if any.
1.16      harris41 3627: 
1.112     bowersj2 3628: =cut
1.1       albertel 3629: 
                   3630: sub get_previous_attempt {
1.43      ng       3631:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3632:   my $prevattempts='';
1.43      ng       3633:   no strict 'refs';
1.1       albertel 3634:   if ($symb) {
1.3       albertel 3635:     my (%returnhash)=
                   3636:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3637:     if ($returnhash{'version'}) {
                   3638:       my %lasthash=();
                   3639:       my $version;
                   3640:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3641:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3642: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3643:         }
1.1       albertel 3644:       }
1.596     albertel 3645:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3646:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3647:       my (%typeparts,%lasthidden);
1.945     raeburn  3648:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3649:       foreach my $key (sort(keys(%lasthash))) {
                   3650: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3651: 	if ($#parts > 0) {
1.31      albertel 3652: 	  my $data=$parts[-1];
1.989     raeburn  3653:           next if ($data eq 'foilorder');
1.31      albertel 3654: 	  pop(@parts);
1.1010    www      3655:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  3656:           if ($data eq 'type') {
                   3657:               unless ($showsurv) {
                   3658:                   my $id = join(',',@parts);
                   3659:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3660:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3661:                       $lasthidden{$ign.'.'.$id} = 1;
                   3662:                   }
1.945     raeburn  3663:               }
1.1010    www      3664:           } 
1.31      albertel 3665: 	} else {
1.41      ng       3666: 	  if ($#parts == 0) {
                   3667: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3668: 	  } else {
                   3669: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3670: 	  }
1.31      albertel 3671: 	}
1.16      harris41 3672:       }
1.596     albertel 3673:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3674:       if ($getattempt eq '') {
                   3675: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3676:             my @hidden;
                   3677:             if (%typeparts) {
                   3678:                 foreach my $id (keys(%typeparts)) {
                   3679:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3680:                         push(@hidden,$id);
                   3681:                     }
                   3682:                 }
                   3683:             }
                   3684:             $prevattempts.=&start_data_table_row().
                   3685:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3686:             if (@hidden) {
                   3687:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3688:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3689:                     my $hide;
                   3690:                     foreach my $id (@hidden) {
                   3691:                         if ($key =~ /^\Q$id\E/) {
                   3692:                             $hide = 1;
                   3693:                             last;
                   3694:                         }
                   3695:                     }
                   3696:                     if ($hide) {
                   3697:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3698:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3699:                             my $value = &format_previous_attempt_value($key,
                   3700:                                              $returnhash{$version.':'.$key});
                   3701:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3702:                         } else {
                   3703:                             $prevattempts.='<td>&nbsp;</td>';
                   3704:                         }
                   3705:                     } else {
                   3706:                         if ($key =~ /\./) {
                   3707:                             my $value = &format_previous_attempt_value($key,
                   3708:                                               $returnhash{$version.':'.$key});
                   3709:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3710:                         } else {
                   3711:                             $prevattempts.='<td>&nbsp;</td>';
                   3712:                         }
                   3713:                     }
                   3714:                 }
                   3715:             } else {
                   3716: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3717:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3718: 		    my $value = &format_previous_attempt_value($key,
                   3719: 			            $returnhash{$version.':'.$key});
                   3720: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3721: 	        }
                   3722:             }
                   3723: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3724: 	 }
1.1       albertel 3725:       }
1.945     raeburn  3726:       my @currhidden = keys(%lasthidden);
1.596     albertel 3727:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3728:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3729:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  3730:           if (%typeparts) {
                   3731:               my $hidden;
                   3732:               foreach my $id (@currhidden) {
                   3733:                   if ($key =~ /^\Q$id\E/) {
                   3734:                       $hidden = 1;
                   3735:                       last;
                   3736:                   }
                   3737:               }
                   3738:               if ($hidden) {
                   3739:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3740:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3741:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3742:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3743:                           $value = &$gradesub($value);
                   3744:                       }
                   3745:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3746:                   } else {
                   3747:                       $prevattempts.='<td>&nbsp;</td>';
                   3748:                   }
                   3749:               } else {
                   3750:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3751:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3752:                       $value = &$gradesub($value);
                   3753:                   }
                   3754:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3755:               }
                   3756:           } else {
                   3757: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3758: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3759:                   $value = &$gradesub($value);
                   3760:               }
                   3761: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3762:           }
1.16      harris41 3763:       }
1.596     albertel 3764:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3765:     } else {
1.596     albertel 3766:       $prevattempts=
                   3767: 	  &start_data_table().&start_data_table_row().
                   3768: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3769: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3770:     }
                   3771:   } else {
1.596     albertel 3772:     $prevattempts=
                   3773: 	  &start_data_table().&start_data_table_row().
                   3774: 	  '<td>'.&mt('No data.').'</td>'.
                   3775: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3776:   }
1.10      albertel 3777: }
                   3778: 
1.581     albertel 3779: sub format_previous_attempt_value {
                   3780:     my ($key,$value) = @_;
1.1011    www      3781:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 3782: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3783:     } elsif (ref($value) eq 'ARRAY') {
                   3784: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  3785:     } elsif ($key =~ /answerstring$/) {
                   3786:         my %answers = &Apache::lonnet::str2hash($value);
                   3787:         my @anskeys = sort(keys(%answers));
                   3788:         if (@anskeys == 1) {
                   3789:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  3790:             if ($answer =~ m{\0}) {
                   3791:                 $answer =~ s{\0}{,}g;
1.988     raeburn  3792:             }
                   3793:             my $tag_internal_answer_name = 'INTERNAL';
                   3794:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   3795:                 $value = $answer; 
                   3796:             } else {
                   3797:                 $value = $anskeys[0].'='.$answer;
                   3798:             }
                   3799:         } else {
                   3800:             foreach my $ans (@anskeys) {
                   3801:                 my $answer = $answers{$ans};
1.1001    raeburn  3802:                 if ($answer =~ m{\0}) {
                   3803:                     $answer =~ s{\0}{,}g;
1.988     raeburn  3804:                 }
                   3805:                 $value .=  $ans.'='.$answer.'<br />';;
                   3806:             } 
                   3807:         }
1.581     albertel 3808:     } else {
                   3809: 	$value = &unescape($value);
                   3810:     }
                   3811:     return $value;
                   3812: }
                   3813: 
                   3814: 
1.107     albertel 3815: sub relative_to_absolute {
                   3816:     my ($url,$output)=@_;
                   3817:     my $parser=HTML::TokeParser->new(\$output);
                   3818:     my $token;
                   3819:     my $thisdir=$url;
                   3820:     my @rlinks=();
                   3821:     while ($token=$parser->get_token) {
                   3822: 	if ($token->[0] eq 'S') {
                   3823: 	    if ($token->[1] eq 'a') {
                   3824: 		if ($token->[2]->{'href'}) {
                   3825: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3826: 		}
                   3827: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3828: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3829: 	    } elsif ($token->[1] eq 'base') {
                   3830: 		$thisdir=$token->[2]->{'href'};
                   3831: 	    }
                   3832: 	}
                   3833:     }
                   3834:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3835:     foreach my $link (@rlinks) {
1.726     raeburn  3836: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3837: 		($link=~/^\//) ||
                   3838: 		($link=~/^javascript:/i) ||
                   3839: 		($link=~/^mailto:/i) ||
                   3840: 		($link=~/^\#/)) {
                   3841: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3842: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3843: 	}
                   3844:     }
                   3845: # -------------------------------------------------- Deal with Applet codebases
                   3846:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3847:     return $output;
                   3848: }
                   3849: 
1.112     bowersj2 3850: =pod
                   3851: 
1.648     raeburn  3852: =item * &get_student_view()
1.112     bowersj2 3853: 
                   3854: show a snapshot of what student was looking at
                   3855: 
                   3856: =cut
                   3857: 
1.10      albertel 3858: sub get_student_view {
1.186     albertel 3859:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3860:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3861:   my (%form);
1.10      albertel 3862:   my @elements=('symb','courseid','domain','username');
                   3863:   foreach my $element (@elements) {
1.186     albertel 3864:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3865:   }
1.186     albertel 3866:   if (defined($moreenv)) {
                   3867:       %form=(%form,%{$moreenv});
                   3868:   }
1.236     albertel 3869:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3870:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3871:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3872:   $userview=~s/\<body[^\>]*\>//gi;
                   3873:   $userview=~s/\<\/body\>//gi;
                   3874:   $userview=~s/\<html\>//gi;
                   3875:   $userview=~s/\<\/html\>//gi;
                   3876:   $userview=~s/\<head\>//gi;
                   3877:   $userview=~s/\<\/head\>//gi;
                   3878:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3879:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3880:   if (wantarray) {
                   3881:      return ($userview,$response);
                   3882:   } else {
                   3883:      return $userview;
                   3884:   }
                   3885: }
                   3886: 
                   3887: sub get_student_view_with_retries {
                   3888:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3889: 
                   3890:     my $ok = 0;                 # True if we got a good response.
                   3891:     my $content;
                   3892:     my $response;
                   3893: 
                   3894:     # Try to get the student_view done. within the retries count:
                   3895:     
                   3896:     do {
                   3897:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3898:          $ok      = $response->is_success;
                   3899:          if (!$ok) {
                   3900:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3901:          }
                   3902:          $retries--;
                   3903:     } while (!$ok && ($retries > 0));
                   3904:     
                   3905:     if (!$ok) {
                   3906:        $content = '';          # On error return an empty content.
                   3907:     }
1.651     www      3908:     if (wantarray) {
                   3909:        return ($content, $response);
                   3910:     } else {
                   3911:        return $content;
                   3912:     }
1.11      albertel 3913: }
                   3914: 
1.112     bowersj2 3915: =pod
                   3916: 
1.648     raeburn  3917: =item * &get_student_answers() 
1.112     bowersj2 3918: 
                   3919: show a snapshot of how student was answering problem
                   3920: 
                   3921: =cut
                   3922: 
1.11      albertel 3923: sub get_student_answers {
1.100     sakharuk 3924:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3925:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3926:   my (%moreenv);
1.11      albertel 3927:   my @elements=('symb','courseid','domain','username');
                   3928:   foreach my $element (@elements) {
1.186     albertel 3929:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3930:   }
1.186     albertel 3931:   $moreenv{'grade_target'}='answer';
                   3932:   %moreenv=(%form,%moreenv);
1.497     raeburn  3933:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3934:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3935:   return $userview;
1.1       albertel 3936: }
1.116     albertel 3937: 
                   3938: =pod
                   3939: 
                   3940: =item * &submlink()
                   3941: 
1.242     albertel 3942: Inputs: $text $uname $udom $symb $target
1.116     albertel 3943: 
                   3944: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3945: 
                   3946: =cut
                   3947: 
                   3948: ###############################################
                   3949: sub submlink {
1.242     albertel 3950:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3951:     if (!($uname && $udom)) {
                   3952: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3953: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3954: 	if (!$symb) { $symb=$cursymb; }
                   3955:     }
1.254     matthew  3956:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3957:     $symb=&escape($symb);
1.960     bisitz   3958:     if ($target) { $target=" target=\"$target\""; }
                   3959:     return
                   3960:         '<a href="/adm/grades?command=submission'.
                   3961:         '&amp;symb='.$symb.
                   3962:         '&amp;student='.$uname.
                   3963:         '&amp;userdom='.$udom.'"'.
                   3964:         $target.'>'.$text.'</a>';
1.242     albertel 3965: }
                   3966: ##############################################
                   3967: 
                   3968: =pod
                   3969: 
                   3970: =item * &pgrdlink()
                   3971: 
                   3972: Inputs: $text $uname $udom $symb $target
                   3973: 
                   3974: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3975: 
                   3976: =cut
                   3977: 
                   3978: ###############################################
                   3979: sub pgrdlink {
                   3980:     my $link=&submlink(@_);
                   3981:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3982:     return $link;
                   3983: }
                   3984: ##############################################
                   3985: 
                   3986: =pod
                   3987: 
                   3988: =item * &pprmlink()
                   3989: 
                   3990: Inputs: $text $uname $udom $symb $target
                   3991: 
                   3992: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3993: student and a specific resource
1.242     albertel 3994: 
                   3995: =cut
                   3996: 
                   3997: ###############################################
                   3998: sub pprmlink {
                   3999:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4000:     if (!($uname && $udom)) {
                   4001: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4002: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4003: 	if (!$symb) { $symb=$cursymb; }
                   4004:     }
1.254     matthew  4005:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4006:     $symb=&escape($symb);
1.242     albertel 4007:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4008:     return '<a href="/adm/parmset?command=set&amp;'.
                   4009: 	'symb='.$symb.'&amp;uname='.$uname.
                   4010: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4011: }
                   4012: ##############################################
1.37      matthew  4013: 
1.112     bowersj2 4014: =pod
                   4015: 
                   4016: =back
                   4017: 
                   4018: =cut
                   4019: 
1.37      matthew  4020: ###############################################
1.51      www      4021: 
                   4022: 
                   4023: sub timehash {
1.687     raeburn  4024:     my ($thistime) = @_;
                   4025:     my $timezone = &Apache::lonlocal::gettimezone();
                   4026:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4027:                      ->set_time_zone($timezone);
                   4028:     my $wday = $dt->day_of_week();
                   4029:     if ($wday == 7) { $wday = 0; }
                   4030:     return ( 'second' => $dt->second(),
                   4031:              'minute' => $dt->minute(),
                   4032:              'hour'   => $dt->hour(),
                   4033:              'day'     => $dt->day_of_month(),
                   4034:              'month'   => $dt->month(),
                   4035:              'year'    => $dt->year(),
                   4036:              'weekday' => $wday,
                   4037:              'dayyear' => $dt->day_of_year(),
                   4038:              'dlsav'   => $dt->is_dst() );
1.51      www      4039: }
                   4040: 
1.370     www      4041: sub utc_string {
                   4042:     my ($date)=@_;
1.371     www      4043:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4044: }
                   4045: 
1.51      www      4046: sub maketime {
                   4047:     my %th=@_;
1.687     raeburn  4048:     my ($epoch_time,$timezone,$dt);
                   4049:     $timezone = &Apache::lonlocal::gettimezone();
                   4050:     eval {
                   4051:         $dt = DateTime->new( year   => $th{'year'},
                   4052:                              month  => $th{'month'},
                   4053:                              day    => $th{'day'},
                   4054:                              hour   => $th{'hour'},
                   4055:                              minute => $th{'minute'},
                   4056:                              second => $th{'second'},
                   4057:                              time_zone => $timezone,
                   4058:                          );
                   4059:     };
                   4060:     if (!$@) {
                   4061:         $epoch_time = $dt->epoch;
                   4062:         if ($epoch_time) {
                   4063:             return $epoch_time;
                   4064:         }
                   4065:     }
1.51      www      4066:     return POSIX::mktime(
                   4067:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4068:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4069: }
                   4070: 
                   4071: #########################################
1.51      www      4072: 
                   4073: sub findallcourses {
1.482     raeburn  4074:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4075:     my %roles;
                   4076:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4077:     my %courses;
1.51      www      4078:     my $now=time;
1.482     raeburn  4079:     if (!defined($uname)) {
                   4080:         $uname = $env{'user.name'};
                   4081:     }
                   4082:     if (!defined($udom)) {
                   4083:         $udom = $env{'user.domain'};
                   4084:     }
                   4085:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4086:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4087:         if (!%roles) {
                   4088:             %roles = (
                   4089:                        cc => 1,
1.907     raeburn  4090:                        co => 1,
1.482     raeburn  4091:                        in => 1,
                   4092:                        ep => 1,
                   4093:                        ta => 1,
                   4094:                        cr => 1,
                   4095:                        st => 1,
                   4096:              );
                   4097:         }
                   4098:         foreach my $entry (keys(%roleshash)) {
                   4099:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4100:             if ($trole =~ /^cr/) { 
                   4101:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4102:             } else {
                   4103:                 next if (!exists($roles{$trole}));
                   4104:             }
                   4105:             if ($tend) {
                   4106:                 next if ($tend < $now);
                   4107:             }
                   4108:             if ($tstart) {
                   4109:                 next if ($tstart > $now);
                   4110:             }
1.1058    raeburn  4111:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4112:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4113:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4114:             if ($secpart eq '') {
                   4115:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4116:                 $sec = 'none';
1.1058    raeburn  4117:                 $value .= $cnum.'/';
1.482     raeburn  4118:             } else {
                   4119:                 $cnum = $cnumpart;
                   4120:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4121:                 $value .= $cnum.'/'.$sec;
                   4122:             }
                   4123:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4124:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4125:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4126:                 }
                   4127:             } else {
                   4128:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4129:             }
1.482     raeburn  4130:         }
                   4131:     } else {
                   4132:         foreach my $key (keys(%env)) {
1.483     albertel 4133: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4134:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4135: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4136: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4137: 	        next if (%roles && !exists($roles{$role}));
                   4138: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4139:                 my $active=1;
                   4140:                 if ($starttime) {
                   4141: 		    if ($now<$starttime) { $active=0; }
                   4142:                 }
                   4143:                 if ($endtime) {
                   4144:                     if ($now>$endtime) { $active=0; }
                   4145:                 }
                   4146:                 if ($active) {
1.1058    raeburn  4147:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4148:                     if ($sec eq '') {
                   4149:                         $sec = 'none';
1.1058    raeburn  4150:                     } else {
                   4151:                         $value .= $sec;
                   4152:                     }
                   4153:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4154:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4155:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4156:                         }
                   4157:                     } else {
                   4158:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4159:                     }
1.474     raeburn  4160:                 }
                   4161:             }
1.51      www      4162:         }
                   4163:     }
1.474     raeburn  4164:     return %courses;
1.51      www      4165: }
1.37      matthew  4166: 
1.54      www      4167: ###############################################
1.474     raeburn  4168: 
                   4169: sub blockcheck {
1.1062    raeburn  4170:     my ($setters,$activity,$uname,$udom,$url) = @_;
1.490     raeburn  4171: 
                   4172:     if (!defined($udom)) {
                   4173:         $udom = $env{'user.domain'};
                   4174:     }
                   4175:     if (!defined($uname)) {
                   4176:         $uname = $env{'user.name'};
                   4177:     }
                   4178: 
                   4179:     # If uname and udom are for a course, check for blocks in the course.
                   4180: 
                   4181:     if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062    raeburn  4182:         my ($startblock,$endblock,$triggerblock) = 
                   4183:             &get_blocks($setters,$activity,$udom,$uname,$url);
                   4184:         return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4185:     }
1.474     raeburn  4186: 
1.502     raeburn  4187:     my $startblock = 0;
                   4188:     my $endblock = 0;
1.1062    raeburn  4189:     my $triggerblock = '';
1.482     raeburn  4190:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4191: 
1.490     raeburn  4192:     # If uname is for a user, and activity is course-specific, i.e.,
                   4193:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4194: 
1.490     raeburn  4195:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4196:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4197:         foreach my $key (keys(%live_courses)) {
                   4198:             if ($key ne $env{'request.course.id'}) {
                   4199:                 delete($live_courses{$key});
                   4200:             }
                   4201:         }
                   4202:     }
                   4203: 
                   4204:     my $otheruser = 0;
                   4205:     my %own_courses;
                   4206:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4207:         # Resource belongs to user other than current user.
                   4208:         $otheruser = 1;
                   4209:         # Gather courses for current user
                   4210:         %own_courses = 
                   4211:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4212:     }
                   4213: 
                   4214:     # Gather active course roles - course coordinator, instructor, 
                   4215:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4216: 
                   4217:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4218:         my ($cdom,$cnum);
                   4219:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4220:             $cdom = $env{'course.'.$course.'.domain'};
                   4221:             $cnum = $env{'course.'.$course.'.num'};
                   4222:         } else {
1.490     raeburn  4223:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4224:         }
                   4225:         my $no_ownblock = 0;
                   4226:         my $no_userblock = 0;
1.533     raeburn  4227:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4228:             # Check if current user has 'evb' priv for this
                   4229:             if (defined($own_courses{$course})) {
                   4230:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4231:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4232:                     if ($sec ne 'none') {
                   4233:                         $checkrole .= '/'.$sec;
                   4234:                     }
                   4235:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4236:                         $no_ownblock = 1;
                   4237:                         last;
                   4238:                     }
                   4239:                 }
                   4240:             }
                   4241:             # if they have 'evb' priv and are currently not playing student
                   4242:             next if (($no_ownblock) &&
                   4243:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4244:         }
1.474     raeburn  4245:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4246:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4247:             if ($sec ne 'none') {
1.482     raeburn  4248:                 $checkrole .= '/'.$sec;
1.474     raeburn  4249:             }
1.490     raeburn  4250:             if ($otheruser) {
                   4251:                 # Resource belongs to user other than current user.
                   4252:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4253:                 my (%allroles,%userroles);
                   4254:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4255:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4256:                         my ($trole,$tdom,$tnum,$tsec);
                   4257:                         if ($entry =~ /^cr/) {
                   4258:                             ($trole,$tdom,$tnum,$tsec) = 
                   4259:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4260:                         } else {
                   4261:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4262:                         }
                   4263:                         my ($spec,$area,$trest);
                   4264:                         $area = '/'.$tdom.'/'.$tnum;
                   4265:                         $trest = $tnum;
                   4266:                         if ($tsec ne '') {
                   4267:                             $area .= '/'.$tsec;
                   4268:                             $trest .= '/'.$tsec;
                   4269:                         }
                   4270:                         $spec = $trole.'.'.$area;
                   4271:                         if ($trole =~ /^cr/) {
                   4272:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4273:                                                               $tdom,$spec,$trest,$area);
                   4274:                         } else {
                   4275:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4276:                                                                 $tdom,$spec,$trest,$area);
                   4277:                         }
                   4278:                     }
                   4279:                     my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   4280:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4281:                         if ($1) {
                   4282:                             $no_userblock = 1;
                   4283:                             last;
                   4284:                         }
1.486     raeburn  4285:                     }
                   4286:                 }
1.490     raeburn  4287:             } else {
                   4288:                 # Resource belongs to current user
                   4289:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4290:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4291:                     $no_ownblock = 1;
                   4292:                     last;
                   4293:                 }
1.474     raeburn  4294:             }
                   4295:         }
                   4296:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4297:         next if (($no_ownblock) &&
1.491     albertel 4298:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4299:         next if ($no_userblock);
1.474     raeburn  4300: 
1.866     kalberla 4301:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4302:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4303:         
1.1062    raeburn  4304:         my ($start,$end,$trigger) = 
                   4305:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4306:         if (($start != 0) && 
                   4307:             (($startblock == 0) || ($startblock > $start))) {
                   4308:             $startblock = $start;
1.1062    raeburn  4309:             if ($trigger ne '') {
                   4310:                 $triggerblock = $trigger;
                   4311:             }
1.502     raeburn  4312:         }
                   4313:         if (($end != 0)  &&
                   4314:             (($endblock == 0) || ($endblock < $end))) {
                   4315:             $endblock = $end;
1.1062    raeburn  4316:             if ($trigger ne '') {
                   4317:                 $triggerblock = $trigger;
                   4318:             }
1.502     raeburn  4319:         }
1.490     raeburn  4320:     }
1.1062    raeburn  4321:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4322: }
                   4323: 
                   4324: sub get_blocks {
1.1062    raeburn  4325:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4326:     my $startblock = 0;
                   4327:     my $endblock = 0;
1.1062    raeburn  4328:     my $triggerblock = '';
1.490     raeburn  4329:     my $course = $cdom.'_'.$cnum;
                   4330:     $setters->{$course} = {};
                   4331:     $setters->{$course}{'staff'} = [];
                   4332:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4333:     $setters->{$course}{'triggers'} = [];
                   4334:     my (@blockers,%triggered);
                   4335:     my $now = time;
                   4336:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4337:     if ($activity eq 'docs') {
                   4338:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4339:         foreach my $block (@blockers) {
                   4340:             if ($block =~ /^firstaccess____(.+)$/) {
                   4341:                 my $item = $1;
                   4342:                 my $type = 'map';
                   4343:                 my $timersymb = $item;
                   4344:                 if ($item eq 'course') {
                   4345:                     $type = 'course';
                   4346:                 } elsif ($item =~ /___\d+___/) {
                   4347:                     $type = 'resource';
                   4348:                 } else {
                   4349:                     $timersymb = &Apache::lonnet::symbread($item);
                   4350:                 }
                   4351:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4352:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4353:                 $triggered{$block} = {
                   4354:                                        start => $start,
                   4355:                                        end   => $end,
                   4356:                                        type  => $type,
                   4357:                                      };
                   4358:             }
                   4359:         }
                   4360:     } else {
                   4361:         foreach my $block (keys(%commblocks)) {
                   4362:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4363:                 my ($start,$end) = ($1,$2);
                   4364:                 if ($start <= time && $end >= time) {
                   4365:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4366:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4367:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4368:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4369:                                     push(@blockers,$block);
                   4370:                                 }
                   4371:                             }
                   4372:                         }
                   4373:                     }
                   4374:                 }
                   4375:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4376:                 my $item = $1;
                   4377:                 my $timersymb = $item; 
                   4378:                 my $type = 'map';
                   4379:                 if ($item eq 'course') {
                   4380:                     $type = 'course';
                   4381:                 } elsif ($item =~ /___\d+___/) {
                   4382:                     $type = 'resource';
                   4383:                 } else {
                   4384:                     $timersymb = &Apache::lonnet::symbread($item);
                   4385:                 }
                   4386:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4387:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4388:                 if ($start && $end) {
                   4389:                     if (($start <= time) && ($end >= time)) {
                   4390:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4391:                             push(@blockers,$block);
                   4392:                             $triggered{$block} = {
                   4393:                                                    start => $start,
                   4394:                                                    end   => $end,
                   4395:                                                    type  => $type,
                   4396:                                                  };
                   4397:                         }
                   4398:                     }
1.490     raeburn  4399:                 }
1.1062    raeburn  4400:             }
                   4401:         }
                   4402:     }
                   4403:     foreach my $blocker (@blockers) {
                   4404:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4405:             &parse_block_record($commblocks{$blocker});
                   4406:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4407:         my ($start,$end,$triggertype);
                   4408:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4409:             ($start,$end) = ($1,$2);
                   4410:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4411:             $start = $triggered{$blocker}{'start'};
                   4412:             $end = $triggered{$blocker}{'end'};
                   4413:             $triggertype = $triggered{$blocker}{'type'};
                   4414:         }
                   4415:         if ($start) {
                   4416:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4417:             if ($triggertype) {
                   4418:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4419:             } else {
                   4420:                 push(@{$$setters{$course}{'triggers'}},0);
                   4421:             }
                   4422:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4423:                 $startblock = $start;
                   4424:                 if ($triggertype) {
                   4425:                     $triggerblock = $blocker;
1.474     raeburn  4426:                 }
                   4427:             }
1.1062    raeburn  4428:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4429:                $endblock = $end;
                   4430:                if ($triggertype) {
                   4431:                    $triggerblock = $blocker;
                   4432:                }
                   4433:             }
1.474     raeburn  4434:         }
                   4435:     }
1.1062    raeburn  4436:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4437: }
                   4438: 
                   4439: sub parse_block_record {
                   4440:     my ($record) = @_;
                   4441:     my ($setuname,$setudom,$title,$blocks);
                   4442:     if (ref($record) eq 'HASH') {
                   4443:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4444:         $title = &unescape($record->{'event'});
                   4445:         $blocks = $record->{'blocks'};
                   4446:     } else {
                   4447:         my @data = split(/:/,$record,3);
                   4448:         if (scalar(@data) eq 2) {
                   4449:             $title = $data[1];
                   4450:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4451:         } else {
                   4452:             ($setuname,$setudom,$title) = @data;
                   4453:         }
                   4454:         $blocks = { 'com' => 'on' };
                   4455:     }
                   4456:     return ($setuname,$setudom,$title,$blocks);
                   4457: }
                   4458: 
1.854     kalberla 4459: sub blocking_status {
1.1062    raeburn  4460:     my ($activity,$uname,$udom,$url) = @_;
1.1061    raeburn  4461:     my %setters;
1.890     droeschl 4462: 
1.1061    raeburn  4463: # check for active blocking
1.1062    raeburn  4464:     my ($startblock,$endblock,$triggerblock) = 
                   4465:         &blockcheck(\%setters,$activity,$uname,$udom,$url);
                   4466:     my $blocked = 0;
                   4467:     if ($startblock && $endblock) {
                   4468:         $blocked = 1;
                   4469:     }
1.890     droeschl 4470: 
1.1061    raeburn  4471: # caller just wants to know whether a block is active
                   4472:     if (!wantarray) { return $blocked; }
                   4473: 
                   4474: # build a link to a popup window containing the details
                   4475:     my $querystring  = "?activity=$activity";
                   4476: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062    raeburn  4477:     if ($activity eq 'port') {
                   4478:         $querystring .= "&amp;udom=$udom"      if $udom;
                   4479:         $querystring .= "&amp;uname=$uname"    if $uname;
                   4480:     } elsif ($activity eq 'docs') {
                   4481:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4482:     }
1.1061    raeburn  4483: 
                   4484:     my $output .= <<'END_MYBLOCK';
                   4485: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4486:     var options = "width=" + w + ",height=" + h + ",";
                   4487:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4488:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4489:     var newWin = window.open(url, wdwName, options);
                   4490:     newWin.focus();
                   4491: }
1.890     droeschl 4492: END_MYBLOCK
1.854     kalberla 4493: 
1.1061    raeburn  4494:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4495:   
1.1061    raeburn  4496:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  4497:     my $text = &mt('Communication Blocked');
                   4498:     if ($activity eq 'docs') {
                   4499:         $text = &mt('Content Access Blocked');
1.1063    raeburn  4500:     } elsif ($activity eq 'printout') {
                   4501:         $text = &mt('Printing Blocked');
1.1062    raeburn  4502:     }
1.1061    raeburn  4503:     $output .= <<"END_BLOCK";
1.867     kalberla 4504: <div class='LC_comblock'>
1.869     kalberla 4505:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4506:   title='$text'>
                   4507:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4508:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4509:   title='$text'>$text</a>
1.867     kalberla 4510: </div>
                   4511: 
                   4512: END_BLOCK
1.474     raeburn  4513: 
1.1061    raeburn  4514:     return ($blocked, $output);
1.854     kalberla 4515: }
1.490     raeburn  4516: 
1.60      matthew  4517: ###############################################
                   4518: 
1.682     raeburn  4519: sub check_ip_acc {
                   4520:     my ($acc)=@_;
                   4521:     &Apache::lonxml::debug("acc is $acc");
                   4522:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4523:         return 1;
                   4524:     }
                   4525:     my $allowed=0;
                   4526:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4527: 
                   4528:     my $name;
                   4529:     foreach my $pattern (split(',',$acc)) {
                   4530:         $pattern =~ s/^\s*//;
                   4531:         $pattern =~ s/\s*$//;
                   4532:         if ($pattern =~ /\*$/) {
                   4533:             #35.8.*
                   4534:             $pattern=~s/\*//;
                   4535:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4536:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4537:             #35.8.3.[34-56]
                   4538:             my $low=$2;
                   4539:             my $high=$3;
                   4540:             $pattern=$1;
                   4541:             if ($ip =~ /^\Q$pattern\E/) {
                   4542:                 my $last=(split(/\./,$ip))[3];
                   4543:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4544:             }
                   4545:         } elsif ($pattern =~ /^\*/) {
                   4546:             #*.msu.edu
                   4547:             $pattern=~s/\*//;
                   4548:             if (!defined($name)) {
                   4549:                 use Socket;
                   4550:                 my $netaddr=inet_aton($ip);
                   4551:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4552:             }
                   4553:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4554:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4555:             #127.0.0.1
                   4556:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4557:         } else {
                   4558:             #some.name.com
                   4559:             if (!defined($name)) {
                   4560:                 use Socket;
                   4561:                 my $netaddr=inet_aton($ip);
                   4562:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4563:             }
                   4564:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4565:         }
                   4566:         if ($allowed) { last; }
                   4567:     }
                   4568:     return $allowed;
                   4569: }
                   4570: 
                   4571: ###############################################
                   4572: 
1.60      matthew  4573: =pod
                   4574: 
1.112     bowersj2 4575: =head1 Domain Template Functions
                   4576: 
                   4577: =over 4
                   4578: 
                   4579: =item * &determinedomain()
1.60      matthew  4580: 
                   4581: Inputs: $domain (usually will be undef)
                   4582: 
1.63      www      4583: Returns: Determines which domain should be used for designs
1.60      matthew  4584: 
                   4585: =cut
1.54      www      4586: 
1.60      matthew  4587: ###############################################
1.63      www      4588: sub determinedomain {
                   4589:     my $domain=shift;
1.531     albertel 4590:     if (! $domain) {
1.60      matthew  4591:         # Determine domain if we have not been given one
1.893     raeburn  4592:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4593:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4594:         if ($env{'request.role.domain'}) { 
                   4595:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4596:         }
                   4597:     }
1.63      www      4598:     return $domain;
                   4599: }
                   4600: ###############################################
1.517     raeburn  4601: 
1.518     albertel 4602: sub devalidate_domconfig_cache {
                   4603:     my ($udom)=@_;
                   4604:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4605: }
                   4606: 
                   4607: # ---------------------- Get domain configuration for a domain
                   4608: sub get_domainconf {
                   4609:     my ($udom) = @_;
                   4610:     my $cachetime=1800;
                   4611:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4612:     if (defined($cached)) { return %{$result}; }
                   4613: 
                   4614:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4615: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4616:     my (%designhash,%legacy);
1.518     albertel 4617:     if (keys(%domconfig) > 0) {
                   4618:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4619:             if (keys(%{$domconfig{'login'}})) {
                   4620:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4621:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4622:                         if ($key eq 'loginvia') {
                   4623:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4624:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4625:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4626:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4627:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4628:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4629:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4630: 
                   4631:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4632:                                             } else {
1.1013    raeburn  4633:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4634:                                             }
                   4635:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4636:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4637:                                             }
1.946     raeburn  4638:                                         }
                   4639:                                     }
                   4640:                                 }
                   4641:                             }
                   4642:                         } else {
                   4643:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4644:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4645:                                     $domconfig{'login'}{$key}{$img};
                   4646:                             }
1.699     raeburn  4647:                         }
                   4648:                     } else {
                   4649:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4650:                     }
1.632     raeburn  4651:                 }
                   4652:             } else {
                   4653:                 $legacy{'login'} = 1;
1.518     albertel 4654:             }
1.632     raeburn  4655:         } else {
                   4656:             $legacy{'login'} = 1;
1.518     albertel 4657:         }
                   4658:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4659:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4660:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4661:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4662:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4663:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4664:                         }
1.518     albertel 4665:                     }
                   4666:                 }
1.632     raeburn  4667:             } else {
                   4668:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4669:             }
1.632     raeburn  4670:         } else {
                   4671:             $legacy{'rolecolors'} = 1;
1.518     albertel 4672:         }
1.948     raeburn  4673:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4674:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4675:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4676:             }
                   4677:         }
1.632     raeburn  4678:         if (keys(%legacy) > 0) {
                   4679:             my %legacyhash = &get_legacy_domconf($udom);
                   4680:             foreach my $item (keys(%legacyhash)) {
                   4681:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4682:                     if ($legacy{'login'}) { 
                   4683:                         $designhash{$item} = $legacyhash{$item};
                   4684:                     }
                   4685:                 } else {
                   4686:                     if ($legacy{'rolecolors'}) {
                   4687:                         $designhash{$item} = $legacyhash{$item};
                   4688:                     }
1.518     albertel 4689:                 }
                   4690:             }
                   4691:         }
1.632     raeburn  4692:     } else {
                   4693:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4694:     }
                   4695:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4696: 				  $cachetime);
                   4697:     return %designhash;
                   4698: }
                   4699: 
1.632     raeburn  4700: sub get_legacy_domconf {
                   4701:     my ($udom) = @_;
                   4702:     my %legacyhash;
                   4703:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4704:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4705:     if (-e $designfile) {
                   4706:         if ( open (my $fh,"<$designfile") ) {
                   4707:             while (my $line = <$fh>) {
                   4708:                 next if ($line =~ /^\#/);
                   4709:                 chomp($line);
                   4710:                 my ($key,$val)=(split(/\=/,$line));
                   4711:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4712:             }
                   4713:             close($fh);
                   4714:         }
                   4715:     }
1.1026    raeburn  4716:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4717:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4718:     }
                   4719:     return %legacyhash;
                   4720: }
                   4721: 
1.63      www      4722: =pod
                   4723: 
1.112     bowersj2 4724: =item * &domainlogo()
1.63      www      4725: 
                   4726: Inputs: $domain (usually will be undef)
                   4727: 
                   4728: Returns: A link to a domain logo, if the domain logo exists.
                   4729: If the domain logo does not exist, a description of the domain.
                   4730: 
                   4731: =cut
1.112     bowersj2 4732: 
1.63      www      4733: ###############################################
                   4734: sub domainlogo {
1.517     raeburn  4735:     my $domain = &determinedomain(shift);
1.518     albertel 4736:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4737:     # See if there is a logo
                   4738:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4739:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4740:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4741: 	    if ($imgsrc =~ m{^/res/}) {
                   4742: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4743: 		&Apache::lonnet::repcopy($local_name);
                   4744: 	    }
                   4745: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4746:         } 
                   4747:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4748:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4749:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4750:     } else {
1.60      matthew  4751:         return '';
1.59      www      4752:     }
                   4753: }
1.63      www      4754: ##############################################
                   4755: 
                   4756: =pod
                   4757: 
1.112     bowersj2 4758: =item * &designparm()
1.63      www      4759: 
                   4760: Inputs: $which parameter; $domain (usually will be undef)
                   4761: 
                   4762: Returns: value of designparamter $which
                   4763: 
                   4764: =cut
1.112     bowersj2 4765: 
1.397     albertel 4766: 
1.400     albertel 4767: ##############################################
1.397     albertel 4768: sub designparm {
                   4769:     my ($which,$domain)=@_;
                   4770:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4771:         return $env{'environment.color.'.$which};
1.96      www      4772:     }
1.63      www      4773:     $domain=&determinedomain($domain);
1.1016    raeburn  4774:     my %domdesign;
                   4775:     unless ($domain eq 'public') {
                   4776:         %domdesign = &get_domainconf($domain);
                   4777:     }
1.520     raeburn  4778:     my $output;
1.517     raeburn  4779:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4780:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4781:     } else {
1.520     raeburn  4782:         $output = $defaultdesign{$which};
                   4783:     }
                   4784:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4785:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4786:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4787:             if ($output =~ m{^/res/}) {
                   4788:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4789:                 &Apache::lonnet::repcopy($local_name);
                   4790:             }
1.520     raeburn  4791:             $output = &lonhttpdurl($output);
                   4792:         }
1.63      www      4793:     }
1.520     raeburn  4794:     return $output;
1.63      www      4795: }
1.59      www      4796: 
1.822     bisitz   4797: ##############################################
                   4798: =pod
                   4799: 
1.832     bisitz   4800: =item * &authorspace()
                   4801: 
1.1028    raeburn  4802: Inputs: $url (usually will be undef).
1.832     bisitz   4803: 
1.1028    raeburn  4804: Returns: Path to Construction Space containing the resource or 
                   4805:          directory being viewed (or for which action is being taken). 
                   4806:          If $url is provided, and begins /priv/<domain>/<uname>
                   4807:          the path will be that portion of the $context argument.
                   4808:          Otherwise the path will be for the author space of the current
                   4809:          user when the current role is author, or for that of the 
                   4810:          co-author/assistant co-author space when the current role 
                   4811:          is co-author or assistant co-author.
1.832     bisitz   4812: 
                   4813: =cut
                   4814: 
                   4815: sub authorspace {
1.1028    raeburn  4816:     my ($url) = @_;
                   4817:     if ($url ne '') {
                   4818:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4819:            return $1;
                   4820:         }
                   4821:     }
1.832     bisitz   4822:     my $caname = '';
1.1024    www      4823:     my $cadom = '';
1.1028    raeburn  4824:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4825:         ($cadom,$caname) =
1.832     bisitz   4826:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4827:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4828:         $caname = $env{'user.name'};
1.1024    www      4829:         $cadom = $env{'user.domain'};
1.832     bisitz   4830:     }
1.1028    raeburn  4831:     if (($caname ne '') && ($cadom ne '')) {
                   4832:         return "/priv/$cadom/$caname/";
                   4833:     }
                   4834:     return;
1.832     bisitz   4835: }
                   4836: 
                   4837: ##############################################
                   4838: =pod
                   4839: 
1.822     bisitz   4840: =item * &head_subbox()
                   4841: 
                   4842: Inputs: $content (contains HTML code with page functions, etc.)
                   4843: 
                   4844: Returns: HTML div with $content
                   4845:          To be included in page header
                   4846: 
                   4847: =cut
                   4848: 
                   4849: sub head_subbox {
                   4850:     my ($content)=@_;
                   4851:     my $output =
1.993     raeburn  4852:         '<div class="LC_head_subbox">'
1.822     bisitz   4853:        .$content
                   4854:        .'</div>'
                   4855: }
                   4856: 
                   4857: ##############################################
                   4858: =pod
                   4859: 
                   4860: =item * &CSTR_pageheader()
                   4861: 
1.1026    raeburn  4862: Input: (optional) filename from which breadcrumb trail is built.
                   4863:        In most cases no input as needed, as $env{'request.filename'}
                   4864:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4865: 
                   4866: Returns: HTML div with CSTR path and recent box
                   4867:          To be included on Construction Space pages
                   4868: 
                   4869: =cut
                   4870: 
                   4871: sub CSTR_pageheader {
1.1026    raeburn  4872:     my ($trailfile) = @_;
                   4873:     if ($trailfile eq '') {
                   4874:         $trailfile = $env{'request.filename'};
                   4875:     }
                   4876: 
                   4877: # this is for resources; directories have customtitle, and crumbs
                   4878: # and select recent are created in lonpubdir.pm
                   4879: 
                   4880:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      4881:     my ($udom,$uname,$thisdisfn)=
1.1026    raeburn  4882:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)/(.*)$});
                   4883:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   4884:     $formaction =~ s{/+}{/}g;
1.822     bisitz   4885: 
                   4886:     my $parentpath = '';
                   4887:     my $lastitem = '';
                   4888:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4889:         $parentpath = $1;
                   4890:         $lastitem = $2;
                   4891:     } else {
                   4892:         $lastitem = $thisdisfn;
                   4893:     }
1.921     bisitz   4894: 
                   4895:     my $output =
1.822     bisitz   4896:          '<div>'
                   4897:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4898:         .'<b>'.&mt('Construction Space:').'</b> '
                   4899:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   4900:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      4901:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   4902: 
                   4903:     if ($lastitem) {
                   4904:         $output .=
                   4905:              '<span class="LC_filename">'
                   4906:             .$lastitem
                   4907:             .'</span>';
                   4908:     }
                   4909:     $output .=
                   4910:          '<br />'
1.822     bisitz   4911:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4912:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4913:         .'</form>'
                   4914:         .&Apache::lonmenu::constspaceform()
                   4915:         .'</div>';
1.921     bisitz   4916: 
                   4917:     return $output;
1.822     bisitz   4918: }
                   4919: 
1.60      matthew  4920: ###############################################
                   4921: ###############################################
                   4922: 
                   4923: =pod
                   4924: 
1.112     bowersj2 4925: =back
                   4926: 
1.549     albertel 4927: =head1 HTML Helpers
1.112     bowersj2 4928: 
                   4929: =over 4
                   4930: 
                   4931: =item * &bodytag()
1.60      matthew  4932: 
                   4933: Returns a uniform header for LON-CAPA web pages.
                   4934: 
                   4935: Inputs: 
                   4936: 
1.112     bowersj2 4937: =over 4
                   4938: 
                   4939: =item * $title, A title to be displayed on the page.
                   4940: 
                   4941: =item * $function, the current role (can be undef).
                   4942: 
                   4943: =item * $addentries, extra parameters for the <body> tag.
                   4944: 
                   4945: =item * $bodyonly, if defined, only return the <body> tag.
                   4946: 
                   4947: =item * $domain, if defined, force a given domain.
                   4948: 
                   4949: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4950:             text interface only)
1.60      matthew  4951: 
1.814     bisitz   4952: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4953:                      navigational links
1.317     albertel 4954: 
1.338     albertel 4955: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4956: 
1.460     albertel 4957: =item * $args, optional argument valid values are
                   4958:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4959:             inherit_jsmath -> when creating popup window in a page,
                   4960:                               should it have jsmath forced on by the
                   4961:                               current page
1.460     albertel 4962: 
1.112     bowersj2 4963: =back
                   4964: 
1.60      matthew  4965: Returns: A uniform header for LON-CAPA web pages.  
                   4966: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4967: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4968: other decorations will be returned.
                   4969: 
                   4970: =cut
                   4971: 
1.54      www      4972: sub bodytag {
1.831     bisitz   4973:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.962     droeschl 4974:         $no_nav_bar,$bgcolor,$args)=@_;
1.339     albertel 4975: 
1.954     raeburn  4976:     my $public;
                   4977:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   4978:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   4979:         $public = 1;
                   4980:     }
1.460     albertel 4981:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4982: 
1.183     matthew  4983:     $function = &get_users_function() if (!$function);
1.339     albertel 4984:     my $img =    &designparm($function.'.img',$domain);
                   4985:     my $font =   &designparm($function.'.font',$domain);
                   4986:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4987: 
1.803     bisitz   4988:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4989: 		   'bgcolor' => $pgbg,
1.339     albertel 4990: 		   'text'    => $font,
                   4991:                    'alink'   => &designparm($function.'.alink',$domain),
                   4992: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4993: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4994:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4995: 
1.63      www      4996:  # role and realm
1.378     raeburn  4997:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4998:     if ($role  eq 'ca') {
1.479     albertel 4999:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5000:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5001:     } 
1.55      www      5002: # realm
1.258     albertel 5003:     if ($env{'request.course.id'}) {
1.378     raeburn  5004:         if ($env{'request.role'} !~ /^cr/) {
                   5005:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   5006:         }
1.898     raeburn  5007:         if ($env{'request.course.sec'}) {
                   5008:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5009:         }   
1.359     albertel 5010: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5011:     } else {
                   5012:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5013:     }
1.433     albertel 5014: 
1.359     albertel 5015:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5016: 
1.438     albertel 5017:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5018: 
1.101     www      5019: # construct main body tag
1.359     albertel 5020:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 5021: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 5022: 
1.530     albertel 5023:     if ($bodyonly) {
1.60      matthew  5024:         return $bodytag;
1.798     tempelho 5025:     } 
1.359     albertel 5026: 
1.410     albertel 5027:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  5028:     if ($public) {
1.433     albertel 5029: 	undef($role);
1.434     albertel 5030:     } else {
1.1070    raeburn  5031: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5032:                                 undef,'LC_menubuttons_link');
1.433     albertel 5033:     }
1.359     albertel 5034:     
1.762     bisitz   5035:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5036:     #
                   5037:     # Extra info if you are the DC
                   5038:     my $dc_info = '';
                   5039:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5040:                         $env{'course.'.$env{'request.course.id'}.
                   5041:                                  '.domain'}.'/'})) {
                   5042:         my $cid = $env{'request.course.id'};
1.917     raeburn  5043:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5044:         $dc_info =~ s/\s+$//;
1.359     albertel 5045:     }
                   5046: 
1.898     raeburn  5047:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 5048:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5049: 
1.916     droeschl 5050:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   5051:             return $bodytag; 
                   5052:         } 
1.903     droeschl 5053: 
                   5054:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5055: 
                   5056:         #    if ($env{'request.state'} eq 'construct') {
                   5057:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5058:         #    }
                   5059: 
1.359     albertel 5060: 
1.1075.2.2  raeburn  5061: 
1.916     droeschl 5062:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.1  raeburn  5063:             unless ($env{'request.noversionuri'} =~ m{/res/adm/pages/bookmarkmenu/}) {
                   5064:                 if ($dc_info) {
                   5065:                      $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5066:                 }
                   5067:                 $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   5068:                                <em>$realm</em> $dc_info</div>|;
                   5069:             }
1.903     droeschl 5070:             return $bodytag;
                   5071:         }
1.894     droeschl 5072: 
1.927     raeburn  5073:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5074:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   5075:         }
1.916     droeschl 5076: 
1.903     droeschl 5077:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   5078:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   5079: 
1.903     droeschl 5080:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 5081: 
1.917     raeburn  5082:         if ($dc_info) {
                   5083:             $dc_info = &dc_courseid_toggle($dc_info);
                   5084:         }
                   5085:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5086: 
1.903     droeschl 5087:         #don't show menus for public users
1.954     raeburn  5088:         if (!$public){
1.903     droeschl 5089:             $bodytag .= Apache::lonmenu::secondary_menu();
                   5090:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5091:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5092:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5093:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5094:                                 $args->{'bread_crumbs'});
                   5095:             } elsif ($forcereg) { 
                   5096:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   5097:             }
1.903     droeschl 5098:         }else{
                   5099:             # this is to seperate menu from content when there's no secondary
                   5100:             # menu. Especially needed for public accessible ressources.
                   5101:             $bodytag .= '<hr style="clear:both" />';
                   5102:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5103:         }
1.903     droeschl 5104: 
1.235     raeburn  5105:         return $bodytag;
1.182     matthew  5106: }
                   5107: 
1.917     raeburn  5108: sub dc_courseid_toggle {
                   5109:     my ($dc_info) = @_;
1.980     raeburn  5110:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5111:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5112:            &mt('(More ...)').'</a></span>'.
                   5113:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5114: }
                   5115: 
1.330     albertel 5116: sub make_attr_string {
                   5117:     my ($register,$attr_ref) = @_;
                   5118: 
                   5119:     if ($attr_ref && !ref($attr_ref)) {
                   5120: 	die("addentries Must be a hash ref ".
                   5121: 	    join(':',caller(1))." ".
                   5122: 	    join(':',caller(0))." ");
                   5123:     }
                   5124: 
                   5125:     if ($register) {
1.339     albertel 5126: 	my ($on_load,$on_unload);
                   5127: 	foreach my $key (keys(%{$attr_ref})) {
                   5128: 	    if      (lc($key) eq 'onload') {
                   5129: 		$on_load.=$attr_ref->{$key}.';';
                   5130: 		delete($attr_ref->{$key});
                   5131: 
                   5132: 	    } elsif (lc($key) eq 'onunload') {
                   5133: 		$on_unload.=$attr_ref->{$key}.';';
                   5134: 		delete($attr_ref->{$key});
                   5135: 	    }
                   5136: 	}
1.953     droeschl 5137: 	$attr_ref->{'onload'}  = $on_load;
                   5138: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5139:     }
1.339     albertel 5140: 
1.330     albertel 5141:     my $attr_string;
                   5142:     foreach my $attr (keys(%$attr_ref)) {
                   5143: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5144:     }
                   5145:     return $attr_string;
                   5146: }
                   5147: 
                   5148: 
1.182     matthew  5149: ###############################################
1.251     albertel 5150: ###############################################
                   5151: 
                   5152: =pod
                   5153: 
                   5154: =item * &endbodytag()
                   5155: 
                   5156: Returns a uniform footer for LON-CAPA web pages.
                   5157: 
1.635     raeburn  5158: Inputs: 1 - optional reference to an args hash
                   5159: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5160: a 'Continue' link is not displayed if the page contains an
                   5161: internal redirect in the <head></head> section,
                   5162: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5163: 
                   5164: =cut
                   5165: 
                   5166: sub endbodytag {
1.635     raeburn  5167:     my ($args) = @_;
1.1075.2.6  raeburn  5168:     my $endbodytag;
                   5169:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5170:         $endbodytag='</body>';
                   5171:     }
1.269     albertel 5172:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5173:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5174:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5175: 	    $endbodytag=
                   5176: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5177: 	        &mt('Continue').'</a>'.
                   5178: 	        $endbodytag;
                   5179:         }
1.315     albertel 5180:     }
1.251     albertel 5181:     return $endbodytag;
                   5182: }
                   5183: 
1.352     albertel 5184: =pod
                   5185: 
                   5186: =item * &standard_css()
                   5187: 
                   5188: Returns a style sheet
                   5189: 
                   5190: Inputs: (all optional)
                   5191:             domain         -> force to color decorate a page for a specific
                   5192:                                domain
                   5193:             function       -> force usage of a specific rolish color scheme
                   5194:             bgcolor        -> override the default page bgcolor
                   5195: 
                   5196: =cut
                   5197: 
1.343     albertel 5198: sub standard_css {
1.345     albertel 5199:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5200:     $function  = &get_users_function() if (!$function);
                   5201:     my $img    = &designparm($function.'.img',   $domain);
                   5202:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5203:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5204:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5205: #second colour for later usage
1.345     albertel 5206:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5207:     my $pgbg_or_bgcolor =
                   5208: 	         $bgcolor ||
1.352     albertel 5209: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5210:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5211:     my $alink  = &designparm($function.'.alink', $domain);
                   5212:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5213:     my $link   = &designparm($function.'.link',  $domain);
                   5214: 
1.602     albertel 5215:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5216:     my $mono                 = 'monospace';
1.850     bisitz   5217:     my $data_table_head      = $sidebg;
                   5218:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5219:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5220:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5221:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5222:     my $mail_new             = '#FFBB77';
                   5223:     my $mail_new_hover       = '#DD9955';
                   5224:     my $mail_read            = '#BBBB77';
                   5225:     my $mail_read_hover      = '#999944';
                   5226:     my $mail_replied         = '#AAAA88';
                   5227:     my $mail_replied_hover   = '#888855';
                   5228:     my $mail_other           = '#99BBBB';
                   5229:     my $mail_other_hover     = '#669999';
1.391     albertel 5230:     my $table_header         = '#DDDDDD';
1.489     raeburn  5231:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5232:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5233:     my $button_hover         = '#BF2317';
1.392     albertel 5234: 
1.608     albertel 5235:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5236:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5237:                                              : '0 3px 0 4px';
1.448     albertel 5238: 
1.523     albertel 5239: 
1.343     albertel 5240:     return <<END;
1.947     droeschl 5241: 
                   5242: /* needed for iframe to allow 100% height in FF */
                   5243: body, html { 
                   5244:     margin: 0;
                   5245:     padding: 0 0.5%;
                   5246:     height: 99%; /* to avoid scrollbars */
                   5247: }
                   5248: 
1.795     www      5249: body {
1.911     bisitz   5250:   font-family: $sans;
                   5251:   line-height:130%;
                   5252:   font-size:0.83em;
                   5253:   color:$font;
1.795     www      5254: }
                   5255: 
1.959     onken    5256: a:focus,
                   5257: a:focus img {
1.795     www      5258:   color: red;
                   5259: }
1.698     harmsja  5260: 
1.911     bisitz   5261: form, .inline {
                   5262:   display: inline;
1.795     www      5263: }
1.721     harmsja  5264: 
1.795     www      5265: .LC_right {
1.911     bisitz   5266:   text-align:right;
1.795     www      5267: }
                   5268: 
                   5269: .LC_middle {
1.911     bisitz   5270:   vertical-align:middle;
1.795     www      5271: }
1.721     harmsja  5272: 
1.911     bisitz   5273: .LC_400Box {
                   5274:   width:400px;
                   5275: }
1.721     harmsja  5276: 
1.947     droeschl 5277: .LC_iframecontainer {
                   5278:     width: 98%;
                   5279:     margin: 0;
                   5280:     position: fixed;
                   5281:     top: 8.5em;
                   5282:     bottom: 0;
                   5283: }
                   5284: 
                   5285: .LC_iframecontainer iframe{
                   5286:     border: none;
                   5287:     width: 100%;
                   5288:     height: 100%;
                   5289: }
                   5290: 
1.778     bisitz   5291: .LC_filename {
                   5292:   font-family: $mono;
                   5293:   white-space:pre;
1.921     bisitz   5294:   font-size: 120%;
1.778     bisitz   5295: }
                   5296: 
                   5297: .LC_fileicon {
                   5298:   border: none;
                   5299:   height: 1.3em;
                   5300:   vertical-align: text-bottom;
                   5301:   margin-right: 0.3em;
                   5302:   text-decoration:none;
                   5303: }
                   5304: 
1.1008    www      5305: .LC_setting {
                   5306:   text-decoration:underline;
                   5307: }
                   5308: 
1.350     albertel 5309: .LC_error {
                   5310:   color: red;
                   5311:   font-size: larger;
                   5312: }
1.795     www      5313: 
1.457     albertel 5314: .LC_warning,
                   5315: .LC_diff_removed {
1.733     bisitz   5316:   color: red;
1.394     albertel 5317: }
1.532     albertel 5318: 
                   5319: .LC_info,
1.457     albertel 5320: .LC_success,
                   5321: .LC_diff_added {
1.350     albertel 5322:   color: green;
                   5323: }
1.795     www      5324: 
1.802     bisitz   5325: div.LC_confirm_box {
                   5326:   background-color: #FAFAFA;
                   5327:   border: 1px solid $lg_border_color;
                   5328:   margin-right: 0;
                   5329:   padding: 5px;
                   5330: }
                   5331: 
                   5332: div.LC_confirm_box .LC_error img,
                   5333: div.LC_confirm_box .LC_success img {
                   5334:   vertical-align: middle;
                   5335: }
                   5336: 
1.440     albertel 5337: .LC_icon {
1.771     droeschl 5338:   border: none;
1.790     droeschl 5339:   vertical-align: middle;
1.771     droeschl 5340: }
                   5341: 
1.543     albertel 5342: .LC_docs_spacer {
                   5343:   width: 25px;
                   5344:   height: 1px;
1.771     droeschl 5345:   border: none;
1.543     albertel 5346: }
1.346     albertel 5347: 
1.532     albertel 5348: .LC_internal_info {
1.735     bisitz   5349:   color: #999999;
1.532     albertel 5350: }
                   5351: 
1.794     www      5352: .LC_discussion {
1.1050    www      5353:   background: $data_table_dark;
1.911     bisitz   5354:   border: 1px solid black;
                   5355:   margin: 2px;
1.794     www      5356: }
                   5357: 
                   5358: .LC_disc_action_left {
1.1050    www      5359:   background: $sidebg;
1.911     bisitz   5360:   text-align: left;
1.1050    www      5361:   padding: 4px;
                   5362:   margin: 2px;
1.794     www      5363: }
                   5364: 
                   5365: .LC_disc_action_right {
1.1050    www      5366:   background: $sidebg;
1.911     bisitz   5367:   text-align: right;
1.1050    www      5368:   padding: 4px;
                   5369:   margin: 2px;
1.794     www      5370: }
                   5371: 
                   5372: .LC_disc_new_item {
1.911     bisitz   5373:   background: white;
                   5374:   border: 2px solid red;
1.1050    www      5375:   margin: 4px;
                   5376:   padding: 4px;
1.794     www      5377: }
                   5378: 
                   5379: .LC_disc_old_item {
1.911     bisitz   5380:   background: white;
1.1050    www      5381:   margin: 4px;
                   5382:   padding: 4px;
1.794     www      5383: }
                   5384: 
1.458     albertel 5385: table.LC_pastsubmission {
                   5386:   border: 1px solid black;
                   5387:   margin: 2px;
                   5388: }
                   5389: 
1.924     bisitz   5390: table#LC_menubuttons {
1.345     albertel 5391:   width: 100%;
                   5392:   background: $pgbg;
1.392     albertel 5393:   border: 2px;
1.402     albertel 5394:   border-collapse: separate;
1.803     bisitz   5395:   padding: 0;
1.345     albertel 5396: }
1.392     albertel 5397: 
1.801     tempelho 5398: table#LC_title_bar a {
                   5399:   color: $fontmenu;
                   5400: }
1.836     bisitz   5401: 
1.807     droeschl 5402: table#LC_title_bar {
1.819     tempelho 5403:   clear: both;
1.836     bisitz   5404:   display: none;
1.807     droeschl 5405: }
                   5406: 
1.795     www      5407: table#LC_title_bar,
1.933     droeschl 5408: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5409: table#LC_title_bar.LC_with_remote {
1.359     albertel 5410:   width: 100%;
1.392     albertel 5411:   border-color: $pgbg;
                   5412:   border-style: solid;
                   5413:   border-width: $border;
1.379     albertel 5414:   background: $pgbg;
1.801     tempelho 5415:   color: $fontmenu;
1.392     albertel 5416:   border-collapse: collapse;
1.803     bisitz   5417:   padding: 0;
1.819     tempelho 5418:   margin: 0;
1.359     albertel 5419: }
1.795     www      5420: 
1.933     droeschl 5421: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5422:     margin: 0;
                   5423:     padding: 0;
1.933     droeschl 5424:     position: relative;
                   5425:     list-style: none;
1.913     droeschl 5426: }
1.933     droeschl 5427: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5428:     display: inline;
                   5429: }
1.933     droeschl 5430: 
                   5431: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5432:     padding: 0;
1.933     droeschl 5433:     margin: 0;
                   5434:     float: left;
1.913     droeschl 5435: }
1.933     droeschl 5436: .LC_breadcrumb_tools_tools {
                   5437:     padding: 0;
                   5438:     margin: 0;
1.913     droeschl 5439:     float: right;
                   5440: }
                   5441: 
1.359     albertel 5442: table#LC_title_bar td {
                   5443:   background: $tabbg;
                   5444: }
1.795     www      5445: 
1.911     bisitz   5446: table#LC_menubuttons img {
1.803     bisitz   5447:   border: none;
1.346     albertel 5448: }
1.795     www      5449: 
1.842     droeschl 5450: .LC_breadcrumbs_component {
1.911     bisitz   5451:   float: right;
                   5452:   margin: 0 1em;
1.357     albertel 5453: }
1.842     droeschl 5454: .LC_breadcrumbs_component img {
1.911     bisitz   5455:   vertical-align: middle;
1.777     tempelho 5456: }
1.795     www      5457: 
1.383     albertel 5458: td.LC_table_cell_checkbox {
                   5459:   text-align: center;
                   5460: }
1.795     www      5461: 
                   5462: .LC_fontsize_small {
1.911     bisitz   5463:   font-size: 70%;
1.705     tempelho 5464: }
                   5465: 
1.844     bisitz   5466: #LC_breadcrumbs {
1.911     bisitz   5467:   clear:both;
                   5468:   background: $sidebg;
                   5469:   border-bottom: 1px solid $lg_border_color;
                   5470:   line-height: 2.5em;
1.933     droeschl 5471:   overflow: hidden;
1.911     bisitz   5472:   margin: 0;
                   5473:   padding: 0;
1.995     raeburn  5474:   text-align: left;
1.819     tempelho 5475: }
1.862     bisitz   5476: 
1.993     raeburn  5477: .LC_head_subbox {
1.911     bisitz   5478:   clear:both;
                   5479:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5480:   border: 1px solid $sidebg;
                   5481:   margin: 0 0 10px 0;      
1.966     bisitz   5482:   padding: 3px;
1.995     raeburn  5483:   text-align: left;
1.822     bisitz   5484: }
                   5485: 
1.795     www      5486: .LC_fontsize_medium {
1.911     bisitz   5487:   font-size: 85%;
1.705     tempelho 5488: }
                   5489: 
1.795     www      5490: .LC_fontsize_large {
1.911     bisitz   5491:   font-size: 120%;
1.705     tempelho 5492: }
                   5493: 
1.346     albertel 5494: .LC_menubuttons_inline_text {
                   5495:   color: $font;
1.698     harmsja  5496:   font-size: 90%;
1.701     harmsja  5497:   padding-left:3px;
1.346     albertel 5498: }
                   5499: 
1.934     droeschl 5500: .LC_menubuttons_inline_text img{
                   5501:   vertical-align: middle;
                   5502: }
                   5503: 
1.1051    www      5504: li.LC_menubuttons_inline_text img {
1.951     onken    5505:   cursor:pointer;
1.1002    droeschl 5506:   text-decoration: none;
1.951     onken    5507: }
                   5508: 
1.526     www      5509: .LC_menubuttons_link {
                   5510:   text-decoration: none;
                   5511: }
1.795     www      5512: 
1.522     albertel 5513: .LC_menubuttons_category {
1.521     www      5514:   color: $font;
1.526     www      5515:   background: $pgbg;
1.521     www      5516:   font-size: larger;
                   5517:   font-weight: bold;
                   5518: }
                   5519: 
1.346     albertel 5520: td.LC_menubuttons_text {
1.911     bisitz   5521:   color: $font;
1.346     albertel 5522: }
1.706     harmsja  5523: 
1.346     albertel 5524: .LC_current_location {
                   5525:   background: $tabbg;
                   5526: }
1.795     www      5527: 
1.938     bisitz   5528: table.LC_data_table {
1.347     albertel 5529:   border: 1px solid #000000;
1.402     albertel 5530:   border-collapse: separate;
1.426     albertel 5531:   border-spacing: 1px;
1.610     albertel 5532:   background: $pgbg;
1.347     albertel 5533: }
1.795     www      5534: 
1.422     albertel 5535: .LC_data_table_dense {
                   5536:   font-size: small;
                   5537: }
1.795     www      5538: 
1.507     raeburn  5539: table.LC_nested_outer {
                   5540:   border: 1px solid #000000;
1.589     raeburn  5541:   border-collapse: collapse;
1.803     bisitz   5542:   border-spacing: 0;
1.507     raeburn  5543:   width: 100%;
                   5544: }
1.795     www      5545: 
1.879     raeburn  5546: table.LC_innerpickbox,
1.507     raeburn  5547: table.LC_nested {
1.803     bisitz   5548:   border: none;
1.589     raeburn  5549:   border-collapse: collapse;
1.803     bisitz   5550:   border-spacing: 0;
1.507     raeburn  5551:   width: 100%;
                   5552: }
1.795     www      5553: 
1.911     bisitz   5554: table.LC_data_table tr th,
                   5555: table.LC_calendar tr th,
1.879     raeburn  5556: table.LC_prior_tries tr th,
                   5557: table.LC_innerpickbox tr th {
1.349     albertel 5558:   font-weight: bold;
                   5559:   background-color: $data_table_head;
1.801     tempelho 5560:   color:$fontmenu;
1.701     harmsja  5561:   font-size:90%;
1.347     albertel 5562: }
1.795     www      5563: 
1.879     raeburn  5564: table.LC_innerpickbox tr th,
                   5565: table.LC_innerpickbox tr td {
                   5566:   vertical-align: top;
                   5567: }
                   5568: 
1.711     raeburn  5569: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5570:   background-color: #CCCCCC;
1.711     raeburn  5571:   font-weight: bold;
                   5572:   text-align: left;
                   5573: }
1.795     www      5574: 
1.912     bisitz   5575: table.LC_data_table tr.LC_odd_row > td {
                   5576:   background-color: $data_table_light;
                   5577:   padding: 2px;
                   5578:   vertical-align: top;
                   5579: }
                   5580: 
1.809     bisitz   5581: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5582:   background-color: $data_table_light;
1.912     bisitz   5583:   vertical-align: top;
                   5584: }
                   5585: 
                   5586: table.LC_data_table tr.LC_even_row > td {
                   5587:   background-color: $data_table_dark;
1.425     albertel 5588:   padding: 2px;
1.900     bisitz   5589:   vertical-align: top;
1.347     albertel 5590: }
1.795     www      5591: 
1.809     bisitz   5592: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5593:   background-color: $data_table_dark;
1.900     bisitz   5594:   vertical-align: top;
1.347     albertel 5595: }
1.795     www      5596: 
1.425     albertel 5597: table.LC_data_table tr.LC_data_table_highlight td {
                   5598:   background-color: $data_table_darker;
                   5599: }
1.795     www      5600: 
1.639     raeburn  5601: table.LC_data_table tr td.LC_leftcol_header {
                   5602:   background-color: $data_table_head;
                   5603:   font-weight: bold;
                   5604: }
1.795     www      5605: 
1.451     albertel 5606: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5607: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5608:   font-weight: bold;
                   5609:   font-style: italic;
                   5610:   text-align: center;
                   5611:   padding: 8px;
1.347     albertel 5612: }
1.795     www      5613: 
1.940     bisitz   5614: table.LC_data_table tr.LC_empty_row td {
                   5615:   background-color: $sidebg;
                   5616: }
                   5617: 
                   5618: table.LC_nested tr.LC_empty_row td {
                   5619:   background-color: #FFFFFF;
                   5620: }
                   5621: 
1.890     droeschl 5622: table.LC_caption {
                   5623: }
                   5624: 
1.507     raeburn  5625: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5626:   padding: 4ex
                   5627: }
1.795     www      5628: 
1.507     raeburn  5629: table.LC_nested_outer tr th {
                   5630:   font-weight: bold;
1.801     tempelho 5631:   color:$fontmenu;
1.507     raeburn  5632:   background-color: $data_table_head;
1.701     harmsja  5633:   font-size: small;
1.507     raeburn  5634:   border-bottom: 1px solid #000000;
                   5635: }
1.795     www      5636: 
1.507     raeburn  5637: table.LC_nested_outer tr td.LC_subheader {
                   5638:   background-color: $data_table_head;
                   5639:   font-weight: bold;
                   5640:   font-size: small;
                   5641:   border-bottom: 1px solid #000000;
                   5642:   text-align: right;
1.451     albertel 5643: }
1.795     www      5644: 
1.507     raeburn  5645: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5646:   background-color: #CCCCCC;
1.451     albertel 5647:   font-weight: bold;
                   5648:   font-size: small;
1.507     raeburn  5649:   text-align: center;
                   5650: }
1.795     www      5651: 
1.589     raeburn  5652: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5653: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5654:   text-align: left;
1.451     albertel 5655: }
1.795     www      5656: 
1.507     raeburn  5657: table.LC_nested td {
1.735     bisitz   5658:   background-color: #FFFFFF;
1.451     albertel 5659:   font-size: small;
1.507     raeburn  5660: }
1.795     www      5661: 
1.507     raeburn  5662: table.LC_nested_outer tr th.LC_right_item,
                   5663: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5664: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5665: table.LC_nested tr td.LC_right_item {
1.451     albertel 5666:   text-align: right;
                   5667: }
                   5668: 
1.507     raeburn  5669: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5670:   background-color: #EEEEEE;
1.451     albertel 5671: }
                   5672: 
1.473     raeburn  5673: table.LC_createuser {
                   5674: }
                   5675: 
                   5676: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5677:   font-size: small;
1.473     raeburn  5678: }
                   5679: 
                   5680: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5681:   background-color: #CCCCCC;
1.473     raeburn  5682:   font-weight: bold;
                   5683:   text-align: center;
                   5684: }
                   5685: 
1.349     albertel 5686: table.LC_calendar {
                   5687:   border: 1px solid #000000;
                   5688:   border-collapse: collapse;
1.917     raeburn  5689:   width: 98%;
1.349     albertel 5690: }
1.795     www      5691: 
1.349     albertel 5692: table.LC_calendar_pickdate {
                   5693:   font-size: xx-small;
                   5694: }
1.795     www      5695: 
1.349     albertel 5696: table.LC_calendar tr td {
                   5697:   border: 1px solid #000000;
                   5698:   vertical-align: top;
1.917     raeburn  5699:   width: 14%;
1.349     albertel 5700: }
1.795     www      5701: 
1.349     albertel 5702: table.LC_calendar tr td.LC_calendar_day_empty {
                   5703:   background-color: $data_table_dark;
                   5704: }
1.795     www      5705: 
1.779     bisitz   5706: table.LC_calendar tr td.LC_calendar_day_current {
                   5707:   background-color: $data_table_highlight;
1.777     tempelho 5708: }
1.795     www      5709: 
1.938     bisitz   5710: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5711:   background-color: $mail_new;
                   5712: }
1.795     www      5713: 
1.938     bisitz   5714: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5715:   background-color: $mail_new_hover;
                   5716: }
1.795     www      5717: 
1.938     bisitz   5718: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5719:   background-color: $mail_read;
                   5720: }
1.795     www      5721: 
1.938     bisitz   5722: /*
                   5723: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5724:   background-color: $mail_read_hover;
                   5725: }
1.938     bisitz   5726: */
1.795     www      5727: 
1.938     bisitz   5728: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5729:   background-color: $mail_replied;
                   5730: }
1.795     www      5731: 
1.938     bisitz   5732: /*
                   5733: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5734:   background-color: $mail_replied_hover;
                   5735: }
1.938     bisitz   5736: */
1.795     www      5737: 
1.938     bisitz   5738: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5739:   background-color: $mail_other;
                   5740: }
1.795     www      5741: 
1.938     bisitz   5742: /*
                   5743: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5744:   background-color: $mail_other_hover;
                   5745: }
1.938     bisitz   5746: */
1.494     raeburn  5747: 
1.777     tempelho 5748: table.LC_data_table tr > td.LC_browser_file,
                   5749: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5750:   background: #AAEE77;
1.389     albertel 5751: }
1.795     www      5752: 
1.777     tempelho 5753: table.LC_data_table tr > td.LC_browser_file_locked,
                   5754: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5755:   background: #FFAA99;
1.387     albertel 5756: }
1.795     www      5757: 
1.777     tempelho 5758: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5759:   background: #888888;
1.779     bisitz   5760: }
1.795     www      5761: 
1.777     tempelho 5762: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5763: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5764:   background: #F8F866;
1.777     tempelho 5765: }
1.795     www      5766: 
1.696     bisitz   5767: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5768:   background: #E0E8FF;
1.387     albertel 5769: }
1.696     bisitz   5770: 
1.707     bisitz   5771: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5772:   /* background: #77FF77; */
1.707     bisitz   5773: }
1.795     www      5774: 
1.707     bisitz   5775: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5776:   border-right: 8px solid #FFFF77;
1.707     bisitz   5777: }
1.795     www      5778: 
1.707     bisitz   5779: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5780:   border-right: 8px solid #FFAA77;
1.707     bisitz   5781: }
1.795     www      5782: 
1.707     bisitz   5783: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5784:   border-right: 8px solid #FF7777;
1.707     bisitz   5785: }
1.795     www      5786: 
1.707     bisitz   5787: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5788:   border-right: 8px solid #AAFF77;
1.707     bisitz   5789: }
1.795     www      5790: 
1.707     bisitz   5791: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5792:   border-right: 8px solid #11CC55;
1.707     bisitz   5793: }
                   5794: 
1.388     albertel 5795: span.LC_current_location {
1.701     harmsja  5796:   font-size:larger;
1.388     albertel 5797:   background: $pgbg;
                   5798: }
1.387     albertel 5799: 
1.1029    www      5800: span.LC_current_nav_location {
                   5801:   font-weight:bold;
                   5802:   background: $sidebg;
                   5803: }
                   5804: 
1.395     albertel 5805: span.LC_parm_menu_item {
                   5806:   font-size: larger;
                   5807: }
1.795     www      5808: 
1.395     albertel 5809: span.LC_parm_scope_all {
                   5810:   color: red;
                   5811: }
1.795     www      5812: 
1.395     albertel 5813: span.LC_parm_scope_folder {
                   5814:   color: green;
                   5815: }
1.795     www      5816: 
1.395     albertel 5817: span.LC_parm_scope_resource {
                   5818:   color: orange;
                   5819: }
1.795     www      5820: 
1.395     albertel 5821: span.LC_parm_part {
                   5822:   color: blue;
                   5823: }
1.795     www      5824: 
1.911     bisitz   5825: span.LC_parm_folder,
                   5826: span.LC_parm_symb {
1.395     albertel 5827:   font-size: x-small;
                   5828:   font-family: $mono;
                   5829:   color: #AAAAAA;
                   5830: }
                   5831: 
1.977     bisitz   5832: ul.LC_parm_parmlist li {
                   5833:   display: inline-block;
                   5834:   padding: 0.3em 0.8em;
                   5835:   vertical-align: top;
                   5836:   width: 150px;
                   5837:   border-top:1px solid $lg_border_color;
                   5838: }
                   5839: 
1.795     www      5840: td.LC_parm_overview_level_menu,
                   5841: td.LC_parm_overview_map_menu,
                   5842: td.LC_parm_overview_parm_selectors,
                   5843: td.LC_parm_overview_restrictions  {
1.396     albertel 5844:   border: 1px solid black;
                   5845:   border-collapse: collapse;
                   5846: }
1.795     www      5847: 
1.396     albertel 5848: table.LC_parm_overview_restrictions td {
                   5849:   border-width: 1px 4px 1px 4px;
                   5850:   border-style: solid;
                   5851:   border-color: $pgbg;
                   5852:   text-align: center;
                   5853: }
1.795     www      5854: 
1.396     albertel 5855: table.LC_parm_overview_restrictions th {
                   5856:   background: $tabbg;
                   5857:   border-width: 1px 4px 1px 4px;
                   5858:   border-style: solid;
                   5859:   border-color: $pgbg;
                   5860: }
1.795     www      5861: 
1.398     albertel 5862: table#LC_helpmenu {
1.803     bisitz   5863:   border: none;
1.398     albertel 5864:   height: 55px;
1.803     bisitz   5865:   border-spacing: 0;
1.398     albertel 5866: }
                   5867: 
                   5868: table#LC_helpmenu fieldset legend {
                   5869:   font-size: larger;
                   5870: }
1.795     www      5871: 
1.397     albertel 5872: table#LC_helpmenu_links {
                   5873:   width: 100%;
                   5874:   border: 1px solid black;
                   5875:   background: $pgbg;
1.803     bisitz   5876:   padding: 0;
1.397     albertel 5877:   border-spacing: 1px;
                   5878: }
1.795     www      5879: 
1.397     albertel 5880: table#LC_helpmenu_links tr td {
                   5881:   padding: 1px;
                   5882:   background: $tabbg;
1.399     albertel 5883:   text-align: center;
                   5884:   font-weight: bold;
1.397     albertel 5885: }
1.396     albertel 5886: 
1.795     www      5887: table#LC_helpmenu_links a:link,
                   5888: table#LC_helpmenu_links a:visited,
1.397     albertel 5889: table#LC_helpmenu_links a:active {
                   5890:   text-decoration: none;
                   5891:   color: $font;
                   5892: }
1.795     www      5893: 
1.397     albertel 5894: table#LC_helpmenu_links a:hover {
                   5895:   text-decoration: underline;
                   5896:   color: $vlink;
                   5897: }
1.396     albertel 5898: 
1.417     albertel 5899: .LC_chrt_popup_exists {
                   5900:   border: 1px solid #339933;
                   5901:   margin: -1px;
                   5902: }
1.795     www      5903: 
1.417     albertel 5904: .LC_chrt_popup_up {
                   5905:   border: 1px solid yellow;
                   5906:   margin: -1px;
                   5907: }
1.795     www      5908: 
1.417     albertel 5909: .LC_chrt_popup {
                   5910:   border: 1px solid #8888FF;
                   5911:   background: #CCCCFF;
                   5912: }
1.795     www      5913: 
1.421     albertel 5914: table.LC_pick_box {
                   5915:   border-collapse: separate;
                   5916:   background: white;
                   5917:   border: 1px solid black;
                   5918:   border-spacing: 1px;
                   5919: }
1.795     www      5920: 
1.421     albertel 5921: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5922:   background: $sidebg;
1.421     albertel 5923:   font-weight: bold;
1.900     bisitz   5924:   text-align: left;
1.740     bisitz   5925:   vertical-align: top;
1.421     albertel 5926:   width: 184px;
                   5927:   padding: 8px;
                   5928: }
1.795     www      5929: 
1.579     raeburn  5930: table.LC_pick_box td.LC_pick_box_value {
                   5931:   text-align: left;
                   5932:   padding: 8px;
                   5933: }
1.795     www      5934: 
1.579     raeburn  5935: table.LC_pick_box td.LC_pick_box_select {
                   5936:   text-align: left;
                   5937:   padding: 8px;
                   5938: }
1.795     www      5939: 
1.424     albertel 5940: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5941:   padding: 0;
1.421     albertel 5942:   height: 1px;
                   5943:   background: black;
                   5944: }
1.795     www      5945: 
1.421     albertel 5946: table.LC_pick_box td.LC_pick_box_submit {
                   5947:   text-align: right;
                   5948: }
1.795     www      5949: 
1.579     raeburn  5950: table.LC_pick_box td.LC_evenrow_value {
                   5951:   text-align: left;
                   5952:   padding: 8px;
                   5953:   background-color: $data_table_light;
                   5954: }
1.795     www      5955: 
1.579     raeburn  5956: table.LC_pick_box td.LC_oddrow_value {
                   5957:   text-align: left;
                   5958:   padding: 8px;
                   5959:   background-color: $data_table_light;
                   5960: }
1.795     www      5961: 
1.579     raeburn  5962: span.LC_helpform_receipt_cat {
                   5963:   font-weight: bold;
                   5964: }
1.795     www      5965: 
1.424     albertel 5966: table.LC_group_priv_box {
                   5967:   background: white;
                   5968:   border: 1px solid black;
                   5969:   border-spacing: 1px;
                   5970: }
1.795     www      5971: 
1.424     albertel 5972: table.LC_group_priv_box td.LC_pick_box_title {
                   5973:   background: $tabbg;
                   5974:   font-weight: bold;
                   5975:   text-align: right;
                   5976:   width: 184px;
                   5977: }
1.795     www      5978: 
1.424     albertel 5979: table.LC_group_priv_box td.LC_groups_fixed {
                   5980:   background: $data_table_light;
                   5981:   text-align: center;
                   5982: }
1.795     www      5983: 
1.424     albertel 5984: table.LC_group_priv_box td.LC_groups_optional {
                   5985:   background: $data_table_dark;
                   5986:   text-align: center;
                   5987: }
1.795     www      5988: 
1.424     albertel 5989: table.LC_group_priv_box td.LC_groups_functionality {
                   5990:   background: $data_table_darker;
                   5991:   text-align: center;
                   5992:   font-weight: bold;
                   5993: }
1.795     www      5994: 
1.424     albertel 5995: table.LC_group_priv td {
                   5996:   text-align: left;
1.803     bisitz   5997:   padding: 0;
1.424     albertel 5998: }
                   5999: 
                   6000: .LC_navbuttons {
                   6001:   margin: 2ex 0ex 2ex 0ex;
                   6002: }
1.795     www      6003: 
1.423     albertel 6004: .LC_topic_bar {
                   6005:   font-weight: bold;
                   6006:   background: $tabbg;
1.918     wenzelju 6007:   margin: 1em 0em 1em 2em;
1.805     bisitz   6008:   padding: 3px;
1.918     wenzelju 6009:   font-size: 1.2em;
1.423     albertel 6010: }
1.795     www      6011: 
1.423     albertel 6012: .LC_topic_bar span {
1.918     wenzelju 6013:   left: 0.5em;
                   6014:   position: absolute;
1.423     albertel 6015:   vertical-align: middle;
1.918     wenzelju 6016:   font-size: 1.2em;
1.423     albertel 6017: }
1.795     www      6018: 
1.423     albertel 6019: table.LC_course_group_status {
                   6020:   margin: 20px;
                   6021: }
1.795     www      6022: 
1.423     albertel 6023: table.LC_status_selector td {
                   6024:   vertical-align: top;
                   6025:   text-align: center;
1.424     albertel 6026:   padding: 4px;
                   6027: }
1.795     www      6028: 
1.599     albertel 6029: div.LC_feedback_link {
1.616     albertel 6030:   clear: both;
1.829     kalberla 6031:   background: $sidebg;
1.779     bisitz   6032:   width: 100%;
1.829     kalberla 6033:   padding-bottom: 10px;
                   6034:   border: 1px $tabbg solid;
1.833     kalberla 6035:   height: 22px;
                   6036:   line-height: 22px;
                   6037:   padding-top: 5px;
                   6038: }
                   6039: 
                   6040: div.LC_feedback_link img {
                   6041:   height: 22px;
1.867     kalberla 6042:   vertical-align:middle;
1.829     kalberla 6043: }
                   6044: 
1.911     bisitz   6045: div.LC_feedback_link a {
1.829     kalberla 6046:   text-decoration: none;
1.489     raeburn  6047: }
1.795     www      6048: 
1.867     kalberla 6049: div.LC_comblock {
1.911     bisitz   6050:   display:inline;
1.867     kalberla 6051:   color:$font;
                   6052:   font-size:90%;
                   6053: }
                   6054: 
                   6055: div.LC_feedback_link div.LC_comblock {
                   6056:   padding-left:5px;
                   6057: }
                   6058: 
                   6059: div.LC_feedback_link div.LC_comblock a {
                   6060:   color:$font;
                   6061: }
                   6062: 
1.489     raeburn  6063: span.LC_feedback_link {
1.858     bisitz   6064:   /* background: $feedback_link_bg; */
1.599     albertel 6065:   font-size: larger;
                   6066: }
1.795     www      6067: 
1.599     albertel 6068: span.LC_message_link {
1.858     bisitz   6069:   /* background: $feedback_link_bg; */
1.599     albertel 6070:   font-size: larger;
                   6071:   position: absolute;
                   6072:   right: 1em;
1.489     raeburn  6073: }
1.421     albertel 6074: 
1.515     albertel 6075: table.LC_prior_tries {
1.524     albertel 6076:   border: 1px solid #000000;
                   6077:   border-collapse: separate;
                   6078:   border-spacing: 1px;
1.515     albertel 6079: }
1.523     albertel 6080: 
1.515     albertel 6081: table.LC_prior_tries td {
1.524     albertel 6082:   padding: 2px;
1.515     albertel 6083: }
1.523     albertel 6084: 
                   6085: .LC_answer_correct {
1.795     www      6086:   background: lightgreen;
                   6087:   color: darkgreen;
                   6088:   padding: 6px;
1.523     albertel 6089: }
1.795     www      6090: 
1.523     albertel 6091: .LC_answer_charged_try {
1.797     www      6092:   background: #FFAAAA;
1.795     www      6093:   color: darkred;
                   6094:   padding: 6px;
1.523     albertel 6095: }
1.795     www      6096: 
1.779     bisitz   6097: .LC_answer_not_charged_try,
1.523     albertel 6098: .LC_answer_no_grade,
                   6099: .LC_answer_late {
1.795     www      6100:   background: lightyellow;
1.523     albertel 6101:   color: black;
1.795     www      6102:   padding: 6px;
1.523     albertel 6103: }
1.795     www      6104: 
1.523     albertel 6105: .LC_answer_previous {
1.795     www      6106:   background: lightblue;
                   6107:   color: darkblue;
                   6108:   padding: 6px;
1.523     albertel 6109: }
1.795     www      6110: 
1.779     bisitz   6111: .LC_answer_no_message {
1.777     tempelho 6112:   background: #FFFFFF;
                   6113:   color: black;
1.795     www      6114:   padding: 6px;
1.779     bisitz   6115: }
1.795     www      6116: 
1.779     bisitz   6117: .LC_answer_unknown {
                   6118:   background: orange;
                   6119:   color: black;
1.795     www      6120:   padding: 6px;
1.777     tempelho 6121: }
1.795     www      6122: 
1.529     albertel 6123: span.LC_prior_numerical,
                   6124: span.LC_prior_string,
                   6125: span.LC_prior_custom,
                   6126: span.LC_prior_reaction,
                   6127: span.LC_prior_math {
1.925     bisitz   6128:   font-family: $mono;
1.523     albertel 6129:   white-space: pre;
                   6130: }
                   6131: 
1.525     albertel 6132: span.LC_prior_string {
1.925     bisitz   6133:   font-family: $mono;
1.525     albertel 6134:   white-space: pre;
                   6135: }
                   6136: 
1.523     albertel 6137: table.LC_prior_option {
                   6138:   width: 100%;
                   6139:   border-collapse: collapse;
                   6140: }
1.795     www      6141: 
1.911     bisitz   6142: table.LC_prior_rank,
1.795     www      6143: table.LC_prior_match {
1.528     albertel 6144:   border-collapse: collapse;
                   6145: }
1.795     www      6146: 
1.528     albertel 6147: table.LC_prior_option tr td,
                   6148: table.LC_prior_rank tr td,
                   6149: table.LC_prior_match tr td {
1.524     albertel 6150:   border: 1px solid #000000;
1.515     albertel 6151: }
                   6152: 
1.855     bisitz   6153: .LC_nobreak {
1.544     albertel 6154:   white-space: nowrap;
1.519     raeburn  6155: }
                   6156: 
1.576     raeburn  6157: span.LC_cusr_emph {
                   6158:   font-style: italic;
                   6159: }
                   6160: 
1.633     raeburn  6161: span.LC_cusr_subheading {
                   6162:   font-weight: normal;
                   6163:   font-size: 85%;
                   6164: }
                   6165: 
1.861     bisitz   6166: div.LC_docs_entry_move {
1.859     bisitz   6167:   border: 1px solid #BBBBBB;
1.545     albertel 6168:   background: #DDDDDD;
1.861     bisitz   6169:   width: 22px;
1.859     bisitz   6170:   padding: 1px;
                   6171:   margin: 0;
1.545     albertel 6172: }
                   6173: 
1.861     bisitz   6174: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6175: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6176:   background: #DDDDDD;
                   6177:   font-size: x-small;
                   6178: }
1.795     www      6179: 
1.861     bisitz   6180: .LC_docs_entry_parameter {
                   6181:   white-space: nowrap;
                   6182: }
                   6183: 
1.544     albertel 6184: .LC_docs_copy {
1.545     albertel 6185:   color: #000099;
1.544     albertel 6186: }
1.795     www      6187: 
1.544     albertel 6188: .LC_docs_cut {
1.545     albertel 6189:   color: #550044;
1.544     albertel 6190: }
1.795     www      6191: 
1.544     albertel 6192: .LC_docs_rename {
1.545     albertel 6193:   color: #009900;
1.544     albertel 6194: }
1.795     www      6195: 
1.544     albertel 6196: .LC_docs_remove {
1.545     albertel 6197:   color: #990000;
                   6198: }
                   6199: 
1.547     albertel 6200: .LC_docs_reinit_warn,
                   6201: .LC_docs_ext_edit {
                   6202:   font-size: x-small;
                   6203: }
                   6204: 
1.545     albertel 6205: table.LC_docs_adddocs td,
                   6206: table.LC_docs_adddocs th {
                   6207:   border: 1px solid #BBBBBB;
                   6208:   padding: 4px;
                   6209:   background: #DDDDDD;
1.543     albertel 6210: }
                   6211: 
1.584     albertel 6212: table.LC_sty_begin {
                   6213:   background: #BBFFBB;
                   6214: }
1.795     www      6215: 
1.584     albertel 6216: table.LC_sty_end {
                   6217:   background: #FFBBBB;
                   6218: }
                   6219: 
1.589     raeburn  6220: table.LC_double_column {
1.803     bisitz   6221:   border-width: 0;
1.589     raeburn  6222:   border-collapse: collapse;
                   6223:   width: 100%;
                   6224:   padding: 2px;
                   6225: }
                   6226: 
                   6227: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6228:   top: 2px;
1.589     raeburn  6229:   left: 2px;
                   6230:   width: 47%;
                   6231:   vertical-align: top;
                   6232: }
                   6233: 
                   6234: table.LC_double_column tr td.LC_right_col {
                   6235:   top: 2px;
1.779     bisitz   6236:   right: 2px;
1.589     raeburn  6237:   width: 47%;
                   6238:   vertical-align: top;
                   6239: }
                   6240: 
1.591     raeburn  6241: div.LC_left_float {
                   6242:   float: left;
                   6243:   padding-right: 5%;
1.597     albertel 6244:   padding-bottom: 4px;
1.591     raeburn  6245: }
                   6246: 
                   6247: div.LC_clear_float_header {
1.597     albertel 6248:   padding-bottom: 2px;
1.591     raeburn  6249: }
                   6250: 
                   6251: div.LC_clear_float_footer {
1.597     albertel 6252:   padding-top: 10px;
1.591     raeburn  6253:   clear: both;
                   6254: }
                   6255: 
1.597     albertel 6256: div.LC_grade_show_user {
1.941     bisitz   6257: /*  border-left: 5px solid $sidebg; */
                   6258:   border-top: 5px solid #000000;
                   6259:   margin: 50px 0 0 0;
1.936     bisitz   6260:   padding: 15px 0 5px 10px;
1.597     albertel 6261: }
1.795     www      6262: 
1.936     bisitz   6263: div.LC_grade_show_user_odd_row {
1.941     bisitz   6264: /*  border-left: 5px solid #000000; */
                   6265: }
                   6266: 
                   6267: div.LC_grade_show_user div.LC_Box {
                   6268:   margin-right: 50px;
1.597     albertel 6269: }
                   6270: 
                   6271: div.LC_grade_submissions,
                   6272: div.LC_grade_message_center,
1.936     bisitz   6273: div.LC_grade_info_links {
1.597     albertel 6274:   margin: 5px;
                   6275:   width: 99%;
                   6276:   background: #FFFFFF;
                   6277: }
1.795     www      6278: 
1.597     albertel 6279: div.LC_grade_submissions_header,
1.936     bisitz   6280: div.LC_grade_message_center_header {
1.705     tempelho 6281:   font-weight: bold;
                   6282:   font-size: large;
1.597     albertel 6283: }
1.795     www      6284: 
1.597     albertel 6285: div.LC_grade_submissions_body,
1.936     bisitz   6286: div.LC_grade_message_center_body {
1.597     albertel 6287:   border: 1px solid black;
                   6288:   width: 99%;
                   6289:   background: #FFFFFF;
                   6290: }
1.795     www      6291: 
1.613     albertel 6292: table.LC_scantron_action {
                   6293:   width: 100%;
                   6294: }
1.795     www      6295: 
1.613     albertel 6296: table.LC_scantron_action tr th {
1.698     harmsja  6297:   font-weight:bold;
                   6298:   font-style:normal;
1.613     albertel 6299: }
1.795     www      6300: 
1.779     bisitz   6301: .LC_edit_problem_header,
1.614     albertel 6302: div.LC_edit_problem_footer {
1.705     tempelho 6303:   font-weight: normal;
                   6304:   font-size:  medium;
1.602     albertel 6305:   margin: 2px;
1.1060    bisitz   6306:   background-color: $sidebg;
1.600     albertel 6307: }
1.795     www      6308: 
1.600     albertel 6309: div.LC_edit_problem_header,
1.602     albertel 6310: div.LC_edit_problem_header div,
1.614     albertel 6311: div.LC_edit_problem_footer,
                   6312: div.LC_edit_problem_footer div,
1.602     albertel 6313: div.LC_edit_problem_editxml_header,
                   6314: div.LC_edit_problem_editxml_header div {
1.600     albertel 6315:   margin-top: 5px;
                   6316: }
1.795     www      6317: 
1.600     albertel 6318: div.LC_edit_problem_header_title {
1.705     tempelho 6319:   font-weight: bold;
                   6320:   font-size: larger;
1.602     albertel 6321:   background: $tabbg;
                   6322:   padding: 3px;
1.1060    bisitz   6323:   margin: 0 0 5px 0;
1.602     albertel 6324: }
1.795     www      6325: 
1.602     albertel 6326: table.LC_edit_problem_header_title {
                   6327:   width: 100%;
1.600     albertel 6328:   background: $tabbg;
1.602     albertel 6329: }
                   6330: 
                   6331: div.LC_edit_problem_discards {
                   6332:   float: left;
                   6333:   padding-bottom: 5px;
                   6334: }
1.795     www      6335: 
1.602     albertel 6336: div.LC_edit_problem_saves {
                   6337:   float: right;
                   6338:   padding-bottom: 5px;
1.600     albertel 6339: }
1.795     www      6340: 
1.911     bisitz   6341: img.stift {
1.803     bisitz   6342:   border-width: 0;
                   6343:   vertical-align: middle;
1.677     riegler  6344: }
1.680     riegler  6345: 
1.923     bisitz   6346: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6347:   vertical-align: top;
1.777     tempelho 6348: }
1.795     www      6349: 
1.716     raeburn  6350: div.LC_createcourse {
1.911     bisitz   6351:   margin: 10px 10px 10px 10px;
1.716     raeburn  6352: }
                   6353: 
1.917     raeburn  6354: .LC_dccid {
                   6355:   margin: 0.2em 0 0 0;
                   6356:   padding: 0;
                   6357:   font-size: 90%;
                   6358:   display:none;
                   6359: }
                   6360: 
1.897     wenzelju 6361: ol.LC_primary_menu a:hover,
1.721     harmsja  6362: ol#LC_MenuBreadcrumbs a:hover,
                   6363: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6364: ul#LC_secondary_menu a:hover,
1.721     harmsja  6365: .LC_FormSectionClearButton input:hover
1.795     www      6366: ul.LC_TabContent   li:hover a {
1.952     onken    6367:   color:$button_hover;
1.911     bisitz   6368:   text-decoration:none;
1.693     droeschl 6369: }
                   6370: 
1.779     bisitz   6371: h1 {
1.911     bisitz   6372:   padding: 0;
                   6373:   line-height:130%;
1.693     droeschl 6374: }
1.698     harmsja  6375: 
1.911     bisitz   6376: h2,
                   6377: h3,
                   6378: h4,
                   6379: h5,
                   6380: h6 {
                   6381:   margin: 5px 0 5px 0;
                   6382:   padding: 0;
                   6383:   line-height:130%;
1.693     droeschl 6384: }
1.795     www      6385: 
                   6386: .LC_hcell {
1.911     bisitz   6387:   padding:3px 15px 3px 15px;
                   6388:   margin: 0;
                   6389:   background-color:$tabbg;
                   6390:   color:$fontmenu;
                   6391:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6392: }
1.795     www      6393: 
1.840     bisitz   6394: .LC_Box > .LC_hcell {
1.911     bisitz   6395:   margin: 0 -10px 10px -10px;
1.835     bisitz   6396: }
                   6397: 
1.721     harmsja  6398: .LC_noBorder {
1.911     bisitz   6399:   border: 0;
1.698     harmsja  6400: }
1.693     droeschl 6401: 
1.721     harmsja  6402: .LC_FormSectionClearButton input {
1.911     bisitz   6403:   background-color:transparent;
                   6404:   border: none;
                   6405:   cursor:pointer;
                   6406:   text-decoration:underline;
1.693     droeschl 6407: }
1.763     bisitz   6408: 
                   6409: .LC_help_open_topic {
1.911     bisitz   6410:   color: #FFFFFF;
                   6411:   background-color: #EEEEFF;
                   6412:   margin: 1px;
                   6413:   padding: 4px;
                   6414:   border: 1px solid #000033;
                   6415:   white-space: nowrap;
                   6416:   /* vertical-align: middle; */
1.759     neumanie 6417: }
1.693     droeschl 6418: 
1.911     bisitz   6419: dl,
                   6420: ul,
                   6421: div,
                   6422: fieldset {
                   6423:   margin: 10px 10px 10px 0;
                   6424:   /* overflow: hidden; */
1.693     droeschl 6425: }
1.795     www      6426: 
1.838     bisitz   6427: fieldset > legend {
1.911     bisitz   6428:   font-weight: bold;
                   6429:   padding: 0 5px 0 5px;
1.838     bisitz   6430: }
                   6431: 
1.813     bisitz   6432: #LC_nav_bar {
1.911     bisitz   6433:   float: left;
1.995     raeburn  6434:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6435:   margin: 0 0 2px 0;
1.807     droeschl 6436: }
                   6437: 
1.916     droeschl 6438: #LC_realm {
                   6439:   margin: 0.2em 0 0 0;
                   6440:   padding: 0;
                   6441:   font-weight: bold;
                   6442:   text-align: center;
1.995     raeburn  6443:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6444: }
                   6445: 
1.911     bisitz   6446: #LC_nav_bar em {
                   6447:   font-weight: bold;
                   6448:   font-style: normal;
1.807     droeschl 6449: }
                   6450: 
1.897     wenzelju 6451: ol.LC_primary_menu {
1.911     bisitz   6452:   float: right;
1.934     droeschl 6453:   margin: 0;
1.1075.2.2  raeburn  6454:   padding: 0;
1.995     raeburn  6455:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6456: }
                   6457: 
1.852     droeschl 6458: ol#LC_PathBreadcrumbs {
1.911     bisitz   6459:   margin: 0;
1.693     droeschl 6460: }
                   6461: 
1.897     wenzelju 6462: ol.LC_primary_menu li {
1.1075.2.2  raeburn  6463:   color: RGB(80, 80, 80);
                   6464:   vertical-align: middle;
                   6465:   text-align: left;
                   6466:   list-style: none;
                   6467:   float: left;
                   6468: }
                   6469: 
                   6470: ol.LC_primary_menu li a {
                   6471:   display: block;
                   6472:   margin: 0;
                   6473:   padding: 0 5px 0 10px;
                   6474:   text-decoration: none;
                   6475: }
                   6476: 
                   6477: ol.LC_primary_menu li ul {
                   6478:   display: none;
                   6479:   width: 10em;
                   6480:   background-color: $data_table_light;
                   6481: }
                   6482: 
                   6483: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
                   6484:   display: block;
                   6485:   position: absolute;
                   6486:   margin: 0;
                   6487:   padding: 0;
1.1075.2.5  raeburn  6488:   z-index: 2;
1.1075.2.2  raeburn  6489: }
                   6490: 
                   6491: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
                   6492:   font-size: 90%;
1.911     bisitz   6493:   vertical-align: top;
1.1075.2.2  raeburn  6494:   float: none;
1.1075.2.5  raeburn  6495:   border-left: 1px solid black;
                   6496:   border-right: 1px solid black;
1.1075.2.2  raeburn  6497: }
                   6498: 
                   6499: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1075.2.5  raeburn  6500:   background-color:$data_table_light;
1.1075.2.2  raeburn  6501: }
                   6502: 
                   6503: ol.LC_primary_menu li li a:hover {
                   6504:    color:$button_hover;
                   6505:    background-color:$data_table_dark;
1.693     droeschl 6506: }
                   6507: 
1.897     wenzelju 6508: ol.LC_primary_menu li img {
1.911     bisitz   6509:   vertical-align: bottom;
1.934     droeschl 6510:   height: 1.1em;
1.1075.2.3  raeburn  6511:   margin: 0.2em 0 0 0;
1.693     droeschl 6512: }
                   6513: 
1.897     wenzelju 6514: ol.LC_primary_menu a {
1.911     bisitz   6515:   color: RGB(80, 80, 80);
                   6516:   text-decoration: none;
1.693     droeschl 6517: }
1.795     www      6518: 
1.949     droeschl 6519: ol.LC_primary_menu a.LC_new_message {
                   6520:   font-weight:bold;
                   6521:   color: darkred;
                   6522: }
                   6523: 
1.975     raeburn  6524: ol.LC_docs_parameters {
                   6525:   margin-left: 0;
                   6526:   padding: 0;
                   6527:   list-style: none;
                   6528: }
                   6529: 
                   6530: ol.LC_docs_parameters li {
                   6531:   margin: 0;
                   6532:   padding-right: 20px;
                   6533:   display: inline;
                   6534: }
                   6535: 
1.976     raeburn  6536: ol.LC_docs_parameters li:before {
                   6537:   content: "\\002022 \\0020";
                   6538: }
                   6539: 
                   6540: li.LC_docs_parameters_title {
                   6541:   font-weight: bold;
                   6542: }
                   6543: 
                   6544: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6545:   content: "";
                   6546: }
                   6547: 
1.897     wenzelju 6548: ul#LC_secondary_menu {
1.911     bisitz   6549:   clear: both;
                   6550:   color: $fontmenu;
                   6551:   background: $tabbg;
                   6552:   list-style: none;
                   6553:   padding: 0;
                   6554:   margin: 0;
                   6555:   width: 100%;
1.995     raeburn  6556:   text-align: left;
1.1075.2.4  raeburn  6557:   float: left;
1.808     droeschl 6558: }
                   6559: 
1.897     wenzelju 6560: ul#LC_secondary_menu li {
1.911     bisitz   6561:   font-weight: bold;
                   6562:   line-height: 1.8em;
                   6563:   border-right: 1px solid black;
                   6564:   vertical-align: middle;
1.1075.2.4  raeburn  6565:   float: left;
                   6566: }
                   6567: 
                   6568: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   6569:   background-color: $data_table_light;
                   6570: }
                   6571: 
                   6572: ul#LC_secondary_menu li a {
                   6573:   padding: 0 0.8em;
                   6574: }
                   6575: 
                   6576: ul#LC_secondary_menu li ul {
                   6577:   display: none;
                   6578: }
                   6579: 
                   6580: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   6581:   display: block;
                   6582:   position: absolute;
                   6583:   margin: 0;
                   6584:   padding: 0;
                   6585:   list-style:none;
                   6586:   float: none;
                   6587:   background-color: $data_table_light;
1.1075.2.5  raeburn  6588:   z-index: 2;
1.1075.2.4  raeburn  6589: }
                   6590: 
                   6591: ul#LC_secondary_menu li ul li {
                   6592:   font-size: 90%;
                   6593:   vertical-align: top;
                   6594:   border-left: 1px solid black;
                   6595:   border-right: 1px solid black;
                   6596:   background-color: $data_table_light
                   6597:   list-style:none;
                   6598:   float: none;
1.1075.2.8  raeburn  6599:   margin-left: -1px;
1.1075.2.4  raeburn  6600: }
                   6601: 
                   6602: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   6603:   background-color: $data_table_dark;
1.807     droeschl 6604: }
                   6605: 
1.847     tempelho 6606: ul.LC_TabContent {
1.911     bisitz   6607:   display:block;
                   6608:   background: $sidebg;
                   6609:   border-bottom: solid 1px $lg_border_color;
                   6610:   list-style:none;
1.1020    raeburn  6611:   margin: -1px -10px 0 -10px;
1.911     bisitz   6612:   padding: 0;
1.693     droeschl 6613: }
                   6614: 
1.795     www      6615: ul.LC_TabContent li,
                   6616: ul.LC_TabContentBigger li {
1.911     bisitz   6617:   float:left;
1.741     harmsja  6618: }
1.795     www      6619: 
1.897     wenzelju 6620: ul#LC_secondary_menu li a {
1.911     bisitz   6621:   color: $fontmenu;
                   6622:   text-decoration: none;
1.693     droeschl 6623: }
1.795     www      6624: 
1.721     harmsja  6625: ul.LC_TabContent {
1.952     onken    6626:   min-height:20px;
1.721     harmsja  6627: }
1.795     www      6628: 
                   6629: ul.LC_TabContent li {
1.911     bisitz   6630:   vertical-align:middle;
1.959     onken    6631:   padding: 0 16px 0 10px;
1.911     bisitz   6632:   background-color:$tabbg;
                   6633:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6634:   border-left: solid 1px $font;
1.721     harmsja  6635: }
1.795     www      6636: 
1.847     tempelho 6637: ul.LC_TabContent .right {
1.911     bisitz   6638:   float:right;
1.847     tempelho 6639: }
                   6640: 
1.911     bisitz   6641: ul.LC_TabContent li a,
                   6642: ul.LC_TabContent li {
                   6643:   color:rgb(47,47,47);
                   6644:   text-decoration:none;
                   6645:   font-size:95%;
                   6646:   font-weight:bold;
1.952     onken    6647:   min-height:20px;
                   6648: }
                   6649: 
1.959     onken    6650: ul.LC_TabContent li a:hover,
                   6651: ul.LC_TabContent li a:focus {
1.952     onken    6652:   color: $button_hover;
1.959     onken    6653:   background:none;
                   6654:   outline:none;
1.952     onken    6655: }
                   6656: 
                   6657: ul.LC_TabContent li:hover {
                   6658:   color: $button_hover;
                   6659:   cursor:pointer;
1.721     harmsja  6660: }
1.795     www      6661: 
1.911     bisitz   6662: ul.LC_TabContent li.active {
1.952     onken    6663:   color: $font;
1.911     bisitz   6664:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6665:   border-bottom:solid 1px #FFFFFF;
                   6666:   cursor: default;
1.744     ehlerst  6667: }
1.795     www      6668: 
1.959     onken    6669: ul.LC_TabContent li.active a {
                   6670:   color:$font;
                   6671:   background:#FFFFFF;
                   6672:   outline: none;
                   6673: }
1.1047    raeburn  6674: 
                   6675: ul.LC_TabContent li.goback {
                   6676:   float: left;
                   6677:   border-left: none;
                   6678: }
                   6679: 
1.870     tempelho 6680: #maincoursedoc {
1.911     bisitz   6681:   clear:both;
1.870     tempelho 6682: }
                   6683: 
                   6684: ul.LC_TabContentBigger {
1.911     bisitz   6685:   display:block;
                   6686:   list-style:none;
                   6687:   padding: 0;
1.870     tempelho 6688: }
                   6689: 
1.795     www      6690: ul.LC_TabContentBigger li {
1.911     bisitz   6691:   vertical-align:bottom;
                   6692:   height: 30px;
                   6693:   font-size:110%;
                   6694:   font-weight:bold;
                   6695:   color: #737373;
1.841     tempelho 6696: }
                   6697: 
1.957     onken    6698: ul.LC_TabContentBigger li.active {
                   6699:   position: relative;
                   6700:   top: 1px;
                   6701: }
                   6702: 
1.870     tempelho 6703: ul.LC_TabContentBigger li a {
1.911     bisitz   6704:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6705:   height: 30px;
                   6706:   line-height: 30px;
                   6707:   text-align: center;
                   6708:   display: block;
                   6709:   text-decoration: none;
1.958     onken    6710:   outline: none;  
1.741     harmsja  6711: }
1.795     www      6712: 
1.870     tempelho 6713: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6714:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6715:   color:$font;
1.744     ehlerst  6716: }
1.795     www      6717: 
1.870     tempelho 6718: ul.LC_TabContentBigger li b {
1.911     bisitz   6719:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6720:   display: block;
                   6721:   float: left;
                   6722:   padding: 0 30px;
1.957     onken    6723:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6724: }
                   6725: 
1.956     onken    6726: ul.LC_TabContentBigger li:hover b {
                   6727:   color:$button_hover;
                   6728: }
                   6729: 
1.870     tempelho 6730: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6731:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6732:   color:$font;
1.957     onken    6733:   border: 0;
1.741     harmsja  6734: }
1.693     droeschl 6735: 
1.870     tempelho 6736: 
1.862     bisitz   6737: ul.LC_CourseBreadcrumbs {
                   6738:   background: $sidebg;
1.1020    raeburn  6739:   height: 2em;
1.862     bisitz   6740:   padding-left: 10px;
1.1020    raeburn  6741:   margin: 0;
1.862     bisitz   6742:   list-style-position: inside;
                   6743: }
                   6744: 
1.911     bisitz   6745: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6746: ol#LC_PathBreadcrumbs {
1.911     bisitz   6747:   padding-left: 10px;
                   6748:   margin: 0;
1.933     droeschl 6749:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6750: }
                   6751: 
1.911     bisitz   6752: ol#LC_MenuBreadcrumbs li,
                   6753: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6754: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6755:   display: inline;
1.933     droeschl 6756:   white-space: normal;  
1.693     droeschl 6757: }
                   6758: 
1.823     bisitz   6759: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6760: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6761:   text-decoration: none;
                   6762:   font-size:90%;
1.693     droeschl 6763: }
1.795     www      6764: 
1.969     droeschl 6765: ol#LC_MenuBreadcrumbs h1 {
                   6766:   display: inline;
                   6767:   font-size: 90%;
                   6768:   line-height: 2.5em;
                   6769:   margin: 0;
                   6770:   padding: 0;
                   6771: }
                   6772: 
1.795     www      6773: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6774:   text-decoration:none;
                   6775:   font-size:100%;
                   6776:   font-weight:bold;
1.693     droeschl 6777: }
1.795     www      6778: 
1.840     bisitz   6779: .LC_Box {
1.911     bisitz   6780:   border: solid 1px $lg_border_color;
                   6781:   padding: 0 10px 10px 10px;
1.746     neumanie 6782: }
1.795     www      6783: 
1.1020    raeburn  6784: .LC_DocsBox {
                   6785:   border: solid 1px $lg_border_color;
                   6786:   padding: 0 0 10px 10px;
                   6787: }
                   6788: 
1.795     www      6789: .LC_AboutMe_Image {
1.911     bisitz   6790:   float:left;
                   6791:   margin-right:10px;
1.747     neumanie 6792: }
1.795     www      6793: 
                   6794: .LC_Clear_AboutMe_Image {
1.911     bisitz   6795:   clear:left;
1.747     neumanie 6796: }
1.795     www      6797: 
1.721     harmsja  6798: dl.LC_ListStyleClean dt {
1.911     bisitz   6799:   padding-right: 5px;
                   6800:   display: table-header-group;
1.693     droeschl 6801: }
                   6802: 
1.721     harmsja  6803: dl.LC_ListStyleClean dd {
1.911     bisitz   6804:   display: table-row;
1.693     droeschl 6805: }
                   6806: 
1.721     harmsja  6807: .LC_ListStyleClean,
                   6808: .LC_ListStyleSimple,
                   6809: .LC_ListStyleNormal,
1.795     www      6810: .LC_ListStyleSpecial {
1.911     bisitz   6811:   /* display:block; */
                   6812:   list-style-position: inside;
                   6813:   list-style-type: none;
                   6814:   overflow: hidden;
                   6815:   padding: 0;
1.693     droeschl 6816: }
                   6817: 
1.721     harmsja  6818: .LC_ListStyleSimple li,
                   6819: .LC_ListStyleSimple dd,
                   6820: .LC_ListStyleNormal li,
                   6821: .LC_ListStyleNormal dd,
                   6822: .LC_ListStyleSpecial li,
1.795     www      6823: .LC_ListStyleSpecial dd {
1.911     bisitz   6824:   margin: 0;
                   6825:   padding: 5px 5px 5px 10px;
                   6826:   clear: both;
1.693     droeschl 6827: }
                   6828: 
1.721     harmsja  6829: .LC_ListStyleClean li,
                   6830: .LC_ListStyleClean dd {
1.911     bisitz   6831:   padding-top: 0;
                   6832:   padding-bottom: 0;
1.693     droeschl 6833: }
                   6834: 
1.721     harmsja  6835: .LC_ListStyleSimple dd,
1.795     www      6836: .LC_ListStyleSimple li {
1.911     bisitz   6837:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6838: }
                   6839: 
1.721     harmsja  6840: .LC_ListStyleSpecial li,
                   6841: .LC_ListStyleSpecial dd {
1.911     bisitz   6842:   list-style-type: none;
                   6843:   background-color: RGB(220, 220, 220);
                   6844:   margin-bottom: 4px;
1.693     droeschl 6845: }
                   6846: 
1.721     harmsja  6847: table.LC_SimpleTable {
1.911     bisitz   6848:   margin:5px;
                   6849:   border:solid 1px $lg_border_color;
1.795     www      6850: }
1.693     droeschl 6851: 
1.721     harmsja  6852: table.LC_SimpleTable tr {
1.911     bisitz   6853:   padding: 0;
                   6854:   border:solid 1px $lg_border_color;
1.693     droeschl 6855: }
1.795     www      6856: 
                   6857: table.LC_SimpleTable thead {
1.911     bisitz   6858:   background:rgb(220,220,220);
1.693     droeschl 6859: }
                   6860: 
1.721     harmsja  6861: div.LC_columnSection {
1.911     bisitz   6862:   display: block;
                   6863:   clear: both;
                   6864:   overflow: hidden;
                   6865:   margin: 0;
1.693     droeschl 6866: }
                   6867: 
1.721     harmsja  6868: div.LC_columnSection>* {
1.911     bisitz   6869:   float: left;
                   6870:   margin: 10px 20px 10px 0;
                   6871:   overflow:hidden;
1.693     droeschl 6872: }
1.721     harmsja  6873: 
1.795     www      6874: table em {
1.911     bisitz   6875:   font-weight: bold;
                   6876:   font-style: normal;
1.748     schulted 6877: }
1.795     www      6878: 
1.779     bisitz   6879: table.LC_tableBrowseRes,
1.795     www      6880: table.LC_tableOfContent {
1.911     bisitz   6881:   border:none;
                   6882:   border-spacing: 1px;
                   6883:   padding: 3px;
                   6884:   background-color: #FFFFFF;
                   6885:   font-size: 90%;
1.753     droeschl 6886: }
1.789     droeschl 6887: 
1.911     bisitz   6888: table.LC_tableOfContent {
                   6889:   border-collapse: collapse;
1.789     droeschl 6890: }
                   6891: 
1.771     droeschl 6892: table.LC_tableBrowseRes a,
1.768     schulted 6893: table.LC_tableOfContent a {
1.911     bisitz   6894:   background-color: transparent;
                   6895:   text-decoration: none;
1.753     droeschl 6896: }
                   6897: 
1.795     www      6898: table.LC_tableOfContent img {
1.911     bisitz   6899:   border: none;
                   6900:   height: 1.3em;
                   6901:   vertical-align: text-bottom;
                   6902:   margin-right: 0.3em;
1.753     droeschl 6903: }
1.757     schulted 6904: 
1.795     www      6905: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6906:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6907: }
                   6908: 
1.795     www      6909: a#LC_content_toolbar_everything {
1.911     bisitz   6910:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6911: }
                   6912: 
1.795     www      6913: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6914:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6915: }
                   6916: 
1.795     www      6917: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6918:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6919: }
                   6920: 
1.795     www      6921: a#LC_content_toolbar_changefolder {
1.911     bisitz   6922:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6923: }
                   6924: 
1.795     www      6925: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6926:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6927: }
                   6928: 
1.1043    raeburn  6929: a#LC_content_toolbar_edittoplevel {
                   6930:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6931: }
                   6932: 
1.795     www      6933: ul#LC_toolbar li a:hover {
1.911     bisitz   6934:   background-position: bottom center;
1.757     schulted 6935: }
                   6936: 
1.795     www      6937: ul#LC_toolbar {
1.911     bisitz   6938:   padding: 0;
                   6939:   margin: 2px;
                   6940:   list-style:none;
                   6941:   position:relative;
                   6942:   background-color:white;
1.1075.2.9! raeburn  6943:   overflow: auto;
1.757     schulted 6944: }
                   6945: 
1.795     www      6946: ul#LC_toolbar li {
1.911     bisitz   6947:   border:1px solid white;
                   6948:   padding: 0;
                   6949:   margin: 0;
                   6950:   float: left;
                   6951:   display:inline;
                   6952:   vertical-align:middle;
1.1075.2.9! raeburn  6953:   white-space: nowrap;
1.911     bisitz   6954: }
1.757     schulted 6955: 
1.783     amueller 6956: 
1.795     www      6957: a.LC_toolbarItem {
1.911     bisitz   6958:   display:block;
                   6959:   padding: 0;
                   6960:   margin: 0;
                   6961:   height: 32px;
                   6962:   width: 32px;
                   6963:   color:white;
                   6964:   border: none;
                   6965:   background-repeat:no-repeat;
                   6966:   background-color:transparent;
1.757     schulted 6967: }
                   6968: 
1.915     droeschl 6969: ul.LC_funclist {
                   6970:     margin: 0;
                   6971:     padding: 0.5em 1em 0.5em 0;
                   6972: }
                   6973: 
1.933     droeschl 6974: ul.LC_funclist > li:first-child {
                   6975:     font-weight:bold; 
                   6976:     margin-left:0.8em;
                   6977: }
                   6978: 
1.915     droeschl 6979: ul.LC_funclist + ul.LC_funclist {
                   6980:     /* 
                   6981:        left border as a seperator if we have more than
                   6982:        one list 
                   6983:     */
                   6984:     border-left: 1px solid $sidebg;
                   6985:     /* 
                   6986:        this hides the left border behind the border of the 
                   6987:        outer box if element is wrapped to the next 'line' 
                   6988:     */
                   6989:     margin-left: -1px;
                   6990: }
                   6991: 
1.843     bisitz   6992: ul.LC_funclist li {
1.915     droeschl 6993:   display: inline;
1.782     bisitz   6994:   white-space: nowrap;
1.915     droeschl 6995:   margin: 0 0 0 25px;
                   6996:   line-height: 150%;
1.782     bisitz   6997: }
                   6998: 
1.974     wenzelju 6999: .LC_hidden {
                   7000:   display: none;
                   7001: }
                   7002: 
1.1030    www      7003: .LCmodal-overlay {
                   7004: 		position:fixed;
                   7005: 		top:0;
                   7006: 		right:0;
                   7007: 		bottom:0;
                   7008: 		left:0;
                   7009: 		height:100%;
                   7010: 		width:100%;
                   7011: 		margin:0;
                   7012: 		padding:0;
                   7013: 		background:#999;
                   7014: 		opacity:.75;
                   7015: 		filter: alpha(opacity=75);
                   7016: 		-moz-opacity: 0.75;
                   7017: 		z-index:101;
                   7018: }
                   7019: 
                   7020: * html .LCmodal-overlay {   
                   7021: 		position: absolute;
                   7022: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7023: }
                   7024: 
                   7025: .LCmodal-window {
                   7026: 		position:fixed;
                   7027: 		top:50%;
                   7028: 		left:50%;
                   7029: 		margin:0;
                   7030: 		padding:0;
                   7031: 		z-index:102;
                   7032: 	}
                   7033: 
                   7034: * html .LCmodal-window {
                   7035: 		position:absolute;
                   7036: }
                   7037: 
                   7038: .LCclose-window {
                   7039: 		position:absolute;
                   7040: 		width:32px;
                   7041: 		height:32px;
                   7042: 		right:8px;
                   7043: 		top:8px;
                   7044: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7045: 		text-indent:-99999px;
                   7046: 		overflow:hidden;
                   7047: 		cursor:pointer;
                   7048: }
                   7049: 
1.343     albertel 7050: END
                   7051: }
                   7052: 
1.306     albertel 7053: =pod
                   7054: 
                   7055: =item * &headtag()
                   7056: 
                   7057: Returns a uniform footer for LON-CAPA web pages.
                   7058: 
1.307     albertel 7059: Inputs: $title - optional title for the head
                   7060:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7061:         $args - optional arguments
1.319     albertel 7062:             force_register - if is true call registerurl so the remote is 
                   7063:                              informed
1.415     albertel 7064:             redirect       -> array ref of
                   7065:                                    1- seconds before redirect occurs
                   7066:                                    2- url to redirect to
                   7067:                                    3- whether the side effect should occur
1.315     albertel 7068:                            (side effect of setting 
                   7069:                                $env{'internal.head.redirect'} to the url 
                   7070:                                redirected too)
1.352     albertel 7071:             domain         -> force to color decorate a page for a specific
                   7072:                                domain
                   7073:             function       -> force usage of a specific rolish color scheme
                   7074:             bgcolor        -> override the default page bgcolor
1.460     albertel 7075:             no_auto_mt_title
                   7076:                            -> prevent &mt()ing the title arg
1.464     albertel 7077: 
1.306     albertel 7078: =cut
                   7079: 
                   7080: sub headtag {
1.313     albertel 7081:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7082:     
1.363     albertel 7083:     my $function = $args->{'function'} || &get_users_function();
                   7084:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7085:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 7086:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7087: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7088: 		   #time(),
1.418     albertel 7089: 		   $env{'environment.color.timestamp'},
1.363     albertel 7090: 		   $function,$domain,$bgcolor);
                   7091: 
1.369     www      7092:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7093: 
1.308     albertel 7094:     my $result =
                   7095: 	'<head>'.
1.461     albertel 7096: 	&font_settings();
1.319     albertel 7097: 
1.1064    raeburn  7098:     my $inhibitprint = &print_suppression();
                   7099: 
1.461     albertel 7100:     if (!$args->{'frameset'}) {
                   7101: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7102:     }
1.962     droeschl 7103:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   7104:         $result .= Apache::lonxml::display_title();
1.319     albertel 7105:     }
1.436     albertel 7106:     if (!$args->{'no_nav_bar'} 
                   7107: 	&& !$args->{'only_body'}
                   7108: 	&& !$args->{'frameset'}) {
                   7109: 	$result .= &help_menu_js();
1.1032    www      7110:         $result.=&modal_window();
1.1038    www      7111:         $result.=&togglebox_script();
1.1034    www      7112:         $result.=&wishlist_window();
1.1041    www      7113:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7114:     } else {
                   7115:         if ($args->{'add_modal'}) {
                   7116:            $result.=&modal_window();
                   7117:         }
                   7118:         if ($args->{'add_wishlist'}) {
                   7119:            $result.=&wishlist_window();
                   7120:         }
1.1038    www      7121:         if ($args->{'add_togglebox'}) {
                   7122:            $result.=&togglebox_script();
                   7123:         }
1.1041    www      7124:         if ($args->{'add_progressbar'}) {
                   7125:            $result.=&LCprogressbarUpdate_script();
                   7126:         }
1.436     albertel 7127:     }
1.314     albertel 7128:     if (ref($args->{'redirect'})) {
1.414     albertel 7129: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7130: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7131: 	if (!$inhibit_continue) {
                   7132: 	    $env{'internal.head.redirect'} = $url;
                   7133: 	}
1.313     albertel 7134: 	$result.=<<ADDMETA
                   7135: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7136: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7137: ADDMETA
                   7138:     }
1.306     albertel 7139:     if (!defined($title)) {
                   7140: 	$title = 'The LearningOnline Network with CAPA';
                   7141:     }
1.460     albertel 7142:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7143:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 7144: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064    raeburn  7145:         .$inhibitprint
1.414     albertel 7146: 	.$head_extra;
1.962     droeschl 7147:     return $result.'</head>';
1.306     albertel 7148: }
                   7149: 
                   7150: =pod
                   7151: 
1.340     albertel 7152: =item * &font_settings()
                   7153: 
                   7154: Returns neccessary <meta> to set the proper encoding
                   7155: 
                   7156: Inputs: none
                   7157: 
                   7158: =cut
                   7159: 
                   7160: sub font_settings {
                   7161:     my $headerstring='';
1.647     www      7162:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 7163: 	$headerstring.=
                   7164: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   7165:     }
                   7166:     return $headerstring;
                   7167: }
                   7168: 
1.341     albertel 7169: =pod
                   7170: 
1.1064    raeburn  7171: =item * &print_suppression()
                   7172: 
                   7173: In course context returns css which causes the body to be blank when media="print",
                   7174: if printout generation is unavailable for the current resource.
                   7175: 
                   7176: This could be because:
                   7177: 
                   7178: (a) printstartdate is in the future
                   7179: 
                   7180: (b) printenddate is in the past
                   7181: 
                   7182: (c) there is an active exam block with "printout"
                   7183: functionality blocked
                   7184: 
                   7185: Users with pav, pfo or evb privileges are exempt.
                   7186: 
                   7187: Inputs: none
                   7188: 
                   7189: =cut
                   7190: 
                   7191: 
                   7192: sub print_suppression {
                   7193:     my $noprint;
                   7194:     if ($env{'request.course.id'}) {
                   7195:         my $scope = $env{'request.course.id'};
                   7196:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7197:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   7198:             return;
                   7199:         }
                   7200:         if ($env{'request.course.sec'} ne '') {
                   7201:             $scope .= "/$env{'request.course.sec'}";
                   7202:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7203:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  7204:                 return;
1.1064    raeburn  7205:             }
                   7206:         }
                   7207:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7208:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065    raeburn  7209:         my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064    raeburn  7210:         if ($blocked) {
                   7211:             my $checkrole = "cm./$cdom/$cnum";
                   7212:             if ($env{'request.course.sec'} ne '') {
                   7213:                 $checkrole .= "/$env{'request.course.sec'}";
                   7214:             }
                   7215:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   7216:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   7217:                 $noprint = 1;
                   7218:             }
                   7219:         }
                   7220:         unless ($noprint) {
                   7221:             my $symb = &Apache::lonnet::symbread();
                   7222:             if ($symb ne '') {
                   7223:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   7224:                 if (ref($navmap)) {
                   7225:                     my $res = $navmap->getBySymb($symb);
                   7226:                     if (ref($res)) {
                   7227:                         if (!$res->resprintable()) {
                   7228:                             $noprint = 1;
                   7229:                         }
                   7230:                     }
                   7231:                 }
                   7232:             }
                   7233:         }
                   7234:         if ($noprint) {
                   7235:             return <<"ENDSTYLE";
                   7236: <style type="text/css" media="print">
                   7237:     body { display:none }
                   7238: </style>
                   7239: ENDSTYLE
                   7240:         }
                   7241:     }
                   7242:     return;
                   7243: }
                   7244: 
                   7245: =pod
                   7246: 
1.341     albertel 7247: =item * &xml_begin()
                   7248: 
                   7249: Returns the needed doctype and <html>
                   7250: 
                   7251: Inputs: none
                   7252: 
                   7253: =cut
                   7254: 
                   7255: sub xml_begin {
                   7256:     my $output='';
                   7257: 
                   7258:     if ($env{'browser.mathml'}) {
                   7259: 	$output='<?xml version="1.0"?>'
                   7260:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7261: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7262:             
                   7263: #	    .'<!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">] >'
                   7264: 	    .'<!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">'
                   7265:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7266: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   7267:     } else {
1.849     bisitz   7268: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   7269:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 7270:     }
                   7271:     return $output;
                   7272: }
1.340     albertel 7273: 
                   7274: =pod
                   7275: 
1.306     albertel 7276: =item * &start_page()
                   7277: 
                   7278: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7279: 
1.648     raeburn  7280: Inputs:
                   7281: 
                   7282: =over 4
                   7283: 
                   7284: $title - optional title for the page
                   7285: 
                   7286: $head_extra - optional extra HTML to incude inside the <head>
                   7287: 
                   7288: $args - additional optional args supported are:
                   7289: 
                   7290: =over 8
                   7291: 
                   7292:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7293:                                     arg on
1.814     bisitz   7294:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7295:              add_entries    -> additional attributes to add to the  <body>
                   7296:              domain         -> force to color decorate a page for a 
1.317     albertel 7297:                                     specific domain
1.648     raeburn  7298:              function       -> force usage of a specific rolish color
1.317     albertel 7299:                                     scheme
1.648     raeburn  7300:              redirect       -> see &headtag()
                   7301:              bgcolor        -> override the default page bg color
                   7302:              js_ready       -> return a string ready for being used in 
1.317     albertel 7303:                                     a javascript writeln
1.648     raeburn  7304:              html_encode    -> return a string ready for being used in 
1.320     albertel 7305:                                     a html attribute
1.648     raeburn  7306:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7307:                                     $forcereg arg
1.648     raeburn  7308:              frameset       -> if true will start with a <frameset>
1.330     albertel 7309:                                     rather than <body>
1.648     raeburn  7310:              skip_phases    -> hash ref of 
1.338     albertel 7311:                                     head -> skip the <html><head> generation
                   7312:                                     body -> skip all <body> generation
1.648     raeburn  7313:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7314:              inherit_jsmath -> when creating popup window in a page,
                   7315:                                     should it have jsmath forced on by the
                   7316:                                     current page
1.867     kalberla 7317:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7318:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 7319: 
1.648     raeburn  7320: =back
1.460     albertel 7321: 
1.648     raeburn  7322: =back
1.562     albertel 7323: 
1.306     albertel 7324: =cut
                   7325: 
                   7326: sub start_page {
1.309     albertel 7327:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7328:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7329: 
1.315     albertel 7330:     $env{'internal.start_page'}++;
1.338     albertel 7331:     my $result;
1.964     droeschl 7332: 
1.338     albertel 7333:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      7334:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 7335:     }
                   7336:     
                   7337:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7338: 	if ($args->{'frameset'}) {
                   7339: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7340: 						$args->{'add_entries'});
                   7341: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   7342:         } else {
                   7343:             $result .=
                   7344:                 &bodytag($title, 
                   7345:                          $args->{'function'},       $args->{'add_entries'},
                   7346:                          $args->{'only_body'},      $args->{'domain'},
                   7347:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 7348:                          $args->{'bgcolor'},        $args);
1.831     bisitz   7349:         }
1.330     albertel 7350:     }
1.338     albertel 7351: 
1.315     albertel 7352:     if ($args->{'js_ready'}) {
1.713     kaisler  7353: 		$result = &js_ready($result);
1.315     albertel 7354:     }
1.320     albertel 7355:     if ($args->{'html_encode'}) {
1.713     kaisler  7356: 		$result = &html_encode($result);
                   7357:     }
                   7358: 
1.813     bisitz   7359:     # Preparation for new and consistent functionlist at top of screen
                   7360:     # if ($args->{'functionlist'}) {
                   7361:     #            $result .= &build_functionlist();
                   7362:     #}
                   7363: 
1.964     droeschl 7364:     # Don't add anything more if only_body wanted or in const space
                   7365:     return $result if    $args->{'only_body'} 
                   7366:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   7367: 
                   7368:     #Breadcrumbs
1.758     kaisler  7369:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   7370: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   7371: 		#if any br links exists, add them to the breadcrumbs
                   7372: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   7373: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   7374: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   7375: 			}
                   7376: 		}
                   7377: 
                   7378: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   7379: 		if(exists($args->{'bread_crumbs_component'})){
                   7380: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   7381: 		}else{
                   7382: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   7383: 		}
1.320     albertel 7384:     }
1.315     albertel 7385:     return $result;
1.306     albertel 7386: }
                   7387: 
                   7388: sub end_page {
1.315     albertel 7389:     my ($args) = @_;
                   7390:     $env{'internal.end_page'}++;
1.330     albertel 7391:     my $result;
1.335     albertel 7392:     if ($args->{'discussion'}) {
                   7393: 	my ($target,$parser);
                   7394: 	if (ref($args->{'discussion'})) {
                   7395: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7396: 				$args->{'discussion'}{'parser'});
                   7397: 	}
                   7398: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7399:     }
1.330     albertel 7400:     if ($args->{'frameset'}) {
                   7401: 	$result .= '</frameset>';
                   7402:     } else {
1.635     raeburn  7403: 	$result .= &endbodytag($args);
1.330     albertel 7404:     }
1.1075.2.6  raeburn  7405:     unless ($args->{'notbody'}) {
                   7406:         $result .= "\n</html>";
                   7407:     }
1.330     albertel 7408: 
1.315     albertel 7409:     if ($args->{'js_ready'}) {
1.317     albertel 7410: 	$result = &js_ready($result);
1.315     albertel 7411:     }
1.335     albertel 7412: 
1.320     albertel 7413:     if ($args->{'html_encode'}) {
                   7414: 	$result = &html_encode($result);
                   7415:     }
1.335     albertel 7416: 
1.315     albertel 7417:     return $result;
                   7418: }
                   7419: 
1.1034    www      7420: sub wishlist_window {
                   7421:     return(<<'ENDWISHLIST');
1.1046    raeburn  7422: <script type="text/javascript">
1.1034    www      7423: // <![CDATA[
                   7424: // <!-- BEGIN LON-CAPA Internal
                   7425: function set_wishlistlink(title, path) {
                   7426:     if (!title) {
                   7427:         title = document.title;
                   7428:         title = title.replace(/^LON-CAPA /,'');
                   7429:     }
                   7430:     if (!path) {
                   7431:         path = location.pathname;
                   7432:     }
                   7433:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7434:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7435: }
                   7436: // END LON-CAPA Internal -->
                   7437: // ]]>
                   7438: </script>
                   7439: ENDWISHLIST
                   7440: }
                   7441: 
1.1030    www      7442: sub modal_window {
                   7443:     return(<<'ENDMODAL');
1.1046    raeburn  7444: <script type="text/javascript">
1.1030    www      7445: // <![CDATA[
                   7446: // <!-- BEGIN LON-CAPA Internal
                   7447: var modalWindow = {
                   7448: 	parent:"body",
                   7449: 	windowId:null,
                   7450: 	content:null,
                   7451: 	width:null,
                   7452: 	height:null,
                   7453: 	close:function()
                   7454: 	{
                   7455: 	        $(".LCmodal-window").remove();
                   7456: 	        $(".LCmodal-overlay").remove();
                   7457: 	},
                   7458: 	open:function()
                   7459: 	{
                   7460: 		var modal = "";
                   7461: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7462: 		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;\">";
                   7463: 		modal += this.content;
                   7464: 		modal += "</div>";	
                   7465: 
                   7466: 		$(this.parent).append(modal);
                   7467: 
                   7468: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7469: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7470: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7471: 	}
                   7472: };
1.1031    www      7473: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7474: 	{
                   7475: 		modalWindow.windowId = "myModal";
                   7476: 		modalWindow.width = width;
                   7477: 		modalWindow.height = height;
1.1031    www      7478: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7479: 		modalWindow.open();
                   7480: 	};	
                   7481: // END LON-CAPA Internal -->
                   7482: // ]]>
                   7483: </script>
                   7484: ENDMODAL
                   7485: }
                   7486: 
                   7487: sub modal_link {
1.1052    www      7488:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7489:     unless ($width) { $width=480; }
                   7490:     unless ($height) { $height=400; }
1.1031    www      7491:     unless ($scrolling) { $scrolling='yes'; }
1.1074    raeburn  7492:     my $target_attr;
                   7493:     if (defined($target)) {
                   7494:         $target_attr = 'target="'.$target.'"';
                   7495:     }
                   7496:     return <<"ENDLINK";
                   7497: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
                   7498:            $linktext</a>
                   7499: ENDLINK
1.1030    www      7500: }
                   7501: 
1.1032    www      7502: sub modal_adhoc_script {
                   7503:     my ($funcname,$width,$height,$content)=@_;
                   7504:     return (<<ENDADHOC);
1.1046    raeburn  7505: <script type="text/javascript">
1.1032    www      7506: // <![CDATA[
                   7507:         var $funcname = function()
                   7508:         {
                   7509:                 modalWindow.windowId = "myModal";
                   7510:                 modalWindow.width = $width;
                   7511:                 modalWindow.height = $height;
                   7512:                 modalWindow.content = '$content';
                   7513:                 modalWindow.open();
                   7514:         };  
                   7515: // ]]>
                   7516: </script>
                   7517: ENDADHOC
                   7518: }
                   7519: 
1.1041    www      7520: sub modal_adhoc_inner {
                   7521:     my ($funcname,$width,$height,$content)=@_;
                   7522:     my $innerwidth=$width-20;
                   7523:     $content=&js_ready(
1.1042    www      7524:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7525:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7526:                     $content.
                   7527:                  &end_scrollbox().
                   7528:                &end_page()
                   7529:              );
                   7530:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7531: }
                   7532: 
                   7533: sub modal_adhoc_window {
                   7534:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7535:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7536:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7537: }
                   7538: 
                   7539: sub modal_adhoc_launch {
                   7540:     my ($funcname,$width,$height,$content)=@_;
                   7541:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7542: <script type="text/javascript">
                   7543: // <![CDATA[
                   7544: $funcname();
                   7545: // ]]>
                   7546: </script>
                   7547: ENDLAUNCH
                   7548: }
                   7549: 
                   7550: sub modal_adhoc_close {
                   7551:     return (<<ENDCLOSE);
                   7552: <script type="text/javascript">
                   7553: // <![CDATA[
                   7554: modalWindow.close();
                   7555: // ]]>
                   7556: </script>
                   7557: ENDCLOSE
                   7558: }
                   7559: 
1.1038    www      7560: sub togglebox_script {
                   7561:    return(<<ENDTOGGLE);
                   7562: <script type="text/javascript"> 
                   7563: // <![CDATA[
                   7564: function LCtoggleDisplay(id,hidetext,showtext) {
                   7565:    link = document.getElementById(id + "link").childNodes[0];
                   7566:    with (document.getElementById(id).style) {
                   7567:       if (display == "none" ) {
                   7568:           display = "inline";
                   7569:           link.nodeValue = hidetext;
                   7570:         } else {
                   7571:           display = "none";
                   7572:           link.nodeValue = showtext;
                   7573:        }
                   7574:    }
                   7575: }
                   7576: // ]]>
                   7577: </script>
                   7578: ENDTOGGLE
                   7579: }
                   7580: 
1.1039    www      7581: sub start_togglebox {
                   7582:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7583:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7584:     unless ($showtext) { $showtext=&mt('show'); }
                   7585:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7586:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7587:     return &start_data_table().
                   7588:            &start_data_table_header_row().
                   7589:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7590:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7591:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7592:            &end_data_table_header_row().
                   7593:            '<tr id="'.$id.'" style="display:none""><td>';
                   7594: }
                   7595: 
                   7596: sub end_togglebox {
                   7597:     return '</td></tr>'.&end_data_table();
                   7598: }
                   7599: 
1.1041    www      7600: sub LCprogressbar_script {
1.1045    www      7601:    my ($id)=@_;
1.1041    www      7602:    return(<<ENDPROGRESS);
                   7603: <script type="text/javascript">
                   7604: // <![CDATA[
1.1045    www      7605: \$('#progressbar$id').progressbar({
1.1041    www      7606:   value: 0,
                   7607:   change: function(event, ui) {
                   7608:     var newVal = \$(this).progressbar('option', 'value');
                   7609:     \$('.pblabel', this).text(LCprogressTxt);
                   7610:   }
                   7611: });
                   7612: // ]]>
                   7613: </script>
                   7614: ENDPROGRESS
                   7615: }
                   7616: 
                   7617: sub LCprogressbarUpdate_script {
                   7618:    return(<<ENDPROGRESSUPDATE);
                   7619: <style type="text/css">
                   7620: .ui-progressbar { position:relative; }
                   7621: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7622: </style>
                   7623: <script type="text/javascript">
                   7624: // <![CDATA[
1.1045    www      7625: var LCprogressTxt='---';
                   7626: 
                   7627: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7628:    LCprogressTxt=progresstext;
1.1045    www      7629:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7630: }
                   7631: // ]]>
                   7632: </script>
                   7633: ENDPROGRESSUPDATE
                   7634: }
                   7635: 
1.1042    www      7636: my $LClastpercent;
1.1045    www      7637: my $LCidcnt;
                   7638: my $LCcurrentid;
1.1042    www      7639: 
1.1041    www      7640: sub LCprogressbar {
1.1042    www      7641:     my ($r)=(@_);
                   7642:     $LClastpercent=0;
1.1045    www      7643:     $LCidcnt++;
                   7644:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7645:     my $starting=&mt('Starting');
                   7646:     my $content=(<<ENDPROGBAR);
                   7647: <p>
1.1045    www      7648:   <div id="progressbar$LCcurrentid">
1.1041    www      7649:     <span class="pblabel">$starting</span>
                   7650:   </div>
                   7651: </p>
                   7652: ENDPROGBAR
1.1045    www      7653:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7654: }
                   7655: 
                   7656: sub LCprogressbarUpdate {
1.1042    www      7657:     my ($r,$val,$text)=@_;
                   7658:     unless ($val) { 
                   7659:        if ($LClastpercent) {
                   7660:            $val=$LClastpercent;
                   7661:        } else {
                   7662:            $val=0;
                   7663:        }
                   7664:     }
1.1041    www      7665:     if ($val<0) { $val=0; }
                   7666:     if ($val>100) { $val=0; }
1.1042    www      7667:     $LClastpercent=$val;
1.1041    www      7668:     unless ($text) { $text=$val.'%'; }
                   7669:     $text=&js_ready($text);
1.1044    www      7670:     &r_print($r,<<ENDUPDATE);
1.1041    www      7671: <script type="text/javascript">
                   7672: // <![CDATA[
1.1045    www      7673: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7674: // ]]>
                   7675: </script>
                   7676: ENDUPDATE
1.1035    www      7677: }
                   7678: 
1.1042    www      7679: sub LCprogressbarClose {
                   7680:     my ($r)=@_;
                   7681:     $LClastpercent=0;
1.1044    www      7682:     &r_print($r,<<ENDCLOSE);
1.1042    www      7683: <script type="text/javascript">
                   7684: // <![CDATA[
1.1045    www      7685: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7686: // ]]>
                   7687: </script>
                   7688: ENDCLOSE
1.1044    www      7689: }
                   7690: 
                   7691: sub r_print {
                   7692:     my ($r,$to_print)=@_;
                   7693:     if ($r) {
                   7694:       $r->print($to_print);
                   7695:       $r->rflush();
                   7696:     } else {
                   7697:       print($to_print);
                   7698:     }
1.1042    www      7699: }
                   7700: 
1.320     albertel 7701: sub html_encode {
                   7702:     my ($result) = @_;
                   7703: 
1.322     albertel 7704:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7705:     
                   7706:     return $result;
                   7707: }
1.1044    www      7708: 
1.317     albertel 7709: sub js_ready {
                   7710:     my ($result) = @_;
                   7711: 
1.323     albertel 7712:     $result =~ s/[\n\r]/ /xmsg;
                   7713:     $result =~ s/\\/\\\\/xmsg;
                   7714:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7715:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7716:     
                   7717:     return $result;
                   7718: }
                   7719: 
1.315     albertel 7720: sub validate_page {
                   7721:     if (  exists($env{'internal.start_page'})
1.316     albertel 7722: 	  &&     $env{'internal.start_page'} > 1) {
                   7723: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7724: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7725: 				 $ENV{'request.filename'});
1.315     albertel 7726:     }
                   7727:     if (  exists($env{'internal.end_page'})
1.316     albertel 7728: 	  &&     $env{'internal.end_page'} > 1) {
                   7729: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7730: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7731: 				 $env{'request.filename'});
1.315     albertel 7732:     }
                   7733:     if (     exists($env{'internal.start_page'})
                   7734: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7735: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7736: 				 $env{'request.filename'});
1.315     albertel 7737:     }
                   7738:     if (   ! exists($env{'internal.start_page'})
                   7739: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7740: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7741: 				 $env{'request.filename'});
1.315     albertel 7742:     }
1.306     albertel 7743: }
1.315     albertel 7744: 
1.996     www      7745: 
                   7746: sub start_scrollbox {
1.1075    raeburn  7747:     my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998     raeburn  7748:     unless ($outerwidth) { $outerwidth='520px'; }
                   7749:     unless ($width) { $width='500px'; }
                   7750:     unless ($height) { $height='200px'; }
1.1075    raeburn  7751:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  7752:     if ($id ne '') {
1.1020    raeburn  7753:         $table_id = " id='table_$id'";
                   7754:         $div_id = " id='div_$id'";
1.1018    raeburn  7755:     }
1.1075    raeburn  7756:     if ($bgcolor ne '') {
                   7757:         $tdcol = "background-color: $bgcolor;";
                   7758:     }
                   7759:     return <<"END";
                   7760: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol"><div style="overflow:auto; width:$width; height: $height;"$div_id>
                   7761: END
1.996     www      7762: }
                   7763: 
                   7764: sub end_scrollbox {
1.1036    www      7765:     return '</div></td></tr></table>';
1.996     www      7766: }
                   7767: 
1.318     albertel 7768: sub simple_error_page {
                   7769:     my ($r,$title,$msg) = @_;
                   7770:     my $page =
                   7771: 	&Apache::loncommon::start_page($title).
                   7772: 	&mt($msg).
                   7773: 	&Apache::loncommon::end_page();
                   7774:     if (ref($r)) {
                   7775: 	$r->print($page);
1.327     albertel 7776: 	return;
1.318     albertel 7777:     }
                   7778:     return $page;
                   7779: }
1.347     albertel 7780: 
                   7781: {
1.610     albertel 7782:     my @row_count;
1.961     onken    7783: 
                   7784:     sub start_data_table_count {
                   7785:         unshift(@row_count, 0);
                   7786:         return;
                   7787:     }
                   7788: 
                   7789:     sub end_data_table_count {
                   7790:         shift(@row_count);
                   7791:         return;
                   7792:     }
                   7793: 
1.347     albertel 7794:     sub start_data_table {
1.1018    raeburn  7795: 	my ($add_class,$id) = @_;
1.422     albertel 7796: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7797:         my $table_id;
                   7798:         if (defined($id)) {
                   7799:             $table_id = ' id="'.$id.'"';
                   7800:         }
1.961     onken    7801: 	&start_data_table_count();
1.1018    raeburn  7802: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7803:     }
                   7804: 
                   7805:     sub end_data_table {
1.961     onken    7806: 	&end_data_table_count();
1.389     albertel 7807: 	return '</table>'."\n";;
1.347     albertel 7808:     }
                   7809: 
                   7810:     sub start_data_table_row {
1.974     wenzelju 7811: 	my ($add_class, $id) = @_;
1.610     albertel 7812: 	$row_count[0]++;
                   7813: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7814: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7815:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7816:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7817:     }
1.471     banghart 7818:     
                   7819:     sub continue_data_table_row {
1.974     wenzelju 7820: 	my ($add_class, $id) = @_;
1.610     albertel 7821: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7822: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7823:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7824:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7825:     }
1.347     albertel 7826: 
                   7827:     sub end_data_table_row {
1.389     albertel 7828: 	return '</tr>'."\n";;
1.347     albertel 7829:     }
1.367     www      7830: 
1.421     albertel 7831:     sub start_data_table_empty_row {
1.707     bisitz   7832: #	$row_count[0]++;
1.421     albertel 7833: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7834:     }
                   7835: 
                   7836:     sub end_data_table_empty_row {
                   7837: 	return '</tr>'."\n";;
                   7838:     }
                   7839: 
1.367     www      7840:     sub start_data_table_header_row {
1.389     albertel 7841: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7842:     }
                   7843: 
                   7844:     sub end_data_table_header_row {
1.389     albertel 7845: 	return '</tr>'."\n";;
1.367     www      7846:     }
1.890     droeschl 7847: 
                   7848:     sub data_table_caption {
                   7849:         my $caption = shift;
                   7850:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7851:     }
1.347     albertel 7852: }
                   7853: 
1.548     albertel 7854: =pod
                   7855: 
                   7856: =item * &inhibit_menu_check($arg)
                   7857: 
                   7858: Checks for a inhibitmenu state and generates output to preserve it
                   7859: 
                   7860: Inputs:         $arg - can be any of
                   7861:                      - undef - in which case the return value is a string 
                   7862:                                to add  into arguments list of a uri
                   7863:                      - 'input' - in which case the return value is a HTML
                   7864:                                  <form> <input> field of type hidden to
                   7865:                                  preserve the value
                   7866:                      - a url - in which case the return value is the url with
                   7867:                                the neccesary cgi args added to preserve the
                   7868:                                inhibitmenu state
                   7869:                      - a ref to a url - no return value, but the string is
                   7870:                                         updated to include the neccessary cgi
                   7871:                                         args to preserve the inhibitmenu state
                   7872: 
                   7873: =cut
                   7874: 
                   7875: sub inhibit_menu_check {
                   7876:     my ($arg) = @_;
                   7877:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7878:     if ($arg eq 'input') {
                   7879: 	if ($env{'form.inhibitmenu'}) {
                   7880: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7881: 	} else {
                   7882: 	    return
                   7883: 	}
                   7884:     }
                   7885:     if ($env{'form.inhibitmenu'}) {
                   7886: 	if (ref($arg)) {
                   7887: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7888: 	} elsif ($arg eq '') {
                   7889: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7890: 	} else {
                   7891: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7892: 	}
                   7893:     }
                   7894:     if (!ref($arg)) {
                   7895: 	return $arg;
                   7896:     }
                   7897: }
                   7898: 
1.251     albertel 7899: ###############################################
1.182     matthew  7900: 
                   7901: =pod
                   7902: 
1.549     albertel 7903: =back
                   7904: 
                   7905: =head1 User Information Routines
                   7906: 
                   7907: =over 4
                   7908: 
1.405     albertel 7909: =item * &get_users_function()
1.182     matthew  7910: 
                   7911: Used by &bodytag to determine the current users primary role.
                   7912: Returns either 'student','coordinator','admin', or 'author'.
                   7913: 
                   7914: =cut
                   7915: 
                   7916: ###############################################
                   7917: sub get_users_function {
1.815     tempelho 7918:     my $function = 'norole';
1.818     tempelho 7919:     if ($env{'request.role'}=~/^(st)/) {
                   7920:         $function='student';
                   7921:     }
1.907     raeburn  7922:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7923:         $function='coordinator';
                   7924:     }
1.258     albertel 7925:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7926:         $function='admin';
                   7927:     }
1.826     bisitz   7928:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7929:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7930:         $function='author';
                   7931:     }
                   7932:     return $function;
1.54      www      7933: }
1.99      www      7934: 
                   7935: ###############################################
                   7936: 
1.233     raeburn  7937: =pod
                   7938: 
1.821     raeburn  7939: =item * &show_course()
                   7940: 
                   7941: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7942: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7943: 
                   7944: Inputs:
                   7945: None
                   7946: 
                   7947: Outputs:
                   7948: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7949: 
                   7950: =cut
                   7951: 
                   7952: ###############################################
                   7953: sub show_course {
                   7954:     my $course = !$env{'user.adv'};
                   7955:     if (!$env{'user.adv'}) {
                   7956:         foreach my $env (keys(%env)) {
                   7957:             next if ($env !~ m/^user\.priv\./);
                   7958:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7959:                 $course = 0;
                   7960:                 last;
                   7961:             }
                   7962:         }
                   7963:     }
                   7964:     return $course;
                   7965: }
                   7966: 
                   7967: ###############################################
                   7968: 
                   7969: =pod
                   7970: 
1.542     raeburn  7971: =item * &check_user_status()
1.274     raeburn  7972: 
                   7973: Determines current status of supplied role for a
                   7974: specific user. Roles can be active, previous or future.
                   7975: 
                   7976: Inputs: 
                   7977: user's domain, user's username, course's domain,
1.375     raeburn  7978: course's number, optional section ID.
1.274     raeburn  7979: 
                   7980: Outputs:
                   7981: role status: active, previous or future. 
                   7982: 
                   7983: =cut
                   7984: 
                   7985: sub check_user_status {
1.412     raeburn  7986:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  7987:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274     raeburn  7988:     my @uroles = keys %userinfo;
                   7989:     my $srchstr;
                   7990:     my $active_chk = 'none';
1.412     raeburn  7991:     my $now = time;
1.274     raeburn  7992:     if (@uroles > 0) {
1.908     raeburn  7993:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7994:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7995:         } else {
1.412     raeburn  7996:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7997:         }
                   7998:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7999:             my $role_end = 0;
                   8000:             my $role_start = 0;
                   8001:             $active_chk = 'active';
1.412     raeburn  8002:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   8003:                 $role_end = $1;
                   8004:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   8005:                     $role_start = $1;
1.274     raeburn  8006:                 }
                   8007:             }
                   8008:             if ($role_start > 0) {
1.412     raeburn  8009:                 if ($now < $role_start) {
1.274     raeburn  8010:                     $active_chk = 'future';
                   8011:                 }
                   8012:             }
                   8013:             if ($role_end > 0) {
1.412     raeburn  8014:                 if ($now > $role_end) {
1.274     raeburn  8015:                     $active_chk = 'previous';
                   8016:                 }
                   8017:             }
                   8018:         }
                   8019:     }
                   8020:     return $active_chk;
                   8021: }
                   8022: 
                   8023: ###############################################
                   8024: 
                   8025: =pod
                   8026: 
1.405     albertel 8027: =item * &get_sections()
1.233     raeburn  8028: 
                   8029: Determines all the sections for a course including
                   8030: sections with students and sections containing other roles.
1.419     raeburn  8031: Incoming parameters: 
                   8032: 
                   8033: 1. domain
                   8034: 2. course number 
                   8035: 3. reference to array containing roles for which sections should 
                   8036: be gathered (optional).
                   8037: 4. reference to array containing status types for which sections 
                   8038: should be gathered (optional).
                   8039: 
                   8040: If the third argument is undefined, sections are gathered for any role. 
                   8041: If the fourth argument is undefined, sections are gathered for any status.
                   8042: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  8043:  
1.374     raeburn  8044: Returns section hash (keys are section IDs, values are
                   8045: number of users in each section), subject to the
1.419     raeburn  8046: optional roles filter, optional status filter 
1.233     raeburn  8047: 
                   8048: =cut
                   8049: 
                   8050: ###############################################
                   8051: sub get_sections {
1.419     raeburn  8052:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 8053:     if (!defined($cdom) || !defined($cnum)) {
                   8054:         my $cid =  $env{'request.course.id'};
                   8055: 
                   8056: 	return if (!defined($cid));
                   8057: 
                   8058:         $cdom = $env{'course.'.$cid.'.domain'};
                   8059:         $cnum = $env{'course.'.$cid.'.num'};
                   8060:     }
                   8061: 
                   8062:     my %sectioncount;
1.419     raeburn  8063:     my $now = time;
1.240     albertel 8064: 
1.366     albertel 8065:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 8066: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 8067: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   8068: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  8069:         my $start_index = &Apache::loncoursedata::CL_START();
                   8070:         my $end_index = &Apache::loncoursedata::CL_END();
                   8071:         my $status;
1.366     albertel 8072: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  8073: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   8074: 				                     $data->[$status_index],
                   8075:                                                      $data->[$start_index],
                   8076:                                                      $data->[$end_index]);
                   8077:             if ($stu_status eq 'Active') {
                   8078:                 $status = 'active';
                   8079:             } elsif ($end < $now) {
                   8080:                 $status = 'previous';
                   8081:             } elsif ($start > $now) {
                   8082:                 $status = 'future';
                   8083:             } 
                   8084: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   8085:                 if ((!defined($possible_status)) || (($status ne '') && 
                   8086:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   8087: 		    $sectioncount{$section}++;
                   8088:                 }
1.240     albertel 8089: 	    }
                   8090: 	}
                   8091:     }
                   8092:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8093:     foreach my $user (sort(keys(%courseroles))) {
                   8094: 	if ($user !~ /^(\w{2})/) { next; }
                   8095: 	my ($role) = ($user =~ /^(\w{2})/);
                   8096: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  8097: 	my ($section,$status);
1.240     albertel 8098: 	if ($role eq 'cr' &&
                   8099: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   8100: 	    $section=$1;
                   8101: 	}
                   8102: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   8103: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  8104:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   8105:         if ($end == -1 && $start == -1) {
                   8106:             next; #deleted role
                   8107:         }
                   8108:         if (!defined($possible_status)) { 
                   8109:             $sectioncount{$section}++;
                   8110:         } else {
                   8111:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   8112:                 $status = 'active';
                   8113:             } elsif ($end < $now) {
                   8114:                 $status = 'future';
                   8115:             } elsif ($start > $now) {
                   8116:                 $status = 'previous';
                   8117:             }
                   8118:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   8119:                 $sectioncount{$section}++;
                   8120:             }
                   8121:         }
1.233     raeburn  8122:     }
1.366     albertel 8123:     return %sectioncount;
1.233     raeburn  8124: }
                   8125: 
1.274     raeburn  8126: ###############################################
1.294     raeburn  8127: 
                   8128: =pod
1.405     albertel 8129: 
                   8130: =item * &get_course_users()
                   8131: 
1.275     raeburn  8132: Retrieves usernames:domains for users in the specified course
                   8133: with specific role(s), and access status. 
                   8134: 
                   8135: Incoming parameters:
1.277     albertel 8136: 1. course domain
                   8137: 2. course number
                   8138: 3. access status: users must have - either active, 
1.275     raeburn  8139: previous, future, or all.
1.277     albertel 8140: 4. reference to array of permissible roles
1.288     raeburn  8141: 5. reference to array of section restrictions (optional)
                   8142: 6. reference to results object (hash of hashes).
                   8143: 7. reference to optional userdata hash
1.609     raeburn  8144: 8. reference to optional statushash
1.630     raeburn  8145: 9. flag if privileged users (except those set to unhide in
                   8146:    course settings) should be excluded    
1.609     raeburn  8147: Keys of top level results hash are roles.
1.275     raeburn  8148: Keys of inner hashes are username:domain, with 
                   8149: values set to access type.
1.288     raeburn  8150: Optional userdata hash returns an array with arguments in the 
                   8151: same order as loncoursedata::get_classlist() for student data.
                   8152: 
1.609     raeburn  8153: Optional statushash returns
                   8154: 
1.288     raeburn  8155: Entries for end, start, section and status are blank because
                   8156: of the possibility of multiple values for non-student roles.
                   8157: 
1.275     raeburn  8158: =cut
1.405     albertel 8159: 
1.275     raeburn  8160: ###############################################
1.405     albertel 8161: 
1.275     raeburn  8162: sub get_course_users {
1.630     raeburn  8163:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  8164:     my %idx = ();
1.419     raeburn  8165:     my %seclists;
1.288     raeburn  8166: 
                   8167:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   8168:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   8169:     $idx{end} = &Apache::loncoursedata::CL_END();
                   8170:     $idx{start} = &Apache::loncoursedata::CL_START();
                   8171:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   8172:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   8173:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   8174:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   8175: 
1.290     albertel 8176:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 8177:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  8178:         my $now = time;
1.277     albertel 8179:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  8180:             my $match = 0;
1.412     raeburn  8181:             my $secmatch = 0;
1.419     raeburn  8182:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  8183:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  8184:             if ($section eq '') {
                   8185:                 $section = 'none';
                   8186:             }
1.291     albertel 8187:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8188:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8189:                     $secmatch = 1;
                   8190:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 8191:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8192:                         $secmatch = 1;
                   8193:                     }
                   8194:                 } else {  
1.419     raeburn  8195: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  8196: 		        $secmatch = 1;
                   8197:                     }
1.290     albertel 8198: 		}
1.412     raeburn  8199:                 if (!$secmatch) {
                   8200:                     next;
                   8201:                 }
1.419     raeburn  8202:             }
1.275     raeburn  8203:             if (defined($$types{'active'})) {
1.288     raeburn  8204:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  8205:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  8206:                     $match = 1;
1.275     raeburn  8207:                 }
                   8208:             }
                   8209:             if (defined($$types{'previous'})) {
1.609     raeburn  8210:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  8211:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  8212:                     $match = 1;
1.275     raeburn  8213:                 }
                   8214:             }
                   8215:             if (defined($$types{'future'})) {
1.609     raeburn  8216:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  8217:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  8218:                     $match = 1;
1.275     raeburn  8219:                 }
                   8220:             }
1.609     raeburn  8221:             if ($match) {
                   8222:                 push(@{$seclists{$student}},$section);
                   8223:                 if (ref($userdata) eq 'HASH') {
                   8224:                     $$userdata{$student} = $$classlist{$student};
                   8225:                 }
                   8226:                 if (ref($statushash) eq 'HASH') {
                   8227:                     $statushash->{$student}{'st'}{$section} = $status;
                   8228:                 }
1.288     raeburn  8229:             }
1.275     raeburn  8230:         }
                   8231:     }
1.412     raeburn  8232:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  8233:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8234:         my $now = time;
1.609     raeburn  8235:         my %displaystatus = ( previous => 'Expired',
                   8236:                               active   => 'Active',
                   8237:                               future   => 'Future',
                   8238:                             );
1.630     raeburn  8239:         my %nothide;
                   8240:         if ($hidepriv) {
                   8241:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   8242:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   8243:                 if ($user !~ /:/) {
                   8244:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   8245:                 } else {
                   8246:                     $nothide{$user} = 1;
                   8247:                 }
                   8248:             }
                   8249:         }
1.439     raeburn  8250:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  8251:             my $match = 0;
1.412     raeburn  8252:             my $secmatch = 0;
1.439     raeburn  8253:             my $status;
1.412     raeburn  8254:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  8255:             $user =~ s/:$//;
1.439     raeburn  8256:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   8257:             if ($end == -1 || $start == -1) {
                   8258:                 next;
                   8259:             }
                   8260:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   8261:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  8262:                 my ($uname,$udom) = split(/:/,$user);
                   8263:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8264:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8265:                         $secmatch = 1;
                   8266:                     } elsif ($usec eq '') {
1.420     albertel 8267:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8268:                             $secmatch = 1;
                   8269:                         }
                   8270:                     } else {
                   8271:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   8272:                             $secmatch = 1;
                   8273:                         }
                   8274:                     }
                   8275:                     if (!$secmatch) {
                   8276:                         next;
                   8277:                     }
1.288     raeburn  8278:                 }
1.419     raeburn  8279:                 if ($usec eq '') {
                   8280:                     $usec = 'none';
                   8281:                 }
1.275     raeburn  8282:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  8283:                     if ($hidepriv) {
                   8284:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   8285:                             (!$nothide{$uname.':'.$udom})) {
                   8286:                             next;
                   8287:                         }
                   8288:                     }
1.503     raeburn  8289:                     if ($end > 0 && $end < $now) {
1.439     raeburn  8290:                         $status = 'previous';
                   8291:                     } elsif ($start > $now) {
                   8292:                         $status = 'future';
                   8293:                     } else {
                   8294:                         $status = 'active';
                   8295:                     }
1.277     albertel 8296:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  8297:                         if ($status eq $type) {
1.420     albertel 8298:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  8299:                                 push(@{$$users{$role}{$user}},$type);
                   8300:                             }
1.288     raeburn  8301:                             $match = 1;
                   8302:                         }
                   8303:                     }
1.419     raeburn  8304:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   8305:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   8306: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   8307:                         }
1.420     albertel 8308:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  8309:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   8310:                         }
1.609     raeburn  8311:                         if (ref($statushash) eq 'HASH') {
                   8312:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   8313:                         }
1.275     raeburn  8314:                     }
                   8315:                 }
                   8316:             }
                   8317:         }
1.290     albertel 8318:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  8319:             if ((defined($cdom)) && (defined($cnum))) {
                   8320:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   8321:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   8322:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  8323:                     next if ($owner eq '');
                   8324:                     my ($ownername,$ownerdom);
                   8325:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   8326:                         $ownername = $1;
                   8327:                         $ownerdom = $2;
                   8328:                     } else {
                   8329:                         $ownername = $owner;
                   8330:                         $ownerdom = $cdom;
                   8331:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  8332:                     }
                   8333:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 8334:                     if (defined($userdata) && 
1.609     raeburn  8335: 			!exists($$userdata{$owner})) {
                   8336: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   8337:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   8338:                             push(@{$seclists{$owner}},'none');
                   8339:                         }
                   8340:                         if (ref($statushash) eq 'HASH') {
                   8341:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  8342:                         }
1.290     albertel 8343: 		    }
1.279     raeburn  8344:                 }
                   8345:             }
                   8346:         }
1.419     raeburn  8347:         foreach my $user (keys(%seclists)) {
                   8348:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   8349:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   8350:         }
1.275     raeburn  8351:     }
                   8352:     return;
                   8353: }
                   8354: 
1.288     raeburn  8355: sub get_user_info {
                   8356:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 8357:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   8358: 	&plainname($uname,$udom,'lastname');
1.291     albertel 8359:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  8360:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  8361:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   8362:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  8363:     return;
                   8364: }
1.275     raeburn  8365: 
1.472     raeburn  8366: ###############################################
                   8367: 
                   8368: =pod
                   8369: 
                   8370: =item * &get_user_quota()
                   8371: 
                   8372: Retrieves quota assigned for storage of portfolio files for a user  
                   8373: 
                   8374: Incoming parameters:
                   8375: 1. user's username
                   8376: 2. user's domain
                   8377: 
                   8378: Returns:
1.536     raeburn  8379: 1. Disk quota (in Mb) assigned to student.
                   8380: 2. (Optional) Type of setting: custom or default
                   8381:    (individually assigned or default for user's 
                   8382:    institutional status).
                   8383: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   8384:    or student - types as defined in localenroll::inst_usertypes 
                   8385:    for user's domain, which determines default quota for user.
                   8386: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  8387: 
                   8388: If a value has been stored in the user's environment, 
1.536     raeburn  8389: it will return that, otherwise it returns the maximal default
                   8390: defined for the user's instituional status(es) in the domain.
1.472     raeburn  8391: 
                   8392: =cut
                   8393: 
                   8394: ###############################################
                   8395: 
                   8396: 
                   8397: sub get_user_quota {
                   8398:     my ($uname,$udom) = @_;
1.536     raeburn  8399:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8400:     if (!defined($udom)) {
                   8401:         $udom = $env{'user.domain'};
                   8402:     }
                   8403:     if (!defined($uname)) {
                   8404:         $uname = $env{'user.name'};
                   8405:     }
                   8406:     if (($udom eq '' || $uname eq '') ||
                   8407:         ($udom eq 'public') && ($uname eq 'public')) {
                   8408:         $quota = 0;
1.536     raeburn  8409:         $quotatype = 'default';
                   8410:         $defquota = 0; 
1.472     raeburn  8411:     } else {
1.536     raeburn  8412:         my $inststatus;
1.472     raeburn  8413:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8414:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8415:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8416:         } else {
1.536     raeburn  8417:             my %userenv = 
                   8418:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8419:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8420:             my ($tmp) = keys(%userenv);
                   8421:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8422:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8423:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8424:             } else {
                   8425:                 undef(%userenv);
                   8426:             }
                   8427:         }
1.536     raeburn  8428:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8429:         if ($quota eq '') {
1.536     raeburn  8430:             $quota = $defquota;
                   8431:             $quotatype = 'default';
                   8432:         } else {
                   8433:             $quotatype = 'custom';
1.472     raeburn  8434:         }
                   8435:     }
1.536     raeburn  8436:     if (wantarray) {
                   8437:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8438:     } else {
                   8439:         return $quota;
                   8440:     }
1.472     raeburn  8441: }
                   8442: 
                   8443: ###############################################
                   8444: 
                   8445: =pod
                   8446: 
                   8447: =item * &default_quota()
                   8448: 
1.536     raeburn  8449: Retrieves default quota assigned for storage of user portfolio files,
                   8450: given an (optional) user's institutional status.
1.472     raeburn  8451: 
                   8452: Incoming parameters:
                   8453: 1. domain
1.536     raeburn  8454: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8455:    status types (e.g., faculty, staff, student etc.)
                   8456:    which apply to the user for whom the default is being retrieved.
                   8457:    If the institutional status string in undefined, the domain
                   8458:    default quota will be returned. 
1.472     raeburn  8459: 
                   8460: Returns:
                   8461: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8462: 2. (Optional) institutional type which determined the value of the
                   8463:    default quota.
1.472     raeburn  8464: 
                   8465: If a value has been stored in the domain's configuration db,
                   8466: it will return that, otherwise it returns 20 (for backwards 
                   8467: compatibility with domains which have not set up a configuration
                   8468: db file; the original statically defined portfolio quota was 20 Mb). 
                   8469: 
1.536     raeburn  8470: If the user's status includes multiple types (e.g., staff and student),
                   8471: the largest default quota which applies to the user determines the
                   8472: default quota returned.
                   8473: 
1.780     raeburn  8474: =back
                   8475: 
1.472     raeburn  8476: =cut
                   8477: 
                   8478: ###############################################
                   8479: 
                   8480: 
                   8481: sub default_quota {
1.536     raeburn  8482:     my ($udom,$inststatus) = @_;
                   8483:     my ($defquota,$settingstatus);
                   8484:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8485:                                             ['quotas'],$udom);
                   8486:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8487:         if ($inststatus ne '') {
1.765     raeburn  8488:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8489:             foreach my $item (@statuses) {
1.711     raeburn  8490:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8491:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8492:                         if ($defquota eq '') {
                   8493:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8494:                             $settingstatus = $item;
                   8495:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8496:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8497:                             $settingstatus = $item;
                   8498:                         }
                   8499:                     }
                   8500:                 } else {
                   8501:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8502:                         if ($defquota eq '') {
                   8503:                             $defquota = $quotahash{'quotas'}{$item};
                   8504:                             $settingstatus = $item;
                   8505:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8506:                             $defquota = $quotahash{'quotas'}{$item};
                   8507:                             $settingstatus = $item;
                   8508:                         }
1.536     raeburn  8509:                     }
                   8510:                 }
                   8511:             }
                   8512:         }
                   8513:         if ($defquota eq '') {
1.711     raeburn  8514:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8515:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8516:             } else {
                   8517:                 $defquota = $quotahash{'quotas'}{'default'};
                   8518:             }
1.536     raeburn  8519:             $settingstatus = 'default';
                   8520:         }
                   8521:     } else {
                   8522:         $settingstatus = 'default';
                   8523:         $defquota = 20;
                   8524:     }
                   8525:     if (wantarray) {
                   8526:         return ($defquota,$settingstatus);
1.472     raeburn  8527:     } else {
1.536     raeburn  8528:         return $defquota;
1.472     raeburn  8529:     }
                   8530: }
                   8531: 
1.384     raeburn  8532: sub get_secgrprole_info {
                   8533:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8534:     my %sections_count = &get_sections($cdom,$cnum);
                   8535:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8536:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8537:     my @groups = sort(keys(%curr_groups));
                   8538:     my $allroles = [];
                   8539:     my $rolehash;
                   8540:     my $accesshash = {
                   8541:                      active => 'Currently has access',
                   8542:                      future => 'Will have future access',
                   8543:                      previous => 'Previously had access',
                   8544:                   };
                   8545:     if ($needroles) {
                   8546:         $rolehash = {'all' => 'all'};
1.385     albertel 8547:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8548: 	if (&Apache::lonnet::error(%user_roles)) {
                   8549: 	    undef(%user_roles);
                   8550: 	}
                   8551:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8552:             my ($role)=split(/\:/,$item,2);
                   8553:             if ($role eq 'cr') { next; }
                   8554:             if ($role =~ /^cr/) {
                   8555:                 $$rolehash{$role} = (split('/',$role))[3];
                   8556:             } else {
                   8557:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8558:             }
                   8559:         }
                   8560:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8561:             push(@{$allroles},$key);
                   8562:         }
                   8563:         push (@{$allroles},'st');
                   8564:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8565:     }
                   8566:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8567: }
                   8568: 
1.555     raeburn  8569: sub user_picker {
1.994     raeburn  8570:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8571:     my $currdom = $dom;
                   8572:     my %curr_selected = (
                   8573:                         srchin => 'dom',
1.580     raeburn  8574:                         srchby => 'lastname',
1.555     raeburn  8575:                       );
                   8576:     my $srchterm;
1.625     raeburn  8577:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8578:         if ($srch->{'srchby'} ne '') {
                   8579:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8580:         }
                   8581:         if ($srch->{'srchin'} ne '') {
                   8582:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8583:         }
                   8584:         if ($srch->{'srchtype'} ne '') {
                   8585:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8586:         }
                   8587:         if ($srch->{'srchdomain'} ne '') {
                   8588:             $currdom = $srch->{'srchdomain'};
                   8589:         }
                   8590:         $srchterm = $srch->{'srchterm'};
                   8591:     }
                   8592:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8593:                     'usr'       => 'Search criteria',
1.563     raeburn  8594:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8595:                     'uname'     => 'username',
                   8596:                     'lastname'  => 'last name',
1.555     raeburn  8597:                     'lastfirst' => 'last name, first name',
1.558     albertel 8598:                     'crs'       => 'in this course',
1.576     raeburn  8599:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8600:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8601:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8602:                     'exact'     => 'is',
                   8603:                     'contains'  => 'contains',
1.569     raeburn  8604:                     'begins'    => 'begins with',
1.571     raeburn  8605:                     'youm'      => "You must include some text to search for.",
                   8606:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8607:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8608:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8609:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8610:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8611:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8612:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8613:                                        );
1.563     raeburn  8614:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8615:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8616: 
                   8617:     my @srchins = ('crs','dom','alc','instd');
                   8618: 
                   8619:     foreach my $option (@srchins) {
                   8620:         # FIXME 'alc' option unavailable until 
                   8621:         #       loncreateuser::print_user_query_page()
                   8622:         #       has been completed.
                   8623:         next if ($option eq 'alc');
1.880     raeburn  8624:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8625:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8626:         if ($curr_selected{'srchin'} eq $option) {
                   8627:             $srchinsel .= ' 
                   8628:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8629:         } else {
                   8630:             $srchinsel .= '
                   8631:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8632:         }
1.555     raeburn  8633:     }
1.563     raeburn  8634:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8635: 
                   8636:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8637:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8638:         if ($curr_selected{'srchby'} eq $option) {
                   8639:             $srchbysel .= '
                   8640:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8641:         } else {
                   8642:             $srchbysel .= '
                   8643:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8644:          }
                   8645:     }
                   8646:     $srchbysel .= "\n  </select>\n";
                   8647: 
                   8648:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8649:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8650:         if ($curr_selected{'srchtype'} eq $option) {
                   8651:             $srchtypesel .= '
                   8652:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8653:         } else {
                   8654:             $srchtypesel .= '
                   8655:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8656:         }
                   8657:     }
                   8658:     $srchtypesel .= "\n  </select>\n";
                   8659: 
1.558     albertel 8660:     my ($newuserscript,$new_user_create);
1.994     raeburn  8661:     my $context_dom = $env{'request.role.domain'};
                   8662:     if ($context eq 'requestcrs') {
                   8663:         if ($env{'form.coursedom'} ne '') { 
                   8664:             $context_dom = $env{'form.coursedom'};
                   8665:         }
                   8666:     }
1.556     raeburn  8667:     if ($forcenewuser) {
1.576     raeburn  8668:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8669:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8670:                 if ($cancreate) {
                   8671:                     $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>';
                   8672:                 } else {
1.799     bisitz   8673:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8674:                     my %usertypetext = (
                   8675:                         official   => 'institutional',
                   8676:                         unofficial => 'non-institutional',
                   8677:                     );
1.799     bisitz   8678:                     $new_user_create = '<p class="LC_warning">'
                   8679:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8680:                                       .' '
                   8681:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8682:                                           ,'<a href="'.$helplink.'">','</a>')
                   8683:                                       .'</p><br />';
1.627     raeburn  8684:                 }
1.576     raeburn  8685:             }
                   8686:         }
                   8687: 
1.556     raeburn  8688:         $newuserscript = <<"ENDSCRIPT";
                   8689: 
1.570     raeburn  8690: function setSearch(createnew,callingForm) {
1.556     raeburn  8691:     if (createnew == 1) {
1.570     raeburn  8692:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8693:             if (callingForm.srchby.options[i].value == 'uname') {
                   8694:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8695:             }
                   8696:         }
1.570     raeburn  8697:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8698:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8699: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8700:             }
                   8701:         }
1.570     raeburn  8702:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8703:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8704:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8705:             }
                   8706:         }
1.570     raeburn  8707:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8708:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8709:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8710:             }
                   8711:         }
                   8712:     }
                   8713: }
                   8714: ENDSCRIPT
1.558     albertel 8715: 
1.556     raeburn  8716:     }
                   8717: 
1.555     raeburn  8718:     my $output = <<"END_BLOCK";
1.556     raeburn  8719: <script type="text/javascript">
1.824     bisitz   8720: // <![CDATA[
1.570     raeburn  8721: function validateEntry(callingForm) {
1.558     albertel 8722: 
1.556     raeburn  8723:     var checkok = 1;
1.558     albertel 8724:     var srchin;
1.570     raeburn  8725:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8726: 	if ( callingForm.srchin[i].checked ) {
                   8727: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8728: 	}
                   8729:     }
                   8730: 
1.570     raeburn  8731:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8732:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8733:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8734:     var srchterm =  callingForm.srchterm.value;
                   8735:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8736:     var msg = "";
                   8737: 
                   8738:     if (srchterm == "") {
                   8739:         checkok = 0;
1.571     raeburn  8740:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8741:     }
                   8742: 
1.569     raeburn  8743:     if (srchtype== 'begins') {
                   8744:         if (srchterm.length < 2) {
                   8745:             checkok = 0;
1.571     raeburn  8746:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8747:         }
                   8748:     }
                   8749: 
1.556     raeburn  8750:     if (srchtype== 'contains') {
                   8751:         if (srchterm.length < 3) {
                   8752:             checkok = 0;
1.571     raeburn  8753:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8754:         }
                   8755:     }
                   8756:     if (srchin == 'instd') {
                   8757:         if (srchdomain == '') {
                   8758:             checkok = 0;
1.571     raeburn  8759:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8760:         }
                   8761:     }
                   8762:     if (srchin == 'dom') {
                   8763:         if (srchdomain == '') {
                   8764:             checkok = 0;
1.571     raeburn  8765:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8766:         }
                   8767:     }
                   8768:     if (srchby == 'lastfirst') {
                   8769:         if (srchterm.indexOf(",") == -1) {
                   8770:             checkok = 0;
1.571     raeburn  8771:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8772:         }
                   8773:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8774:             checkok = 0;
1.571     raeburn  8775:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8776:         }
                   8777:     }
                   8778:     if (checkok == 0) {
1.571     raeburn  8779:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8780:         return;
                   8781:     }
                   8782:     if (checkok == 1) {
1.570     raeburn  8783:         callingForm.submit();
1.556     raeburn  8784:     }
                   8785: }
                   8786: 
                   8787: $newuserscript
                   8788: 
1.824     bisitz   8789: // ]]>
1.556     raeburn  8790: </script>
1.558     albertel 8791: 
                   8792: $new_user_create
                   8793: 
1.555     raeburn  8794: END_BLOCK
1.558     albertel 8795: 
1.876     raeburn  8796:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8797:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8798:                $domform.
                   8799:                &Apache::lonhtmlcommon::row_closure().
                   8800:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8801:                $srchbysel.
                   8802:                $srchtypesel. 
                   8803:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8804:                $srchinsel.
                   8805:                &Apache::lonhtmlcommon::row_closure(1). 
                   8806:                &Apache::lonhtmlcommon::end_pick_box().
                   8807:                '<br />';
1.555     raeburn  8808:     return $output;
                   8809: }
                   8810: 
1.612     raeburn  8811: sub user_rule_check {
1.615     raeburn  8812:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8813:     my $response;
                   8814:     if (ref($usershash) eq 'HASH') {
                   8815:         foreach my $user (keys(%{$usershash})) {
                   8816:             my ($uname,$udom) = split(/:/,$user);
                   8817:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8818:             my ($id,$newuser);
1.612     raeburn  8819:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8820:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8821:                 $id = $usershash->{$user}->{'id'};
                   8822:             }
                   8823:             my $inst_response;
                   8824:             if (ref($checks) eq 'HASH') {
                   8825:                 if (defined($checks->{'username'})) {
1.615     raeburn  8826:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8827:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8828:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8829:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8830:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8831:                 }
1.615     raeburn  8832:             } else {
                   8833:                 ($inst_response,%{$inst_results->{$user}}) =
                   8834:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8835:                 return;
1.612     raeburn  8836:             }
1.615     raeburn  8837:             if (!$got_rules->{$udom}) {
1.612     raeburn  8838:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8839:                                                   ['usercreation'],$udom);
                   8840:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8841:                     foreach my $item ('username','id') {
1.612     raeburn  8842:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8843:                             $$curr_rules{$udom}{$item} = 
                   8844:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8845:                         }
                   8846:                     }
                   8847:                 }
1.615     raeburn  8848:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8849:             }
1.612     raeburn  8850:             foreach my $item (keys(%{$checks})) {
                   8851:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8852:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8853:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8854:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8855:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8856:                                 if ($rule_check{$rule}) {
                   8857:                                     $$rulematch{$user}{$item} = $rule;
                   8858:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8859:                                         if (ref($inst_results) eq 'HASH') {
                   8860:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8861:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8862:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8863:                                                 }
1.612     raeburn  8864:                                             }
                   8865:                                         }
1.615     raeburn  8866:                                     }
                   8867:                                     last;
1.585     raeburn  8868:                                 }
                   8869:                             }
                   8870:                         }
                   8871:                     }
                   8872:                 }
                   8873:             }
                   8874:         }
                   8875:     }
1.612     raeburn  8876:     return;
                   8877: }
                   8878: 
                   8879: sub user_rule_formats {
                   8880:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8881:     my %text = ( 
                   8882:                  'username' => 'Usernames',
                   8883:                  'id'       => 'IDs',
                   8884:                );
                   8885:     my $output;
                   8886:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8887:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8888:         if (@{$ruleorder} > 0) {
                   8889:             $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>';
                   8890:             foreach my $rule (@{$ruleorder}) {
                   8891:                 if (ref($curr_rules) eq 'ARRAY') {
                   8892:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8893:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8894:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8895:                                         $rules->{$rule}{'desc'}.'</li>';
                   8896:                         }
                   8897:                     }
                   8898:                 }
                   8899:             }
                   8900:             $output .= '</ul>';
                   8901:         }
                   8902:     }
                   8903:     return $output;
                   8904: }
                   8905: 
                   8906: sub instrule_disallow_msg {
1.615     raeburn  8907:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8908:     my $response;
                   8909:     my %text = (
                   8910:                   item   => 'username',
                   8911:                   items  => 'usernames',
                   8912:                   match  => 'matches',
                   8913:                   do     => 'does',
                   8914:                   action => 'a username',
                   8915:                   one    => 'one',
                   8916:                );
                   8917:     if ($count > 1) {
                   8918:         $text{'item'} = 'usernames';
                   8919:         $text{'match'} ='match';
                   8920:         $text{'do'} = 'do';
                   8921:         $text{'action'} = 'usernames',
                   8922:         $text{'one'} = 'ones';
                   8923:     }
                   8924:     if ($checkitem eq 'id') {
                   8925:         $text{'items'} = 'IDs';
                   8926:         $text{'item'} = 'ID';
                   8927:         $text{'action'} = 'an ID';
1.615     raeburn  8928:         if ($count > 1) {
                   8929:             $text{'item'} = 'IDs';
                   8930:             $text{'action'} = 'IDs';
                   8931:         }
1.612     raeburn  8932:     }
1.674     bisitz   8933:     $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  8934:     if ($mode eq 'upload') {
                   8935:         if ($checkitem eq 'username') {
                   8936:             $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'}.");
                   8937:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8938:             $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  8939:         }
1.669     raeburn  8940:     } elsif ($mode eq 'selfcreate') {
                   8941:         if ($checkitem eq 'id') {
                   8942:             $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.");
                   8943:         }
1.615     raeburn  8944:     } else {
                   8945:         if ($checkitem eq 'username') {
                   8946:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8947:         } elsif ($checkitem eq 'id') {
                   8948:             $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.");
                   8949:         }
1.612     raeburn  8950:     }
                   8951:     return $response;
1.585     raeburn  8952: }
                   8953: 
1.624     raeburn  8954: sub personal_data_fieldtitles {
                   8955:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8956:                         id => 'Student/Employee ID',
                   8957:                         permanentemail => 'E-mail address',
                   8958:                         lastname => 'Last Name',
                   8959:                         firstname => 'First Name',
                   8960:                         middlename => 'Middle Name',
                   8961:                         generation => 'Generation',
                   8962:                         gen => 'Generation',
1.765     raeburn  8963:                         inststatus => 'Affiliation',
1.624     raeburn  8964:                    );
                   8965:     return %fieldtitles;
                   8966: }
                   8967: 
1.642     raeburn  8968: sub sorted_inst_types {
                   8969:     my ($dom) = @_;
                   8970:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8971:     my $othertitle = &mt('All users');
                   8972:     if ($env{'request.course.id'}) {
1.668     raeburn  8973:         $othertitle  = &mt('Any users');
1.642     raeburn  8974:     }
                   8975:     my @types;
                   8976:     if (ref($order) eq 'ARRAY') {
                   8977:         @types = @{$order};
                   8978:     }
                   8979:     if (@types == 0) {
                   8980:         if (ref($usertypes) eq 'HASH') {
                   8981:             @types = sort(keys(%{$usertypes}));
                   8982:         }
                   8983:     }
                   8984:     if (keys(%{$usertypes}) > 0) {
                   8985:         $othertitle = &mt('Other users');
                   8986:     }
                   8987:     return ($othertitle,$usertypes,\@types);
                   8988: }
                   8989: 
1.645     raeburn  8990: sub get_institutional_codes {
                   8991:     my ($settings,$allcourses,$LC_code) = @_;
                   8992: # Get complete list of course sections to update
                   8993:     my @currsections = ();
                   8994:     my @currxlists = ();
                   8995:     my $coursecode = $$settings{'internal.coursecode'};
                   8996: 
                   8997:     if ($$settings{'internal.sectionnums'} ne '') {
                   8998:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8999:     }
                   9000: 
                   9001:     if ($$settings{'internal.crosslistings'} ne '') {
                   9002:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   9003:     }
                   9004: 
                   9005:     if (@currxlists > 0) {
                   9006:         foreach (@currxlists) {
                   9007:             if (m/^([^:]+):(\w*)$/) {
                   9008:                 unless (grep/^$1$/,@{$allcourses}) {
                   9009:                     push @{$allcourses},$1;
                   9010:                     $$LC_code{$1} = $2;
                   9011:                 }
                   9012:             }
                   9013:         }
                   9014:     }
                   9015:  
                   9016:     if (@currsections > 0) {
                   9017:         foreach (@currsections) {
                   9018:             if (m/^(\w+):(\w*)$/) {
                   9019:                 my $sec = $coursecode.$1;
                   9020:                 my $lc_sec = $2;
                   9021:                 unless (grep/^$sec$/,@{$allcourses}) {
                   9022:                     push @{$allcourses},$sec;
                   9023:                     $$LC_code{$sec} = $lc_sec;
                   9024:                 }
                   9025:             }
                   9026:         }
                   9027:     }
                   9028:     return;
                   9029: }
                   9030: 
1.971     raeburn  9031: sub get_standard_codeitems {
                   9032:     return ('Year','Semester','Department','Number','Section');
                   9033: }
                   9034: 
1.112     bowersj2 9035: =pod
                   9036: 
1.780     raeburn  9037: =head1 Slot Helpers
                   9038: 
                   9039: =over 4
                   9040: 
                   9041: =item * sorted_slots()
                   9042: 
1.1040    raeburn  9043: Sorts an array of slot names in order of an optional sort key,
                   9044: default sort is by slot start time (earliest first). 
1.780     raeburn  9045: 
                   9046: Inputs:
                   9047: 
                   9048: =over 4
                   9049: 
                   9050: slotsarr  - Reference to array of unsorted slot names.
                   9051: 
                   9052: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   9053: 
1.1040    raeburn  9054: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   9055: 
1.549     albertel 9056: =back
                   9057: 
1.780     raeburn  9058: Returns:
                   9059: 
                   9060: =over 4
                   9061: 
1.1040    raeburn  9062: sorted   - An array of slot names sorted by a specified sort key 
                   9063:            (default sort key is start time of the slot).
1.780     raeburn  9064: 
                   9065: =back
                   9066: 
                   9067: =cut
                   9068: 
                   9069: 
                   9070: sub sorted_slots {
1.1040    raeburn  9071:     my ($slotsarr,$slots,$sortkey) = @_;
                   9072:     if ($sortkey eq '') {
                   9073:         $sortkey = 'starttime';
                   9074:     }
1.780     raeburn  9075:     my @sorted;
                   9076:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   9077:         @sorted =
                   9078:             sort {
                   9079:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  9080:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  9081:                      }
                   9082:                      if (ref($slots->{$a})) { return -1;}
                   9083:                      if (ref($slots->{$b})) { return 1;}
                   9084:                      return 0;
                   9085:                  } @{$slotsarr};
                   9086:     }
                   9087:     return @sorted;
                   9088: }
                   9089: 
1.1040    raeburn  9090: =pod
                   9091: 
                   9092: =item * get_future_slots()
                   9093: 
                   9094: Inputs:
                   9095: 
                   9096: =over 4
                   9097: 
                   9098: cnum - course number
                   9099: 
                   9100: cdom - course domain
                   9101: 
                   9102: now - current UNIX time
                   9103: 
                   9104: symb - optional symb
                   9105: 
                   9106: =back
                   9107: 
                   9108: Returns:
                   9109: 
                   9110: =over 4
                   9111: 
                   9112: sorted_reservable - ref to array of student_schedulable slots currently 
                   9113:                     reservable, ordered by end date of reservation period.
                   9114: 
                   9115: reservable_now - ref to hash of student_schedulable slots currently
                   9116:                  reservable.
                   9117: 
                   9118:     Keys in inner hash are:
                   9119:     (a) symb: either blank or symb to which slot use is restricted.
                   9120:     (b) endreserve: end date of reservation period. 
                   9121: 
                   9122: sorted_future - ref to array of student_schedulable slots reservable in
                   9123:                 the future, ordered by start date of reservation period.
                   9124: 
                   9125: future_reservable - ref to hash of student_schedulable slots reservable
                   9126:                     in the future.
                   9127: 
                   9128:     Keys in inner hash are:
                   9129:     (a) symb: either blank or symb to which slot use is restricted.
                   9130:     (b) startreserve:  start date of reservation period.
                   9131: 
                   9132: =back
                   9133: 
                   9134: =cut
                   9135: 
                   9136: sub get_future_slots {
                   9137:     my ($cnum,$cdom,$now,$symb) = @_;
                   9138:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   9139:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   9140:     foreach my $slot (keys(%slots)) {
                   9141:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   9142:         if ($symb) {
                   9143:             next if (($slots{$slot}->{'symb'} ne '') && 
                   9144:                      ($slots{$slot}->{'symb'} ne $symb));
                   9145:         }
                   9146:         if (($slots{$slot}->{'starttime'} > $now) &&
                   9147:             ($slots{$slot}->{'endtime'} > $now)) {
                   9148:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   9149:                 my $userallowed = 0;
                   9150:                 if ($slots{$slot}->{'allowedsections'}) {
                   9151:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   9152:                     if (!defined($env{'request.role.sec'})
                   9153:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   9154:                         $userallowed=1;
                   9155:                     } else {
                   9156:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   9157:                             $userallowed=1;
                   9158:                         }
                   9159:                     }
                   9160:                     unless ($userallowed) {
                   9161:                         if (defined($env{'request.course.groups'})) {
                   9162:                             my @groups = split(/:/,$env{'request.course.groups'});
                   9163:                             foreach my $group (@groups) {
                   9164:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   9165:                                     $userallowed=1;
                   9166:                                     last;
                   9167:                                 }
                   9168:                             }
                   9169:                         }
                   9170:                     }
                   9171:                 }
                   9172:                 if ($slots{$slot}->{'allowedusers'}) {
                   9173:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   9174:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   9175:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   9176:                         $userallowed = 1;
                   9177:                     }
                   9178:                 }
                   9179:                 next unless($userallowed);
                   9180:             }
                   9181:             my $startreserve = $slots{$slot}->{'startreserve'};
                   9182:             my $endreserve = $slots{$slot}->{'endreserve'};
                   9183:             my $symb = $slots{$slot}->{'symb'};
                   9184:             if (($startreserve < $now) &&
                   9185:                 (!$endreserve || $endreserve > $now)) {
                   9186:                 my $lastres = $endreserve;
                   9187:                 if (!$lastres) {
                   9188:                     $lastres = $slots{$slot}->{'starttime'};
                   9189:                 }
                   9190:                 $reservable_now{$slot} = {
                   9191:                                            symb       => $symb,
                   9192:                                            endreserve => $lastres
                   9193:                                          };
                   9194:             } elsif (($startreserve > $now) &&
                   9195:                      (!$endreserve || $endreserve > $startreserve)) {
                   9196:                 $future_reservable{$slot} = {
                   9197:                                               symb         => $symb,
                   9198:                                               startreserve => $startreserve
                   9199:                                             };
                   9200:             }
                   9201:         }
                   9202:     }
                   9203:     my @unsorted_reservable = keys(%reservable_now);
                   9204:     if (@unsorted_reservable > 0) {
                   9205:         @sorted_reservable = 
                   9206:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   9207:     }
                   9208:     my @unsorted_future = keys(%future_reservable);
                   9209:     if (@unsorted_future > 0) {
                   9210:         @sorted_future =
                   9211:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   9212:     }
                   9213:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   9214: }
1.780     raeburn  9215: 
                   9216: =pod
                   9217: 
1.1057    foxr     9218: =back
                   9219: 
1.549     albertel 9220: =head1 HTTP Helpers
                   9221: 
                   9222: =over 4
                   9223: 
1.648     raeburn  9224: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 9225: 
1.258     albertel 9226: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 9227: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 9228: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 9229: 
                   9230: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   9231: $possible_names is an ref to an array of form element names.  As an example:
                   9232: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 9233: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 9234: 
                   9235: =cut
1.1       albertel 9236: 
1.6       albertel 9237: sub get_unprocessed_cgi {
1.25      albertel 9238:   my ($query,$possible_names)= @_;
1.26      matthew  9239:   # $Apache::lonxml::debug=1;
1.356     albertel 9240:   foreach my $pair (split(/&/,$query)) {
                   9241:     my ($name, $value) = split(/=/,$pair);
1.369     www      9242:     $name = &unescape($name);
1.25      albertel 9243:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   9244:       $value =~ tr/+/ /;
                   9245:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 9246:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 9247:     }
1.16      harris41 9248:   }
1.6       albertel 9249: }
                   9250: 
1.112     bowersj2 9251: =pod
                   9252: 
1.648     raeburn  9253: =item * &cacheheader() 
1.112     bowersj2 9254: 
                   9255: returns cache-controlling header code
                   9256: 
                   9257: =cut
                   9258: 
1.7       albertel 9259: sub cacheheader {
1.258     albertel 9260:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 9261:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   9262:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 9263:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   9264:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 9265:     return $output;
1.7       albertel 9266: }
                   9267: 
1.112     bowersj2 9268: =pod
                   9269: 
1.648     raeburn  9270: =item * &no_cache($r) 
1.112     bowersj2 9271: 
                   9272: specifies header code to not have cache
                   9273: 
                   9274: =cut
                   9275: 
1.9       albertel 9276: sub no_cache {
1.216     albertel 9277:     my ($r) = @_;
                   9278:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 9279: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 9280:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   9281:     $r->no_cache(1);
                   9282:     $r->header_out("Expires" => $date);
                   9283:     $r->header_out("Pragma" => "no-cache");
1.123     www      9284: }
                   9285: 
                   9286: sub content_type {
1.181     albertel 9287:     my ($r,$type,$charset) = @_;
1.299     foxr     9288:     if ($r) {
                   9289: 	#  Note that printout.pl calls this with undef for $r.
                   9290: 	&no_cache($r);
                   9291:     }
1.258     albertel 9292:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 9293:     unless ($charset) {
                   9294: 	$charset=&Apache::lonlocal::current_encoding;
                   9295:     }
                   9296:     if ($charset) { $type.='; charset='.$charset; }
                   9297:     if ($r) {
                   9298: 	$r->content_type($type);
                   9299:     } else {
                   9300: 	print("Content-type: $type\n\n");
                   9301:     }
1.9       albertel 9302: }
1.25      albertel 9303: 
1.112     bowersj2 9304: =pod
                   9305: 
1.648     raeburn  9306: =item * &add_to_env($name,$value) 
1.112     bowersj2 9307: 
1.258     albertel 9308: adds $name to the %env hash with value
1.112     bowersj2 9309: $value, if $name already exists, the entry is converted to an array
                   9310: reference and $value is added to the array.
                   9311: 
                   9312: =cut
                   9313: 
1.25      albertel 9314: sub add_to_env {
                   9315:   my ($name,$value)=@_;
1.258     albertel 9316:   if (defined($env{$name})) {
                   9317:     if (ref($env{$name})) {
1.25      albertel 9318:       #already have multiple values
1.258     albertel 9319:       push(@{ $env{$name} },$value);
1.25      albertel 9320:     } else {
                   9321:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 9322:       my $first=$env{$name};
                   9323:       undef($env{$name});
                   9324:       push(@{ $env{$name} },$first,$value);
1.25      albertel 9325:     }
                   9326:   } else {
1.258     albertel 9327:     $env{$name}=$value;
1.25      albertel 9328:   }
1.31      albertel 9329: }
1.149     albertel 9330: 
                   9331: =pod
                   9332: 
1.648     raeburn  9333: =item * &get_env_multiple($name) 
1.149     albertel 9334: 
1.258     albertel 9335: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 9336: values may be defined and end up as an array ref.
                   9337: 
                   9338: returns an array of values
                   9339: 
                   9340: =cut
                   9341: 
                   9342: sub get_env_multiple {
                   9343:     my ($name) = @_;
                   9344:     my @values;
1.258     albertel 9345:     if (defined($env{$name})) {
1.149     albertel 9346:         # exists is it an array
1.258     albertel 9347:         if (ref($env{$name})) {
                   9348:             @values=@{ $env{$name} };
1.149     albertel 9349:         } else {
1.258     albertel 9350:             $values[0]=$env{$name};
1.149     albertel 9351:         }
                   9352:     }
                   9353:     return(@values);
                   9354: }
                   9355: 
1.660     raeburn  9356: sub ask_for_embedded_content {
                   9357:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  9358:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
                   9359:         %currsubfile,%unused);
                   9360:     my $counter = 0;
                   9361:     my $numnew = 0;
1.987     raeburn  9362:     my $numremref = 0;
                   9363:     my $numinvalid = 0;
                   9364:     my $numpathchg = 0;
                   9365:     my $numexisting = 0;
1.1071    raeburn  9366:     my $numunused = 0;
                   9367:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
                   9368:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
                   9369:     my $heading = &mt('Upload embedded files');
                   9370:     my $buttontext = &mt('Upload');
                   9371: 
1.984     raeburn  9372:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9373:         my $current_path='/';
                   9374:         if ($env{'form.currentpath'}) {
                   9375:             $current_path = $env{'form.currentpath'};
                   9376:         }
                   9377:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   9378:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9379:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9380:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   9381:         } else {
                   9382:             $udom = $env{'user.domain'};
                   9383:             $uname = $env{'user.name'};
                   9384:             $url = '/userfiles/portfolio';
                   9385:         }
1.987     raeburn  9386:         $toplevel = $url.'/';
1.984     raeburn  9387:         $url .= $current_path;
                   9388:         $getpropath = 1;
1.987     raeburn  9389:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   9390:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      9391:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  9392:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  9393:         $toplevel = $url;
1.984     raeburn  9394:         if ($rest ne '') {
1.987     raeburn  9395:             $url .= $rest;
                   9396:         }
                   9397:     } elsif ($actionurl eq '/adm/coursedocs') {
                   9398:         if (ref($args) eq 'HASH') {
1.1071    raeburn  9399:             $url = $args->{'docs_url'};
                   9400:             $toplevel = $url;
                   9401:         }
                   9402:     } elsif ($actionurl eq '/adm/dependencies') {
                   9403:         if ($env{'request.course.id'} ne '') {
                   9404:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9405:             $cnum =  $env{'course.'.$env{'request.course.id'}.'.num'};
                   9406:             if (ref($args) eq 'HASH') {
                   9407:                 $url = $args->{'docs_url'};
                   9408:                 $title = $args->{'docs_title'};
                   9409:                 $toplevel = "/$url";
                   9410:                 ($path) =  
                   9411:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   9412:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   9413:                 $fileloc =~ s{^/}{};
                   9414:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   9415:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   9416:             }
1.987     raeburn  9417:         }
                   9418:     }
                   9419:     my $now = time();
                   9420:     foreach my $embed_file (keys(%{$allfiles})) {
                   9421:         my $absolutepath;
                   9422:         if ($embed_file =~ m{^\w+://}) {
                   9423:             $newfiles{$embed_file} = 1;
                   9424:             $mapping{$embed_file} = $embed_file;
                   9425:         } else {
                   9426:             if ($embed_file =~ m{^/}) {
                   9427:                 $absolutepath = $embed_file;
                   9428:                 $embed_file =~ s{^(/+)}{};
                   9429:             }
                   9430:             if ($embed_file =~ m{/}) {
                   9431:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9432:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9433:                 my $item = $fname;
                   9434:                 if ($path ne '') {
                   9435:                     $item = $path.'/'.$fname;
                   9436:                     $subdependencies{$path}{$fname} = 1;
                   9437:                 } else {
                   9438:                     $dependencies{$item} = 1;
                   9439:                 }
                   9440:                 if ($absolutepath) {
                   9441:                     $mapping{$item} = $absolutepath;
                   9442:                 } else {
                   9443:                     $mapping{$item} = $embed_file;
                   9444:                 }
                   9445:             } else {
                   9446:                 $dependencies{$embed_file} = 1;
                   9447:                 if ($absolutepath) {
                   9448:                     $mapping{$embed_file} = $absolutepath;
                   9449:                 } else {
                   9450:                     $mapping{$embed_file} = $embed_file;
                   9451:                 }
                   9452:             }
1.984     raeburn  9453:         }
                   9454:     }
1.1071    raeburn  9455:     my $dirptr = 16384;
1.984     raeburn  9456:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  9457:         $currsubfile{$path} = {};
1.984     raeburn  9458:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9459:             my ($sublistref,$listerror) =
                   9460:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9461:             if (ref($sublistref) eq 'ARRAY') {
                   9462:                 foreach my $line (@{$sublistref}) {
                   9463:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  9464:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  9465:                 }
1.984     raeburn  9466:             }
1.987     raeburn  9467:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9468:             if (opendir(my $dir,$url.'/'.$path)) {
                   9469:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  9470:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   9471:             }
                   9472:         } elsif ($actionurl eq '/adm/dependencies') {
                   9473:             if ($env{'request.course.id'} ne '') {
                   9474:                 my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9475:                 if ($dir ne '') {
                   9476:                     my ($sublistref,$listerror) =
                   9477:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   9478:                     if (ref($sublistref) eq 'ARRAY') {
                   9479:                         foreach my $line (@{$sublistref}) {
                   9480:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   9481:                                 undef,$mtime)=split(/\&/,$line,12);
                   9482:                             unless (($testdir&$dirptr) ||
                   9483:                                     ($file_name =~ /^\.\.?$/)) {
                   9484:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   9485:                             }
                   9486:                         }
                   9487:                     }
                   9488:                 }
1.984     raeburn  9489:             }
                   9490:         }
                   9491:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  9492:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  9493:                 my $item = $path.'/'.$file;
                   9494:                 unless ($mapping{$item} eq $item) {
                   9495:                     $pathchanges{$item} = 1;
                   9496:                 }
                   9497:                 $existing{$item} = 1;
                   9498:                 $numexisting ++;
                   9499:             } else {
                   9500:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9501:             }
                   9502:         }
1.1071    raeburn  9503:         if ($actionurl eq '/adm/dependencies') {
                   9504:             foreach my $path (keys(%currsubfile)) {
                   9505:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   9506:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   9507:                          unless ($subdependencies{$path}{$file}) {
                   9508:                              $unused{$path.'/'.$file} = 1; 
                   9509:                          }
                   9510:                     }
                   9511:                 }
                   9512:             }
                   9513:         }
1.984     raeburn  9514:     }
1.987     raeburn  9515:     my %currfile;
1.984     raeburn  9516:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9517:         my ($dirlistref,$listerror) =
                   9518:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9519:         if (ref($dirlistref) eq 'ARRAY') {
                   9520:             foreach my $line (@{$dirlistref}) {
                   9521:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9522:                 $currfile{$file_name} = 1;
                   9523:             }
1.984     raeburn  9524:         }
1.987     raeburn  9525:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9526:         if (opendir(my $dir,$url)) {
1.987     raeburn  9527:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9528:             map {$currfile{$_} = 1;} @dir_list;
                   9529:         }
1.1071    raeburn  9530:     } elsif ($actionurl eq '/adm/dependencies') {
                   9531:         if ($env{'request.course.id'} ne '') {
                   9532:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9533:             if ($dir ne '') {
                   9534:                 my ($dirlistref,$listerror) =
                   9535:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   9536:                 if (ref($dirlistref) eq 'ARRAY') {
                   9537:                     foreach my $line (@{$dirlistref}) {
                   9538:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   9539:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   9540:                         unless (($testdir&$dirptr) ||
                   9541:                                 ($file_name =~ /^\.\.?$/)) {
                   9542:                             $currfile{$file_name} = [$size,$mtime];
                   9543:                         }
                   9544:                     }
                   9545:                 }
                   9546:             }
                   9547:         }
1.984     raeburn  9548:     }
                   9549:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  9550:         if (exists($currfile{$file})) {
1.987     raeburn  9551:             unless ($mapping{$file} eq $file) {
                   9552:                 $pathchanges{$file} = 1;
                   9553:             }
                   9554:             $existing{$file} = 1;
                   9555:             $numexisting ++;
                   9556:         } else {
1.984     raeburn  9557:             $newfiles{$file} = 1;
                   9558:         }
                   9559:     }
1.1071    raeburn  9560:     foreach my $file (keys(%currfile)) {
                   9561:         unless (($file eq $filename) ||
                   9562:                 ($file eq $filename.'.bak') ||
                   9563:                 ($dependencies{$file})) {
                   9564:             $unused{$file} = 1;
                   9565:         }
                   9566:     }
1.984     raeburn  9567:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  9568:         if ($actionurl eq '/adm/dependencies') {
                   9569:             next if ($embed_file =~ m{^\w+://});
                   9570:         }
1.660     raeburn  9571:         $upload_output .= &start_data_table_row().
1.1071    raeburn  9572:                           '<td><img src="'.&icon($embed_file).'" />&nbsp;'.
                   9573:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  9574:         unless ($mapping{$embed_file} eq $embed_file) {
                   9575:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9576:         }
                   9577:         $upload_output .= '</td><td>';
1.1071    raeburn  9578:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.660     raeburn  9579:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9580:             $numremref++;
1.660     raeburn  9581:         } elsif ($args->{'error_on_invalid_names'}
                   9582:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9583: 
1.987     raeburn  9584:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9585:             $numinvalid++;
1.660     raeburn  9586:         } else {
1.1071    raeburn  9587:             $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  9588:                                                      $embed_file,\%mapping,
1.1071    raeburn  9589:                                                      $allfiles,$codebase,'upload');
                   9590:             $counter ++;
                   9591:             $numnew ++;
1.987     raeburn  9592:         }
                   9593:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9594:     }
                   9595:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  9596:         if ($actionurl eq '/adm/dependencies') {
                   9597:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   9598:             $modify_output .= &start_data_table_row().
                   9599:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   9600:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   9601:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   9602:                               '<td>'.$size.'</td>'.
                   9603:                               '<td>'.$mtime.'</td>'.
                   9604:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   9605:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   9606:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   9607:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   9608:                               &embedded_file_element('upload_embedded',$counter,
                   9609:                                                      $embed_file,\%mapping,
                   9610:                                                      $allfiles,$codebase,'modify').
                   9611:                               '</div></td>'.
                   9612:                               &end_data_table_row()."\n";
                   9613:             $counter ++;
                   9614:         } else {
                   9615:             $upload_output .= &start_data_table_row().
                   9616:                               '<td><span class="LC_filename">'.$embed_file.'</span></td>';
                   9617:                               '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9618:                               &Apache::loncommon::end_data_table_row()."\n";
                   9619:         }
                   9620:     }
                   9621:     my $delidx = $counter;
                   9622:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   9623:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   9624:         $delete_output .= &start_data_table_row().
                   9625:                           '<td><img src="'.&icon($oldfile).'" />'.
                   9626:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   9627:                           '<td>'.$size.'</td>'.
                   9628:                           '<td>'.$mtime.'</td>'.
                   9629:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   9630:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   9631:                           &embedded_file_element('upload_embedded',$delidx,
                   9632:                                                  $oldfile,\%mapping,$allfiles,
                   9633:                                                  $codebase,'delete').'</td>'.
                   9634:                           &end_data_table_row()."\n"; 
                   9635:         $numunused ++;
                   9636:         $delidx ++;
1.987     raeburn  9637:     }
                   9638:     if ($upload_output) {
                   9639:         $upload_output = &start_data_table().
                   9640:                          $upload_output.
                   9641:                          &end_data_table()."\n";
                   9642:     }
1.1071    raeburn  9643:     if ($modify_output) {
                   9644:         $modify_output = &start_data_table().
                   9645:                          &start_data_table_header_row().
                   9646:                          '<th>'.&mt('File').'</th>'.
                   9647:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9648:                          '<th>'.&mt('Modified').'</th>'.
                   9649:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   9650:                          &end_data_table_header_row().
                   9651:                          $modify_output.
                   9652:                          &end_data_table()."\n";
                   9653:     }
                   9654:     if ($delete_output) {
                   9655:         $delete_output = &start_data_table().
                   9656:                          &start_data_table_header_row().
                   9657:                          '<th>'.&mt('File').'</th>'.
                   9658:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9659:                          '<th>'.&mt('Modified').'</th>'.
                   9660:                          '<th>'.&mt('Delete?').'</th>'.
                   9661:                          &end_data_table_header_row().
                   9662:                          $delete_output.
                   9663:                          &end_data_table()."\n";
                   9664:     }
1.987     raeburn  9665:     my $applies = 0;
                   9666:     if ($numremref) {
                   9667:         $applies ++;
                   9668:     }
                   9669:     if ($numinvalid) {
                   9670:         $applies ++;
                   9671:     }
                   9672:     if ($numexisting) {
                   9673:         $applies ++;
                   9674:     }
1.1071    raeburn  9675:     if ($counter || $numunused) {
1.987     raeburn  9676:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9677:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  9678:                   $state.'<h3>'.$heading.'</h3>'; 
                   9679:         if ($actionurl eq '/adm/dependencies') {
                   9680:             if ($numnew) {
                   9681:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   9682:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   9683:                            $upload_output.'<br />'."\n";
                   9684:             }
                   9685:             if ($numexisting) {
                   9686:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   9687:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   9688:                            $modify_output.'<br />'."\n";
                   9689:                            $buttontext = &mt('Save changes');
                   9690:             }
                   9691:             if ($numunused) {
                   9692:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   9693:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   9694:                            $delete_output.'<br />'."\n";
                   9695:                            $buttontext = &mt('Save changes');
                   9696:             }
                   9697:         } else {
                   9698:             $output .= $upload_output.'<br />'."\n";
                   9699:         }
                   9700:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   9701:                    $counter.'" />'."\n";
                   9702:         if ($actionurl eq '/adm/dependencies') { 
                   9703:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   9704:                        $numnew.'" />'."\n";
                   9705:         } elsif ($actionurl eq '') {
1.987     raeburn  9706:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9707:         }
                   9708:     } elsif ($applies) {
                   9709:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9710:         if ($applies > 1) {
                   9711:             $output .=  
                   9712:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9713:             if ($numremref) {
                   9714:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9715:             }
                   9716:             if ($numinvalid) {
                   9717:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9718:             }
                   9719:             if ($numexisting) {
                   9720:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9721:             }
                   9722:             $output .= '</ul><br />';
                   9723:         } elsif ($numremref) {
                   9724:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9725:         } elsif ($numinvalid) {
                   9726:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9727:         } elsif ($numexisting) {
                   9728:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9729:         }
                   9730:         $output .= $upload_output.'<br />';
                   9731:     }
                   9732:     my ($pathchange_output,$chgcount);
1.1071    raeburn  9733:     $chgcount = $counter;
1.987     raeburn  9734:     if (keys(%pathchanges) > 0) {
                   9735:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  9736:             if ($counter) {
1.987     raeburn  9737:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9738:                                                   $embed_file,\%mapping,
1.1071    raeburn  9739:                                                   $allfiles,$codebase,'change');
1.987     raeburn  9740:             } else {
                   9741:                 $pathchange_output .= 
                   9742:                     &start_data_table_row().
                   9743:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9744:                     $chgcount.'" checked="checked" /></td>'.
                   9745:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9746:                     '<td>'.$embed_file.
                   9747:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  9748:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  9749:                     '</td>'.&end_data_table_row();
1.660     raeburn  9750:             }
1.987     raeburn  9751:             $numpathchg ++;
                   9752:             $chgcount ++;
1.660     raeburn  9753:         }
                   9754:     }
1.1071    raeburn  9755:     if ($counter) {
1.987     raeburn  9756:         if ($numpathchg) {
                   9757:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9758:                        $numpathchg.'" />'."\n";
                   9759:         }
                   9760:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9761:             ($actionurl eq '/adm/imsimport')) {
                   9762:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9763:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9764:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  9765:         } elsif ($actionurl eq '/adm/dependencies') {
                   9766:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  9767:         }
1.1071    raeburn  9768:         $output .=  '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  9769:     } elsif ($numpathchg) {
                   9770:         my %pathchange = ();
                   9771:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9772:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9773:             $output .= '<p>'.&mt('or').'</p>'; 
                   9774:         } 
                   9775:     }
1.1071    raeburn  9776:     return ($output,$counter,$numpathchg);
1.987     raeburn  9777: }
                   9778: 
                   9779: sub embedded_file_element {
1.1071    raeburn  9780:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  9781:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9782:                    (ref($codebase) eq 'HASH'));
                   9783:     my $output;
1.1071    raeburn  9784:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  9785:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9786:     }
                   9787:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9788:                &escape($embed_file).'" />';
                   9789:     unless (($context eq 'upload_embedded') && 
                   9790:             ($mapping->{$embed_file} eq $embed_file)) {
                   9791:         $output .='
                   9792:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9793:     }
                   9794:     my $attrib;
                   9795:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9796:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9797:     }
                   9798:     $output .=
                   9799:         "\n\t\t".
                   9800:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9801:         $attrib.'" />';
                   9802:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9803:         $output .=
                   9804:             "\n\t\t".
                   9805:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9806:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9807:     }
1.987     raeburn  9808:     return $output;
1.660     raeburn  9809: }
                   9810: 
1.1071    raeburn  9811: sub get_dependency_details {
                   9812:     my ($currfile,$currsubfile,$embed_file) = @_;
                   9813:     my ($size,$mtime,$showsize,$showmtime);
                   9814:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   9815:         if ($embed_file =~ m{/}) {
                   9816:             my ($path,$fname) = split(/\//,$embed_file);
                   9817:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   9818:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   9819:             }
                   9820:         } else {
                   9821:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   9822:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   9823:             }
                   9824:         }
                   9825:         $showsize = $size/1024.0;
                   9826:         $showsize = sprintf("%.1f",$showsize);
                   9827:         if ($mtime > 0) {
                   9828:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   9829:         }
                   9830:     }
                   9831:     return ($showsize,$showmtime);
                   9832: }
                   9833: 
                   9834: sub ask_embedded_js {
                   9835:     return <<"END";
                   9836: <script type="text/javascript"">
                   9837: // <![CDATA[
                   9838: function toggleBrowse(counter) {
                   9839:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   9840:     var fileid = document.getElementById('embedded_item_'+counter);
                   9841:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   9842:     if (chkboxid.checked == true) {
                   9843:         uploaddivid.style.display='block';
                   9844:     } else {
                   9845:         uploaddivid.style.display='none';
                   9846:         fileid.value = '';
                   9847:     }
                   9848: }
                   9849: // ]]>
                   9850: </script>
                   9851: 
                   9852: END
                   9853: }
                   9854: 
1.661     raeburn  9855: sub upload_embedded {
                   9856:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9857:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9858:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9859:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9860:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9861:         my $orig_uploaded_filename =
                   9862:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9863:         foreach my $type ('orig','ref','attrib','codebase') {
                   9864:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9865:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9866:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9867:             }
                   9868:         }
1.661     raeburn  9869:         my ($path,$fname) =
                   9870:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9871:         # no path, whole string is fname
                   9872:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9873:         $fname = &Apache::lonnet::clean_filename($fname);
                   9874:         # See if there is anything left
                   9875:         next if ($fname eq '');
                   9876: 
                   9877:         # Check if file already exists as a file or directory.
                   9878:         my ($state,$msg);
                   9879:         if ($context eq 'portfolio') {
                   9880:             my $port_path = $dirpath;
                   9881:             if ($group ne '') {
                   9882:                 $port_path = "groups/$group/$port_path";
                   9883:             }
1.987     raeburn  9884:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9885:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9886:                                               $dir_root,$port_path,$disk_quota,
                   9887:                                               $current_disk_usage,$uname,$udom);
                   9888:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9889:                 || $state eq 'file_locked') {
1.661     raeburn  9890:                 $output .= $msg;
                   9891:                 next;
                   9892:             }
                   9893:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9894:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9895:             if ($state eq 'exists') {
                   9896:                 $output .= $msg;
                   9897:                 next;
                   9898:             }
                   9899:         }
                   9900:         # Check if extension is valid
                   9901:         if (($fname =~ /\.(\w+)$/) &&
                   9902:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9903:             $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  9904:             next;
                   9905:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9906:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9907:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9908:             next;
                   9909:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9910:             $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  9911:             next;
                   9912:         }
                   9913:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9914:         if ($context eq 'portfolio') {
1.984     raeburn  9915:             my $result;
                   9916:             if ($state eq 'existingfile') {
                   9917:                 $result=
                   9918:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9919:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9920:             } else {
1.984     raeburn  9921:                 $result=
                   9922:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9923:                                                     $dirpath.
                   9924:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9925:                 if ($result !~ m|^/uploaded/|) {
                   9926:                     $output .= '<span class="LC_error">'
                   9927:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9928:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9929:                                .'</span><br />';
                   9930:                     next;
                   9931:                 } else {
1.987     raeburn  9932:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9933:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9934:                 }
1.661     raeburn  9935:             }
1.987     raeburn  9936:         } elsif ($context eq 'coursedoc') {
                   9937:             my $result =
                   9938:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9939:                                                 $dirpath.'/'.$path);
                   9940:             if ($result !~ m|^/uploaded/|) {
                   9941:                 $output .= '<span class="LC_error">'
                   9942:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9943:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9944:                            .'</span><br />';
                   9945:                     next;
                   9946:             } else {
                   9947:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9948:                            $path.$fname.'</span>').'<br />';
                   9949:             }
1.661     raeburn  9950:         } else {
                   9951: # Save the file
                   9952:             my $target = $env{'form.embedded_item_'.$i};
                   9953:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9954:             my $dest = $fullpath.$fname;
                   9955:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9956:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9957:             my $count;
                   9958:             my $filepath = $dir_root;
1.1027    raeburn  9959:             foreach my $subdir (@parts) {
                   9960:                 $filepath .= "/$subdir";
                   9961:                 if (!-e $filepath) {
1.661     raeburn  9962:                     mkdir($filepath,0770);
                   9963:                 }
                   9964:             }
                   9965:             my $fh;
                   9966:             if (!open($fh,'>'.$dest)) {
                   9967:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9968:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  9969:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   9970:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  9971:                            '</span><br />';
                   9972:             } else {
                   9973:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9974:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9975:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  9976:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   9977:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  9978:                               '</span><br />';
                   9979:                 } else {
1.987     raeburn  9980:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9981:                                $url.'</span>').'<br />';
                   9982:                     unless ($context eq 'testbank') {
                   9983:                         $footer .= &mt('View embedded file: [_1]',
                   9984:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9985:                     }
                   9986:                 }
                   9987:                 close($fh);
                   9988:             }
                   9989:         }
                   9990:         if ($env{'form.embedded_ref_'.$i}) {
                   9991:             $pathchange{$i} = 1;
                   9992:         }
                   9993:     }
                   9994:     if ($output) {
                   9995:         $output = '<p>'.$output.'</p>';
                   9996:     }
                   9997:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9998:     $returnflag = 'ok';
1.1071    raeburn  9999:     my $numpathchgs = scalar(keys(%pathchange));
                   10000:     if ($numpathchgs > 0) {
1.987     raeburn  10001:         if ($context eq 'portfolio') {
                   10002:             $output .= '<p>'.&mt('or').'</p>';
                   10003:         } elsif ($context eq 'testbank') {
1.1071    raeburn  10004:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   10005:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  10006:             $returnflag = 'modify_orightml';
                   10007:         }
                   10008:     }
1.1071    raeburn  10009:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  10010: }
                   10011: 
                   10012: sub modify_html_form {
                   10013:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   10014:     my $end = 0;
                   10015:     my $modifyform;
                   10016:     if ($context eq 'upload_embedded') {
                   10017:         return unless (ref($pathchange) eq 'HASH');
                   10018:         if ($env{'form.number_embedded_items'}) {
                   10019:             $end += $env{'form.number_embedded_items'};
                   10020:         }
                   10021:         if ($env{'form.number_pathchange_items'}) {
                   10022:             $end += $env{'form.number_pathchange_items'};
                   10023:         }
                   10024:         if ($end) {
                   10025:             for (my $i=0; $i<$end; $i++) {
                   10026:                 if ($i < $env{'form.number_embedded_items'}) {
                   10027:                     next unless($pathchange->{$i});
                   10028:                 }
                   10029:                 $modifyform .=
                   10030:                     &start_data_table_row().
                   10031:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   10032:                     'checked="checked" /></td>'.
                   10033:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   10034:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   10035:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   10036:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   10037:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   10038:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   10039:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   10040:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   10041:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   10042:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   10043:                     &end_data_table_row();
1.1071    raeburn  10044:             }
1.987     raeburn  10045:         }
                   10046:     } else {
                   10047:         $modifyform = $pathchgtable;
                   10048:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   10049:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   10050:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   10051:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   10052:         }
                   10053:     }
                   10054:     if ($modifyform) {
1.1071    raeburn  10055:         if ($actionurl eq '/adm/dependencies') {
                   10056:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   10057:         }
1.987     raeburn  10058:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   10059:                '<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".
                   10060:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   10061:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   10062:                '</ol></p>'."\n".'<p>'.
                   10063:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   10064:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   10065:                &start_data_table()."\n".
                   10066:                &start_data_table_header_row().
                   10067:                '<th>'.&mt('Change?').'</th>'.
                   10068:                '<th>'.&mt('Current reference').'</th>'.
                   10069:                '<th>'.&mt('Required reference').'</th>'.
                   10070:                &end_data_table_header_row()."\n".
                   10071:                $modifyform.
                   10072:                &end_data_table().'<br />'."\n".$hiddenstate.
                   10073:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   10074:                '</form>'."\n";
                   10075:     }
                   10076:     return;
                   10077: }
                   10078: 
                   10079: sub modify_html_refs {
                   10080:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   10081:     my $container;
                   10082:     if ($context eq 'portfolio') {
                   10083:         $container = $env{'form.container'};
                   10084:     } elsif ($context eq 'coursedoc') {
                   10085:         $container = $env{'form.primaryurl'};
1.1071    raeburn  10086:     } elsif ($context eq 'manage_dependencies') {
                   10087:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   10088:         $container = "/$container";
1.987     raeburn  10089:     } else {
1.1027    raeburn  10090:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  10091:     }
                   10092:     my (%allfiles,%codebase,$output,$content);
                   10093:     my @changes = &get_env_multiple('form.namechange');
1.1071    raeburn  10094:     unless (@changes > 0) {
                   10095:         if (wantarray) {
                   10096:             return ('',0,0); 
                   10097:         } else {
                   10098:             return;
                   10099:         }
                   10100:     }
                   10101:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
                   10102:         ($context eq 'manage_dependencies')) {
                   10103:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   10104:             if (wantarray) {
                   10105:                 return ('',0,0);
                   10106:             } else {
                   10107:                 return;
                   10108:             }
                   10109:         } 
1.987     raeburn  10110:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  10111:         if ($content eq '-1') {
                   10112:             if (wantarray) {
                   10113:                 return ('',0,0);
                   10114:             } else {
                   10115:                 return;
                   10116:             }
                   10117:         }
1.987     raeburn  10118:     } else {
1.1071    raeburn  10119:         unless ($container =~ /^\Q$dir_root\E/) {
                   10120:             if (wantarray) {
                   10121:                 return ('',0,0);
                   10122:             } else {
                   10123:                 return;
                   10124:             }
                   10125:         } 
1.987     raeburn  10126:         if (open(my $fh,"<$container")) {
                   10127:             $content = join('', <$fh>);
                   10128:             close($fh);
                   10129:         } else {
1.1071    raeburn  10130:             if (wantarray) {
                   10131:                 return ('',0,0);
                   10132:             } else {
                   10133:                 return;
                   10134:             }
1.987     raeburn  10135:         }
                   10136:     }
                   10137:     my ($count,$codebasecount) = (0,0);
                   10138:     my $mm = new File::MMagic;
                   10139:     my $mime_type = $mm->checktype_contents($content);
                   10140:     if ($mime_type eq 'text/html') {
                   10141:         my $parse_result = 
                   10142:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   10143:                                                     \%codebase,\$content);
                   10144:         if ($parse_result eq 'ok') {
                   10145:             foreach my $i (@changes) {
                   10146:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   10147:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   10148:                 if ($allfiles{$ref}) {
                   10149:                     my $newname =  $orig;
                   10150:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  10151:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  10152:                     if ($attrib_regexp =~ /:/) {
                   10153:                         $attrib_regexp =~ s/\:/|/g;
                   10154:                     }
                   10155:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   10156:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   10157:                         $count += $numchg;
                   10158:                     }
                   10159:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  10160:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  10161:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   10162:                         $codebasecount ++;
                   10163:                     }
                   10164:                 }
                   10165:             }
                   10166:             if ($count || $codebasecount) {
                   10167:                 my $saveresult;
1.1071    raeburn  10168:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
                   10169:                     ($context eq 'manage_dependencies')) {
1.987     raeburn  10170:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   10171:                     if ($url eq $container) {
                   10172:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   10173:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10174:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  10175:                                             $fname.'</span>').'</p>';
1.987     raeburn  10176:                     } else {
                   10177:                          $output = '<p class="LC_error">'.
                   10178:                                    &mt('Error: update failed for: [_1].',
                   10179:                                    '<span class="LC_filename">'.
                   10180:                                    $container.'</span>').'</p>';
                   10181:                     }
                   10182:                 } else {
                   10183:                     if (open(my $fh,">$container")) {
                   10184:                         print $fh $content;
                   10185:                         close($fh);
                   10186:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10187:                                   $count,'<span class="LC_filename">'.
                   10188:                                   $container.'</span>').'</p>';
1.661     raeburn  10189:                     } else {
1.987     raeburn  10190:                          $output = '<p class="LC_error">'.
                   10191:                                    &mt('Error: could not update [_1].',
                   10192:                                    '<span class="LC_filename">'.
                   10193:                                    $container.'</span>').'</p>';
1.661     raeburn  10194:                     }
                   10195:                 }
                   10196:             }
1.987     raeburn  10197:         } else {
                   10198:             &logthis('Failed to parse '.$container.
                   10199:                      ' to modify references: '.$parse_result);
1.661     raeburn  10200:         }
                   10201:     }
1.1071    raeburn  10202:     if (wantarray) {
                   10203:         return ($output,$count,$codebasecount);
                   10204:     } else {
                   10205:         return $output;
                   10206:     }
1.661     raeburn  10207: }
                   10208: 
                   10209: sub check_for_existing {
                   10210:     my ($path,$fname,$element) = @_;
                   10211:     my ($state,$msg);
                   10212:     if (-d $path.'/'.$fname) {
                   10213:         $state = 'exists';
                   10214:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10215:     } elsif (-e $path.'/'.$fname) {
                   10216:         $state = 'exists';
                   10217:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10218:     }
                   10219:     if ($state eq 'exists') {
                   10220:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   10221:     }
                   10222:     return ($state,$msg);
                   10223: }
                   10224: 
                   10225: sub check_for_upload {
                   10226:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   10227:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  10228:     my $filesize = length($env{'form.'.$element});
                   10229:     if (!$filesize) {
                   10230:         my $msg = '<span class="LC_error">'.
                   10231:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   10232:                       '<span class="LC_filename">'.$fname.'</span>',
                   10233:                       $filesize).'<br />'.
1.1007    raeburn  10234:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  10235:                   '</span>';
                   10236:         return ('zero_bytes',$msg);
                   10237:     }
                   10238:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  10239:     my $getpropath = 1;
1.1021    raeburn  10240:     my ($dirlistref,$listerror) =
                   10241:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  10242:     my $found_file = 0;
                   10243:     my $locked_file = 0;
1.991     raeburn  10244:     my @lockers;
                   10245:     my $navmap;
                   10246:     if ($env{'request.course.id'}) {
                   10247:         $navmap = Apache::lonnavmaps::navmap->new();
                   10248:     }
1.1021    raeburn  10249:     if (ref($dirlistref) eq 'ARRAY') {
                   10250:         foreach my $line (@{$dirlistref}) {
                   10251:             my ($file_name,$rest)=split(/\&/,$line,2);
                   10252:             if ($file_name eq $fname){
                   10253:                 $file_name = $path.$file_name;
                   10254:                 if ($group ne '') {
                   10255:                     $file_name = $group.$file_name;
                   10256:                 }
                   10257:                 $found_file = 1;
                   10258:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   10259:                     foreach my $lock (@lockers) {
                   10260:                         if (ref($lock) eq 'ARRAY') {
                   10261:                             my ($symb,$crsid) = @{$lock};
                   10262:                             if ($crsid eq $env{'request.course.id'}) {
                   10263:                                 if (ref($navmap)) {
                   10264:                                     my $res = $navmap->getBySymb($symb);
                   10265:                                     foreach my $part (@{$res->parts()}) { 
                   10266:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   10267:                                         unless (($slot_status == $res->RESERVED) ||
                   10268:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   10269:                                             $locked_file = 1;
                   10270:                                         }
1.991     raeburn  10271:                                     }
1.1021    raeburn  10272:                                 } else {
                   10273:                                     $locked_file = 1;
1.991     raeburn  10274:                                 }
                   10275:                             } else {
                   10276:                                 $locked_file = 1;
                   10277:                             }
                   10278:                         }
1.1021    raeburn  10279:                    }
                   10280:                 } else {
                   10281:                     my @info = split(/\&/,$rest);
                   10282:                     my $currsize = $info[6]/1000;
                   10283:                     if ($currsize < $filesize) {
                   10284:                         my $extra = $filesize - $currsize;
                   10285:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   10286:                             my $msg = '<span class="LC_error">'.
                   10287:                                       &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.',
                   10288:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   10289:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   10290:                                                    $disk_quota,$current_disk_usage);
                   10291:                             return ('will_exceed_quota',$msg);
                   10292:                         }
1.984     raeburn  10293:                     }
                   10294:                 }
1.661     raeburn  10295:             }
                   10296:         }
                   10297:     }
                   10298:     if (($current_disk_usage + $filesize) > $disk_quota){
                   10299:         my $msg = '<span class="LC_error">'.
                   10300:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   10301:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   10302:         return ('will_exceed_quota',$msg);
                   10303:     } elsif ($found_file) {
                   10304:         if ($locked_file) {
                   10305:             my $msg = '<span class="LC_error">';
                   10306:             $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>');
                   10307:             $msg .= '</span><br />';
                   10308:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   10309:             return ('file_locked',$msg);
                   10310:         } else {
                   10311:             my $msg = '<span class="LC_error">';
1.984     raeburn  10312:             $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  10313:             $msg .= '</span>';
1.984     raeburn  10314:             return ('existingfile',$msg);
1.661     raeburn  10315:         }
                   10316:     }
                   10317: }
                   10318: 
1.987     raeburn  10319: sub check_for_traversal {
                   10320:     my ($path,$url,$toplevel) = @_;
                   10321:     my @parts=split(/\//,$path);
                   10322:     my $cleanpath;
                   10323:     my $fullpath = $url;
                   10324:     for (my $i=0;$i<@parts;$i++) {
                   10325:         next if ($parts[$i] eq '.');
                   10326:         if ($parts[$i] eq '..') {
                   10327:             $fullpath =~ s{([^/]+/)$}{};
                   10328:         } else {
                   10329:             $fullpath .= $parts[$i].'/';
                   10330:         }
                   10331:     }
                   10332:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   10333:         $cleanpath = $1;
                   10334:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   10335:         my $curr_toprel = $1;
                   10336:         my @parts = split(/\//,$curr_toprel);
                   10337:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   10338:         my @urlparts = split(/\//,$url_toprel);
                   10339:         my $doubledots;
                   10340:         my $startdiff = -1;
                   10341:         for (my $i=0; $i<@urlparts; $i++) {
                   10342:             if ($startdiff == -1) {
                   10343:                 unless ($urlparts[$i] eq $parts[$i]) {
                   10344:                     $startdiff = $i;
                   10345:                     $doubledots .= '../';
                   10346:                 }
                   10347:             } else {
                   10348:                 $doubledots .= '../';
                   10349:             }
                   10350:         }
                   10351:         if ($startdiff > -1) {
                   10352:             $cleanpath = $doubledots;
                   10353:             for (my $i=$startdiff; $i<@parts; $i++) {
                   10354:                 $cleanpath .= $parts[$i].'/';
                   10355:             }
                   10356:         }
                   10357:     }
                   10358:     $cleanpath =~ s{(/)$}{};
                   10359:     return $cleanpath;
                   10360: }
1.31      albertel 10361: 
1.1053    raeburn  10362: sub is_archive_file {
                   10363:     my ($mimetype) = @_;
                   10364:     if (($mimetype eq 'application/octet-stream') ||
                   10365:         ($mimetype eq 'application/x-stuffit') ||
                   10366:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   10367:         return 1;
                   10368:     }
                   10369:     return;
                   10370: }
                   10371: 
                   10372: sub decompress_form {
1.1065    raeburn  10373:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  10374:     my %lt = &Apache::lonlocal::texthash (
                   10375:         this => 'This file is an archive file.',
1.1067    raeburn  10376:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  10377:         itsc => 'Its contents are as follows:',
1.1053    raeburn  10378:         youm => 'You may wish to extract its contents.',
                   10379:         extr => 'Extract contents',
1.1067    raeburn  10380:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   10381:         proa => 'Process automatically?',
1.1053    raeburn  10382:         yes  => 'Yes',
                   10383:         no   => 'No',
1.1067    raeburn  10384:         fold => 'Title for folder containing movie',
                   10385:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  10386:     );
1.1065    raeburn  10387:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  10388:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  10389:     my $info = &list_archive_contents($fileloc,\@paths);
                   10390:     if (@paths) {
                   10391:         foreach my $path (@paths) {
                   10392:             $path =~ s{^/}{};
1.1067    raeburn  10393:             if ($path =~ m{^([^/]+)/$}) {
                   10394:                 $topdir = $1;
                   10395:             }
1.1065    raeburn  10396:             if ($path =~ m{^([^/]+)/}) {
                   10397:                 $toplevel{$1} = $path;
                   10398:             } else {
                   10399:                 $toplevel{$path} = $path;
                   10400:             }
                   10401:         }
                   10402:     }
1.1067    raeburn  10403:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   10404:         my @camtasia = ("$topdir/","$topdir/index.html",
                   10405:                         "$topdir/media/",
                   10406:                         "$topdir/media/$topdir.mp4",
                   10407:                         "$topdir/media/FirstFrame.png",
                   10408:                         "$topdir/media/player.swf",
                   10409:                         "$topdir/media/swfobject.js",
                   10410:                         "$topdir/media/expressInstall.swf");
                   10411:         my @diffs = &compare_arrays(\@paths,\@camtasia);
                   10412:         if (@diffs == 0) {
                   10413:             $is_camtasia = 1;
                   10414:         }
                   10415:     }
                   10416:     my $output;
                   10417:     if ($is_camtasia) {
                   10418:         $output = <<"ENDCAM";
                   10419: <script type="text/javascript" language="Javascript">
                   10420: // <![CDATA[
                   10421: 
                   10422: function camtasiaToggle() {
                   10423:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   10424:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
                   10425:             if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
                   10426: 
                   10427:                 document.getElementById('camtasia_titles').style.display='block';
                   10428:             } else {
                   10429:                 document.getElementById('camtasia_titles').style.display='none';
                   10430:             }
                   10431:         }
                   10432:     }
                   10433:     return;
                   10434: }
                   10435: 
                   10436: // ]]>
                   10437: </script>
                   10438: <p>$lt{'camt'}</p>
                   10439: ENDCAM
1.1065    raeburn  10440:     } else {
1.1067    raeburn  10441:         $output = '<p>'.$lt{'this'};
                   10442:         if ($info eq '') {
                   10443:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   10444:         } else {
                   10445:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   10446:                        '<div><pre>'.$info.'</pre></div>';
                   10447:         }
1.1065    raeburn  10448:     }
1.1067    raeburn  10449:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  10450:     my $duplicates;
                   10451:     my $num = 0;
                   10452:     if (ref($dirlist) eq 'ARRAY') {
                   10453:         foreach my $item (@{$dirlist}) {
                   10454:             if (ref($item) eq 'ARRAY') {
                   10455:                 if (exists($toplevel{$item->[0]})) {
                   10456:                     $duplicates .= 
                   10457:                         &start_data_table_row().
                   10458:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10459:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   10460:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10461:                         'value="1" />'.&mt('Yes').'</label>'.
                   10462:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   10463:                         '<td>'.$item->[0].'</td>';
                   10464:                     if ($item->[2]) {
                   10465:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   10466:                     } else {
                   10467:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   10468:                     }
                   10469:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   10470:                                    '<td>'.
                   10471:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   10472:                                    '</td>'.
                   10473:                                    &end_data_table_row();
                   10474:                     $num ++;
                   10475:                 }
                   10476:             }
                   10477:         }
                   10478:     }
                   10479:     my $itemcount;
                   10480:     if (@paths > 0) {
                   10481:         $itemcount = scalar(@paths);
                   10482:     } else {
                   10483:         $itemcount = 1;
                   10484:     }
1.1067    raeburn  10485:     if ($is_camtasia) {
                   10486:         $output .= $lt{'auto'}.'<br />'.
                   10487:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
                   10488:                    '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
                   10489:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   10490:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   10491:                    $lt{'no'}.'</label></span><br />'.
                   10492:                    '<div id="camtasia_titles" style="display:block">'.
                   10493:                    &Apache::lonhtmlcommon::start_pick_box().
                   10494:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   10495:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   10496:                    &Apache::lonhtmlcommon::row_closure().
                   10497:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   10498:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   10499:                    &Apache::lonhtmlcommon::row_closure(1).
                   10500:                    &Apache::lonhtmlcommon::end_pick_box().
                   10501:                    '</div>';
                   10502:     }
1.1065    raeburn  10503:     $output .= 
                   10504:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  10505:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   10506:         "\n";
1.1065    raeburn  10507:     if ($duplicates ne '') {
                   10508:         $output .= '<p><span class="LC_warning">'.
                   10509:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   10510:                    &start_data_table().
                   10511:                    &start_data_table_header_row().
                   10512:                    '<th>'.&mt('Overwrite?').'</th>'.
                   10513:                    '<th>'.&mt('Name').'</th>'.
                   10514:                    '<th>'.&mt('Type').'</th>'.
                   10515:                    '<th>'.&mt('Size').'</th>'.
                   10516:                    '<th>'.&mt('Last modified').'</th>'.
                   10517:                    &end_data_table_header_row().
                   10518:                    $duplicates.
                   10519:                    &end_data_table().
                   10520:                    '</p>';
                   10521:     }
1.1067    raeburn  10522:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  10523:     if (ref($hiddenelements) eq 'HASH') {
                   10524:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   10525:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   10526:         }
                   10527:     }
                   10528:     $output .= <<"END";
1.1067    raeburn  10529: <br />
1.1053    raeburn  10530: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   10531: </form>
                   10532: $noextract
                   10533: END
                   10534:     return $output;
                   10535: }
                   10536: 
1.1065    raeburn  10537: sub decompression_utility {
                   10538:     my ($program) = @_;
                   10539:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   10540:     my $location;
                   10541:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   10542:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   10543:                          '/usr/sbin/') {
                   10544:             if (-x $dir.$program) {
                   10545:                 $location = $dir.$program;
                   10546:                 last;
                   10547:             }
                   10548:         }
                   10549:     }
                   10550:     return $location;
                   10551: }
                   10552: 
                   10553: sub list_archive_contents {
                   10554:     my ($file,$pathsref) = @_;
                   10555:     my (@cmd,$output);
                   10556:     my $needsregexp;
                   10557:     if ($file =~ /\.zip$/) {
                   10558:         @cmd = (&decompression_utility('unzip'),"-l");
                   10559:         $needsregexp = 1;
                   10560:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   10561:              ($file =~ /\.tgz$/)) {
                   10562:         @cmd = (&decompression_utility('tar'),"-ztf");
                   10563:     } elsif ($file =~ /\.tar\.bz2$/) {
                   10564:         @cmd = (&decompression_utility('tar'),"-jtf");
                   10565:     } elsif ($file =~ m|\.tar$|) {
                   10566:         @cmd = (&decompression_utility('tar'),"-tf");
                   10567:     }
                   10568:     if (@cmd) {
                   10569:         undef($!);
                   10570:         undef($@);
                   10571:         if (open(my $fh,"-|", @cmd, $file)) {
                   10572:             while (my $line = <$fh>) {
                   10573:                 $output .= $line;
                   10574:                 chomp($line);
                   10575:                 my $item;
                   10576:                 if ($needsregexp) {
                   10577:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   10578:                 } else {
                   10579:                     $item = $line;
                   10580:                 }
                   10581:                 if ($item ne '') {
                   10582:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   10583:                         push(@{$pathsref},$item);
                   10584:                     } 
                   10585:                 }
                   10586:             }
                   10587:             close($fh);
                   10588:         }
                   10589:     }
                   10590:     return $output;
                   10591: }
                   10592: 
1.1053    raeburn  10593: sub decompress_uploaded_file {
                   10594:     my ($file,$dir) = @_;
                   10595:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   10596:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   10597:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   10598:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   10599:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   10600:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   10601:     my $decompressed = $env{'cgi.decompressed'};
                   10602:     &Apache::lonnet::delenv('cgi.file');
                   10603:     &Apache::lonnet::delenv('cgi.dir');
                   10604:     &Apache::lonnet::delenv('cgi.decompressed');
                   10605:     return ($decompressed,$result);
                   10606: }
                   10607: 
1.1055    raeburn  10608: sub process_decompression {
                   10609:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   10610:     my ($dir,$error,$warning,$output);
                   10611:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
                   10612:         $error = &mt('File name not a supported archive file type.').
                   10613:                  '<br />'.&mt('File name should end with one of: [_1].',
                   10614:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   10615:     } else {
                   10616:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10617:         if ($docuhome eq 'no_host') {
                   10618:             $error = &mt('Could not determine home server for course.');
                   10619:         } else {
                   10620:             my @ids=&Apache::lonnet::current_machine_ids();
                   10621:             my $currdir = "$dir_root/$destination";
                   10622:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10623:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   10624:                        "$dir_root/$destination";
                   10625:             } else {
                   10626:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   10627:                        "$dir_root/$docudom/$docuname/$destination";
                   10628:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   10629:                     $error = &mt('Archive file not found.');
                   10630:                 }
                   10631:             }
1.1065    raeburn  10632:             my (@to_overwrite,@to_skip);
                   10633:             if ($env{'form.archive_overwrite_total'} > 0) {
                   10634:                 my $total = $env{'form.archive_overwrite_total'};
                   10635:                 for (my $i=0; $i<$total; $i++) {
                   10636:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   10637:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   10638:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   10639:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   10640:                     }
                   10641:                 }
                   10642:             }
                   10643:             my $numskip = scalar(@to_skip);
                   10644:             if (($numskip > 0) && 
                   10645:                 ($numskip == $env{'form.archive_itemcount'})) {
                   10646:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   10647:             } elsif ($dir eq '') {
1.1055    raeburn  10648:                 $error = &mt('Directory containing archive file unavailable.');
                   10649:             } elsif (!$error) {
1.1065    raeburn  10650:                 my ($decompressed,$display);
                   10651:                 if ($numskip > 0) {
                   10652:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   10653:                     mkdir("$dir/$tempdir",0755);
                   10654:                     system("mv $dir/$file $dir/$tempdir/$file");
                   10655:                     ($decompressed,$display) = 
                   10656:                         &decompress_uploaded_file($file,"$dir/$tempdir");
                   10657:                     foreach my $item (@to_skip) {
                   10658:                         if (($item ne '') && ($item !~ /\.\./)) {
                   10659:                             if (-f "$dir/$tempdir/$item") { 
                   10660:                                 unlink("$dir/$tempdir/$item");
                   10661:                             } elsif (-d "$dir/$tempdir/$item") {
                   10662:                                 system("rm -rf $dir/$tempdir/$item");
                   10663:                             }
                   10664:                         }
                   10665:                     }
                   10666:                     system("mv $dir/$tempdir/* $dir");
                   10667:                     rmdir("$dir/$tempdir");   
                   10668:                 } else {
                   10669:                     ($decompressed,$display) = 
                   10670:                         &decompress_uploaded_file($file,$dir);
                   10671:                 }
1.1055    raeburn  10672:                 if ($decompressed eq 'ok') {
1.1065    raeburn  10673:                     $output = '<p class="LC_info">'.
                   10674:                               &mt('Files extracted successfully from archive.').
                   10675:                               '</p>'."\n";
1.1055    raeburn  10676:                     my ($warning,$result,@contents);
                   10677:                     my ($newdirlistref,$newlisterror) =
                   10678:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   10679:                                                  $docuname,1);
                   10680:                     my (%is_dir,%changes,@newitems);
                   10681:                     my $dirptr = 16384;
1.1065    raeburn  10682:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  10683:                         foreach my $dir_line (@{$newdirlistref}) {
                   10684:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065    raeburn  10685:                             unless (($item =~ /^\.+$/) || ($item eq $file) || 
                   10686:                                     ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055    raeburn  10687:                                 push(@newitems,$item);
                   10688:                                 if ($dirptr&$testdir) {
                   10689:                                     $is_dir{$item} = 1;
                   10690:                                 }
                   10691:                                 $changes{$item} = 1;
                   10692:                             }
                   10693:                         }
                   10694:                     }
                   10695:                     if (keys(%changes) > 0) {
                   10696:                         foreach my $item (sort(@newitems)) {
                   10697:                             if ($changes{$item}) {
                   10698:                                 push(@contents,$item);
                   10699:                             }
                   10700:                         }
                   10701:                     }
                   10702:                     if (@contents > 0) {
1.1067    raeburn  10703:                         my $wantform;
                   10704:                         unless ($env{'form.autoextract_camtasia'}) {
                   10705:                             $wantform = 1;
                   10706:                         }
1.1056    raeburn  10707:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  10708:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   10709:                                                                 $currdir,\%is_dir,
                   10710:                                                                 \%children,\%parent,
1.1056    raeburn  10711:                                                                 \@contents,\%dirorder,
                   10712:                                                                 \%titles,$wantform);
1.1055    raeburn  10713:                         if ($datatable ne '') {
                   10714:                             $output .= &archive_options_form('decompressed',$datatable,
                   10715:                                                              $count,$hiddenelem);
1.1065    raeburn  10716:                             my $startcount = 6;
1.1055    raeburn  10717:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  10718:                                                            \%titles,\%children);
1.1055    raeburn  10719:                         }
1.1067    raeburn  10720:                         if ($env{'form.autoextract_camtasia'}) {
                   10721:                             my %displayed;
                   10722:                             my $total = 1;
                   10723:                             $env{'form.archive_directory'} = [];
                   10724:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   10725:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   10726:                                 $path =~ s{/$}{};
                   10727:                                 my $item;
                   10728:                                 if ($path ne '') {
                   10729:                                     $item = "$path/$titles{$i}";
                   10730:                                 } else {
                   10731:                                     $item = $titles{$i};
                   10732:                                 }
                   10733:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   10734:                                 if ($item eq $contents[0]) {
                   10735:                                     push(@{$env{'form.archive_directory'}},$i);
                   10736:                                     $env{'form.archive_'.$i} = 'display';
                   10737:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   10738:                                     $displayed{'folder'} = $i;
                   10739:                                 } elsif ($item eq "$contents[0]/index.html") {
                   10740:                                     $env{'form.archive_'.$i} = 'display';
                   10741:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   10742:                                     $displayed{'web'} = $i;
                   10743:                                 } else {
                   10744:                                     if ($item eq "$contents[0]/media") {
                   10745:                                         push(@{$env{'form.archive_directory'}},$i);
                   10746:                                     }
                   10747:                                     $env{'form.archive_'.$i} = 'dependency';
                   10748:                                 }
                   10749:                                 $total ++;
                   10750:                             }
                   10751:                             for (my $i=1; $i<$total; $i++) {
                   10752:                                 next if ($i == $displayed{'web'});
                   10753:                                 next if ($i == $displayed{'folder'});
                   10754:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   10755:                             }
                   10756:                             $env{'form.phase'} = 'decompress_cleanup';
                   10757:                             $env{'form.archivedelete'} = 1;
                   10758:                             $env{'form.archive_count'} = $total-1;
                   10759:                             $output .=
                   10760:                                 &process_extracted_files('coursedocs',$docudom,
                   10761:                                                          $docuname,$destination,
                   10762:                                                          $dir_root,$hiddenelem);
                   10763:                         }
1.1055    raeburn  10764:                     } else {
                   10765:                         $warning = &mt('No new items extracted from archive file.');
                   10766:                     }
                   10767:                 } else {
                   10768:                     $output = $display;
                   10769:                     $error = &mt('An error occurred during extraction from the archive file.');
                   10770:                 }
                   10771:             }
                   10772:         }
                   10773:     }
                   10774:     if ($error) {
                   10775:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10776:                    $error.'</p>'."\n";
                   10777:     }
                   10778:     if ($warning) {
                   10779:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10780:     }
                   10781:     return $output;
                   10782: }
                   10783: 
                   10784: sub get_extracted {
1.1056    raeburn  10785:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   10786:         $titles,$wantform) = @_;
1.1055    raeburn  10787:     my $count = 0;
                   10788:     my $depth = 0;
                   10789:     my $datatable;
1.1056    raeburn  10790:     my @hierarchy;
1.1055    raeburn  10791:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  10792:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   10793:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  10794:     foreach my $item (@{$contents}) {
                   10795:         $count ++;
1.1056    raeburn  10796:         @{$dirorder->{$count}} = @hierarchy;
                   10797:         $titles->{$count} = $item;
1.1055    raeburn  10798:         &archive_hierarchy($depth,$count,$parent,$children);
                   10799:         if ($wantform) {
                   10800:             $datatable .= &archive_row($is_dir->{$item},$item,
                   10801:                                        $currdir,$depth,$count);
                   10802:         }
                   10803:         if ($is_dir->{$item}) {
                   10804:             $depth ++;
1.1056    raeburn  10805:             push(@hierarchy,$count);
                   10806:             $parent->{$depth} = $count;
1.1055    raeburn  10807:             $datatable .=
                   10808:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  10809:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   10810:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  10811:             $depth --;
1.1056    raeburn  10812:             pop(@hierarchy);
1.1055    raeburn  10813:         }
                   10814:     }
                   10815:     return ($count,$datatable);
                   10816: }
                   10817: 
                   10818: sub recurse_extracted_archive {
1.1056    raeburn  10819:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   10820:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  10821:     my $result='';
1.1056    raeburn  10822:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   10823:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   10824:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  10825:         return $result;
                   10826:     }
                   10827:     my $dirptr = 16384;
                   10828:     my ($newdirlistref,$newlisterror) =
                   10829:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   10830:     if (ref($newdirlistref) eq 'ARRAY') {
                   10831:         foreach my $dir_line (@{$newdirlistref}) {
                   10832:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   10833:             unless ($item =~ /^\.+$/) {
                   10834:                 $$count ++;
1.1056    raeburn  10835:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   10836:                 $titles->{$$count} = $item;
1.1055    raeburn  10837:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  10838: 
1.1055    raeburn  10839:                 my $is_dir;
                   10840:                 if ($dirptr&$testdir) {
                   10841:                     $is_dir = 1;
                   10842:                 }
                   10843:                 if ($wantform) {
                   10844:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   10845:                 }
                   10846:                 if ($is_dir) {
                   10847:                     $$depth ++;
1.1056    raeburn  10848:                     push(@{$hierarchy},$$count);
                   10849:                     $parent->{$$depth} = $$count;
1.1055    raeburn  10850:                     $result .=
                   10851:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   10852:                                                    $docuname,$depth,$count,
1.1056    raeburn  10853:                                                    $hierarchy,$dirorder,$children,
                   10854:                                                    $parent,$titles,$wantform);
1.1055    raeburn  10855:                     $$depth --;
1.1056    raeburn  10856:                     pop(@{$hierarchy});
1.1055    raeburn  10857:                 }
                   10858:             }
                   10859:         }
                   10860:     }
                   10861:     return $result;
                   10862: }
                   10863: 
                   10864: sub archive_hierarchy {
                   10865:     my ($depth,$count,$parent,$children) =@_;
                   10866:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   10867:         if (exists($parent->{$depth})) {
                   10868:              $children->{$parent->{$depth}} .= $count.':';
                   10869:         }
                   10870:     }
                   10871:     return;
                   10872: }
                   10873: 
                   10874: sub archive_row {
                   10875:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   10876:     my ($name) = ($item =~ m{([^/]+)$});
                   10877:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  10878:                                        'display'    => 'Add as file',
1.1055    raeburn  10879:                                        'dependency' => 'Include as dependency',
                   10880:                                        'discard'    => 'Discard',
                   10881:                                       );
                   10882:     if ($is_dir) {
1.1059    raeburn  10883:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  10884:     }
1.1056    raeburn  10885:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   10886:     my $offset = 0;
1.1055    raeburn  10887:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  10888:         $offset ++;
1.1065    raeburn  10889:         if ($action ne 'display') {
                   10890:             $offset ++;
                   10891:         }  
1.1055    raeburn  10892:         $output .= '<td><span class="LC_nobreak">'.
                   10893:                    '<label><input type="radio" name="archive_'.$count.
                   10894:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   10895:         my $text = $choices{$action};
                   10896:         if ($is_dir) {
                   10897:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   10898:             if ($action eq 'display') {
1.1059    raeburn  10899:                 $text = &mt('Add as folder');
1.1055    raeburn  10900:             }
1.1056    raeburn  10901:         } else {
                   10902:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   10903: 
                   10904:         }
                   10905:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   10906:         if ($action eq 'dependency') {
                   10907:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   10908:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   10909:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   10910:                        '<option value=""></option>'."\n".
                   10911:                        '</select>'."\n".
                   10912:                        '</div>';
1.1059    raeburn  10913:         } elsif ($action eq 'display') {
                   10914:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   10915:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   10916:                        '</div>';
1.1055    raeburn  10917:         }
1.1056    raeburn  10918:         $output .= '</td>';
1.1055    raeburn  10919:     }
                   10920:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   10921:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   10922:     for (my $i=0; $i<$depth; $i++) {
                   10923:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   10924:     }
                   10925:     if ($is_dir) {
                   10926:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   10927:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   10928:     } else {
                   10929:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   10930:     }
                   10931:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   10932:                &end_data_table_row();
                   10933:     return $output;
                   10934: }
                   10935: 
                   10936: sub archive_options_form {
1.1065    raeburn  10937:     my ($form,$display,$count,$hiddenelem) = @_;
                   10938:     my %lt = &Apache::lonlocal::texthash(
                   10939:                perm => 'Permanently remove archive file?',
                   10940:                hows => 'How should each extracted item be incorporated in the course?',
                   10941:                cont => 'Content actions for all',
                   10942:                addf => 'Add as folder/file',
                   10943:                incd => 'Include as dependency for a displayed file',
                   10944:                disc => 'Discard',
                   10945:                no   => 'No',
                   10946:                yes  => 'Yes',
                   10947:                save => 'Save',
                   10948:     );
                   10949:     my $output = <<"END";
                   10950: <form name="$form" method="post" action="">
                   10951: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   10952: <label>
                   10953:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   10954: </label>
                   10955: &nbsp;
                   10956: <label>
                   10957:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   10958: </span>
                   10959: </p>
                   10960: <input type="hidden" name="phase" value="decompress_cleanup" />
                   10961: <br />$lt{'hows'}
                   10962: <div class="LC_columnSection">
                   10963:   <fieldset>
                   10964:     <legend>$lt{'cont'}</legend>
                   10965:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   10966:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   10967:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   10968:   </fieldset>
                   10969: </div>
                   10970: END
                   10971:     return $output.
1.1055    raeburn  10972:            &start_data_table()."\n".
1.1065    raeburn  10973:            $display."\n".
1.1055    raeburn  10974:            &end_data_table()."\n".
                   10975:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   10976:            $hiddenelem.
1.1065    raeburn  10977:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  10978:            '</form>';
                   10979: }
                   10980: 
                   10981: sub archive_javascript {
1.1056    raeburn  10982:     my ($startcount,$numitems,$titles,$children) = @_;
                   10983:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  10984:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  10985:     my $scripttag = <<START;
                   10986: <script type="text/javascript">
                   10987: // <![CDATA[
                   10988: 
                   10989: function checkAll(form,prefix) {
                   10990:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   10991:     for (var i=0; i < form.elements.length; i++) {
                   10992:         var id = form.elements[i].id;
                   10993:         if ((id != '') && (id != undefined)) {
                   10994:             if (idstr.test(id)) {
                   10995:                 if (form.elements[i].type == 'radio') {
                   10996:                     form.elements[i].checked = true;
1.1056    raeburn  10997:                     var nostart = i-$startcount;
1.1059    raeburn  10998:                     var offset = nostart%7;
                   10999:                     var count = (nostart-offset)/7;    
1.1056    raeburn  11000:                     dependencyCheck(form,count,offset);
1.1055    raeburn  11001:                 }
                   11002:             }
                   11003:         }
                   11004:     }
                   11005: }
                   11006: 
                   11007: function propagateCheck(form,count) {
                   11008:     if (count > 0) {
1.1059    raeburn  11009:         var startelement = $startcount + ((count-1) * 7);
                   11010:         for (var j=1; j<6; j++) {
                   11011:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  11012:                 var item = startelement + j; 
                   11013:                 if (form.elements[item].type == 'radio') {
                   11014:                     if (form.elements[item].checked) {
                   11015:                         containerCheck(form,count,j);
                   11016:                         break;
                   11017:                     }
1.1055    raeburn  11018:                 }
                   11019:             }
                   11020:         }
                   11021:     }
                   11022: }
                   11023: 
                   11024: numitems = $numitems
1.1056    raeburn  11025: var titles = new Array(numitems);
                   11026: var parents = new Array(numitems);
1.1055    raeburn  11027: for (var i=0; i<numitems; i++) {
1.1056    raeburn  11028:     parents[i] = new Array;
1.1055    raeburn  11029: }
1.1059    raeburn  11030: var maintitle = '$maintitle';
1.1055    raeburn  11031: 
                   11032: START
                   11033: 
1.1056    raeburn  11034:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   11035:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  11036:         for (my $i=0; $i<@contents; $i ++) {
                   11037:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   11038:         }
                   11039:     }
                   11040: 
1.1056    raeburn  11041:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   11042:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   11043:     }
                   11044: 
1.1055    raeburn  11045:     $scripttag .= <<END;
                   11046: 
                   11047: function containerCheck(form,count,offset) {
                   11048:     if (count > 0) {
1.1056    raeburn  11049:         dependencyCheck(form,count,offset);
1.1059    raeburn  11050:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  11051:         form.elements[item].checked = true;
                   11052:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11053:             if (parents[count].length > 0) {
                   11054:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  11055:                     containerCheck(form,parents[count][j],offset);
                   11056:                 }
                   11057:             }
                   11058:         }
                   11059:     }
                   11060: }
                   11061: 
                   11062: function dependencyCheck(form,count,offset) {
                   11063:     if (count > 0) {
1.1059    raeburn  11064:         var chosen = (offset+$startcount)+7*(count-1);
                   11065:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  11066:         var currtype = form.elements[depitem].type;
                   11067:         if (form.elements[chosen].value == 'dependency') {
                   11068:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   11069:             form.elements[depitem].options.length = 0;
                   11070:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   11071:             for (var i=1; i<count; i++) {
1.1059    raeburn  11072:                 var startelement = $startcount + (i-1) * 7;
                   11073:                 for (var j=1; j<6; j++) {
                   11074:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  11075:                         var item = startelement + j;
                   11076:                         if (form.elements[item].type == 'radio') {
                   11077:                             if (form.elements[item].checked) {
                   11078:                                 if (form.elements[item].value == 'display') {
                   11079:                                     var n = form.elements[depitem].options.length;
                   11080:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   11081:                                 }
                   11082:                             }
                   11083:                         }
                   11084:                     }
                   11085:                 }
                   11086:             }
                   11087:         } else {
                   11088:             document.getElementById('arc_depon_'+count).style.display='none';
                   11089:             form.elements[depitem].options.length = 0;
                   11090:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   11091:         }
1.1059    raeburn  11092:         titleCheck(form,count,offset);
1.1056    raeburn  11093:     }
                   11094: }
                   11095: 
                   11096: function propagateSelect(form,count,offset) {
                   11097:     if (count > 0) {
1.1065    raeburn  11098:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  11099:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   11100:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11101:             if (parents[count].length > 0) {
                   11102:                 for (var j=0; j<parents[count].length; j++) {
                   11103:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  11104:                 }
                   11105:             }
                   11106:         }
                   11107:     }
                   11108: }
1.1056    raeburn  11109: 
                   11110: function containerSelect(form,count,offset,picked) {
                   11111:     if (count > 0) {
1.1065    raeburn  11112:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  11113:         if (form.elements[item].type == 'radio') {
                   11114:             if (form.elements[item].value == 'dependency') {
                   11115:                 if (form.elements[item+1].type == 'select-one') {
                   11116:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   11117:                         if (form.elements[item+1].options[i].value == picked) {
                   11118:                             form.elements[item+1].selectedIndex = i;
                   11119:                             break;
                   11120:                         }
                   11121:                     }
                   11122:                 }
                   11123:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11124:                     if (parents[count].length > 0) {
                   11125:                         for (var j=0; j<parents[count].length; j++) {
                   11126:                             containerSelect(form,parents[count][j],offset,picked);
                   11127:                         }
                   11128:                     }
                   11129:                 }
                   11130:             }
                   11131:         }
                   11132:     }
                   11133: }
                   11134: 
1.1059    raeburn  11135: function titleCheck(form,count,offset) {
                   11136:     if (count > 0) {
                   11137:         var chosen = (offset+$startcount)+7*(count-1);
                   11138:         var depitem = $startcount + ((count-1) * 7) + 2;
                   11139:         var currtype = form.elements[depitem].type;
                   11140:         if (form.elements[chosen].value == 'display') {
                   11141:             document.getElementById('arc_title_'+count).style.display='block';
                   11142:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   11143:                 document.getElementById('archive_title_'+count).value=maintitle;
                   11144:             }
                   11145:         } else {
                   11146:             document.getElementById('arc_title_'+count).style.display='none';
                   11147:             if (currtype == 'text') { 
                   11148:                 document.getElementById('archive_title_'+count).value='';
                   11149:             }
                   11150:         }
                   11151:     }
                   11152:     return;
                   11153: }
                   11154: 
1.1055    raeburn  11155: // ]]>
                   11156: </script>
                   11157: END
                   11158:     return $scripttag;
                   11159: }
                   11160: 
                   11161: sub process_extracted_files {
1.1067    raeburn  11162:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  11163:     my $numitems = $env{'form.archive_count'};
                   11164:     return unless ($numitems);
                   11165:     my @ids=&Apache::lonnet::current_machine_ids();
                   11166:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  11167:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  11168:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   11169:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   11170:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   11171:         $pathtocheck = "$dir_root/$destination";
                   11172:         $dir = $dir_root;
                   11173:         $ishome = 1;
                   11174:     } else {
                   11175:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   11176:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   11177:         $dir = "$dir_root/$docudom/$docuname";    
                   11178:     }
                   11179:     my $currdir = "$dir_root/$destination";
                   11180:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   11181:     if ($env{'form.folderpath'}) {
                   11182:         my @items = split('&',$env{'form.folderpath'});
                   11183:         $folders{'0'} = $items[-2];
                   11184:         $containers{'0'}='sequence';
                   11185:     } elsif ($env{'form.pagepath'}) {
                   11186:         my @items = split('&',$env{'form.pagepath'});
                   11187:         $folders{'0'} = $items[-2];
                   11188:         $containers{'0'}='page';
                   11189:     }
                   11190:     my @archdirs = &get_env_multiple('form.archive_directory');
                   11191:     if ($numitems) {
                   11192:         for (my $i=1; $i<=$numitems; $i++) {
                   11193:             my $path = $env{'form.archive_content_'.$i};
                   11194:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   11195:                 my $item = $1;
                   11196:                 $toplevelitems{$item} = $i;
                   11197:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   11198:                     $is_dir{$item} = 1;
                   11199:                 }
                   11200:             }
                   11201:         }
                   11202:     }
1.1067    raeburn  11203:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  11204:     if (keys(%toplevelitems) > 0) {
                   11205:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  11206:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   11207:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  11208:     }
1.1066    raeburn  11209:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  11210:     if ($numitems) {
                   11211:         for (my $i=1; $i<=$numitems; $i++) {
                   11212:             my $path = $env{'form.archive_content_'.$i};
                   11213:             if ($path =~ /^\Q$pathtocheck\E/) {
                   11214:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   11215:                     if ($prefix ne '' && $path ne '') {
                   11216:                         if (-e $prefix.$path) {
1.1066    raeburn  11217:                             if ((@archdirs > 0) && 
                   11218:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   11219:                                 $todeletedir{$prefix.$path} = 1;
                   11220:                             } else {
                   11221:                                 $todelete{$prefix.$path} = 1;
                   11222:                             }
1.1055    raeburn  11223:                         }
                   11224:                     }
                   11225:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  11226:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  11227:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  11228:                     $docstitle = $env{'form.archive_title_'.$i};
                   11229:                     if ($docstitle eq '') {
                   11230:                         $docstitle = $title;
                   11231:                     }
1.1055    raeburn  11232:                     $outer = 0;
1.1056    raeburn  11233:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   11234:                         if (@{$dirorder{$i}} > 0) {
                   11235:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  11236:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   11237:                                     $outer = $item;
                   11238:                                     last;
                   11239:                                 }
                   11240:                             }
                   11241:                         }
                   11242:                     }
                   11243:                     my ($errtext,$fatal) = 
                   11244:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   11245:                                                '/'.$folders{$outer}.'.'.
                   11246:                                                $containers{$outer});
                   11247:                     next if ($fatal);
                   11248:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   11249:                         if ($context eq 'coursedocs') {
1.1056    raeburn  11250:                             $mapinner{$i} = time;
1.1055    raeburn  11251:                             $folders{$i} = 'default_'.$mapinner{$i};
                   11252:                             $containers{$i} = 'sequence';
                   11253:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11254:                                       $folders{$i}.'.'.$containers{$i};
                   11255:                             my $newidx = &LONCAPA::map::getresidx();
                   11256:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11257:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11258:                             push(@LONCAPA::map::order,$newidx);
                   11259:                             my ($outtext,$errtext) =
                   11260:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11261:                                                         $docuname.'/'.$folders{$outer}.
                   11262:                                                         '.'.$containers{$outer},1);
1.1056    raeburn  11263:                             $newseqid{$i} = $newidx;
1.1067    raeburn  11264:                             unless ($errtext) {
                   11265:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
                   11266:                             }
1.1055    raeburn  11267:                         }
                   11268:                     } else {
                   11269:                         if ($context eq 'coursedocs') {
                   11270:                             my $newidx=&LONCAPA::map::getresidx();
                   11271:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11272:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   11273:                                       $title;
                   11274:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   11275:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   11276:                             }
                   11277:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11278:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   11279:                             }
                   11280:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11281:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  11282:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067    raeburn  11283:                                 unless ($ishome) {
                   11284:                                     my $fetch = "$newdest{$i}/$title";
                   11285:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   11286:                                     $prompttofetch{$fetch} = 1;
                   11287:                                 }
1.1055    raeburn  11288:                             }
                   11289:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11290:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11291:                             push(@LONCAPA::map::order, $newidx);
                   11292:                             my ($outtext,$errtext)=
                   11293:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11294:                                                         $docuname.'/'.$folders{$outer}.
                   11295:                                                         '.'.$containers{$outer},1);
1.1067    raeburn  11296:                             unless ($errtext) {
                   11297:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   11298:                                     $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
                   11299:                                 }
                   11300:                             }
1.1055    raeburn  11301:                         }
                   11302:                     }
                   11303:                 } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056    raeburn  11304:                     my ($title) = ($path =~ m{/([^/]+)$});
                   11305:                     $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   11306:                     if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   11307:                         if (ref($dirorder{$i}) eq 'ARRAY') {
1.1067    raeburn  11308:                             my ($itemidx,$fullpath,$relpath);
1.1056    raeburn  11309:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   11310:                                 if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   11311:                                     my $container = $dirorder{$referrer{$i}}->[-1];
                   11312:                                     for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   11313:                                         if ($dirorder{$i}->[$j] eq $container) {
                   11314:                                             $itemidx = $j;
                   11315:                                         }
                   11316:                                     }
                   11317:                                 }
                   11318:                             }
                   11319:                             if ($itemidx ne '') {
                   11320:                                 if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   11321:                                     if ($mapinner{$referrer{$i}}) {
                   11322:                                         $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   11323:                                         for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11324:                                             if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11325:                                                 unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11326:                                                     $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067    raeburn  11327:                                                     $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056    raeburn  11328:                                                     if (!-e $fullpath) {
                   11329:                                                         mkdir($fullpath,0755);
                   11330:                                                     }
                   11331:                                                 }
                   11332:                                             } else {
                   11333:                                                 last;
                   11334:                                             }
                   11335:                                         }
                   11336:                                     }
                   11337:                                 } elsif ($newdest{$referrer{$i}}) {
                   11338:                                     $fullpath = $newdest{$referrer{$i}};
                   11339:                                     for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11340:                                         if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   11341:                                             $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   11342:                                             last;
                   11343:                                         } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11344:                                             unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11345:                                                 $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067    raeburn  11346:                                                 $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056    raeburn  11347:                                                 if (!-e $fullpath) {
                   11348:                                                     mkdir($fullpath,0755);
                   11349:                                                 }
                   11350:                                             }
                   11351:                                         } else {
                   11352:                                             last;
                   11353:                                         }
                   11354:                                     }
                   11355:                                 }
                   11356:                                 if ($fullpath ne '') {
1.1067    raeburn  11357:                                     if (-e "$prefix$path") {
                   11358:                                         system("mv $prefix$path $fullpath/$title");
                   11359:                                     }
                   11360:                                     if (-e "$fullpath/$title") {
                   11361:                                         my $showpath;
                   11362:                                         if ($relpath ne '') {
                   11363:                                             $showpath = "$relpath/$title";
                   11364:                                         } else {
                   11365:                                             $showpath = "/$title";
                   11366:                                         } 
                   11367:                                         $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
                   11368:                                     } 
                   11369:                                     unless ($ishome) {
                   11370:                                         my $fetch = "$fullpath/$title";
                   11371:                                         $fetch =~ s/^\Q$prefix$dir\E//; 
                   11372:                                         $prompttofetch{$fetch} = 1;
                   11373:                                     }
1.1056    raeburn  11374:                                 }
1.1055    raeburn  11375:                             }
                   11376:                         }
1.1056    raeburn  11377:                     } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   11378:                         $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   11379:                                         $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  11380:                     }
                   11381:                 }
                   11382:             } else {
                   11383:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   11384:             }
                   11385:         }
                   11386:         if (keys(%todelete)) {
                   11387:             foreach my $key (keys(%todelete)) {
                   11388:                 unlink($key);
1.1066    raeburn  11389:             }
                   11390:         }
                   11391:         if (keys(%todeletedir)) {
                   11392:             foreach my $key (keys(%todeletedir)) {
                   11393:                 rmdir($key);
                   11394:             }
                   11395:         }
                   11396:         foreach my $dir (sort(keys(%is_dir))) {
                   11397:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   11398:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  11399:             }
                   11400:         }
1.1067    raeburn  11401:         if ($result ne '') {
                   11402:             $output .= '<ul>'."\n".
                   11403:                        $result."\n".
                   11404:                        '</ul>';
                   11405:         }
                   11406:         unless ($ishome) {
                   11407:             my $replicationfail;
                   11408:             foreach my $item (keys(%prompttofetch)) {
                   11409:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   11410:                 unless ($fetchresult eq 'ok') {
                   11411:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   11412:                 }
                   11413:             }
                   11414:             if ($replicationfail) {
                   11415:                 $output .= '<p class="LC_error">'.
                   11416:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   11417:                            $replicationfail.
                   11418:                            '</ul></p>';
                   11419:             }
                   11420:         }
1.1055    raeburn  11421:     } else {
                   11422:         $warning = &mt('No items found in archive.');
                   11423:     }
                   11424:     if ($error) {
                   11425:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   11426:                    $error.'</p>'."\n";
                   11427:     }
                   11428:     if ($warning) {
                   11429:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   11430:     }
                   11431:     return $output;
                   11432: }
                   11433: 
1.1066    raeburn  11434: sub cleanup_empty_dirs {
                   11435:     my ($path) = @_;
                   11436:     if (($path ne '') && (-d $path)) {
                   11437:         if (opendir(my $dirh,$path)) {
                   11438:             my @dircontents = grep(!/^\./,readdir($dirh));
                   11439:             my $numitems = 0;
                   11440:             foreach my $item (@dircontents) {
                   11441:                 if (-d "$path/$item") {
                   11442:                     &recurse_dirs("$path/$item");
                   11443:                     if (-e "$path/$item") {
                   11444:                         $numitems ++;
                   11445:                     }
                   11446:                 } else {
                   11447:                     $numitems ++;
                   11448:                 }
                   11449:             }
                   11450:             if ($numitems == 0) {
                   11451:                 rmdir($path);
                   11452:             }
                   11453:             closedir($dirh);
                   11454:         }
                   11455:     }
                   11456:     return;
                   11457: }
                   11458: 
1.41      ng       11459: =pod
1.45      matthew  11460: 
1.1068    raeburn  11461: =item &get_folder_hierarchy()
                   11462: 
                   11463: Provides hierarchy of names of folders/sub-folders containing the current
                   11464: item,
                   11465: 
                   11466: Inputs: 3
                   11467:      - $navmap - navmaps object
                   11468: 
                   11469:      - $map - url for map (either the trigger itself, or map containing
                   11470:                            the resource, which is the trigger).
                   11471: 
                   11472:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   11473: 
                   11474: Outputs: 1 @pathitems - array of folder/subfolder names.
                   11475: 
                   11476: =cut
                   11477: 
                   11478: sub get_folder_hierarchy {
                   11479:     my ($navmap,$map,$showitem) = @_;
                   11480:     my @pathitems;
                   11481:     if (ref($navmap)) {
                   11482:         my $mapres = $navmap->getResourceByUrl($map);
                   11483:         if (ref($mapres)) {
                   11484:             my $pcslist = $mapres->map_hierarchy();
                   11485:             if ($pcslist ne '') {
                   11486:                 my @pcs = split(/,/,$pcslist);
                   11487:                 foreach my $pc (@pcs) {
                   11488:                     if ($pc == 1) {
                   11489:                         push(@pathitems,&mt('Main Course Documents'));
                   11490:                     } else {
                   11491:                         my $res = $navmap->getByMapPc($pc);
                   11492:                         if (ref($res)) {
                   11493:                             my $title = $res->compTitle();
                   11494:                             $title =~ s/\W+/_/g;
                   11495:                             if ($title ne '') {
                   11496:                                 push(@pathitems,$title);
                   11497:                             }
                   11498:                         }
                   11499:                     }
                   11500:                 }
                   11501:             }
1.1071    raeburn  11502:             if ($showitem) {
                   11503:                 if ($mapres->{ID} eq '0.0') {
                   11504:                     push(@pathitems,&mt('Main Course Documents'));
                   11505:                 } else {
                   11506:                     my $maptitle = $mapres->compTitle();
                   11507:                     $maptitle =~ s/\W+/_/g;
                   11508:                     if ($maptitle ne '') {
                   11509:                         push(@pathitems,$maptitle);
                   11510:                     }
1.1068    raeburn  11511:                 }
                   11512:             }
                   11513:         }
                   11514:     }
                   11515:     return @pathitems;
                   11516: }
                   11517: 
                   11518: =pod
                   11519: 
1.1015    raeburn  11520: =item * &get_turnedin_filepath()
                   11521: 
                   11522: Determines path in a user's portfolio file for storage of files uploaded
                   11523: to a specific essayresponse or dropbox item.
                   11524: 
                   11525: Inputs: 3 required + 1 optional.
                   11526: $symb is symb for resource, $uname and $udom are for current user (required).
                   11527: $caller is optional (can be "submission", if routine is called when storing
                   11528: an upoaded file when "Submit Answer" button was pressed).
                   11529: 
                   11530: Returns array containing $path and $multiresp. 
                   11531: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   11532: than one file upload item.  Callers of routine should append partid as a 
                   11533: subdirectory to $path in cases where $multiresp is 1.
                   11534: 
                   11535: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   11536: 
                   11537: =cut
                   11538: 
                   11539: sub get_turnedin_filepath {
                   11540:     my ($symb,$uname,$udom,$caller) = @_;
                   11541:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   11542:     my $turnindir;
                   11543:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   11544:     $turnindir = $userhash{'turnindir'};
                   11545:     my ($path,$multiresp);
                   11546:     if ($turnindir eq '') {
                   11547:         if ($caller eq 'submission') {
                   11548:             $turnindir = &mt('turned in');
                   11549:             $turnindir =~ s/\W+/_/g;
                   11550:             my %newhash = (
                   11551:                             'turnindir' => $turnindir,
                   11552:                           );
                   11553:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   11554:         }
                   11555:     }
                   11556:     if ($turnindir ne '') {
                   11557:         $path = '/'.$turnindir.'/';
                   11558:         my ($multipart,$turnin,@pathitems);
                   11559:         my $navmap = Apache::lonnavmaps::navmap->new();
                   11560:         if (defined($navmap)) {
                   11561:             my $mapres = $navmap->getResourceByUrl($map);
                   11562:             if (ref($mapres)) {
                   11563:                 my $pcslist = $mapres->map_hierarchy();
                   11564:                 if ($pcslist ne '') {
                   11565:                     foreach my $pc (split(/,/,$pcslist)) {
                   11566:                         my $res = $navmap->getByMapPc($pc);
                   11567:                         if (ref($res)) {
                   11568:                             my $title = $res->compTitle();
                   11569:                             $title =~ s/\W+/_/g;
                   11570:                             if ($title ne '') {
                   11571:                                 push(@pathitems,$title);
                   11572:                             }
                   11573:                         }
                   11574:                     }
                   11575:                 }
                   11576:                 my $maptitle = $mapres->compTitle();
                   11577:                 $maptitle =~ s/\W+/_/g;
                   11578:                 if ($maptitle ne '') {
                   11579:                     push(@pathitems,$maptitle);
                   11580:                 }
                   11581:                 unless ($env{'request.state'} eq 'construct') {
                   11582:                     my $res = $navmap->getBySymb($symb);
                   11583:                     if (ref($res)) {
                   11584:                         my $partlist = $res->parts();
                   11585:                         my $totaluploads = 0;
                   11586:                         if (ref($partlist) eq 'ARRAY') {
                   11587:                             foreach my $part (@{$partlist}) {
                   11588:                                 my @types = $res->responseType($part);
                   11589:                                 my @ids = $res->responseIds($part);
                   11590:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   11591:                                     if ($types[$i] eq 'essay') {
                   11592:                                         my $partid = $part.'_'.$ids[$i];
                   11593:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   11594:                                             $totaluploads ++;
                   11595:                                         }
                   11596:                                     }
                   11597:                                 }
                   11598:                             }
                   11599:                             if ($totaluploads > 1) {
                   11600:                                 $multiresp = 1;
                   11601:                             }
                   11602:                         }
                   11603:                     }
                   11604:                 }
                   11605:             } else {
                   11606:                 return;
                   11607:             }
                   11608:         } else {
                   11609:             return;
                   11610:         }
                   11611:         my $restitle=&Apache::lonnet::gettitle($symb);
                   11612:         $restitle =~ s/\W+/_/g;
                   11613:         if ($restitle eq '') {
                   11614:             $restitle = ($resurl =~ m{/[^/]+$});
                   11615:             if ($restitle eq '') {
                   11616:                 $restitle = time;
                   11617:             }
                   11618:         }
                   11619:         push(@pathitems,$restitle);
                   11620:         $path .= join('/',@pathitems);
                   11621:     }
                   11622:     return ($path,$multiresp);
                   11623: }
                   11624: 
                   11625: =pod
                   11626: 
1.464     albertel 11627: =back
1.41      ng       11628: 
1.112     bowersj2 11629: =head1 CSV Upload/Handling functions
1.38      albertel 11630: 
1.41      ng       11631: =over 4
                   11632: 
1.648     raeburn  11633: =item * &upfile_store($r)
1.41      ng       11634: 
                   11635: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 11636: needs $env{'form.upfile'}
1.41      ng       11637: returns $datatoken to be put into hidden field
                   11638: 
                   11639: =cut
1.31      albertel 11640: 
                   11641: sub upfile_store {
                   11642:     my $r=shift;
1.258     albertel 11643:     $env{'form.upfile'}=~s/\r/\n/gs;
                   11644:     $env{'form.upfile'}=~s/\f/\n/gs;
                   11645:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   11646:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 11647: 
1.258     albertel 11648:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   11649: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 11650:     {
1.158     raeburn  11651:         my $datafile = $r->dir_config('lonDaemons').
                   11652:                            '/tmp/'.$datatoken.'.tmp';
                   11653:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 11654:             print $fh $env{'form.upfile'};
1.158     raeburn  11655:             close($fh);
                   11656:         }
1.31      albertel 11657:     }
                   11658:     return $datatoken;
                   11659: }
                   11660: 
1.56      matthew  11661: =pod
                   11662: 
1.648     raeburn  11663: =item * &load_tmp_file($r)
1.41      ng       11664: 
                   11665: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 11666: needs $env{'form.datatoken'},
                   11667: sets $env{'form.upfile'} to the contents of the file
1.41      ng       11668: 
                   11669: =cut
1.31      albertel 11670: 
                   11671: sub load_tmp_file {
                   11672:     my $r=shift;
                   11673:     my @studentdata=();
                   11674:     {
1.158     raeburn  11675:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 11676:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  11677:         if ( open(my $fh,"<$studentfile") ) {
                   11678:             @studentdata=<$fh>;
                   11679:             close($fh);
                   11680:         }
1.31      albertel 11681:     }
1.258     albertel 11682:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 11683: }
                   11684: 
1.56      matthew  11685: =pod
                   11686: 
1.648     raeburn  11687: =item * &upfile_record_sep()
1.41      ng       11688: 
                   11689: Separate uploaded file into records
                   11690: returns array of records,
1.258     albertel 11691: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       11692: 
                   11693: =cut
1.31      albertel 11694: 
                   11695: sub upfile_record_sep {
1.258     albertel 11696:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 11697:     } else {
1.248     albertel 11698: 	my @records;
1.258     albertel 11699: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 11700: 	    if ($line=~/^\s*$/) { next; }
                   11701: 	    push(@records,$line);
                   11702: 	}
                   11703: 	return @records;
1.31      albertel 11704:     }
                   11705: }
                   11706: 
1.56      matthew  11707: =pod
                   11708: 
1.648     raeburn  11709: =item * &record_sep($record)
1.41      ng       11710: 
1.258     albertel 11711: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       11712: 
                   11713: =cut
                   11714: 
1.263     www      11715: sub takeleft {
                   11716:     my $index=shift;
                   11717:     return substr('0000'.$index,-4,4);
                   11718: }
                   11719: 
1.31      albertel 11720: sub record_sep {
                   11721:     my $record=shift;
                   11722:     my %components=();
1.258     albertel 11723:     if ($env{'form.upfiletype'} eq 'xml') {
                   11724:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 11725:         my $i=0;
1.356     albertel 11726:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 11727:             $field=~s/^(\"|\')//;
                   11728:             $field=~s/(\"|\')$//;
1.263     www      11729:             $components{&takeleft($i)}=$field;
1.31      albertel 11730:             $i++;
                   11731:         }
1.258     albertel 11732:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 11733:         my $i=0;
1.356     albertel 11734:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 11735:             $field=~s/^(\"|\')//;
                   11736:             $field=~s/(\"|\')$//;
1.263     www      11737:             $components{&takeleft($i)}=$field;
1.31      albertel 11738:             $i++;
                   11739:         }
                   11740:     } else {
1.561     www      11741:         my $separator=',';
1.480     banghart 11742:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      11743:             $separator=';';
1.480     banghart 11744:         }
1.31      albertel 11745:         my $i=0;
1.561     www      11746: # the character we are looking for to indicate the end of a quote or a record 
                   11747:         my $looking_for=$separator;
                   11748: # do not add the characters to the fields
                   11749:         my $ignore=0;
                   11750: # we just encountered a separator (or the beginning of the record)
                   11751:         my $just_found_separator=1;
                   11752: # store the field we are working on here
                   11753:         my $field='';
                   11754: # work our way through all characters in record
                   11755:         foreach my $character ($record=~/(.)/g) {
                   11756:             if ($character eq $looking_for) {
                   11757:                if ($character ne $separator) {
                   11758: # Found the end of a quote, again looking for separator
                   11759:                   $looking_for=$separator;
                   11760:                   $ignore=1;
                   11761:                } else {
                   11762: # Found a separator, store away what we got
                   11763:                   $components{&takeleft($i)}=$field;
                   11764: 	          $i++;
                   11765:                   $just_found_separator=1;
                   11766:                   $ignore=0;
                   11767:                   $field='';
                   11768:                }
                   11769:                next;
                   11770:             }
                   11771: # single or double quotation marks after a separator indicate beginning of a quote
                   11772: # we are now looking for the end of the quote and need to ignore separators
                   11773:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   11774:                $looking_for=$character;
                   11775:                next;
                   11776:             }
                   11777: # ignore would be true after we reached the end of a quote
                   11778:             if ($ignore) { next; }
                   11779:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   11780:             $field.=$character;
                   11781:             $just_found_separator=0; 
1.31      albertel 11782:         }
1.561     www      11783: # catch the very last entry, since we never encountered the separator
                   11784:         $components{&takeleft($i)}=$field;
1.31      albertel 11785:     }
                   11786:     return %components;
                   11787: }
                   11788: 
1.144     matthew  11789: ######################################################
                   11790: ######################################################
                   11791: 
1.56      matthew  11792: =pod
                   11793: 
1.648     raeburn  11794: =item * &upfile_select_html()
1.41      ng       11795: 
1.144     matthew  11796: Return HTML code to select a file from the users machine and specify 
                   11797: the file type.
1.41      ng       11798: 
                   11799: =cut
                   11800: 
1.144     matthew  11801: ######################################################
                   11802: ######################################################
1.31      albertel 11803: sub upfile_select_html {
1.144     matthew  11804:     my %Types = (
                   11805:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 11806:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  11807:                  space => &mt('Space separated'),
                   11808:                  tab   => &mt('Tabulator separated'),
                   11809: #                 xml   => &mt('HTML/XML'),
                   11810:                  );
                   11811:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  11812:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  11813:     foreach my $type (sort(keys(%Types))) {
                   11814:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   11815:     }
                   11816:     $Str .= "</select>\n";
                   11817:     return $Str;
1.31      albertel 11818: }
                   11819: 
1.301     albertel 11820: sub get_samples {
                   11821:     my ($records,$toget) = @_;
                   11822:     my @samples=({});
                   11823:     my $got=0;
                   11824:     foreach my $rec (@$records) {
                   11825: 	my %temp = &record_sep($rec);
                   11826: 	if (! grep(/\S/, values(%temp))) { next; }
                   11827: 	if (%temp) {
                   11828: 	    $samples[$got]=\%temp;
                   11829: 	    $got++;
                   11830: 	    if ($got == $toget) { last; }
                   11831: 	}
                   11832:     }
                   11833:     return \@samples;
                   11834: }
                   11835: 
1.144     matthew  11836: ######################################################
                   11837: ######################################################
                   11838: 
1.56      matthew  11839: =pod
                   11840: 
1.648     raeburn  11841: =item * &csv_print_samples($r,$records)
1.41      ng       11842: 
                   11843: Prints a table of sample values from each column uploaded $r is an
                   11844: Apache Request ref, $records is an arrayref from
                   11845: &Apache::loncommon::upfile_record_sep
                   11846: 
                   11847: =cut
                   11848: 
1.144     matthew  11849: ######################################################
                   11850: ######################################################
1.31      albertel 11851: sub csv_print_samples {
                   11852:     my ($r,$records) = @_;
1.662     bisitz   11853:     my $samples = &get_samples($records,5);
1.301     albertel 11854: 
1.594     raeburn  11855:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   11856:               &start_data_table_header_row());
1.356     albertel 11857:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   11858:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  11859:     $r->print(&end_data_table_header_row());
1.301     albertel 11860:     foreach my $hash (@$samples) {
1.594     raeburn  11861: 	$r->print(&start_data_table_row());
1.356     albertel 11862: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 11863: 	    $r->print('<td>');
1.356     albertel 11864: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 11865: 	    $r->print('</td>');
                   11866: 	}
1.594     raeburn  11867: 	$r->print(&end_data_table_row());
1.31      albertel 11868:     }
1.594     raeburn  11869:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 11870: }
                   11871: 
1.144     matthew  11872: ######################################################
                   11873: ######################################################
                   11874: 
1.56      matthew  11875: =pod
                   11876: 
1.648     raeburn  11877: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       11878: 
                   11879: Prints a table to create associations between values and table columns.
1.144     matthew  11880: 
1.41      ng       11881: $r is an Apache Request ref,
                   11882: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  11883: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       11884: 
                   11885: =cut
                   11886: 
1.144     matthew  11887: ######################################################
                   11888: ######################################################
1.31      albertel 11889: sub csv_print_select_table {
                   11890:     my ($r,$records,$d) = @_;
1.301     albertel 11891:     my $i=0;
                   11892:     my $samples = &get_samples($records,1);
1.144     matthew  11893:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  11894: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  11895:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  11896:               '<th>'.&mt('Column').'</th>'.
                   11897:               &end_data_table_header_row()."\n");
1.356     albertel 11898:     foreach my $array_ref (@$d) {
                   11899: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  11900: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 11901: 
1.875     bisitz   11902: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  11903: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 11904: 	$r->print('<option value="none"></option>');
1.356     albertel 11905: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   11906: 	    $r->print('<option value="'.$sample.'"'.
                   11907:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   11908:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 11909: 	}
1.594     raeburn  11910: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 11911: 	$i++;
                   11912:     }
1.594     raeburn  11913:     $r->print(&end_data_table());
1.31      albertel 11914:     $i--;
                   11915:     return $i;
                   11916: }
1.56      matthew  11917: 
1.144     matthew  11918: ######################################################
                   11919: ######################################################
                   11920: 
1.56      matthew  11921: =pod
1.31      albertel 11922: 
1.648     raeburn  11923: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       11924: 
                   11925: Prints a table of sample values from the upload and can make associate samples to internal names.
                   11926: 
                   11927: $r is an Apache Request ref,
                   11928: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   11929: $d is an array of 2 element arrays (internal name, displayed name)
                   11930: 
                   11931: =cut
                   11932: 
1.144     matthew  11933: ######################################################
                   11934: ######################################################
1.31      albertel 11935: sub csv_samples_select_table {
                   11936:     my ($r,$records,$d) = @_;
                   11937:     my $i=0;
1.144     matthew  11938:     #
1.662     bisitz   11939:     my $max_samples = 5;
                   11940:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  11941:     $r->print(&start_data_table().
                   11942:               &start_data_table_header_row().'<th>'.
                   11943:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   11944:               &end_data_table_header_row());
1.301     albertel 11945: 
                   11946:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  11947: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  11948: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 11949: 	foreach my $option (@$d) {
                   11950: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  11951: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 11952:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  11953:                       $display.'</option>');
1.31      albertel 11954: 	}
                   11955: 	$r->print('</select></td><td>');
1.662     bisitz   11956: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 11957: 	    if (defined($samples->[$line]{$key})) { 
                   11958: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   11959: 	    }
                   11960: 	}
1.594     raeburn  11961: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 11962: 	$i++;
                   11963:     }
1.594     raeburn  11964:     $r->print(&end_data_table());
1.31      albertel 11965:     $i--;
                   11966:     return($i);
1.115     matthew  11967: }
                   11968: 
1.144     matthew  11969: ######################################################
                   11970: ######################################################
                   11971: 
1.115     matthew  11972: =pod
                   11973: 
1.648     raeburn  11974: =item * &clean_excel_name($name)
1.115     matthew  11975: 
                   11976: Returns a replacement for $name which does not contain any illegal characters.
                   11977: 
                   11978: =cut
                   11979: 
1.144     matthew  11980: ######################################################
                   11981: ######################################################
1.115     matthew  11982: sub clean_excel_name {
                   11983:     my ($name) = @_;
                   11984:     $name =~ s/[:\*\?\/\\]//g;
                   11985:     if (length($name) > 31) {
                   11986:         $name = substr($name,0,31);
                   11987:     }
                   11988:     return $name;
1.25      albertel 11989: }
1.84      albertel 11990: 
1.85      albertel 11991: =pod
                   11992: 
1.648     raeburn  11993: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 11994: 
                   11995: Returns either 1 or undef
                   11996: 
                   11997: 1 if the part is to be hidden, undef if it is to be shown
                   11998: 
                   11999: Arguments are:
                   12000: 
                   12001: $id the id of the part to be checked
                   12002: $symb, optional the symb of the resource to check
                   12003: $udom, optional the domain of the user to check for
                   12004: $uname, optional the username of the user to check for
                   12005: 
                   12006: =cut
1.84      albertel 12007: 
                   12008: sub check_if_partid_hidden {
                   12009:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 12010:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 12011: 					 $symb,$udom,$uname);
1.141     albertel 12012:     my $truth=1;
                   12013:     #if the string starts with !, then the list is the list to show not hide
                   12014:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 12015:     my @hiddenlist=split(/,/,$hiddenparts);
                   12016:     foreach my $checkid (@hiddenlist) {
1.141     albertel 12017: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 12018:     }
1.141     albertel 12019:     return !$truth;
1.84      albertel 12020: }
1.127     matthew  12021: 
1.138     matthew  12022: 
                   12023: ############################################################
                   12024: ############################################################
                   12025: 
                   12026: =pod
                   12027: 
1.157     matthew  12028: =back 
                   12029: 
1.138     matthew  12030: =head1 cgi-bin script and graphing routines
                   12031: 
1.157     matthew  12032: =over 4
                   12033: 
1.648     raeburn  12034: =item * &get_cgi_id()
1.138     matthew  12035: 
                   12036: Inputs: none
                   12037: 
                   12038: Returns an id which can be used to pass environment variables
                   12039: to various cgi-bin scripts.  These environment variables will
                   12040: be removed from the users environment after a given time by
                   12041: the routine &Apache::lonnet::transfer_profile_to_env.
                   12042: 
                   12043: =cut
                   12044: 
                   12045: ############################################################
                   12046: ############################################################
1.152     albertel 12047: my $uniq=0;
1.136     matthew  12048: sub get_cgi_id {
1.154     albertel 12049:     $uniq=($uniq+1)%100000;
1.280     albertel 12050:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  12051: }
                   12052: 
1.127     matthew  12053: ############################################################
                   12054: ############################################################
                   12055: 
                   12056: =pod
                   12057: 
1.648     raeburn  12058: =item * &DrawBarGraph()
1.127     matthew  12059: 
1.138     matthew  12060: Facilitates the plotting of data in a (stacked) bar graph.
                   12061: Puts plot definition data into the users environment in order for 
                   12062: graph.png to plot it.  Returns an <img> tag for the plot.
                   12063: The bars on the plot are labeled '1','2',...,'n'.
                   12064: 
                   12065: Inputs:
                   12066: 
                   12067: =over 4
                   12068: 
                   12069: =item $Title: string, the title of the plot
                   12070: 
                   12071: =item $xlabel: string, text describing the X-axis of the plot
                   12072: 
                   12073: =item $ylabel: string, text describing the Y-axis of the plot
                   12074: 
                   12075: =item $Max: scalar, the maximum Y value to use in the plot
                   12076: If $Max is < any data point, the graph will not be rendered.
                   12077: 
1.140     matthew  12078: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  12079: they are plotted.  If undefined, default values will be used.
                   12080: 
1.178     matthew  12081: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   12082: 
1.138     matthew  12083: =item @Values: An array of array references.  Each array reference holds data
                   12084: to be plotted in a stacked bar chart.
                   12085: 
1.239     matthew  12086: =item If the final element of @Values is a hash reference the key/value
                   12087: pairs will be added to the graph definition.
                   12088: 
1.138     matthew  12089: =back
                   12090: 
                   12091: Returns:
                   12092: 
                   12093: An <img> tag which references graph.png and the appropriate identifying
                   12094: information for the plot.
                   12095: 
1.127     matthew  12096: =cut
                   12097: 
                   12098: ############################################################
                   12099: ############################################################
1.134     matthew  12100: sub DrawBarGraph {
1.178     matthew  12101:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  12102:     #
                   12103:     if (! defined($colors)) {
                   12104:         $colors = ['#33ff00', 
                   12105:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   12106:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   12107:                   ]; 
                   12108:     }
1.228     matthew  12109:     my $extra_settings = {};
                   12110:     if (ref($Values[-1]) eq 'HASH') {
                   12111:         $extra_settings = pop(@Values);
                   12112:     }
1.127     matthew  12113:     #
1.136     matthew  12114:     my $identifier = &get_cgi_id();
                   12115:     my $id = 'cgi.'.$identifier;        
1.129     matthew  12116:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  12117:         return '';
                   12118:     }
1.225     matthew  12119:     #
                   12120:     my @Labels;
                   12121:     if (defined($labels)) {
                   12122:         @Labels = @$labels;
                   12123:     } else {
                   12124:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   12125:             push (@Labels,$i+1);
                   12126:         }
                   12127:     }
                   12128:     #
1.129     matthew  12129:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  12130:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  12131:     my %ValuesHash;
                   12132:     my $NumSets=1;
                   12133:     foreach my $array (@Values) {
                   12134:         next if (! ref($array));
1.136     matthew  12135:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  12136:             join(',',@$array);
1.129     matthew  12137:     }
1.127     matthew  12138:     #
1.136     matthew  12139:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  12140:     if ($NumBars < 3) {
                   12141:         $width = 120+$NumBars*32;
1.220     matthew  12142:         $xskip = 1;
1.225     matthew  12143:         $bar_width = 30;
                   12144:     } elsif ($NumBars < 5) {
                   12145:         $width = 120+$NumBars*20;
                   12146:         $xskip = 1;
                   12147:         $bar_width = 20;
1.220     matthew  12148:     } elsif ($NumBars < 10) {
1.136     matthew  12149:         $width = 120+$NumBars*15;
                   12150:         $xskip = 1;
                   12151:         $bar_width = 15;
                   12152:     } elsif ($NumBars <= 25) {
                   12153:         $width = 120+$NumBars*11;
                   12154:         $xskip = 5;
                   12155:         $bar_width = 8;
                   12156:     } elsif ($NumBars <= 50) {
                   12157:         $width = 120+$NumBars*8;
                   12158:         $xskip = 5;
                   12159:         $bar_width = 4;
                   12160:     } else {
                   12161:         $width = 120+$NumBars*8;
                   12162:         $xskip = 5;
                   12163:         $bar_width = 4;
                   12164:     }
                   12165:     #
1.137     matthew  12166:     $Max = 1 if ($Max < 1);
                   12167:     if ( int($Max) < $Max ) {
                   12168:         $Max++;
                   12169:         $Max = int($Max);
                   12170:     }
1.127     matthew  12171:     $Title  = '' if (! defined($Title));
                   12172:     $xlabel = '' if (! defined($xlabel));
                   12173:     $ylabel = '' if (! defined($ylabel));
1.369     www      12174:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   12175:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   12176:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  12177:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  12178:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   12179:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   12180:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   12181:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12182:     $ValuesHash{$id.'.height'}   = $height;
                   12183:     $ValuesHash{$id.'.width'}    = $width;
                   12184:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   12185:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   12186:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  12187:     #
1.228     matthew  12188:     # Deal with other parameters
                   12189:     while (my ($key,$value) = each(%$extra_settings)) {
                   12190:         $ValuesHash{$id.'.'.$key} = $value;
                   12191:     }
                   12192:     #
1.646     raeburn  12193:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  12194:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12195: }
                   12196: 
                   12197: ############################################################
                   12198: ############################################################
                   12199: 
                   12200: =pod
                   12201: 
1.648     raeburn  12202: =item * &DrawXYGraph()
1.137     matthew  12203: 
1.138     matthew  12204: Facilitates the plotting of data in an XY graph.
                   12205: Puts plot definition data into the users environment in order for 
                   12206: graph.png to plot it.  Returns an <img> tag for the plot.
                   12207: 
                   12208: Inputs:
                   12209: 
                   12210: =over 4
                   12211: 
                   12212: =item $Title: string, the title of the plot
                   12213: 
                   12214: =item $xlabel: string, text describing the X-axis of the plot
                   12215: 
                   12216: =item $ylabel: string, text describing the Y-axis of the plot
                   12217: 
                   12218: =item $Max: scalar, the maximum Y value to use in the plot
                   12219: If $Max is < any data point, the graph will not be rendered.
                   12220: 
                   12221: =item $colors: Array ref containing the hex color codes for the data to be 
                   12222: plotted in.  If undefined, default values will be used.
                   12223: 
                   12224: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12225: 
                   12226: =item $Ydata: Array ref containing Array refs.  
1.185     www      12227: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  12228: 
                   12229: =item %Values: hash indicating or overriding any default values which are 
                   12230: passed to graph.png.  
                   12231: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12232: 
                   12233: =back
                   12234: 
                   12235: Returns:
                   12236: 
                   12237: An <img> tag which references graph.png and the appropriate identifying
                   12238: information for the plot.
                   12239: 
1.137     matthew  12240: =cut
                   12241: 
                   12242: ############################################################
                   12243: ############################################################
                   12244: sub DrawXYGraph {
                   12245:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   12246:     #
                   12247:     # Create the identifier for the graph
                   12248:     my $identifier = &get_cgi_id();
                   12249:     my $id = 'cgi.'.$identifier;
                   12250:     #
                   12251:     $Title  = '' if (! defined($Title));
                   12252:     $xlabel = '' if (! defined($xlabel));
                   12253:     $ylabel = '' if (! defined($ylabel));
                   12254:     my %ValuesHash = 
                   12255:         (
1.369     www      12256:          $id.'.title'  => &escape($Title),
                   12257:          $id.'.xlabel' => &escape($xlabel),
                   12258:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  12259:          $id.'.y_max_value'=> $Max,
                   12260:          $id.'.labels'     => join(',',@$Xlabels),
                   12261:          $id.'.PlotType'   => 'XY',
                   12262:          );
                   12263:     #
                   12264:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12265:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12266:     }
                   12267:     #
                   12268:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   12269:         return '';
                   12270:     }
                   12271:     my $NumSets=1;
1.138     matthew  12272:     foreach my $array (@{$Ydata}){
1.137     matthew  12273:         next if (! ref($array));
                   12274:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   12275:     }
1.138     matthew  12276:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  12277:     #
                   12278:     # Deal with other parameters
                   12279:     while (my ($key,$value) = each(%Values)) {
                   12280:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  12281:     }
                   12282:     #
1.646     raeburn  12283:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  12284:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12285: }
                   12286: 
                   12287: ############################################################
                   12288: ############################################################
                   12289: 
                   12290: =pod
                   12291: 
1.648     raeburn  12292: =item * &DrawXYYGraph()
1.138     matthew  12293: 
                   12294: Facilitates the plotting of data in an XY graph with two Y axes.
                   12295: Puts plot definition data into the users environment in order for 
                   12296: graph.png to plot it.  Returns an <img> tag for the plot.
                   12297: 
                   12298: Inputs:
                   12299: 
                   12300: =over 4
                   12301: 
                   12302: =item $Title: string, the title of the plot
                   12303: 
                   12304: =item $xlabel: string, text describing the X-axis of the plot
                   12305: 
                   12306: =item $ylabel: string, text describing the Y-axis of the plot
                   12307: 
                   12308: =item $colors: Array ref containing the hex color codes for the data to be 
                   12309: plotted in.  If undefined, default values will be used.
                   12310: 
                   12311: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12312: 
                   12313: =item $Ydata1: The first data set
                   12314: 
                   12315: =item $Min1: The minimum value of the left Y-axis
                   12316: 
                   12317: =item $Max1: The maximum value of the left Y-axis
                   12318: 
                   12319: =item $Ydata2: The second data set
                   12320: 
                   12321: =item $Min2: The minimum value of the right Y-axis
                   12322: 
                   12323: =item $Max2: The maximum value of the left Y-axis
                   12324: 
                   12325: =item %Values: hash indicating or overriding any default values which are 
                   12326: passed to graph.png.  
                   12327: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12328: 
                   12329: =back
                   12330: 
                   12331: Returns:
                   12332: 
                   12333: An <img> tag which references graph.png and the appropriate identifying
                   12334: information for the plot.
1.136     matthew  12335: 
                   12336: =cut
                   12337: 
                   12338: ############################################################
                   12339: ############################################################
1.137     matthew  12340: sub DrawXYYGraph {
                   12341:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   12342:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  12343:     #
                   12344:     # Create the identifier for the graph
                   12345:     my $identifier = &get_cgi_id();
                   12346:     my $id = 'cgi.'.$identifier;
                   12347:     #
                   12348:     $Title  = '' if (! defined($Title));
                   12349:     $xlabel = '' if (! defined($xlabel));
                   12350:     $ylabel = '' if (! defined($ylabel));
                   12351:     my %ValuesHash = 
                   12352:         (
1.369     www      12353:          $id.'.title'  => &escape($Title),
                   12354:          $id.'.xlabel' => &escape($xlabel),
                   12355:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  12356:          $id.'.labels' => join(',',@$Xlabels),
                   12357:          $id.'.PlotType' => 'XY',
                   12358:          $id.'.NumSets' => 2,
1.137     matthew  12359:          $id.'.two_axes' => 1,
                   12360:          $id.'.y1_max_value' => $Max1,
                   12361:          $id.'.y1_min_value' => $Min1,
                   12362:          $id.'.y2_max_value' => $Max2,
                   12363:          $id.'.y2_min_value' => $Min2,
1.136     matthew  12364:          );
                   12365:     #
1.137     matthew  12366:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12367:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12368:     }
                   12369:     #
                   12370:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   12371:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  12372:         return '';
                   12373:     }
                   12374:     my $NumSets=1;
1.137     matthew  12375:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  12376:         next if (! ref($array));
                   12377:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  12378:     }
                   12379:     #
                   12380:     # Deal with other parameters
                   12381:     while (my ($key,$value) = each(%Values)) {
                   12382:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  12383:     }
                   12384:     #
1.646     raeburn  12385:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 12386:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  12387: }
                   12388: 
                   12389: ############################################################
                   12390: ############################################################
                   12391: 
                   12392: =pod
                   12393: 
1.157     matthew  12394: =back 
                   12395: 
1.139     matthew  12396: =head1 Statistics helper routines?  
                   12397: 
                   12398: Bad place for them but what the hell.
                   12399: 
1.157     matthew  12400: =over 4
                   12401: 
1.648     raeburn  12402: =item * &chartlink()
1.139     matthew  12403: 
                   12404: Returns a link to the chart for a specific student.  
                   12405: 
                   12406: Inputs:
                   12407: 
                   12408: =over 4
                   12409: 
                   12410: =item $linktext: The text of the link
                   12411: 
                   12412: =item $sname: The students username
                   12413: 
                   12414: =item $sdomain: The students domain
                   12415: 
                   12416: =back
                   12417: 
1.157     matthew  12418: =back
                   12419: 
1.139     matthew  12420: =cut
                   12421: 
                   12422: ############################################################
                   12423: ############################################################
                   12424: sub chartlink {
                   12425:     my ($linktext, $sname, $sdomain) = @_;
                   12426:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      12427:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 12428:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  12429:        '">'.$linktext.'</a>';
1.153     matthew  12430: }
                   12431: 
                   12432: #######################################################
                   12433: #######################################################
                   12434: 
                   12435: =pod
                   12436: 
                   12437: =head1 Course Environment Routines
1.157     matthew  12438: 
                   12439: =over 4
1.153     matthew  12440: 
1.648     raeburn  12441: =item * &restore_course_settings()
1.153     matthew  12442: 
1.648     raeburn  12443: =item * &store_course_settings()
1.153     matthew  12444: 
                   12445: Restores/Store indicated form parameters from the course environment.
                   12446: Will not overwrite existing values of the form parameters.
                   12447: 
                   12448: Inputs: 
                   12449: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   12450: 
                   12451: a hash ref describing the data to be stored.  For example:
                   12452:    
                   12453: %Save_Parameters = ('Status' => 'scalar',
                   12454:     'chartoutputmode' => 'scalar',
                   12455:     'chartoutputdata' => 'scalar',
                   12456:     'Section' => 'array',
1.373     raeburn  12457:     'Group' => 'array',
1.153     matthew  12458:     'StudentData' => 'array',
                   12459:     'Maps' => 'array');
                   12460: 
                   12461: Returns: both routines return nothing
                   12462: 
1.631     raeburn  12463: =back
                   12464: 
1.153     matthew  12465: =cut
                   12466: 
                   12467: #######################################################
                   12468: #######################################################
                   12469: sub store_course_settings {
1.496     albertel 12470:     return &store_settings($env{'request.course.id'},@_);
                   12471: }
                   12472: 
                   12473: sub store_settings {
1.153     matthew  12474:     # save to the environment
                   12475:     # appenv the same items, just to be safe
1.300     albertel 12476:     my $udom  = $env{'user.domain'};
                   12477:     my $uname = $env{'user.name'};
1.496     albertel 12478:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12479:     my %SaveHash;
                   12480:     my %AppHash;
                   12481:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 12482:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 12483:         my $envname = 'environment.'.$basename;
1.258     albertel 12484:         if (exists($env{'form.'.$setting})) {
1.153     matthew  12485:             # Save this value away
                   12486:             if ($type eq 'scalar' &&
1.258     albertel 12487:                 (! exists($env{$envname}) || 
                   12488:                  $env{$envname} ne $env{'form.'.$setting})) {
                   12489:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   12490:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  12491:             } elsif ($type eq 'array') {
                   12492:                 my $stored_form;
1.258     albertel 12493:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  12494:                     $stored_form = join(',',
                   12495:                                         map {
1.369     www      12496:                                             &escape($_);
1.258     albertel 12497:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  12498:                 } else {
                   12499:                     $stored_form = 
1.369     www      12500:                         &escape($env{'form.'.$setting});
1.153     matthew  12501:                 }
                   12502:                 # Determine if the array contents are the same.
1.258     albertel 12503:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  12504:                     $SaveHash{$basename} = $stored_form;
                   12505:                     $AppHash{$envname}   = $stored_form;
                   12506:                 }
                   12507:             }
                   12508:         }
                   12509:     }
                   12510:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 12511:                                           $udom,$uname);
1.153     matthew  12512:     if ($put_result !~ /^(ok|delayed)/) {
                   12513:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   12514:                                  'got error:'.$put_result);
                   12515:     }
                   12516:     # Make sure these settings stick around in this session, too
1.646     raeburn  12517:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  12518:     return;
                   12519: }
                   12520: 
                   12521: sub restore_course_settings {
1.499     albertel 12522:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 12523: }
                   12524: 
                   12525: sub restore_settings {
                   12526:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12527:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 12528:         next if (exists($env{'form.'.$setting}));
1.496     albertel 12529:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  12530:             '.'.$setting;
1.258     albertel 12531:         if (exists($env{$envname})) {
1.153     matthew  12532:             if ($type eq 'scalar') {
1.258     albertel 12533:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  12534:             } elsif ($type eq 'array') {
1.258     albertel 12535:                 $env{'form.'.$setting} = [ 
1.153     matthew  12536:                                            map { 
1.369     www      12537:                                                &unescape($_); 
1.258     albertel 12538:                                            } split(',',$env{$envname})
1.153     matthew  12539:                                            ];
                   12540:             }
                   12541:         }
                   12542:     }
1.127     matthew  12543: }
                   12544: 
1.618     raeburn  12545: #######################################################
                   12546: #######################################################
                   12547: 
                   12548: =pod
                   12549: 
                   12550: =head1 Domain E-mail Routines  
                   12551: 
                   12552: =over 4
                   12553: 
1.648     raeburn  12554: =item * &build_recipient_list()
1.618     raeburn  12555: 
1.884     raeburn  12556: Build recipient lists for five types of e-mail:
1.766     raeburn  12557: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  12558: (d) Help requests, (e) Course requests needing approval,  generated by
                   12559: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   12560: loncoursequeueadmin.pm respectively.
1.618     raeburn  12561: 
                   12562: Inputs:
1.619     raeburn  12563: defmail (scalar - email address of default recipient), 
1.618     raeburn  12564: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  12565: defdom (domain for which to retrieve configuration settings),
                   12566: origmail (scalar - email address of recipient from loncapa.conf, 
                   12567: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  12568: 
1.655     raeburn  12569: Returns: comma separated list of addresses to which to send e-mail.
                   12570: 
                   12571: =back
1.618     raeburn  12572: 
                   12573: =cut
                   12574: 
                   12575: ############################################################
                   12576: ############################################################
                   12577: sub build_recipient_list {
1.619     raeburn  12578:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  12579:     my @recipients;
                   12580:     my $otheremails;
                   12581:     my %domconfig =
                   12582:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   12583:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  12584:         if (exists($domconfig{'contacts'}{$mailing})) {
                   12585:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   12586:                 my @contacts = ('adminemail','supportemail');
                   12587:                 foreach my $item (@contacts) {
                   12588:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   12589:                         my $addr = $domconfig{'contacts'}{$item}; 
                   12590:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12591:                             push(@recipients,$addr);
                   12592:                         }
1.619     raeburn  12593:                     }
1.766     raeburn  12594:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  12595:                 }
                   12596:             }
1.766     raeburn  12597:         } elsif ($origmail ne '') {
                   12598:             push(@recipients,$origmail);
1.618     raeburn  12599:         }
1.619     raeburn  12600:     } elsif ($origmail ne '') {
                   12601:         push(@recipients,$origmail);
1.618     raeburn  12602:     }
1.688     raeburn  12603:     if (defined($defmail)) {
                   12604:         if ($defmail ne '') {
                   12605:             push(@recipients,$defmail);
                   12606:         }
1.618     raeburn  12607:     }
                   12608:     if ($otheremails) {
1.619     raeburn  12609:         my @others;
                   12610:         if ($otheremails =~ /,/) {
                   12611:             @others = split(/,/,$otheremails);
1.618     raeburn  12612:         } else {
1.619     raeburn  12613:             push(@others,$otheremails);
                   12614:         }
                   12615:         foreach my $addr (@others) {
                   12616:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12617:                 push(@recipients,$addr);
                   12618:             }
1.618     raeburn  12619:         }
                   12620:     }
1.619     raeburn  12621:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  12622:     return $recipientlist;
                   12623: }
                   12624: 
1.127     matthew  12625: ############################################################
                   12626: ############################################################
1.154     albertel 12627: 
1.655     raeburn  12628: =pod
                   12629: 
                   12630: =head1 Course Catalog Routines
                   12631: 
                   12632: =over 4
                   12633: 
                   12634: =item * &gather_categories()
                   12635: 
                   12636: Converts category definitions - keys of categories hash stored in  
                   12637: coursecategories in configuration.db on the primary library server in a 
                   12638: domain - to an array.  Also generates javascript and idx hash used to 
                   12639: generate Domain Coordinator interface for editing Course Categories.
                   12640: 
                   12641: Inputs:
1.663     raeburn  12642: 
1.655     raeburn  12643: categories (reference to hash of category definitions).
1.663     raeburn  12644: 
1.655     raeburn  12645: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12646:       categories and subcategories).
1.663     raeburn  12647: 
1.655     raeburn  12648: idx (reference to hash of counters used in Domain Coordinator interface for 
                   12649:       editing Course Categories).
1.663     raeburn  12650: 
1.655     raeburn  12651: jsarray (reference to array of categories used to create Javascript arrays for
                   12652:          Domain Coordinator interface for editing Course Categories).
                   12653: 
                   12654: Returns: nothing
                   12655: 
                   12656: Side effects: populates cats, idx and jsarray. 
                   12657: 
                   12658: =cut
                   12659: 
                   12660: sub gather_categories {
                   12661:     my ($categories,$cats,$idx,$jsarray) = @_;
                   12662:     my %counters;
                   12663:     my $num = 0;
                   12664:     foreach my $item (keys(%{$categories})) {
                   12665:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   12666:         if ($container eq '' && $depth == 0) {
                   12667:             $cats->[$depth][$categories->{$item}] = $cat;
                   12668:         } else {
                   12669:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   12670:         }
                   12671:         my ($escitem,$tail) = split(/:/,$item,2);
                   12672:         if ($counters{$tail} eq '') {
                   12673:             $counters{$tail} = $num;
                   12674:             $num ++;
                   12675:         }
                   12676:         if (ref($idx) eq 'HASH') {
                   12677:             $idx->{$item} = $counters{$tail};
                   12678:         }
                   12679:         if (ref($jsarray) eq 'ARRAY') {
                   12680:             push(@{$jsarray->[$counters{$tail}]},$item);
                   12681:         }
                   12682:     }
                   12683:     return;
                   12684: }
                   12685: 
                   12686: =pod
                   12687: 
                   12688: =item * &extract_categories()
                   12689: 
                   12690: Used to generate breadcrumb trails for course categories.
                   12691: 
                   12692: Inputs:
1.663     raeburn  12693: 
1.655     raeburn  12694: categories (reference to hash of category definitions).
1.663     raeburn  12695: 
1.655     raeburn  12696: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12697:       categories and subcategories).
1.663     raeburn  12698: 
1.655     raeburn  12699: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  12700: 
1.655     raeburn  12701: allitems (reference to hash - key is category key 
                   12702:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  12703: 
1.655     raeburn  12704: idx (reference to hash of counters used in Domain Coordinator interface for
                   12705:       editing Course Categories).
1.663     raeburn  12706: 
1.655     raeburn  12707: jsarray (reference to array of categories used to create Javascript arrays for
                   12708:          Domain Coordinator interface for editing Course Categories).
                   12709: 
1.665     raeburn  12710: subcats (reference to hash of arrays containing all subcategories within each 
                   12711:          category, -recursive)
                   12712: 
1.655     raeburn  12713: Returns: nothing
                   12714: 
                   12715: Side effects: populates trails and allitems hash references.
                   12716: 
                   12717: =cut
                   12718: 
                   12719: sub extract_categories {
1.665     raeburn  12720:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  12721:     if (ref($categories) eq 'HASH') {
                   12722:         &gather_categories($categories,$cats,$idx,$jsarray);
                   12723:         if (ref($cats->[0]) eq 'ARRAY') {
                   12724:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   12725:                 my $name = $cats->[0][$i];
                   12726:                 my $item = &escape($name).'::0';
                   12727:                 my $trailstr;
                   12728:                 if ($name eq 'instcode') {
                   12729:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  12730:                 } elsif ($name eq 'communities') {
                   12731:                     $trailstr = &mt('Communities');
1.655     raeburn  12732:                 } else {
                   12733:                     $trailstr = $name;
                   12734:                 }
                   12735:                 if ($allitems->{$item} eq '') {
                   12736:                     push(@{$trails},$trailstr);
                   12737:                     $allitems->{$item} = scalar(@{$trails})-1;
                   12738:                 }
                   12739:                 my @parents = ($name);
                   12740:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   12741:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   12742:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  12743:                         if (ref($subcats) eq 'HASH') {
                   12744:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   12745:                         }
                   12746:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   12747:                     }
                   12748:                 } else {
                   12749:                     if (ref($subcats) eq 'HASH') {
                   12750:                         $subcats->{$item} = [];
1.655     raeburn  12751:                     }
                   12752:                 }
                   12753:             }
                   12754:         }
                   12755:     }
                   12756:     return;
                   12757: }
                   12758: 
                   12759: =pod
                   12760: 
                   12761: =item *&recurse_categories()
                   12762: 
                   12763: Recursively used to generate breadcrumb trails for course categories.
                   12764: 
                   12765: Inputs:
1.663     raeburn  12766: 
1.655     raeburn  12767: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12768:       categories and subcategories).
1.663     raeburn  12769: 
1.655     raeburn  12770: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  12771: 
                   12772: category (current course category, for which breadcrumb trail is being generated).
                   12773: 
                   12774: trails (reference to array of breadcrumb trails for each category).
                   12775: 
1.655     raeburn  12776: allitems (reference to hash - key is category key
                   12777:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  12778: 
1.655     raeburn  12779: parents (array containing containers directories for current category, 
                   12780:          back to top level). 
                   12781: 
                   12782: Returns: nothing
                   12783: 
                   12784: Side effects: populates trails and allitems hash references
                   12785: 
                   12786: =cut
                   12787: 
                   12788: sub recurse_categories {
1.665     raeburn  12789:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  12790:     my $shallower = $depth - 1;
                   12791:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   12792:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   12793:             my $name = $cats->[$depth]{$category}[$k];
                   12794:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   12795:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   12796:             if ($allitems->{$item} eq '') {
                   12797:                 push(@{$trails},$trailstr);
                   12798:                 $allitems->{$item} = scalar(@{$trails})-1;
                   12799:             }
                   12800:             my $deeper = $depth+1;
                   12801:             push(@{$parents},$category);
1.665     raeburn  12802:             if (ref($subcats) eq 'HASH') {
                   12803:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   12804:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   12805:                     my $higher;
                   12806:                     if ($j > 0) {
                   12807:                         $higher = &escape($parents->[$j]).':'.
                   12808:                                   &escape($parents->[$j-1]).':'.$j;
                   12809:                     } else {
                   12810:                         $higher = &escape($parents->[$j]).'::'.$j;
                   12811:                     }
                   12812:                     push(@{$subcats->{$higher}},$subcat);
                   12813:                 }
                   12814:             }
                   12815:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   12816:                                 $subcats);
1.655     raeburn  12817:             pop(@{$parents});
                   12818:         }
                   12819:     } else {
                   12820:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   12821:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   12822:         if ($allitems->{$item} eq '') {
                   12823:             push(@{$trails},$trailstr);
                   12824:             $allitems->{$item} = scalar(@{$trails})-1;
                   12825:         }
                   12826:     }
                   12827:     return;
                   12828: }
                   12829: 
1.663     raeburn  12830: =pod
                   12831: 
                   12832: =item *&assign_categories_table()
                   12833: 
                   12834: Create a datatable for display of hierarchical categories in a domain,
                   12835: with checkboxes to allow a course to be categorized. 
                   12836: 
                   12837: Inputs:
                   12838: 
                   12839: cathash - reference to hash of categories defined for the domain (from
                   12840:           configuration.db)
                   12841: 
                   12842: currcat - scalar with an & separated list of categories assigned to a course. 
                   12843: 
1.919     raeburn  12844: type    - scalar contains course type (Course or Community).
                   12845: 
1.663     raeburn  12846: Returns: $output (markup to be displayed) 
                   12847: 
                   12848: =cut
                   12849: 
                   12850: sub assign_categories_table {
1.919     raeburn  12851:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  12852:     my $output;
                   12853:     if (ref($cathash) eq 'HASH') {
                   12854:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   12855:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   12856:         $maxdepth = scalar(@cats);
                   12857:         if (@cats > 0) {
                   12858:             my $itemcount = 0;
                   12859:             if (ref($cats[0]) eq 'ARRAY') {
                   12860:                 my @currcategories;
                   12861:                 if ($currcat ne '') {
                   12862:                     @currcategories = split('&',$currcat);
                   12863:                 }
1.919     raeburn  12864:                 my $table;
1.663     raeburn  12865:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   12866:                     my $parent = $cats[0][$i];
1.919     raeburn  12867:                     next if ($parent eq 'instcode');
                   12868:                     if ($type eq 'Community') {
                   12869:                         next unless ($parent eq 'communities');
                   12870:                     } else {
                   12871:                         next if ($parent eq 'communities');
                   12872:                     }
1.663     raeburn  12873:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12874:                     my $item = &escape($parent).'::0';
                   12875:                     my $checked = '';
                   12876:                     if (@currcategories > 0) {
                   12877:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   12878:                             $checked = ' checked="checked"';
1.663     raeburn  12879:                         }
                   12880:                     }
1.919     raeburn  12881:                     my $parent_title = $parent;
                   12882:                     if ($parent eq 'communities') {
                   12883:                         $parent_title = &mt('Communities');
                   12884:                     }
                   12885:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   12886:                               '<input type="checkbox" name="usecategory" value="'.
                   12887:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   12888:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  12889:                     my $depth = 1;
                   12890:                     push(@path,$parent);
1.919     raeburn  12891:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  12892:                     pop(@path);
1.919     raeburn  12893:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  12894:                     $itemcount ++;
                   12895:                 }
1.919     raeburn  12896:                 if ($itemcount) {
                   12897:                     $output = &Apache::loncommon::start_data_table().
                   12898:                               $table.
                   12899:                               &Apache::loncommon::end_data_table();
                   12900:                 }
1.663     raeburn  12901:             }
                   12902:         }
                   12903:     }
                   12904:     return $output;
                   12905: }
                   12906: 
                   12907: =pod
                   12908: 
                   12909: =item *&assign_category_rows()
                   12910: 
                   12911: Create a datatable row for display of nested categories in a domain,
                   12912: with checkboxes to allow a course to be categorized,called recursively.
                   12913: 
                   12914: Inputs:
                   12915: 
                   12916: itemcount - track row number for alternating colors
                   12917: 
                   12918: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   12919:       categories and subcategories.
                   12920: 
                   12921: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   12922: 
                   12923: parent - parent of current category item
                   12924: 
                   12925: path - Array containing all categories back up through the hierarchy from the
                   12926:        current category to the top level.
                   12927: 
                   12928: currcategories - reference to array of current categories assigned to the course
                   12929: 
                   12930: Returns: $output (markup to be displayed).
                   12931: 
                   12932: =cut
                   12933: 
                   12934: sub assign_category_rows {
                   12935:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   12936:     my ($text,$name,$item,$chgstr);
                   12937:     if (ref($cats) eq 'ARRAY') {
                   12938:         my $maxdepth = scalar(@{$cats});
                   12939:         if (ref($cats->[$depth]) eq 'HASH') {
                   12940:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   12941:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   12942:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12943:                 $text .= '<td><table class="LC_datatable">';
                   12944:                 for (my $j=0; $j<$numchildren; $j++) {
                   12945:                     $name = $cats->[$depth]{$parent}[$j];
                   12946:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   12947:                     my $deeper = $depth+1;
                   12948:                     my $checked = '';
                   12949:                     if (ref($currcategories) eq 'ARRAY') {
                   12950:                         if (@{$currcategories} > 0) {
                   12951:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   12952:                                 $checked = ' checked="checked"';
1.663     raeburn  12953:                             }
                   12954:                         }
                   12955:                     }
1.664     raeburn  12956:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   12957:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  12958:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   12959:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   12960:                              '</td><td>';
1.663     raeburn  12961:                     if (ref($path) eq 'ARRAY') {
                   12962:                         push(@{$path},$name);
                   12963:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   12964:                         pop(@{$path});
                   12965:                     }
                   12966:                     $text .= '</td></tr>';
                   12967:                 }
                   12968:                 $text .= '</table></td>';
                   12969:             }
                   12970:         }
                   12971:     }
                   12972:     return $text;
                   12973: }
                   12974: 
1.655     raeburn  12975: ############################################################
                   12976: ############################################################
                   12977: 
                   12978: 
1.443     albertel 12979: sub commit_customrole {
1.664     raeburn  12980:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  12981:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 12982:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   12983:                          ($end?', ending '.localtime($end):'').': <b>'.
                   12984:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  12985:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 12986:                  '</b><br />';
                   12987:     return $output;
                   12988: }
                   12989: 
                   12990: sub commit_standardrole {
1.541     raeburn  12991:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   12992:     my ($output,$logmsg,$linefeed);
                   12993:     if ($context eq 'auto') {
                   12994:         $linefeed = "\n";
                   12995:     } else {
                   12996:         $linefeed = "<br />\n";
                   12997:     }  
1.443     albertel 12998:     if ($three eq 'st') {
1.541     raeburn  12999:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   13000:                                          $one,$two,$sec,$context);
                   13001:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  13002:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   13003:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 13004:         } else {
1.541     raeburn  13005:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 13006:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  13007:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   13008:             if ($context eq 'auto') {
                   13009:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   13010:             } else {
                   13011:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   13012:                &mt('Add to classlist').': <b>ok</b>';
                   13013:             }
                   13014:             $output .= $linefeed;
1.443     albertel 13015:         }
                   13016:     } else {
                   13017:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   13018:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  13019:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  13020:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  13021:         if ($context eq 'auto') {
                   13022:             $output .= $result.$linefeed;
                   13023:         } else {
                   13024:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   13025:         }
1.443     albertel 13026:     }
                   13027:     return $output;
                   13028: }
                   13029: 
                   13030: sub commit_studentrole {
1.541     raeburn  13031:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  13032:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  13033:     if ($context eq 'auto') {
                   13034:         $linefeed = "\n";
                   13035:     } else {
                   13036:         $linefeed = '<br />'."\n";
                   13037:     }
1.443     albertel 13038:     if (defined($one) && defined($two)) {
                   13039:         my $cid=$one.'_'.$two;
                   13040:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   13041:         my $secchange = 0;
                   13042:         my $expire_role_result;
                   13043:         my $modify_section_result;
1.628     raeburn  13044:         if ($oldsec ne '-1') { 
                   13045:             if ($oldsec ne $sec) {
1.443     albertel 13046:                 $secchange = 1;
1.628     raeburn  13047:                 my $now = time;
1.443     albertel 13048:                 my $uurl='/'.$cid;
                   13049:                 $uurl=~s/\_/\//g;
                   13050:                 if ($oldsec) {
                   13051:                     $uurl.='/'.$oldsec;
                   13052:                 }
1.626     raeburn  13053:                 $oldsecurl = $uurl;
1.628     raeburn  13054:                 $expire_role_result = 
1.652     raeburn  13055:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  13056:                 if ($env{'request.course.sec'} ne '') { 
                   13057:                     if ($expire_role_result eq 'refused') {
                   13058:                         my @roles = ('st');
                   13059:                         my @statuses = ('previous');
                   13060:                         my @roledoms = ($one);
                   13061:                         my $withsec = 1;
                   13062:                         my %roleshash = 
                   13063:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   13064:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   13065:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   13066:                             my ($oldstart,$oldend) = 
                   13067:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   13068:                             if ($oldend > 0 && $oldend <= $now) {
                   13069:                                 $expire_role_result = 'ok';
                   13070:                             }
                   13071:                         }
                   13072:                     }
                   13073:                 }
1.443     albertel 13074:                 $result = $expire_role_result;
                   13075:             }
                   13076:         }
                   13077:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  13078:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 13079:             if ($modify_section_result =~ /^ok/) {
                   13080:                 if ($secchange == 1) {
1.628     raeburn  13081:                     if ($sec eq '') {
                   13082:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   13083:                     } else {
                   13084:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   13085:                     }
1.443     albertel 13086:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  13087:                     if ($sec eq '') {
                   13088:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   13089:                     } else {
                   13090:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13091:                     }
1.443     albertel 13092:                 } else {
1.628     raeburn  13093:                     if ($sec eq '') {
                   13094:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   13095:                     } else {
                   13096:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13097:                     }
1.443     albertel 13098:                 }
                   13099:             } else {
1.628     raeburn  13100:                 if ($secchange) {       
                   13101:                     $$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;
                   13102:                 } else {
                   13103:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   13104:                 }
1.443     albertel 13105:             }
                   13106:             $result = $modify_section_result;
                   13107:         } elsif ($secchange == 1) {
1.628     raeburn  13108:             if ($oldsec eq '') {
                   13109:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   13110:             } else {
                   13111:                 $$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;
                   13112:             }
1.626     raeburn  13113:             if ($expire_role_result eq 'refused') {
                   13114:                 my $newsecurl = '/'.$cid;
                   13115:                 $newsecurl =~ s/\_/\//g;
                   13116:                 if ($sec ne '') {
                   13117:                     $newsecurl.='/'.$sec;
                   13118:                 }
                   13119:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   13120:                     if ($sec eq '') {
                   13121:                         $$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;
                   13122:                     } else {
                   13123:                         $$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;
                   13124:                     }
                   13125:                 }
                   13126:             }
1.443     albertel 13127:         }
                   13128:     } else {
1.626     raeburn  13129:         $$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 13130:         $result = "error: incomplete course id\n";
                   13131:     }
                   13132:     return $result;
                   13133: }
                   13134: 
                   13135: ############################################################
                   13136: ############################################################
                   13137: 
1.566     albertel 13138: sub check_clone {
1.578     raeburn  13139:     my ($args,$linefeed) = @_;
1.566     albertel 13140:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   13141:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   13142:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   13143:     my $clonemsg;
                   13144:     my $can_clone = 0;
1.944     raeburn  13145:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  13146:     if ($lctype ne 'community') {
                   13147:         $lctype = 'course';
                   13148:     }
1.566     albertel 13149:     if ($clonehome eq 'no_host') {
1.944     raeburn  13150:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13151:             $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'});
                   13152:         } else {
                   13153:             $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'});
                   13154:         }     
1.566     albertel 13155:     } else {
                   13156: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  13157:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13158:             if ($clonedesc{'type'} ne 'Community') {
                   13159:                  $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'});
                   13160:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13161:             }
                   13162:         }
1.882     raeburn  13163: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   13164:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 13165: 	    $can_clone = 1;
                   13166: 	} else {
                   13167: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   13168: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   13169: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  13170:             if (grep(/^\*$/,@cloners)) {
                   13171:                 $can_clone = 1;
                   13172:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   13173:                 $can_clone = 1;
                   13174:             } else {
1.908     raeburn  13175:                 my $ccrole = 'cc';
1.944     raeburn  13176:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13177:                     $ccrole = 'co';
                   13178:                 }
1.578     raeburn  13179: 	        my %roleshash =
                   13180: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   13181: 					 $args->{'ccdomain'},
1.908     raeburn  13182:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  13183: 					 [$args->{'clonedomain'}]);
1.908     raeburn  13184: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  13185:                     $can_clone = 1;
                   13186:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   13187:                     $can_clone = 1;
                   13188:                 } else {
1.944     raeburn  13189:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13190:                         $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'});
                   13191:                     } else {
                   13192:                         $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'});
                   13193:                     }
1.578     raeburn  13194: 	        }
1.566     albertel 13195: 	    }
1.578     raeburn  13196:         }
1.566     albertel 13197:     }
                   13198:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13199: }
                   13200: 
1.444     albertel 13201: sub construct_course {
1.885     raeburn  13202:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 13203:     my $outcome;
1.541     raeburn  13204:     my $linefeed =  '<br />'."\n";
                   13205:     if ($context eq 'auto') {
                   13206:         $linefeed = "\n";
                   13207:     }
1.566     albertel 13208: 
                   13209: #
                   13210: # Are we cloning?
                   13211: #
                   13212:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13213:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  13214: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 13215: 	if ($context ne 'auto') {
1.578     raeburn  13216:             if ($clonemsg ne '') {
                   13217: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   13218:             }
1.566     albertel 13219: 	}
                   13220: 	$outcome .= $clonemsg.$linefeed;
                   13221: 
                   13222:         if (!$can_clone) {
                   13223: 	    return (0,$outcome);
                   13224: 	}
                   13225:     }
                   13226: 
1.444     albertel 13227: #
                   13228: # Open course
                   13229: #
                   13230:     my $crstype = lc($args->{'crstype'});
                   13231:     my %cenv=();
                   13232:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   13233:                                              $args->{'cdescr'},
                   13234:                                              $args->{'curl'},
                   13235:                                              $args->{'course_home'},
                   13236:                                              $args->{'nonstandard'},
                   13237:                                              $args->{'crscode'},
                   13238:                                              $args->{'ccuname'}.':'.
                   13239:                                              $args->{'ccdomain'},
1.882     raeburn  13240:                                              $args->{'crstype'},
1.885     raeburn  13241:                                              $cnum,$context,$category);
1.444     albertel 13242: 
                   13243:     # Note: The testing routines depend on this being output; see 
                   13244:     # Utils::Course. This needs to at least be output as a comment
                   13245:     # if anyone ever decides to not show this, and Utils::Course::new
                   13246:     # will need to be suitably modified.
1.541     raeburn  13247:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  13248:     if ($$courseid =~ /^error:/) {
                   13249:         return (0,$outcome);
                   13250:     }
                   13251: 
1.444     albertel 13252: #
                   13253: # Check if created correctly
                   13254: #
1.479     albertel 13255:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 13256:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  13257:     if ($crsuhome eq 'no_host') {
                   13258:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   13259:         return (0,$outcome);
                   13260:     }
1.541     raeburn  13261:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 13262: 
1.444     albertel 13263: #
1.566     albertel 13264: # Do the cloning
                   13265: #   
                   13266:     if ($can_clone && $cloneid) {
                   13267: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   13268: 	if ($context ne 'auto') {
                   13269: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   13270: 	}
                   13271: 	$outcome .= $clonemsg.$linefeed;
                   13272: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 13273: # Copy all files
1.637     www      13274: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 13275: # Restore URL
1.566     albertel 13276: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 13277: # Restore title
1.566     albertel 13278: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  13279: # Restore creation date, creator and creation context.
                   13280:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   13281:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   13282:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 13283: # Mark as cloned
1.566     albertel 13284: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      13285: # Need to clone grading mode
                   13286:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   13287:         $cenv{'grading'}=$newenv{'grading'};
                   13288: # Do not clone these environment entries
                   13289:         &Apache::lonnet::del('environment',
                   13290:                   ['default_enrollment_start_date',
                   13291:                    'default_enrollment_end_date',
                   13292:                    'question.email',
                   13293:                    'policy.email',
                   13294:                    'comment.email',
                   13295:                    'pch.users.denied',
1.725     raeburn  13296:                    'plc.users.denied',
                   13297:                    'hidefromcat',
                   13298:                    'categories'],
1.638     www      13299:                    $$crsudom,$$crsunum);
1.444     albertel 13300:     }
1.566     albertel 13301: 
1.444     albertel 13302: #
                   13303: # Set environment (will override cloned, if existing)
                   13304: #
                   13305:     my @sections = ();
                   13306:     my @xlists = ();
                   13307:     if ($args->{'crstype'}) {
                   13308:         $cenv{'type'}=$args->{'crstype'};
                   13309:     }
                   13310:     if ($args->{'crsid'}) {
                   13311:         $cenv{'courseid'}=$args->{'crsid'};
                   13312:     }
                   13313:     if ($args->{'crscode'}) {
                   13314:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   13315:     }
                   13316:     if ($args->{'crsquota'} ne '') {
                   13317:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   13318:     } else {
                   13319:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   13320:     }
                   13321:     if ($args->{'ccuname'}) {
                   13322:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   13323:                                         ':'.$args->{'ccdomain'};
                   13324:     } else {
                   13325:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   13326:     }
                   13327:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   13328:     if ($args->{'crssections'}) {
                   13329:         $cenv{'internal.sectionnums'} = '';
                   13330:         if ($args->{'crssections'} =~ m/,/) {
                   13331:             @sections = split/,/,$args->{'crssections'};
                   13332:         } else {
                   13333:             $sections[0] = $args->{'crssections'};
                   13334:         }
                   13335:         if (@sections > 0) {
                   13336:             foreach my $item (@sections) {
                   13337:                 my ($sec,$gp) = split/:/,$item;
                   13338:                 my $class = $args->{'crscode'}.$sec;
                   13339:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   13340:                 $cenv{'internal.sectionnums'} .= $item.',';
                   13341:                 unless ($addcheck eq 'ok') {
                   13342:                     push @badclasses, $class;
                   13343:                 }
                   13344:             }
                   13345:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   13346:         }
                   13347:     }
                   13348: # do not hide course coordinator from staff listing, 
                   13349: # even if privileged
                   13350:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13351: # add crosslistings
                   13352:     if ($args->{'crsxlist'}) {
                   13353:         $cenv{'internal.crosslistings'}='';
                   13354:         if ($args->{'crsxlist'} =~ m/,/) {
                   13355:             @xlists = split/,/,$args->{'crsxlist'};
                   13356:         } else {
                   13357:             $xlists[0] = $args->{'crsxlist'};
                   13358:         }
                   13359:         if (@xlists > 0) {
                   13360:             foreach my $item (@xlists) {
                   13361:                 my ($xl,$gp) = split/:/,$item;
                   13362:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   13363:                 $cenv{'internal.crosslistings'} .= $item.',';
                   13364:                 unless ($addcheck eq 'ok') {
                   13365:                     push @badclasses, $xl;
                   13366:                 }
                   13367:             }
                   13368:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   13369:         }
                   13370:     }
                   13371:     if ($args->{'autoadds'}) {
                   13372:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   13373:     }
                   13374:     if ($args->{'autodrops'}) {
                   13375:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   13376:     }
                   13377: # check for notification of enrollment changes
                   13378:     my @notified = ();
                   13379:     if ($args->{'notify_owner'}) {
                   13380:         if ($args->{'ccuname'} ne '') {
                   13381:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   13382:         }
                   13383:     }
                   13384:     if ($args->{'notify_dc'}) {
                   13385:         if ($uname ne '') { 
1.630     raeburn  13386:             push(@notified,$uname.':'.$udom);
1.444     albertel 13387:         }
                   13388:     }
                   13389:     if (@notified > 0) {
                   13390:         my $notifylist;
                   13391:         if (@notified > 1) {
                   13392:             $notifylist = join(',',@notified);
                   13393:         } else {
                   13394:             $notifylist = $notified[0];
                   13395:         }
                   13396:         $cenv{'internal.notifylist'} = $notifylist;
                   13397:     }
                   13398:     if (@badclasses > 0) {
                   13399:         my %lt=&Apache::lonlocal::texthash(
                   13400:                 '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',
                   13401:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   13402:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   13403:         );
1.541     raeburn  13404:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   13405:                            ' ('.$lt{'adby'}.')';
                   13406:         if ($context eq 'auto') {
                   13407:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 13408:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  13409:             foreach my $item (@badclasses) {
                   13410:                 if ($context eq 'auto') {
                   13411:                     $outcome .= " - $item\n";
                   13412:                 } else {
                   13413:                     $outcome .= "<li>$item</li>\n";
                   13414:                 }
                   13415:             }
                   13416:             if ($context eq 'auto') {
                   13417:                 $outcome .= $linefeed;
                   13418:             } else {
1.566     albertel 13419:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  13420:             }
                   13421:         } 
1.444     albertel 13422:     }
                   13423:     if ($args->{'no_end_date'}) {
                   13424:         $args->{'endaccess'} = 0;
                   13425:     }
                   13426:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   13427:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   13428:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   13429:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   13430:     if ($args->{'showphotos'}) {
                   13431:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   13432:     }
                   13433:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   13434:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   13435:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   13436:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  13437:             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'); 
                   13438:             if ($context eq 'auto') {
                   13439:                 $outcome .= $krb_msg;
                   13440:             } else {
1.566     albertel 13441:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  13442:             }
                   13443:             $outcome .= $linefeed;
1.444     albertel 13444:         }
                   13445:     }
                   13446:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   13447:        if ($args->{'setpolicy'}) {
                   13448:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13449:        }
                   13450:        if ($args->{'setcontent'}) {
                   13451:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13452:        }
                   13453:     }
                   13454:     if ($args->{'reshome'}) {
                   13455: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   13456: 	$cenv{'reshome'}=~s/\/+$/\//;
                   13457:     }
                   13458: #
                   13459: # course has keyed access
                   13460: #
                   13461:     if ($args->{'setkeys'}) {
                   13462:        $cenv{'keyaccess'}='yes';
                   13463:     }
                   13464: # if specified, key authority is not course, but user
                   13465: # only active if keyaccess is yes
                   13466:     if ($args->{'keyauth'}) {
1.487     albertel 13467: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   13468: 	$user = &LONCAPA::clean_username($user);
                   13469: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     13470: 	if ($user ne '' && $domain ne '') {
1.487     albertel 13471: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 13472: 	}
                   13473:     }
                   13474: 
                   13475:     if ($args->{'disresdis'}) {
                   13476:         $cenv{'pch.roles.denied'}='st';
                   13477:     }
                   13478:     if ($args->{'disablechat'}) {
                   13479:         $cenv{'plc.roles.denied'}='st';
                   13480:     }
                   13481: 
                   13482:     # Record we've not yet viewed the Course Initialization Helper for this 
                   13483:     # course
                   13484:     $cenv{'course.helper.not.run'} = 1;
                   13485:     #
                   13486:     # Use new Randomseed
                   13487:     #
                   13488:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   13489:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   13490:     #
                   13491:     # The encryption code and receipt prefix for this course
                   13492:     #
                   13493:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   13494:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   13495:     #
                   13496:     # By default, use standard grading
                   13497:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   13498: 
1.541     raeburn  13499:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   13500:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13501: #
                   13502: # Open all assignments
                   13503: #
                   13504:     if ($args->{'openall'}) {
                   13505:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   13506:        my %storecontent = ($storeunder         => time,
                   13507:                            $storeunder.'.type' => 'date_start');
                   13508:        
                   13509:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  13510:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13511:    }
                   13512: #
                   13513: # Set first page
                   13514: #
                   13515:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   13516: 	    || ($cloneid)) {
1.445     albertel 13517: 	use LONCAPA::map;
1.444     albertel 13518: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 13519: 
                   13520: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   13521:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   13522: 
1.444     albertel 13523:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   13524:         my $title; my $url;
                   13525:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   13526: 	    $title=&mt('Syllabus');
1.444     albertel 13527:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   13528:         } else {
1.963     raeburn  13529:             $title=&mt('Table of Contents');
1.444     albertel 13530:             $url='/adm/navmaps';
                   13531:         }
1.445     albertel 13532: 
                   13533:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   13534: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   13535: 
                   13536: 	if ($errtext) { $fatal=2; }
1.541     raeburn  13537:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 13538:     }
1.566     albertel 13539: 
                   13540:     return (1,$outcome);
1.444     albertel 13541: }
                   13542: 
                   13543: ############################################################
                   13544: ############################################################
                   13545: 
1.953     droeschl 13546: #SD
                   13547: # only Community and Course, or anything else?
1.378     raeburn  13548: sub course_type {
                   13549:     my ($cid) = @_;
                   13550:     if (!defined($cid)) {
                   13551:         $cid = $env{'request.course.id'};
                   13552:     }
1.404     albertel 13553:     if (defined($env{'course.'.$cid.'.type'})) {
                   13554:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  13555:     } else {
                   13556:         return 'Course';
1.377     raeburn  13557:     }
                   13558: }
1.156     albertel 13559: 
1.406     raeburn  13560: sub group_term {
                   13561:     my $crstype = &course_type();
                   13562:     my %names = (
                   13563:                   'Course' => 'group',
1.865     raeburn  13564:                   'Community' => 'group',
1.406     raeburn  13565:                 );
                   13566:     return $names{$crstype};
                   13567: }
                   13568: 
1.902     raeburn  13569: sub course_types {
                   13570:     my @types = ('official','unofficial','community');
                   13571:     my %typename = (
                   13572:                          official   => 'Official course',
                   13573:                          unofficial => 'Unofficial course',
                   13574:                          community  => 'Community',
                   13575:                    );
                   13576:     return (\@types,\%typename);
                   13577: }
                   13578: 
1.156     albertel 13579: sub icon {
                   13580:     my ($file)=@_;
1.505     albertel 13581:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 13582:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 13583:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 13584:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   13585: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   13586: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13587: 	            $curfext.".gif") {
                   13588: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13589: 		$curfext.".gif";
                   13590: 	}
                   13591:     }
1.249     albertel 13592:     return &lonhttpdurl($iconname);
1.154     albertel 13593: } 
1.84      albertel 13594: 
1.575     albertel 13595: sub lonhttpdurl {
1.692     www      13596: #
                   13597: # Had been used for "small fry" static images on separate port 8080.
                   13598: # Modify here if lightweight http functionality desired again.
                   13599: # Currently eliminated due to increasing firewall issues.
                   13600: #
1.575     albertel 13601:     my ($url)=@_;
1.692     www      13602:     return $url;
1.215     albertel 13603: }
                   13604: 
1.213     albertel 13605: sub connection_aborted {
                   13606:     my ($r)=@_;
                   13607:     $r->print(" ");$r->rflush();
                   13608:     my $c = $r->connection;
                   13609:     return $c->aborted();
                   13610: }
                   13611: 
1.221     foxr     13612: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     13613: #    strings as 'strings'.
                   13614: sub escape_single {
1.221     foxr     13615:     my ($input) = @_;
1.223     albertel 13616:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     13617:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   13618:     return $input;
                   13619: }
1.223     albertel 13620: 
1.222     foxr     13621: #  Same as escape_single, but escape's "'s  This 
                   13622: #  can be used for  "strings"
                   13623: sub escape_double {
                   13624:     my ($input) = @_;
                   13625:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   13626:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   13627:     return $input;
                   13628: }
1.223     albertel 13629:  
1.222     foxr     13630: #   Escapes the last element of a full URL.
                   13631: sub escape_url {
                   13632:     my ($url)   = @_;
1.238     raeburn  13633:     my @urlslices = split(/\//, $url,-1);
1.369     www      13634:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 13635:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     13636: }
1.462     albertel 13637: 
1.820     raeburn  13638: sub compare_arrays {
                   13639:     my ($arrayref1,$arrayref2) = @_;
                   13640:     my (@difference,%count);
                   13641:     @difference = ();
                   13642:     %count = ();
                   13643:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   13644:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   13645:         foreach my $element (keys(%count)) {
                   13646:             if ($count{$element} == 1) {
                   13647:                 push(@difference,$element);
                   13648:             }
                   13649:         }
                   13650:     }
                   13651:     return @difference;
                   13652: }
                   13653: 
1.817     bisitz   13654: # -------------------------------------------------------- Initialize user login
1.462     albertel 13655: sub init_user_environment {
1.463     albertel 13656:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 13657:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   13658: 
                   13659:     my $public=($username eq 'public' && $domain eq 'public');
                   13660: 
                   13661: # See if old ID present, if so, remove
                   13662: 
1.1062    raeburn  13663:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 13664:     my $now=time;
                   13665: 
                   13666:     if ($public) {
                   13667: 	my $max_public=100;
                   13668: 	my $oldest;
                   13669: 	my $oldest_time=0;
                   13670: 	for(my $next=1;$next<=$max_public;$next++) {
                   13671: 	    if (-e $lonids."/publicuser_$next.id") {
                   13672: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   13673: 		if ($mtime<$oldest_time || !$oldest_time) {
                   13674: 		    $oldest_time=$mtime;
                   13675: 		    $oldest=$next;
                   13676: 		}
                   13677: 	    } else {
                   13678: 		$cookie="publicuser_$next";
                   13679: 		last;
                   13680: 	    }
                   13681: 	}
                   13682: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   13683:     } else {
1.463     albertel 13684: 	# if this isn't a robot, kill any existing non-robot sessions
                   13685: 	if (!$args->{'robot'}) {
                   13686: 	    opendir(DIR,$lonids);
                   13687: 	    while ($filename=readdir(DIR)) {
                   13688: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   13689: 		    unlink($lonids.'/'.$filename);
                   13690: 		}
1.462     albertel 13691: 	    }
1.463     albertel 13692: 	    closedir(DIR);
1.462     albertel 13693: 	}
                   13694: # Give them a new cookie
1.463     albertel 13695: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      13696: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 13697: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 13698:     
                   13699: # Initialize roles
                   13700: 
1.1062    raeburn  13701: 	($userroles,$firstaccenv,$timerintenv) = 
                   13702:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 13703:     }
                   13704: # ------------------------------------ Check browser type and MathML capability
                   13705: 
                   13706:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   13707:         $clientunicode,$clientos) = &decode_user_agent($r);
                   13708: 
                   13709: # ------------------------------------------------------------- Get environment
                   13710: 
                   13711:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   13712:     my ($tmp) = keys(%userenv);
                   13713:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   13714:     } else {
                   13715: 	undef(%userenv);
                   13716:     }
                   13717:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   13718: 	$form->{'interface'}=$userenv{'interface'};
                   13719:     }
                   13720:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   13721: 
                   13722: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   13723:     foreach my $option ('interface','localpath','localres') {
                   13724:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 13725:     }
                   13726: # --------------------------------------------------------- Write first profile
                   13727: 
                   13728:     {
                   13729: 	my %initial_env = 
                   13730: 	    ("user.name"          => $username,
                   13731: 	     "user.domain"        => $domain,
                   13732: 	     "user.home"          => $authhost,
                   13733: 	     "browser.type"       => $clientbrowser,
                   13734: 	     "browser.version"    => $clientversion,
                   13735: 	     "browser.mathml"     => $clientmathml,
                   13736: 	     "browser.unicode"    => $clientunicode,
                   13737: 	     "browser.os"         => $clientos,
                   13738: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   13739: 	     "request.course.fn"  => '',
                   13740: 	     "request.course.uri" => '',
                   13741: 	     "request.course.sec" => '',
                   13742: 	     "request.role"       => 'cm',
                   13743: 	     "request.role.adv"   => $env{'user.adv'},
                   13744: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   13745: 
                   13746:         if ($form->{'localpath'}) {
                   13747: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   13748: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   13749:         }
                   13750: 	
                   13751: 	if ($form->{'interface'}) {
                   13752: 	    $form->{'interface'}=~s/\W//gs;
                   13753: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   13754: 	    $env{'browser.interface'}=$form->{'interface'};
                   13755: 	}
                   13756: 
1.981     raeburn  13757:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  13758:         my %domdef;
                   13759:         unless ($domain eq 'public') {
                   13760:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   13761:         }
1.980     raeburn  13762: 
1.1075.2.7  raeburn  13763:         foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724     raeburn  13764:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  13765:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   13766:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  13767:         }
                   13768: 
1.864     raeburn  13769:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  13770:             $userenv{'canrequest.'.$crstype} =
                   13771:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  13772:                                                   'reload','requestcourses',
                   13773:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  13774:         }
                   13775: 
1.462     albertel 13776: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  13777: 
1.462     albertel 13778: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   13779: 		 &GDBM_WRCREAT(),0640)) {
                   13780: 	    &_add_to_env(\%disk_env,\%initial_env);
                   13781: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   13782: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  13783:             if (ref($firstaccenv) eq 'HASH') {
                   13784:                 &_add_to_env(\%disk_env,$firstaccenv);
                   13785:             }
                   13786:             if (ref($timerintenv) eq 'HASH') {
                   13787:                 &_add_to_env(\%disk_env,$timerintenv);
                   13788:             }
1.463     albertel 13789: 	    if (ref($args->{'extra_env'})) {
                   13790: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   13791: 	    }
1.462     albertel 13792: 	    untie(%disk_env);
                   13793: 	} else {
1.705     tempelho 13794: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   13795: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 13796: 	    return 'error: '.$!;
                   13797: 	}
                   13798:     }
                   13799:     $env{'request.role'}='cm';
                   13800:     $env{'request.role.adv'}=$env{'user.adv'};
                   13801:     $env{'browser.type'}=$clientbrowser;
                   13802: 
                   13803:     return $cookie;
                   13804: 
                   13805: }
                   13806: 
                   13807: sub _add_to_env {
                   13808:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  13809:     if (ref($env_data) eq 'HASH') {
                   13810:         while (my ($key,$value) = each(%$env_data)) {
                   13811: 	    $idf->{$prefix.$key} = $value;
                   13812: 	    $env{$prefix.$key}   = $value;
                   13813:         }
1.462     albertel 13814:     }
                   13815: }
                   13816: 
1.685     tempelho 13817: # --- Get the symbolic name of a problem and the url
                   13818: sub get_symb {
                   13819:     my ($request,$silent) = @_;
1.726     raeburn  13820:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 13821:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   13822:     if ($symb eq '') {
                   13823:         if (!$silent) {
1.1071    raeburn  13824:             if (ref($request)) { 
                   13825:                 $request->print("Unable to handle ambiguous references:$url:.");
                   13826:             }
1.685     tempelho 13827:             return ();
                   13828:         }
                   13829:     }
                   13830:     &Apache::lonenc::check_decrypt(\$symb);
                   13831:     return ($symb);
                   13832: }
                   13833: 
                   13834: # --------------------------------------------------------------Get annotation
                   13835: 
                   13836: sub get_annotation {
                   13837:     my ($symb,$enc) = @_;
                   13838: 
                   13839:     my $key = $symb;
                   13840:     if (!$enc) {
                   13841:         $key =
                   13842:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   13843:     }
                   13844:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   13845:     return $annotation{$key};
                   13846: }
                   13847: 
                   13848: sub clean_symb {
1.731     raeburn  13849:     my ($symb,$delete_enc) = @_;
1.685     tempelho 13850: 
                   13851:     &Apache::lonenc::check_decrypt(\$symb);
                   13852:     my $enc = $env{'request.enc'};
1.731     raeburn  13853:     if ($delete_enc) {
1.730     raeburn  13854:         delete($env{'request.enc'});
                   13855:     }
1.685     tempelho 13856: 
                   13857:     return ($symb,$enc);
                   13858: }
1.462     albertel 13859: 
1.990     raeburn  13860: sub build_release_hashes {
                   13861:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   13862:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   13863:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   13864:                   (ref($randomizetry) eq 'HASH'));
                   13865:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   13866:         my ($item,$name,$value) = split(/:/,$key);
                   13867:         if ($item eq 'parameter') {
                   13868:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   13869:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   13870:                     push(@{$checkparms->{$name}},$value);
                   13871:                 }
                   13872:             } else {
                   13873:                 push(@{$checkparms->{$name}},$value);
                   13874:             }
                   13875:         } elsif ($item eq 'resourcetag') {
                   13876:             if ($name eq 'responsetype') {
                   13877:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   13878:             }
                   13879:         } elsif ($item eq 'course') {
                   13880:             if ($name eq 'crstype') {
                   13881:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   13882:             }
                   13883:         }
                   13884:     }
                   13885:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   13886:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   13887:     return;
                   13888: }
                   13889: 
1.41      ng       13890: =pod
                   13891: 
                   13892: =back
                   13893: 
1.112     bowersj2 13894: =cut
1.41      ng       13895: 
1.112     bowersj2 13896: 1;
                   13897: __END__;
1.41      ng       13898: 

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