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

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.1! raeburn     4: # $Id: loncommon.pm,v 1.1075 2012/05/09 20:17:47 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.916     droeschl 5061:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.1! raeburn  5062:             unless ($env{'request.noversionuri'} =~ m{/res/adm/pages/bookmarkmenu/}) {
        !          5063:                 if ($dc_info) {
        !          5064:                      $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
        !          5065:                 }
        !          5066:                 $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
        !          5067:                                <em>$realm</em> $dc_info</div>|;
        !          5068:             }
1.903     droeschl 5069:             return $bodytag;
                   5070:         }
1.894     droeschl 5071: 
1.927     raeburn  5072:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5073:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   5074:         }
1.916     droeschl 5075: 
1.903     droeschl 5076:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   5077:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   5078: 
1.903     droeschl 5079:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 5080: 
1.917     raeburn  5081:         if ($dc_info) {
                   5082:             $dc_info = &dc_courseid_toggle($dc_info);
                   5083:         }
                   5084:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5085: 
1.903     droeschl 5086:         #don't show menus for public users
1.954     raeburn  5087:         if (!$public){
1.903     droeschl 5088:             $bodytag .= Apache::lonmenu::secondary_menu();
                   5089:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5090:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5091:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5092:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5093:                                 $args->{'bread_crumbs'});
                   5094:             } elsif ($forcereg) { 
                   5095:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg);
                   5096:             }
1.903     droeschl 5097:         }else{
                   5098:             # this is to seperate menu from content when there's no secondary
                   5099:             # menu. Especially needed for public accessible ressources.
                   5100:             $bodytag .= '<hr style="clear:both" />';
                   5101:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5102:         }
1.903     droeschl 5103: 
1.235     raeburn  5104:         return $bodytag;
1.182     matthew  5105: }
                   5106: 
1.917     raeburn  5107: sub dc_courseid_toggle {
                   5108:     my ($dc_info) = @_;
1.980     raeburn  5109:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5110:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5111:            &mt('(More ...)').'</a></span>'.
                   5112:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5113: }
                   5114: 
1.330     albertel 5115: sub make_attr_string {
                   5116:     my ($register,$attr_ref) = @_;
                   5117: 
                   5118:     if ($attr_ref && !ref($attr_ref)) {
                   5119: 	die("addentries Must be a hash ref ".
                   5120: 	    join(':',caller(1))." ".
                   5121: 	    join(':',caller(0))." ");
                   5122:     }
                   5123: 
                   5124:     if ($register) {
1.339     albertel 5125: 	my ($on_load,$on_unload);
                   5126: 	foreach my $key (keys(%{$attr_ref})) {
                   5127: 	    if      (lc($key) eq 'onload') {
                   5128: 		$on_load.=$attr_ref->{$key}.';';
                   5129: 		delete($attr_ref->{$key});
                   5130: 
                   5131: 	    } elsif (lc($key) eq 'onunload') {
                   5132: 		$on_unload.=$attr_ref->{$key}.';';
                   5133: 		delete($attr_ref->{$key});
                   5134: 	    }
                   5135: 	}
1.953     droeschl 5136: 	$attr_ref->{'onload'}  = $on_load;
                   5137: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5138:     }
1.339     albertel 5139: 
1.330     albertel 5140:     my $attr_string;
                   5141:     foreach my $attr (keys(%$attr_ref)) {
                   5142: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5143:     }
                   5144:     return $attr_string;
                   5145: }
                   5146: 
                   5147: 
1.182     matthew  5148: ###############################################
1.251     albertel 5149: ###############################################
                   5150: 
                   5151: =pod
                   5152: 
                   5153: =item * &endbodytag()
                   5154: 
                   5155: Returns a uniform footer for LON-CAPA web pages.
                   5156: 
1.635     raeburn  5157: Inputs: 1 - optional reference to an args hash
                   5158: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5159: a 'Continue' link is not displayed if the page contains an
                   5160: internal redirect in the <head></head> section,
                   5161: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5162: 
                   5163: =cut
                   5164: 
                   5165: sub endbodytag {
1.635     raeburn  5166:     my ($args) = @_;
1.251     albertel 5167:     my $endbodytag='</body>';
1.269     albertel 5168:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5169:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5170:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5171: 	    $endbodytag=
                   5172: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5173: 	        &mt('Continue').'</a>'.
                   5174: 	        $endbodytag;
                   5175:         }
1.315     albertel 5176:     }
1.251     albertel 5177:     return $endbodytag;
                   5178: }
                   5179: 
1.352     albertel 5180: =pod
                   5181: 
                   5182: =item * &standard_css()
                   5183: 
                   5184: Returns a style sheet
                   5185: 
                   5186: Inputs: (all optional)
                   5187:             domain         -> force to color decorate a page for a specific
                   5188:                                domain
                   5189:             function       -> force usage of a specific rolish color scheme
                   5190:             bgcolor        -> override the default page bgcolor
                   5191: 
                   5192: =cut
                   5193: 
1.343     albertel 5194: sub standard_css {
1.345     albertel 5195:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5196:     $function  = &get_users_function() if (!$function);
                   5197:     my $img    = &designparm($function.'.img',   $domain);
                   5198:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5199:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5200:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5201: #second colour for later usage
1.345     albertel 5202:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5203:     my $pgbg_or_bgcolor =
                   5204: 	         $bgcolor ||
1.352     albertel 5205: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5206:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5207:     my $alink  = &designparm($function.'.alink', $domain);
                   5208:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5209:     my $link   = &designparm($function.'.link',  $domain);
                   5210: 
1.602     albertel 5211:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5212:     my $mono                 = 'monospace';
1.850     bisitz   5213:     my $data_table_head      = $sidebg;
                   5214:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5215:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5216:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5217:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5218:     my $mail_new             = '#FFBB77';
                   5219:     my $mail_new_hover       = '#DD9955';
                   5220:     my $mail_read            = '#BBBB77';
                   5221:     my $mail_read_hover      = '#999944';
                   5222:     my $mail_replied         = '#AAAA88';
                   5223:     my $mail_replied_hover   = '#888855';
                   5224:     my $mail_other           = '#99BBBB';
                   5225:     my $mail_other_hover     = '#669999';
1.391     albertel 5226:     my $table_header         = '#DDDDDD';
1.489     raeburn  5227:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5228:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5229:     my $button_hover         = '#BF2317';
1.392     albertel 5230: 
1.608     albertel 5231:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5232:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5233:                                              : '0 3px 0 4px';
1.448     albertel 5234: 
1.523     albertel 5235: 
1.343     albertel 5236:     return <<END;
1.947     droeschl 5237: 
                   5238: /* needed for iframe to allow 100% height in FF */
                   5239: body, html { 
                   5240:     margin: 0;
                   5241:     padding: 0 0.5%;
                   5242:     height: 99%; /* to avoid scrollbars */
                   5243: }
                   5244: 
1.795     www      5245: body {
1.911     bisitz   5246:   font-family: $sans;
                   5247:   line-height:130%;
                   5248:   font-size:0.83em;
                   5249:   color:$font;
1.795     www      5250: }
                   5251: 
1.959     onken    5252: a:focus,
                   5253: a:focus img {
1.795     www      5254:   color: red;
                   5255: }
1.698     harmsja  5256: 
1.911     bisitz   5257: form, .inline {
                   5258:   display: inline;
1.795     www      5259: }
1.721     harmsja  5260: 
1.795     www      5261: .LC_right {
1.911     bisitz   5262:   text-align:right;
1.795     www      5263: }
                   5264: 
                   5265: .LC_middle {
1.911     bisitz   5266:   vertical-align:middle;
1.795     www      5267: }
1.721     harmsja  5268: 
1.911     bisitz   5269: .LC_400Box {
                   5270:   width:400px;
                   5271: }
1.721     harmsja  5272: 
1.947     droeschl 5273: .LC_iframecontainer {
                   5274:     width: 98%;
                   5275:     margin: 0;
                   5276:     position: fixed;
                   5277:     top: 8.5em;
                   5278:     bottom: 0;
                   5279: }
                   5280: 
                   5281: .LC_iframecontainer iframe{
                   5282:     border: none;
                   5283:     width: 100%;
                   5284:     height: 100%;
                   5285: }
                   5286: 
1.778     bisitz   5287: .LC_filename {
                   5288:   font-family: $mono;
                   5289:   white-space:pre;
1.921     bisitz   5290:   font-size: 120%;
1.778     bisitz   5291: }
                   5292: 
                   5293: .LC_fileicon {
                   5294:   border: none;
                   5295:   height: 1.3em;
                   5296:   vertical-align: text-bottom;
                   5297:   margin-right: 0.3em;
                   5298:   text-decoration:none;
                   5299: }
                   5300: 
1.1008    www      5301: .LC_setting {
                   5302:   text-decoration:underline;
                   5303: }
                   5304: 
1.350     albertel 5305: .LC_error {
                   5306:   color: red;
                   5307:   font-size: larger;
                   5308: }
1.795     www      5309: 
1.457     albertel 5310: .LC_warning,
                   5311: .LC_diff_removed {
1.733     bisitz   5312:   color: red;
1.394     albertel 5313: }
1.532     albertel 5314: 
                   5315: .LC_info,
1.457     albertel 5316: .LC_success,
                   5317: .LC_diff_added {
1.350     albertel 5318:   color: green;
                   5319: }
1.795     www      5320: 
1.802     bisitz   5321: div.LC_confirm_box {
                   5322:   background-color: #FAFAFA;
                   5323:   border: 1px solid $lg_border_color;
                   5324:   margin-right: 0;
                   5325:   padding: 5px;
                   5326: }
                   5327: 
                   5328: div.LC_confirm_box .LC_error img,
                   5329: div.LC_confirm_box .LC_success img {
                   5330:   vertical-align: middle;
                   5331: }
                   5332: 
1.440     albertel 5333: .LC_icon {
1.771     droeschl 5334:   border: none;
1.790     droeschl 5335:   vertical-align: middle;
1.771     droeschl 5336: }
                   5337: 
1.543     albertel 5338: .LC_docs_spacer {
                   5339:   width: 25px;
                   5340:   height: 1px;
1.771     droeschl 5341:   border: none;
1.543     albertel 5342: }
1.346     albertel 5343: 
1.532     albertel 5344: .LC_internal_info {
1.735     bisitz   5345:   color: #999999;
1.532     albertel 5346: }
                   5347: 
1.794     www      5348: .LC_discussion {
1.1050    www      5349:   background: $data_table_dark;
1.911     bisitz   5350:   border: 1px solid black;
                   5351:   margin: 2px;
1.794     www      5352: }
                   5353: 
                   5354: .LC_disc_action_left {
1.1050    www      5355:   background: $sidebg;
1.911     bisitz   5356:   text-align: left;
1.1050    www      5357:   padding: 4px;
                   5358:   margin: 2px;
1.794     www      5359: }
                   5360: 
                   5361: .LC_disc_action_right {
1.1050    www      5362:   background: $sidebg;
1.911     bisitz   5363:   text-align: right;
1.1050    www      5364:   padding: 4px;
                   5365:   margin: 2px;
1.794     www      5366: }
                   5367: 
                   5368: .LC_disc_new_item {
1.911     bisitz   5369:   background: white;
                   5370:   border: 2px solid red;
1.1050    www      5371:   margin: 4px;
                   5372:   padding: 4px;
1.794     www      5373: }
                   5374: 
                   5375: .LC_disc_old_item {
1.911     bisitz   5376:   background: white;
1.1050    www      5377:   margin: 4px;
                   5378:   padding: 4px;
1.794     www      5379: }
                   5380: 
1.458     albertel 5381: table.LC_pastsubmission {
                   5382:   border: 1px solid black;
                   5383:   margin: 2px;
                   5384: }
                   5385: 
1.924     bisitz   5386: table#LC_menubuttons {
1.345     albertel 5387:   width: 100%;
                   5388:   background: $pgbg;
1.392     albertel 5389:   border: 2px;
1.402     albertel 5390:   border-collapse: separate;
1.803     bisitz   5391:   padding: 0;
1.345     albertel 5392: }
1.392     albertel 5393: 
1.801     tempelho 5394: table#LC_title_bar a {
                   5395:   color: $fontmenu;
                   5396: }
1.836     bisitz   5397: 
1.807     droeschl 5398: table#LC_title_bar {
1.819     tempelho 5399:   clear: both;
1.836     bisitz   5400:   display: none;
1.807     droeschl 5401: }
                   5402: 
1.795     www      5403: table#LC_title_bar,
1.933     droeschl 5404: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5405: table#LC_title_bar.LC_with_remote {
1.359     albertel 5406:   width: 100%;
1.392     albertel 5407:   border-color: $pgbg;
                   5408:   border-style: solid;
                   5409:   border-width: $border;
1.379     albertel 5410:   background: $pgbg;
1.801     tempelho 5411:   color: $fontmenu;
1.392     albertel 5412:   border-collapse: collapse;
1.803     bisitz   5413:   padding: 0;
1.819     tempelho 5414:   margin: 0;
1.359     albertel 5415: }
1.795     www      5416: 
1.933     droeschl 5417: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5418:     margin: 0;
                   5419:     padding: 0;
1.933     droeschl 5420:     position: relative;
                   5421:     list-style: none;
1.913     droeschl 5422: }
1.933     droeschl 5423: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5424:     display: inline;
                   5425: }
1.933     droeschl 5426: 
                   5427: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5428:     padding: 0;
1.933     droeschl 5429:     margin: 0;
                   5430:     float: left;
1.913     droeschl 5431: }
1.933     droeschl 5432: .LC_breadcrumb_tools_tools {
                   5433:     padding: 0;
                   5434:     margin: 0;
1.913     droeschl 5435:     float: right;
                   5436: }
                   5437: 
1.359     albertel 5438: table#LC_title_bar td {
                   5439:   background: $tabbg;
                   5440: }
1.795     www      5441: 
1.911     bisitz   5442: table#LC_menubuttons img {
1.803     bisitz   5443:   border: none;
1.346     albertel 5444: }
1.795     www      5445: 
1.842     droeschl 5446: .LC_breadcrumbs_component {
1.911     bisitz   5447:   float: right;
                   5448:   margin: 0 1em;
1.357     albertel 5449: }
1.842     droeschl 5450: .LC_breadcrumbs_component img {
1.911     bisitz   5451:   vertical-align: middle;
1.777     tempelho 5452: }
1.795     www      5453: 
1.383     albertel 5454: td.LC_table_cell_checkbox {
                   5455:   text-align: center;
                   5456: }
1.795     www      5457: 
                   5458: .LC_fontsize_small {
1.911     bisitz   5459:   font-size: 70%;
1.705     tempelho 5460: }
                   5461: 
1.844     bisitz   5462: #LC_breadcrumbs {
1.911     bisitz   5463:   clear:both;
                   5464:   background: $sidebg;
                   5465:   border-bottom: 1px solid $lg_border_color;
                   5466:   line-height: 2.5em;
1.933     droeschl 5467:   overflow: hidden;
1.911     bisitz   5468:   margin: 0;
                   5469:   padding: 0;
1.995     raeburn  5470:   text-align: left;
1.819     tempelho 5471: }
1.862     bisitz   5472: 
1.993     raeburn  5473: .LC_head_subbox {
1.911     bisitz   5474:   clear:both;
                   5475:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5476:   border: 1px solid $sidebg;
                   5477:   margin: 0 0 10px 0;      
1.966     bisitz   5478:   padding: 3px;
1.995     raeburn  5479:   text-align: left;
1.822     bisitz   5480: }
                   5481: 
1.795     www      5482: .LC_fontsize_medium {
1.911     bisitz   5483:   font-size: 85%;
1.705     tempelho 5484: }
                   5485: 
1.795     www      5486: .LC_fontsize_large {
1.911     bisitz   5487:   font-size: 120%;
1.705     tempelho 5488: }
                   5489: 
1.346     albertel 5490: .LC_menubuttons_inline_text {
                   5491:   color: $font;
1.698     harmsja  5492:   font-size: 90%;
1.701     harmsja  5493:   padding-left:3px;
1.346     albertel 5494: }
                   5495: 
1.934     droeschl 5496: .LC_menubuttons_inline_text img{
                   5497:   vertical-align: middle;
                   5498: }
                   5499: 
1.1051    www      5500: li.LC_menubuttons_inline_text img {
1.951     onken    5501:   cursor:pointer;
1.1002    droeschl 5502:   text-decoration: none;
1.951     onken    5503: }
                   5504: 
1.526     www      5505: .LC_menubuttons_link {
                   5506:   text-decoration: none;
                   5507: }
1.795     www      5508: 
1.522     albertel 5509: .LC_menubuttons_category {
1.521     www      5510:   color: $font;
1.526     www      5511:   background: $pgbg;
1.521     www      5512:   font-size: larger;
                   5513:   font-weight: bold;
                   5514: }
                   5515: 
1.346     albertel 5516: td.LC_menubuttons_text {
1.911     bisitz   5517:   color: $font;
1.346     albertel 5518: }
1.706     harmsja  5519: 
1.346     albertel 5520: .LC_current_location {
                   5521:   background: $tabbg;
                   5522: }
1.795     www      5523: 
1.938     bisitz   5524: table.LC_data_table {
1.347     albertel 5525:   border: 1px solid #000000;
1.402     albertel 5526:   border-collapse: separate;
1.426     albertel 5527:   border-spacing: 1px;
1.610     albertel 5528:   background: $pgbg;
1.347     albertel 5529: }
1.795     www      5530: 
1.422     albertel 5531: .LC_data_table_dense {
                   5532:   font-size: small;
                   5533: }
1.795     www      5534: 
1.507     raeburn  5535: table.LC_nested_outer {
                   5536:   border: 1px solid #000000;
1.589     raeburn  5537:   border-collapse: collapse;
1.803     bisitz   5538:   border-spacing: 0;
1.507     raeburn  5539:   width: 100%;
                   5540: }
1.795     www      5541: 
1.879     raeburn  5542: table.LC_innerpickbox,
1.507     raeburn  5543: table.LC_nested {
1.803     bisitz   5544:   border: none;
1.589     raeburn  5545:   border-collapse: collapse;
1.803     bisitz   5546:   border-spacing: 0;
1.507     raeburn  5547:   width: 100%;
                   5548: }
1.795     www      5549: 
1.911     bisitz   5550: table.LC_data_table tr th,
                   5551: table.LC_calendar tr th,
1.879     raeburn  5552: table.LC_prior_tries tr th,
                   5553: table.LC_innerpickbox tr th {
1.349     albertel 5554:   font-weight: bold;
                   5555:   background-color: $data_table_head;
1.801     tempelho 5556:   color:$fontmenu;
1.701     harmsja  5557:   font-size:90%;
1.347     albertel 5558: }
1.795     www      5559: 
1.879     raeburn  5560: table.LC_innerpickbox tr th,
                   5561: table.LC_innerpickbox tr td {
                   5562:   vertical-align: top;
                   5563: }
                   5564: 
1.711     raeburn  5565: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5566:   background-color: #CCCCCC;
1.711     raeburn  5567:   font-weight: bold;
                   5568:   text-align: left;
                   5569: }
1.795     www      5570: 
1.912     bisitz   5571: table.LC_data_table tr.LC_odd_row > td {
                   5572:   background-color: $data_table_light;
                   5573:   padding: 2px;
                   5574:   vertical-align: top;
                   5575: }
                   5576: 
1.809     bisitz   5577: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5578:   background-color: $data_table_light;
1.912     bisitz   5579:   vertical-align: top;
                   5580: }
                   5581: 
                   5582: table.LC_data_table tr.LC_even_row > td {
                   5583:   background-color: $data_table_dark;
1.425     albertel 5584:   padding: 2px;
1.900     bisitz   5585:   vertical-align: top;
1.347     albertel 5586: }
1.795     www      5587: 
1.809     bisitz   5588: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5589:   background-color: $data_table_dark;
1.900     bisitz   5590:   vertical-align: top;
1.347     albertel 5591: }
1.795     www      5592: 
1.425     albertel 5593: table.LC_data_table tr.LC_data_table_highlight td {
                   5594:   background-color: $data_table_darker;
                   5595: }
1.795     www      5596: 
1.639     raeburn  5597: table.LC_data_table tr td.LC_leftcol_header {
                   5598:   background-color: $data_table_head;
                   5599:   font-weight: bold;
                   5600: }
1.795     www      5601: 
1.451     albertel 5602: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5603: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5604:   font-weight: bold;
                   5605:   font-style: italic;
                   5606:   text-align: center;
                   5607:   padding: 8px;
1.347     albertel 5608: }
1.795     www      5609: 
1.940     bisitz   5610: table.LC_data_table tr.LC_empty_row td {
                   5611:   background-color: $sidebg;
                   5612: }
                   5613: 
                   5614: table.LC_nested tr.LC_empty_row td {
                   5615:   background-color: #FFFFFF;
                   5616: }
                   5617: 
1.890     droeschl 5618: table.LC_caption {
                   5619: }
                   5620: 
1.507     raeburn  5621: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5622:   padding: 4ex
                   5623: }
1.795     www      5624: 
1.507     raeburn  5625: table.LC_nested_outer tr th {
                   5626:   font-weight: bold;
1.801     tempelho 5627:   color:$fontmenu;
1.507     raeburn  5628:   background-color: $data_table_head;
1.701     harmsja  5629:   font-size: small;
1.507     raeburn  5630:   border-bottom: 1px solid #000000;
                   5631: }
1.795     www      5632: 
1.507     raeburn  5633: table.LC_nested_outer tr td.LC_subheader {
                   5634:   background-color: $data_table_head;
                   5635:   font-weight: bold;
                   5636:   font-size: small;
                   5637:   border-bottom: 1px solid #000000;
                   5638:   text-align: right;
1.451     albertel 5639: }
1.795     www      5640: 
1.507     raeburn  5641: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5642:   background-color: #CCCCCC;
1.451     albertel 5643:   font-weight: bold;
                   5644:   font-size: small;
1.507     raeburn  5645:   text-align: center;
                   5646: }
1.795     www      5647: 
1.589     raeburn  5648: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5649: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5650:   text-align: left;
1.451     albertel 5651: }
1.795     www      5652: 
1.507     raeburn  5653: table.LC_nested td {
1.735     bisitz   5654:   background-color: #FFFFFF;
1.451     albertel 5655:   font-size: small;
1.507     raeburn  5656: }
1.795     www      5657: 
1.507     raeburn  5658: table.LC_nested_outer tr th.LC_right_item,
                   5659: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5660: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5661: table.LC_nested tr td.LC_right_item {
1.451     albertel 5662:   text-align: right;
                   5663: }
                   5664: 
1.507     raeburn  5665: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5666:   background-color: #EEEEEE;
1.451     albertel 5667: }
                   5668: 
1.473     raeburn  5669: table.LC_createuser {
                   5670: }
                   5671: 
                   5672: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5673:   font-size: small;
1.473     raeburn  5674: }
                   5675: 
                   5676: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5677:   background-color: #CCCCCC;
1.473     raeburn  5678:   font-weight: bold;
                   5679:   text-align: center;
                   5680: }
                   5681: 
1.349     albertel 5682: table.LC_calendar {
                   5683:   border: 1px solid #000000;
                   5684:   border-collapse: collapse;
1.917     raeburn  5685:   width: 98%;
1.349     albertel 5686: }
1.795     www      5687: 
1.349     albertel 5688: table.LC_calendar_pickdate {
                   5689:   font-size: xx-small;
                   5690: }
1.795     www      5691: 
1.349     albertel 5692: table.LC_calendar tr td {
                   5693:   border: 1px solid #000000;
                   5694:   vertical-align: top;
1.917     raeburn  5695:   width: 14%;
1.349     albertel 5696: }
1.795     www      5697: 
1.349     albertel 5698: table.LC_calendar tr td.LC_calendar_day_empty {
                   5699:   background-color: $data_table_dark;
                   5700: }
1.795     www      5701: 
1.779     bisitz   5702: table.LC_calendar tr td.LC_calendar_day_current {
                   5703:   background-color: $data_table_highlight;
1.777     tempelho 5704: }
1.795     www      5705: 
1.938     bisitz   5706: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5707:   background-color: $mail_new;
                   5708: }
1.795     www      5709: 
1.938     bisitz   5710: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5711:   background-color: $mail_new_hover;
                   5712: }
1.795     www      5713: 
1.938     bisitz   5714: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5715:   background-color: $mail_read;
                   5716: }
1.795     www      5717: 
1.938     bisitz   5718: /*
                   5719: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5720:   background-color: $mail_read_hover;
                   5721: }
1.938     bisitz   5722: */
1.795     www      5723: 
1.938     bisitz   5724: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5725:   background-color: $mail_replied;
                   5726: }
1.795     www      5727: 
1.938     bisitz   5728: /*
                   5729: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5730:   background-color: $mail_replied_hover;
                   5731: }
1.938     bisitz   5732: */
1.795     www      5733: 
1.938     bisitz   5734: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5735:   background-color: $mail_other;
                   5736: }
1.795     www      5737: 
1.938     bisitz   5738: /*
                   5739: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5740:   background-color: $mail_other_hover;
                   5741: }
1.938     bisitz   5742: */
1.494     raeburn  5743: 
1.777     tempelho 5744: table.LC_data_table tr > td.LC_browser_file,
                   5745: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5746:   background: #AAEE77;
1.389     albertel 5747: }
1.795     www      5748: 
1.777     tempelho 5749: table.LC_data_table tr > td.LC_browser_file_locked,
                   5750: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5751:   background: #FFAA99;
1.387     albertel 5752: }
1.795     www      5753: 
1.777     tempelho 5754: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5755:   background: #888888;
1.779     bisitz   5756: }
1.795     www      5757: 
1.777     tempelho 5758: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5759: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5760:   background: #F8F866;
1.777     tempelho 5761: }
1.795     www      5762: 
1.696     bisitz   5763: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5764:   background: #E0E8FF;
1.387     albertel 5765: }
1.696     bisitz   5766: 
1.707     bisitz   5767: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5768:   /* background: #77FF77; */
1.707     bisitz   5769: }
1.795     www      5770: 
1.707     bisitz   5771: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5772:   border-right: 8px solid #FFFF77;
1.707     bisitz   5773: }
1.795     www      5774: 
1.707     bisitz   5775: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5776:   border-right: 8px solid #FFAA77;
1.707     bisitz   5777: }
1.795     www      5778: 
1.707     bisitz   5779: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5780:   border-right: 8px solid #FF7777;
1.707     bisitz   5781: }
1.795     www      5782: 
1.707     bisitz   5783: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5784:   border-right: 8px solid #AAFF77;
1.707     bisitz   5785: }
1.795     www      5786: 
1.707     bisitz   5787: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5788:   border-right: 8px solid #11CC55;
1.707     bisitz   5789: }
                   5790: 
1.388     albertel 5791: span.LC_current_location {
1.701     harmsja  5792:   font-size:larger;
1.388     albertel 5793:   background: $pgbg;
                   5794: }
1.387     albertel 5795: 
1.1029    www      5796: span.LC_current_nav_location {
                   5797:   font-weight:bold;
                   5798:   background: $sidebg;
                   5799: }
                   5800: 
1.395     albertel 5801: span.LC_parm_menu_item {
                   5802:   font-size: larger;
                   5803: }
1.795     www      5804: 
1.395     albertel 5805: span.LC_parm_scope_all {
                   5806:   color: red;
                   5807: }
1.795     www      5808: 
1.395     albertel 5809: span.LC_parm_scope_folder {
                   5810:   color: green;
                   5811: }
1.795     www      5812: 
1.395     albertel 5813: span.LC_parm_scope_resource {
                   5814:   color: orange;
                   5815: }
1.795     www      5816: 
1.395     albertel 5817: span.LC_parm_part {
                   5818:   color: blue;
                   5819: }
1.795     www      5820: 
1.911     bisitz   5821: span.LC_parm_folder,
                   5822: span.LC_parm_symb {
1.395     albertel 5823:   font-size: x-small;
                   5824:   font-family: $mono;
                   5825:   color: #AAAAAA;
                   5826: }
                   5827: 
1.977     bisitz   5828: ul.LC_parm_parmlist li {
                   5829:   display: inline-block;
                   5830:   padding: 0.3em 0.8em;
                   5831:   vertical-align: top;
                   5832:   width: 150px;
                   5833:   border-top:1px solid $lg_border_color;
                   5834: }
                   5835: 
1.795     www      5836: td.LC_parm_overview_level_menu,
                   5837: td.LC_parm_overview_map_menu,
                   5838: td.LC_parm_overview_parm_selectors,
                   5839: td.LC_parm_overview_restrictions  {
1.396     albertel 5840:   border: 1px solid black;
                   5841:   border-collapse: collapse;
                   5842: }
1.795     www      5843: 
1.396     albertel 5844: table.LC_parm_overview_restrictions td {
                   5845:   border-width: 1px 4px 1px 4px;
                   5846:   border-style: solid;
                   5847:   border-color: $pgbg;
                   5848:   text-align: center;
                   5849: }
1.795     www      5850: 
1.396     albertel 5851: table.LC_parm_overview_restrictions th {
                   5852:   background: $tabbg;
                   5853:   border-width: 1px 4px 1px 4px;
                   5854:   border-style: solid;
                   5855:   border-color: $pgbg;
                   5856: }
1.795     www      5857: 
1.398     albertel 5858: table#LC_helpmenu {
1.803     bisitz   5859:   border: none;
1.398     albertel 5860:   height: 55px;
1.803     bisitz   5861:   border-spacing: 0;
1.398     albertel 5862: }
                   5863: 
                   5864: table#LC_helpmenu fieldset legend {
                   5865:   font-size: larger;
                   5866: }
1.795     www      5867: 
1.397     albertel 5868: table#LC_helpmenu_links {
                   5869:   width: 100%;
                   5870:   border: 1px solid black;
                   5871:   background: $pgbg;
1.803     bisitz   5872:   padding: 0;
1.397     albertel 5873:   border-spacing: 1px;
                   5874: }
1.795     www      5875: 
1.397     albertel 5876: table#LC_helpmenu_links tr td {
                   5877:   padding: 1px;
                   5878:   background: $tabbg;
1.399     albertel 5879:   text-align: center;
                   5880:   font-weight: bold;
1.397     albertel 5881: }
1.396     albertel 5882: 
1.795     www      5883: table#LC_helpmenu_links a:link,
                   5884: table#LC_helpmenu_links a:visited,
1.397     albertel 5885: table#LC_helpmenu_links a:active {
                   5886:   text-decoration: none;
                   5887:   color: $font;
                   5888: }
1.795     www      5889: 
1.397     albertel 5890: table#LC_helpmenu_links a:hover {
                   5891:   text-decoration: underline;
                   5892:   color: $vlink;
                   5893: }
1.396     albertel 5894: 
1.417     albertel 5895: .LC_chrt_popup_exists {
                   5896:   border: 1px solid #339933;
                   5897:   margin: -1px;
                   5898: }
1.795     www      5899: 
1.417     albertel 5900: .LC_chrt_popup_up {
                   5901:   border: 1px solid yellow;
                   5902:   margin: -1px;
                   5903: }
1.795     www      5904: 
1.417     albertel 5905: .LC_chrt_popup {
                   5906:   border: 1px solid #8888FF;
                   5907:   background: #CCCCFF;
                   5908: }
1.795     www      5909: 
1.421     albertel 5910: table.LC_pick_box {
                   5911:   border-collapse: separate;
                   5912:   background: white;
                   5913:   border: 1px solid black;
                   5914:   border-spacing: 1px;
                   5915: }
1.795     www      5916: 
1.421     albertel 5917: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5918:   background: $sidebg;
1.421     albertel 5919:   font-weight: bold;
1.900     bisitz   5920:   text-align: left;
1.740     bisitz   5921:   vertical-align: top;
1.421     albertel 5922:   width: 184px;
                   5923:   padding: 8px;
                   5924: }
1.795     www      5925: 
1.579     raeburn  5926: table.LC_pick_box td.LC_pick_box_value {
                   5927:   text-align: left;
                   5928:   padding: 8px;
                   5929: }
1.795     www      5930: 
1.579     raeburn  5931: table.LC_pick_box td.LC_pick_box_select {
                   5932:   text-align: left;
                   5933:   padding: 8px;
                   5934: }
1.795     www      5935: 
1.424     albertel 5936: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5937:   padding: 0;
1.421     albertel 5938:   height: 1px;
                   5939:   background: black;
                   5940: }
1.795     www      5941: 
1.421     albertel 5942: table.LC_pick_box td.LC_pick_box_submit {
                   5943:   text-align: right;
                   5944: }
1.795     www      5945: 
1.579     raeburn  5946: table.LC_pick_box td.LC_evenrow_value {
                   5947:   text-align: left;
                   5948:   padding: 8px;
                   5949:   background-color: $data_table_light;
                   5950: }
1.795     www      5951: 
1.579     raeburn  5952: table.LC_pick_box td.LC_oddrow_value {
                   5953:   text-align: left;
                   5954:   padding: 8px;
                   5955:   background-color: $data_table_light;
                   5956: }
1.795     www      5957: 
1.579     raeburn  5958: span.LC_helpform_receipt_cat {
                   5959:   font-weight: bold;
                   5960: }
1.795     www      5961: 
1.424     albertel 5962: table.LC_group_priv_box {
                   5963:   background: white;
                   5964:   border: 1px solid black;
                   5965:   border-spacing: 1px;
                   5966: }
1.795     www      5967: 
1.424     albertel 5968: table.LC_group_priv_box td.LC_pick_box_title {
                   5969:   background: $tabbg;
                   5970:   font-weight: bold;
                   5971:   text-align: right;
                   5972:   width: 184px;
                   5973: }
1.795     www      5974: 
1.424     albertel 5975: table.LC_group_priv_box td.LC_groups_fixed {
                   5976:   background: $data_table_light;
                   5977:   text-align: center;
                   5978: }
1.795     www      5979: 
1.424     albertel 5980: table.LC_group_priv_box td.LC_groups_optional {
                   5981:   background: $data_table_dark;
                   5982:   text-align: center;
                   5983: }
1.795     www      5984: 
1.424     albertel 5985: table.LC_group_priv_box td.LC_groups_functionality {
                   5986:   background: $data_table_darker;
                   5987:   text-align: center;
                   5988:   font-weight: bold;
                   5989: }
1.795     www      5990: 
1.424     albertel 5991: table.LC_group_priv td {
                   5992:   text-align: left;
1.803     bisitz   5993:   padding: 0;
1.424     albertel 5994: }
                   5995: 
                   5996: .LC_navbuttons {
                   5997:   margin: 2ex 0ex 2ex 0ex;
                   5998: }
1.795     www      5999: 
1.423     albertel 6000: .LC_topic_bar {
                   6001:   font-weight: bold;
                   6002:   background: $tabbg;
1.918     wenzelju 6003:   margin: 1em 0em 1em 2em;
1.805     bisitz   6004:   padding: 3px;
1.918     wenzelju 6005:   font-size: 1.2em;
1.423     albertel 6006: }
1.795     www      6007: 
1.423     albertel 6008: .LC_topic_bar span {
1.918     wenzelju 6009:   left: 0.5em;
                   6010:   position: absolute;
1.423     albertel 6011:   vertical-align: middle;
1.918     wenzelju 6012:   font-size: 1.2em;
1.423     albertel 6013: }
1.795     www      6014: 
1.423     albertel 6015: table.LC_course_group_status {
                   6016:   margin: 20px;
                   6017: }
1.795     www      6018: 
1.423     albertel 6019: table.LC_status_selector td {
                   6020:   vertical-align: top;
                   6021:   text-align: center;
1.424     albertel 6022:   padding: 4px;
                   6023: }
1.795     www      6024: 
1.599     albertel 6025: div.LC_feedback_link {
1.616     albertel 6026:   clear: both;
1.829     kalberla 6027:   background: $sidebg;
1.779     bisitz   6028:   width: 100%;
1.829     kalberla 6029:   padding-bottom: 10px;
                   6030:   border: 1px $tabbg solid;
1.833     kalberla 6031:   height: 22px;
                   6032:   line-height: 22px;
                   6033:   padding-top: 5px;
                   6034: }
                   6035: 
                   6036: div.LC_feedback_link img {
                   6037:   height: 22px;
1.867     kalberla 6038:   vertical-align:middle;
1.829     kalberla 6039: }
                   6040: 
1.911     bisitz   6041: div.LC_feedback_link a {
1.829     kalberla 6042:   text-decoration: none;
1.489     raeburn  6043: }
1.795     www      6044: 
1.867     kalberla 6045: div.LC_comblock {
1.911     bisitz   6046:   display:inline;
1.867     kalberla 6047:   color:$font;
                   6048:   font-size:90%;
                   6049: }
                   6050: 
                   6051: div.LC_feedback_link div.LC_comblock {
                   6052:   padding-left:5px;
                   6053: }
                   6054: 
                   6055: div.LC_feedback_link div.LC_comblock a {
                   6056:   color:$font;
                   6057: }
                   6058: 
1.489     raeburn  6059: span.LC_feedback_link {
1.858     bisitz   6060:   /* background: $feedback_link_bg; */
1.599     albertel 6061:   font-size: larger;
                   6062: }
1.795     www      6063: 
1.599     albertel 6064: span.LC_message_link {
1.858     bisitz   6065:   /* background: $feedback_link_bg; */
1.599     albertel 6066:   font-size: larger;
                   6067:   position: absolute;
                   6068:   right: 1em;
1.489     raeburn  6069: }
1.421     albertel 6070: 
1.515     albertel 6071: table.LC_prior_tries {
1.524     albertel 6072:   border: 1px solid #000000;
                   6073:   border-collapse: separate;
                   6074:   border-spacing: 1px;
1.515     albertel 6075: }
1.523     albertel 6076: 
1.515     albertel 6077: table.LC_prior_tries td {
1.524     albertel 6078:   padding: 2px;
1.515     albertel 6079: }
1.523     albertel 6080: 
                   6081: .LC_answer_correct {
1.795     www      6082:   background: lightgreen;
                   6083:   color: darkgreen;
                   6084:   padding: 6px;
1.523     albertel 6085: }
1.795     www      6086: 
1.523     albertel 6087: .LC_answer_charged_try {
1.797     www      6088:   background: #FFAAAA;
1.795     www      6089:   color: darkred;
                   6090:   padding: 6px;
1.523     albertel 6091: }
1.795     www      6092: 
1.779     bisitz   6093: .LC_answer_not_charged_try,
1.523     albertel 6094: .LC_answer_no_grade,
                   6095: .LC_answer_late {
1.795     www      6096:   background: lightyellow;
1.523     albertel 6097:   color: black;
1.795     www      6098:   padding: 6px;
1.523     albertel 6099: }
1.795     www      6100: 
1.523     albertel 6101: .LC_answer_previous {
1.795     www      6102:   background: lightblue;
                   6103:   color: darkblue;
                   6104:   padding: 6px;
1.523     albertel 6105: }
1.795     www      6106: 
1.779     bisitz   6107: .LC_answer_no_message {
1.777     tempelho 6108:   background: #FFFFFF;
                   6109:   color: black;
1.795     www      6110:   padding: 6px;
1.779     bisitz   6111: }
1.795     www      6112: 
1.779     bisitz   6113: .LC_answer_unknown {
                   6114:   background: orange;
                   6115:   color: black;
1.795     www      6116:   padding: 6px;
1.777     tempelho 6117: }
1.795     www      6118: 
1.529     albertel 6119: span.LC_prior_numerical,
                   6120: span.LC_prior_string,
                   6121: span.LC_prior_custom,
                   6122: span.LC_prior_reaction,
                   6123: span.LC_prior_math {
1.925     bisitz   6124:   font-family: $mono;
1.523     albertel 6125:   white-space: pre;
                   6126: }
                   6127: 
1.525     albertel 6128: span.LC_prior_string {
1.925     bisitz   6129:   font-family: $mono;
1.525     albertel 6130:   white-space: pre;
                   6131: }
                   6132: 
1.523     albertel 6133: table.LC_prior_option {
                   6134:   width: 100%;
                   6135:   border-collapse: collapse;
                   6136: }
1.795     www      6137: 
1.911     bisitz   6138: table.LC_prior_rank,
1.795     www      6139: table.LC_prior_match {
1.528     albertel 6140:   border-collapse: collapse;
                   6141: }
1.795     www      6142: 
1.528     albertel 6143: table.LC_prior_option tr td,
                   6144: table.LC_prior_rank tr td,
                   6145: table.LC_prior_match tr td {
1.524     albertel 6146:   border: 1px solid #000000;
1.515     albertel 6147: }
                   6148: 
1.855     bisitz   6149: .LC_nobreak {
1.544     albertel 6150:   white-space: nowrap;
1.519     raeburn  6151: }
                   6152: 
1.576     raeburn  6153: span.LC_cusr_emph {
                   6154:   font-style: italic;
                   6155: }
                   6156: 
1.633     raeburn  6157: span.LC_cusr_subheading {
                   6158:   font-weight: normal;
                   6159:   font-size: 85%;
                   6160: }
                   6161: 
1.861     bisitz   6162: div.LC_docs_entry_move {
1.859     bisitz   6163:   border: 1px solid #BBBBBB;
1.545     albertel 6164:   background: #DDDDDD;
1.861     bisitz   6165:   width: 22px;
1.859     bisitz   6166:   padding: 1px;
                   6167:   margin: 0;
1.545     albertel 6168: }
                   6169: 
1.861     bisitz   6170: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6171: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6172:   background: #DDDDDD;
                   6173:   font-size: x-small;
                   6174: }
1.795     www      6175: 
1.861     bisitz   6176: .LC_docs_entry_parameter {
                   6177:   white-space: nowrap;
                   6178: }
                   6179: 
1.544     albertel 6180: .LC_docs_copy {
1.545     albertel 6181:   color: #000099;
1.544     albertel 6182: }
1.795     www      6183: 
1.544     albertel 6184: .LC_docs_cut {
1.545     albertel 6185:   color: #550044;
1.544     albertel 6186: }
1.795     www      6187: 
1.544     albertel 6188: .LC_docs_rename {
1.545     albertel 6189:   color: #009900;
1.544     albertel 6190: }
1.795     www      6191: 
1.544     albertel 6192: .LC_docs_remove {
1.545     albertel 6193:   color: #990000;
                   6194: }
                   6195: 
1.547     albertel 6196: .LC_docs_reinit_warn,
                   6197: .LC_docs_ext_edit {
                   6198:   font-size: x-small;
                   6199: }
                   6200: 
1.545     albertel 6201: table.LC_docs_adddocs td,
                   6202: table.LC_docs_adddocs th {
                   6203:   border: 1px solid #BBBBBB;
                   6204:   padding: 4px;
                   6205:   background: #DDDDDD;
1.543     albertel 6206: }
                   6207: 
1.584     albertel 6208: table.LC_sty_begin {
                   6209:   background: #BBFFBB;
                   6210: }
1.795     www      6211: 
1.584     albertel 6212: table.LC_sty_end {
                   6213:   background: #FFBBBB;
                   6214: }
                   6215: 
1.589     raeburn  6216: table.LC_double_column {
1.803     bisitz   6217:   border-width: 0;
1.589     raeburn  6218:   border-collapse: collapse;
                   6219:   width: 100%;
                   6220:   padding: 2px;
                   6221: }
                   6222: 
                   6223: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6224:   top: 2px;
1.589     raeburn  6225:   left: 2px;
                   6226:   width: 47%;
                   6227:   vertical-align: top;
                   6228: }
                   6229: 
                   6230: table.LC_double_column tr td.LC_right_col {
                   6231:   top: 2px;
1.779     bisitz   6232:   right: 2px;
1.589     raeburn  6233:   width: 47%;
                   6234:   vertical-align: top;
                   6235: }
                   6236: 
1.591     raeburn  6237: div.LC_left_float {
                   6238:   float: left;
                   6239:   padding-right: 5%;
1.597     albertel 6240:   padding-bottom: 4px;
1.591     raeburn  6241: }
                   6242: 
                   6243: div.LC_clear_float_header {
1.597     albertel 6244:   padding-bottom: 2px;
1.591     raeburn  6245: }
                   6246: 
                   6247: div.LC_clear_float_footer {
1.597     albertel 6248:   padding-top: 10px;
1.591     raeburn  6249:   clear: both;
                   6250: }
                   6251: 
1.597     albertel 6252: div.LC_grade_show_user {
1.941     bisitz   6253: /*  border-left: 5px solid $sidebg; */
                   6254:   border-top: 5px solid #000000;
                   6255:   margin: 50px 0 0 0;
1.936     bisitz   6256:   padding: 15px 0 5px 10px;
1.597     albertel 6257: }
1.795     www      6258: 
1.936     bisitz   6259: div.LC_grade_show_user_odd_row {
1.941     bisitz   6260: /*  border-left: 5px solid #000000; */
                   6261: }
                   6262: 
                   6263: div.LC_grade_show_user div.LC_Box {
                   6264:   margin-right: 50px;
1.597     albertel 6265: }
                   6266: 
                   6267: div.LC_grade_submissions,
                   6268: div.LC_grade_message_center,
1.936     bisitz   6269: div.LC_grade_info_links {
1.597     albertel 6270:   margin: 5px;
                   6271:   width: 99%;
                   6272:   background: #FFFFFF;
                   6273: }
1.795     www      6274: 
1.597     albertel 6275: div.LC_grade_submissions_header,
1.936     bisitz   6276: div.LC_grade_message_center_header {
1.705     tempelho 6277:   font-weight: bold;
                   6278:   font-size: large;
1.597     albertel 6279: }
1.795     www      6280: 
1.597     albertel 6281: div.LC_grade_submissions_body,
1.936     bisitz   6282: div.LC_grade_message_center_body {
1.597     albertel 6283:   border: 1px solid black;
                   6284:   width: 99%;
                   6285:   background: #FFFFFF;
                   6286: }
1.795     www      6287: 
1.613     albertel 6288: table.LC_scantron_action {
                   6289:   width: 100%;
                   6290: }
1.795     www      6291: 
1.613     albertel 6292: table.LC_scantron_action tr th {
1.698     harmsja  6293:   font-weight:bold;
                   6294:   font-style:normal;
1.613     albertel 6295: }
1.795     www      6296: 
1.779     bisitz   6297: .LC_edit_problem_header,
1.614     albertel 6298: div.LC_edit_problem_footer {
1.705     tempelho 6299:   font-weight: normal;
                   6300:   font-size:  medium;
1.602     albertel 6301:   margin: 2px;
1.1060    bisitz   6302:   background-color: $sidebg;
1.600     albertel 6303: }
1.795     www      6304: 
1.600     albertel 6305: div.LC_edit_problem_header,
1.602     albertel 6306: div.LC_edit_problem_header div,
1.614     albertel 6307: div.LC_edit_problem_footer,
                   6308: div.LC_edit_problem_footer div,
1.602     albertel 6309: div.LC_edit_problem_editxml_header,
                   6310: div.LC_edit_problem_editxml_header div {
1.600     albertel 6311:   margin-top: 5px;
                   6312: }
1.795     www      6313: 
1.600     albertel 6314: div.LC_edit_problem_header_title {
1.705     tempelho 6315:   font-weight: bold;
                   6316:   font-size: larger;
1.602     albertel 6317:   background: $tabbg;
                   6318:   padding: 3px;
1.1060    bisitz   6319:   margin: 0 0 5px 0;
1.602     albertel 6320: }
1.795     www      6321: 
1.602     albertel 6322: table.LC_edit_problem_header_title {
                   6323:   width: 100%;
1.600     albertel 6324:   background: $tabbg;
1.602     albertel 6325: }
                   6326: 
                   6327: div.LC_edit_problem_discards {
                   6328:   float: left;
                   6329:   padding-bottom: 5px;
                   6330: }
1.795     www      6331: 
1.602     albertel 6332: div.LC_edit_problem_saves {
                   6333:   float: right;
                   6334:   padding-bottom: 5px;
1.600     albertel 6335: }
1.795     www      6336: 
1.911     bisitz   6337: img.stift {
1.803     bisitz   6338:   border-width: 0;
                   6339:   vertical-align: middle;
1.677     riegler  6340: }
1.680     riegler  6341: 
1.923     bisitz   6342: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6343:   vertical-align: top;
1.777     tempelho 6344: }
1.795     www      6345: 
1.716     raeburn  6346: div.LC_createcourse {
1.911     bisitz   6347:   margin: 10px 10px 10px 10px;
1.716     raeburn  6348: }
                   6349: 
1.917     raeburn  6350: .LC_dccid {
                   6351:   margin: 0.2em 0 0 0;
                   6352:   padding: 0;
                   6353:   font-size: 90%;
                   6354:   display:none;
                   6355: }
                   6356: 
1.897     wenzelju 6357: ol.LC_primary_menu a:hover,
1.721     harmsja  6358: ol#LC_MenuBreadcrumbs a:hover,
                   6359: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6360: ul#LC_secondary_menu a:hover,
1.721     harmsja  6361: .LC_FormSectionClearButton input:hover
1.795     www      6362: ul.LC_TabContent   li:hover a {
1.952     onken    6363:   color:$button_hover;
1.911     bisitz   6364:   text-decoration:none;
1.693     droeschl 6365: }
                   6366: 
1.779     bisitz   6367: h1 {
1.911     bisitz   6368:   padding: 0;
                   6369:   line-height:130%;
1.693     droeschl 6370: }
1.698     harmsja  6371: 
1.911     bisitz   6372: h2,
                   6373: h3,
                   6374: h4,
                   6375: h5,
                   6376: h6 {
                   6377:   margin: 5px 0 5px 0;
                   6378:   padding: 0;
                   6379:   line-height:130%;
1.693     droeschl 6380: }
1.795     www      6381: 
                   6382: .LC_hcell {
1.911     bisitz   6383:   padding:3px 15px 3px 15px;
                   6384:   margin: 0;
                   6385:   background-color:$tabbg;
                   6386:   color:$fontmenu;
                   6387:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6388: }
1.795     www      6389: 
1.840     bisitz   6390: .LC_Box > .LC_hcell {
1.911     bisitz   6391:   margin: 0 -10px 10px -10px;
1.835     bisitz   6392: }
                   6393: 
1.721     harmsja  6394: .LC_noBorder {
1.911     bisitz   6395:   border: 0;
1.698     harmsja  6396: }
1.693     droeschl 6397: 
1.721     harmsja  6398: .LC_FormSectionClearButton input {
1.911     bisitz   6399:   background-color:transparent;
                   6400:   border: none;
                   6401:   cursor:pointer;
                   6402:   text-decoration:underline;
1.693     droeschl 6403: }
1.763     bisitz   6404: 
                   6405: .LC_help_open_topic {
1.911     bisitz   6406:   color: #FFFFFF;
                   6407:   background-color: #EEEEFF;
                   6408:   margin: 1px;
                   6409:   padding: 4px;
                   6410:   border: 1px solid #000033;
                   6411:   white-space: nowrap;
                   6412:   /* vertical-align: middle; */
1.759     neumanie 6413: }
1.693     droeschl 6414: 
1.911     bisitz   6415: dl,
                   6416: ul,
                   6417: div,
                   6418: fieldset {
                   6419:   margin: 10px 10px 10px 0;
                   6420:   /* overflow: hidden; */
1.693     droeschl 6421: }
1.795     www      6422: 
1.838     bisitz   6423: fieldset > legend {
1.911     bisitz   6424:   font-weight: bold;
                   6425:   padding: 0 5px 0 5px;
1.838     bisitz   6426: }
                   6427: 
1.813     bisitz   6428: #LC_nav_bar {
1.911     bisitz   6429:   float: left;
1.995     raeburn  6430:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6431:   margin: 0 0 2px 0;
1.807     droeschl 6432: }
                   6433: 
1.916     droeschl 6434: #LC_realm {
                   6435:   margin: 0.2em 0 0 0;
                   6436:   padding: 0;
                   6437:   font-weight: bold;
                   6438:   text-align: center;
1.995     raeburn  6439:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6440: }
                   6441: 
1.911     bisitz   6442: #LC_nav_bar em {
                   6443:   font-weight: bold;
                   6444:   font-style: normal;
1.807     droeschl 6445: }
                   6446: 
1.897     wenzelju 6447: ol.LC_primary_menu {
1.911     bisitz   6448:   float: right;
1.934     droeschl 6449:   margin: 0;
1.995     raeburn  6450:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6451: }
                   6452: 
1.852     droeschl 6453: ol#LC_PathBreadcrumbs {
1.911     bisitz   6454:   margin: 0;
1.693     droeschl 6455: }
                   6456: 
1.897     wenzelju 6457: ol.LC_primary_menu li {
1.911     bisitz   6458:   display: inline;
                   6459:   padding: 5px 5px 0 10px;
                   6460:   vertical-align: top;
1.693     droeschl 6461: }
                   6462: 
1.897     wenzelju 6463: ol.LC_primary_menu li img {
1.911     bisitz   6464:   vertical-align: bottom;
1.934     droeschl 6465:   height: 1.1em;
1.693     droeschl 6466: }
                   6467: 
1.897     wenzelju 6468: ol.LC_primary_menu a {
1.911     bisitz   6469:   color: RGB(80, 80, 80);
                   6470:   text-decoration: none;
1.693     droeschl 6471: }
1.795     www      6472: 
1.949     droeschl 6473: ol.LC_primary_menu a.LC_new_message {
                   6474:   font-weight:bold;
                   6475:   color: darkred;
                   6476: }
                   6477: 
1.975     raeburn  6478: ol.LC_docs_parameters {
                   6479:   margin-left: 0;
                   6480:   padding: 0;
                   6481:   list-style: none;
                   6482: }
                   6483: 
                   6484: ol.LC_docs_parameters li {
                   6485:   margin: 0;
                   6486:   padding-right: 20px;
                   6487:   display: inline;
                   6488: }
                   6489: 
1.976     raeburn  6490: ol.LC_docs_parameters li:before {
                   6491:   content: "\\002022 \\0020";
                   6492: }
                   6493: 
                   6494: li.LC_docs_parameters_title {
                   6495:   font-weight: bold;
                   6496: }
                   6497: 
                   6498: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6499:   content: "";
                   6500: }
                   6501: 
1.897     wenzelju 6502: ul#LC_secondary_menu {
1.911     bisitz   6503:   clear: both;
                   6504:   color: $fontmenu;
                   6505:   background: $tabbg;
                   6506:   list-style: none;
                   6507:   padding: 0;
                   6508:   margin: 0;
                   6509:   width: 100%;
1.995     raeburn  6510:   text-align: left;
1.808     droeschl 6511: }
                   6512: 
1.897     wenzelju 6513: ul#LC_secondary_menu li {
1.911     bisitz   6514:   font-weight: bold;
                   6515:   line-height: 1.8em;
                   6516:   padding: 0 0.8em;
                   6517:   border-right: 1px solid black;
                   6518:   display: inline;
                   6519:   vertical-align: middle;
1.807     droeschl 6520: }
                   6521: 
1.847     tempelho 6522: ul.LC_TabContent {
1.911     bisitz   6523:   display:block;
                   6524:   background: $sidebg;
                   6525:   border-bottom: solid 1px $lg_border_color;
                   6526:   list-style:none;
1.1020    raeburn  6527:   margin: -1px -10px 0 -10px;
1.911     bisitz   6528:   padding: 0;
1.693     droeschl 6529: }
                   6530: 
1.795     www      6531: ul.LC_TabContent li,
                   6532: ul.LC_TabContentBigger li {
1.911     bisitz   6533:   float:left;
1.741     harmsja  6534: }
1.795     www      6535: 
1.897     wenzelju 6536: ul#LC_secondary_menu li a {
1.911     bisitz   6537:   color: $fontmenu;
                   6538:   text-decoration: none;
1.693     droeschl 6539: }
1.795     www      6540: 
1.721     harmsja  6541: ul.LC_TabContent {
1.952     onken    6542:   min-height:20px;
1.721     harmsja  6543: }
1.795     www      6544: 
                   6545: ul.LC_TabContent li {
1.911     bisitz   6546:   vertical-align:middle;
1.959     onken    6547:   padding: 0 16px 0 10px;
1.911     bisitz   6548:   background-color:$tabbg;
                   6549:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6550:   border-left: solid 1px $font;
1.721     harmsja  6551: }
1.795     www      6552: 
1.847     tempelho 6553: ul.LC_TabContent .right {
1.911     bisitz   6554:   float:right;
1.847     tempelho 6555: }
                   6556: 
1.911     bisitz   6557: ul.LC_TabContent li a,
                   6558: ul.LC_TabContent li {
                   6559:   color:rgb(47,47,47);
                   6560:   text-decoration:none;
                   6561:   font-size:95%;
                   6562:   font-weight:bold;
1.952     onken    6563:   min-height:20px;
                   6564: }
                   6565: 
1.959     onken    6566: ul.LC_TabContent li a:hover,
                   6567: ul.LC_TabContent li a:focus {
1.952     onken    6568:   color: $button_hover;
1.959     onken    6569:   background:none;
                   6570:   outline:none;
1.952     onken    6571: }
                   6572: 
                   6573: ul.LC_TabContent li:hover {
                   6574:   color: $button_hover;
                   6575:   cursor:pointer;
1.721     harmsja  6576: }
1.795     www      6577: 
1.911     bisitz   6578: ul.LC_TabContent li.active {
1.952     onken    6579:   color: $font;
1.911     bisitz   6580:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6581:   border-bottom:solid 1px #FFFFFF;
                   6582:   cursor: default;
1.744     ehlerst  6583: }
1.795     www      6584: 
1.959     onken    6585: ul.LC_TabContent li.active a {
                   6586:   color:$font;
                   6587:   background:#FFFFFF;
                   6588:   outline: none;
                   6589: }
1.1047    raeburn  6590: 
                   6591: ul.LC_TabContent li.goback {
                   6592:   float: left;
                   6593:   border-left: none;
                   6594: }
                   6595: 
1.870     tempelho 6596: #maincoursedoc {
1.911     bisitz   6597:   clear:both;
1.870     tempelho 6598: }
                   6599: 
                   6600: ul.LC_TabContentBigger {
1.911     bisitz   6601:   display:block;
                   6602:   list-style:none;
                   6603:   padding: 0;
1.870     tempelho 6604: }
                   6605: 
1.795     www      6606: ul.LC_TabContentBigger li {
1.911     bisitz   6607:   vertical-align:bottom;
                   6608:   height: 30px;
                   6609:   font-size:110%;
                   6610:   font-weight:bold;
                   6611:   color: #737373;
1.841     tempelho 6612: }
                   6613: 
1.957     onken    6614: ul.LC_TabContentBigger li.active {
                   6615:   position: relative;
                   6616:   top: 1px;
                   6617: }
                   6618: 
1.870     tempelho 6619: ul.LC_TabContentBigger li a {
1.911     bisitz   6620:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6621:   height: 30px;
                   6622:   line-height: 30px;
                   6623:   text-align: center;
                   6624:   display: block;
                   6625:   text-decoration: none;
1.958     onken    6626:   outline: none;  
1.741     harmsja  6627: }
1.795     www      6628: 
1.870     tempelho 6629: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6630:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6631:   color:$font;
1.744     ehlerst  6632: }
1.795     www      6633: 
1.870     tempelho 6634: ul.LC_TabContentBigger li b {
1.911     bisitz   6635:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6636:   display: block;
                   6637:   float: left;
                   6638:   padding: 0 30px;
1.957     onken    6639:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6640: }
                   6641: 
1.956     onken    6642: ul.LC_TabContentBigger li:hover b {
                   6643:   color:$button_hover;
                   6644: }
                   6645: 
1.870     tempelho 6646: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6647:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6648:   color:$font;
1.957     onken    6649:   border: 0;
1.741     harmsja  6650: }
1.693     droeschl 6651: 
1.870     tempelho 6652: 
1.862     bisitz   6653: ul.LC_CourseBreadcrumbs {
                   6654:   background: $sidebg;
1.1020    raeburn  6655:   height: 2em;
1.862     bisitz   6656:   padding-left: 10px;
1.1020    raeburn  6657:   margin: 0;
1.862     bisitz   6658:   list-style-position: inside;
                   6659: }
                   6660: 
1.911     bisitz   6661: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6662: ol#LC_PathBreadcrumbs {
1.911     bisitz   6663:   padding-left: 10px;
                   6664:   margin: 0;
1.933     droeschl 6665:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6666: }
                   6667: 
1.911     bisitz   6668: ol#LC_MenuBreadcrumbs li,
                   6669: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6670: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6671:   display: inline;
1.933     droeschl 6672:   white-space: normal;  
1.693     droeschl 6673: }
                   6674: 
1.823     bisitz   6675: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6676: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6677:   text-decoration: none;
                   6678:   font-size:90%;
1.693     droeschl 6679: }
1.795     www      6680: 
1.969     droeschl 6681: ol#LC_MenuBreadcrumbs h1 {
                   6682:   display: inline;
                   6683:   font-size: 90%;
                   6684:   line-height: 2.5em;
                   6685:   margin: 0;
                   6686:   padding: 0;
                   6687: }
                   6688: 
1.795     www      6689: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6690:   text-decoration:none;
                   6691:   font-size:100%;
                   6692:   font-weight:bold;
1.693     droeschl 6693: }
1.795     www      6694: 
1.840     bisitz   6695: .LC_Box {
1.911     bisitz   6696:   border: solid 1px $lg_border_color;
                   6697:   padding: 0 10px 10px 10px;
1.746     neumanie 6698: }
1.795     www      6699: 
1.1020    raeburn  6700: .LC_DocsBox {
                   6701:   border: solid 1px $lg_border_color;
                   6702:   padding: 0 0 10px 10px;
                   6703: }
                   6704: 
1.795     www      6705: .LC_AboutMe_Image {
1.911     bisitz   6706:   float:left;
                   6707:   margin-right:10px;
1.747     neumanie 6708: }
1.795     www      6709: 
                   6710: .LC_Clear_AboutMe_Image {
1.911     bisitz   6711:   clear:left;
1.747     neumanie 6712: }
1.795     www      6713: 
1.721     harmsja  6714: dl.LC_ListStyleClean dt {
1.911     bisitz   6715:   padding-right: 5px;
                   6716:   display: table-header-group;
1.693     droeschl 6717: }
                   6718: 
1.721     harmsja  6719: dl.LC_ListStyleClean dd {
1.911     bisitz   6720:   display: table-row;
1.693     droeschl 6721: }
                   6722: 
1.721     harmsja  6723: .LC_ListStyleClean,
                   6724: .LC_ListStyleSimple,
                   6725: .LC_ListStyleNormal,
1.795     www      6726: .LC_ListStyleSpecial {
1.911     bisitz   6727:   /* display:block; */
                   6728:   list-style-position: inside;
                   6729:   list-style-type: none;
                   6730:   overflow: hidden;
                   6731:   padding: 0;
1.693     droeschl 6732: }
                   6733: 
1.721     harmsja  6734: .LC_ListStyleSimple li,
                   6735: .LC_ListStyleSimple dd,
                   6736: .LC_ListStyleNormal li,
                   6737: .LC_ListStyleNormal dd,
                   6738: .LC_ListStyleSpecial li,
1.795     www      6739: .LC_ListStyleSpecial dd {
1.911     bisitz   6740:   margin: 0;
                   6741:   padding: 5px 5px 5px 10px;
                   6742:   clear: both;
1.693     droeschl 6743: }
                   6744: 
1.721     harmsja  6745: .LC_ListStyleClean li,
                   6746: .LC_ListStyleClean dd {
1.911     bisitz   6747:   padding-top: 0;
                   6748:   padding-bottom: 0;
1.693     droeschl 6749: }
                   6750: 
1.721     harmsja  6751: .LC_ListStyleSimple dd,
1.795     www      6752: .LC_ListStyleSimple li {
1.911     bisitz   6753:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6754: }
                   6755: 
1.721     harmsja  6756: .LC_ListStyleSpecial li,
                   6757: .LC_ListStyleSpecial dd {
1.911     bisitz   6758:   list-style-type: none;
                   6759:   background-color: RGB(220, 220, 220);
                   6760:   margin-bottom: 4px;
1.693     droeschl 6761: }
                   6762: 
1.721     harmsja  6763: table.LC_SimpleTable {
1.911     bisitz   6764:   margin:5px;
                   6765:   border:solid 1px $lg_border_color;
1.795     www      6766: }
1.693     droeschl 6767: 
1.721     harmsja  6768: table.LC_SimpleTable tr {
1.911     bisitz   6769:   padding: 0;
                   6770:   border:solid 1px $lg_border_color;
1.693     droeschl 6771: }
1.795     www      6772: 
                   6773: table.LC_SimpleTable thead {
1.911     bisitz   6774:   background:rgb(220,220,220);
1.693     droeschl 6775: }
                   6776: 
1.721     harmsja  6777: div.LC_columnSection {
1.911     bisitz   6778:   display: block;
                   6779:   clear: both;
                   6780:   overflow: hidden;
                   6781:   margin: 0;
1.693     droeschl 6782: }
                   6783: 
1.721     harmsja  6784: div.LC_columnSection>* {
1.911     bisitz   6785:   float: left;
                   6786:   margin: 10px 20px 10px 0;
                   6787:   overflow:hidden;
1.693     droeschl 6788: }
1.721     harmsja  6789: 
1.795     www      6790: table em {
1.911     bisitz   6791:   font-weight: bold;
                   6792:   font-style: normal;
1.748     schulted 6793: }
1.795     www      6794: 
1.779     bisitz   6795: table.LC_tableBrowseRes,
1.795     www      6796: table.LC_tableOfContent {
1.911     bisitz   6797:   border:none;
                   6798:   border-spacing: 1px;
                   6799:   padding: 3px;
                   6800:   background-color: #FFFFFF;
                   6801:   font-size: 90%;
1.753     droeschl 6802: }
1.789     droeschl 6803: 
1.911     bisitz   6804: table.LC_tableOfContent {
                   6805:   border-collapse: collapse;
1.789     droeschl 6806: }
                   6807: 
1.771     droeschl 6808: table.LC_tableBrowseRes a,
1.768     schulted 6809: table.LC_tableOfContent a {
1.911     bisitz   6810:   background-color: transparent;
                   6811:   text-decoration: none;
1.753     droeschl 6812: }
                   6813: 
1.795     www      6814: table.LC_tableOfContent img {
1.911     bisitz   6815:   border: none;
                   6816:   height: 1.3em;
                   6817:   vertical-align: text-bottom;
                   6818:   margin-right: 0.3em;
1.753     droeschl 6819: }
1.757     schulted 6820: 
1.795     www      6821: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6822:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6823: }
                   6824: 
1.795     www      6825: a#LC_content_toolbar_everything {
1.911     bisitz   6826:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6827: }
                   6828: 
1.795     www      6829: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6830:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6831: }
                   6832: 
1.795     www      6833: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6834:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6835: }
                   6836: 
1.795     www      6837: a#LC_content_toolbar_changefolder {
1.911     bisitz   6838:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6839: }
                   6840: 
1.795     www      6841: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6842:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6843: }
                   6844: 
1.1043    raeburn  6845: a#LC_content_toolbar_edittoplevel {
                   6846:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   6847: }
                   6848: 
1.795     www      6849: ul#LC_toolbar li a:hover {
1.911     bisitz   6850:   background-position: bottom center;
1.757     schulted 6851: }
                   6852: 
1.795     www      6853: ul#LC_toolbar {
1.911     bisitz   6854:   padding: 0;
                   6855:   margin: 2px;
                   6856:   list-style:none;
                   6857:   position:relative;
                   6858:   background-color:white;
1.757     schulted 6859: }
                   6860: 
1.795     www      6861: ul#LC_toolbar li {
1.911     bisitz   6862:   border:1px solid white;
                   6863:   padding: 0;
                   6864:   margin: 0;
                   6865:   float: left;
                   6866:   display:inline;
                   6867:   vertical-align:middle;
                   6868: }
1.757     schulted 6869: 
1.783     amueller 6870: 
1.795     www      6871: a.LC_toolbarItem {
1.911     bisitz   6872:   display:block;
                   6873:   padding: 0;
                   6874:   margin: 0;
                   6875:   height: 32px;
                   6876:   width: 32px;
                   6877:   color:white;
                   6878:   border: none;
                   6879:   background-repeat:no-repeat;
                   6880:   background-color:transparent;
1.757     schulted 6881: }
                   6882: 
1.915     droeschl 6883: ul.LC_funclist {
                   6884:     margin: 0;
                   6885:     padding: 0.5em 1em 0.5em 0;
                   6886: }
                   6887: 
1.933     droeschl 6888: ul.LC_funclist > li:first-child {
                   6889:     font-weight:bold; 
                   6890:     margin-left:0.8em;
                   6891: }
                   6892: 
1.915     droeschl 6893: ul.LC_funclist + ul.LC_funclist {
                   6894:     /* 
                   6895:        left border as a seperator if we have more than
                   6896:        one list 
                   6897:     */
                   6898:     border-left: 1px solid $sidebg;
                   6899:     /* 
                   6900:        this hides the left border behind the border of the 
                   6901:        outer box if element is wrapped to the next 'line' 
                   6902:     */
                   6903:     margin-left: -1px;
                   6904: }
                   6905: 
1.843     bisitz   6906: ul.LC_funclist li {
1.915     droeschl 6907:   display: inline;
1.782     bisitz   6908:   white-space: nowrap;
1.915     droeschl 6909:   margin: 0 0 0 25px;
                   6910:   line-height: 150%;
1.782     bisitz   6911: }
                   6912: 
1.974     wenzelju 6913: .LC_hidden {
                   6914:   display: none;
                   6915: }
                   6916: 
1.1030    www      6917: .LCmodal-overlay {
                   6918: 		position:fixed;
                   6919: 		top:0;
                   6920: 		right:0;
                   6921: 		bottom:0;
                   6922: 		left:0;
                   6923: 		height:100%;
                   6924: 		width:100%;
                   6925: 		margin:0;
                   6926: 		padding:0;
                   6927: 		background:#999;
                   6928: 		opacity:.75;
                   6929: 		filter: alpha(opacity=75);
                   6930: 		-moz-opacity: 0.75;
                   6931: 		z-index:101;
                   6932: }
                   6933: 
                   6934: * html .LCmodal-overlay {   
                   6935: 		position: absolute;
                   6936: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   6937: }
                   6938: 
                   6939: .LCmodal-window {
                   6940: 		position:fixed;
                   6941: 		top:50%;
                   6942: 		left:50%;
                   6943: 		margin:0;
                   6944: 		padding:0;
                   6945: 		z-index:102;
                   6946: 	}
                   6947: 
                   6948: * html .LCmodal-window {
                   6949: 		position:absolute;
                   6950: }
                   6951: 
                   6952: .LCclose-window {
                   6953: 		position:absolute;
                   6954: 		width:32px;
                   6955: 		height:32px;
                   6956: 		right:8px;
                   6957: 		top:8px;
                   6958: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   6959: 		text-indent:-99999px;
                   6960: 		overflow:hidden;
                   6961: 		cursor:pointer;
                   6962: }
                   6963: 
1.343     albertel 6964: END
                   6965: }
                   6966: 
1.306     albertel 6967: =pod
                   6968: 
                   6969: =item * &headtag()
                   6970: 
                   6971: Returns a uniform footer for LON-CAPA web pages.
                   6972: 
1.307     albertel 6973: Inputs: $title - optional title for the head
                   6974:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6975:         $args - optional arguments
1.319     albertel 6976:             force_register - if is true call registerurl so the remote is 
                   6977:                              informed
1.415     albertel 6978:             redirect       -> array ref of
                   6979:                                    1- seconds before redirect occurs
                   6980:                                    2- url to redirect to
                   6981:                                    3- whether the side effect should occur
1.315     albertel 6982:                            (side effect of setting 
                   6983:                                $env{'internal.head.redirect'} to the url 
                   6984:                                redirected too)
1.352     albertel 6985:             domain         -> force to color decorate a page for a specific
                   6986:                                domain
                   6987:             function       -> force usage of a specific rolish color scheme
                   6988:             bgcolor        -> override the default page bgcolor
1.460     albertel 6989:             no_auto_mt_title
                   6990:                            -> prevent &mt()ing the title arg
1.464     albertel 6991: 
1.306     albertel 6992: =cut
                   6993: 
                   6994: sub headtag {
1.313     albertel 6995:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6996:     
1.363     albertel 6997:     my $function = $args->{'function'} || &get_users_function();
                   6998:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6999:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 7000:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7001: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7002: 		   #time(),
1.418     albertel 7003: 		   $env{'environment.color.timestamp'},
1.363     albertel 7004: 		   $function,$domain,$bgcolor);
                   7005: 
1.369     www      7006:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7007: 
1.308     albertel 7008:     my $result =
                   7009: 	'<head>'.
1.461     albertel 7010: 	&font_settings();
1.319     albertel 7011: 
1.1064    raeburn  7012:     my $inhibitprint = &print_suppression();
                   7013: 
1.461     albertel 7014:     if (!$args->{'frameset'}) {
                   7015: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7016:     }
1.962     droeschl 7017:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   7018:         $result .= Apache::lonxml::display_title();
1.319     albertel 7019:     }
1.436     albertel 7020:     if (!$args->{'no_nav_bar'} 
                   7021: 	&& !$args->{'only_body'}
                   7022: 	&& !$args->{'frameset'}) {
                   7023: 	$result .= &help_menu_js();
1.1032    www      7024:         $result.=&modal_window();
1.1038    www      7025:         $result.=&togglebox_script();
1.1034    www      7026:         $result.=&wishlist_window();
1.1041    www      7027:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7028:     } else {
                   7029:         if ($args->{'add_modal'}) {
                   7030:            $result.=&modal_window();
                   7031:         }
                   7032:         if ($args->{'add_wishlist'}) {
                   7033:            $result.=&wishlist_window();
                   7034:         }
1.1038    www      7035:         if ($args->{'add_togglebox'}) {
                   7036:            $result.=&togglebox_script();
                   7037:         }
1.1041    www      7038:         if ($args->{'add_progressbar'}) {
                   7039:            $result.=&LCprogressbarUpdate_script();
                   7040:         }
1.436     albertel 7041:     }
1.314     albertel 7042:     if (ref($args->{'redirect'})) {
1.414     albertel 7043: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7044: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7045: 	if (!$inhibit_continue) {
                   7046: 	    $env{'internal.head.redirect'} = $url;
                   7047: 	}
1.313     albertel 7048: 	$result.=<<ADDMETA
                   7049: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7050: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7051: ADDMETA
                   7052:     }
1.306     albertel 7053:     if (!defined($title)) {
                   7054: 	$title = 'The LearningOnline Network with CAPA';
                   7055:     }
1.460     albertel 7056:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7057:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 7058: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064    raeburn  7059:         .$inhibitprint
1.414     albertel 7060: 	.$head_extra;
1.962     droeschl 7061:     return $result.'</head>';
1.306     albertel 7062: }
                   7063: 
                   7064: =pod
                   7065: 
1.340     albertel 7066: =item * &font_settings()
                   7067: 
                   7068: Returns neccessary <meta> to set the proper encoding
                   7069: 
                   7070: Inputs: none
                   7071: 
                   7072: =cut
                   7073: 
                   7074: sub font_settings {
                   7075:     my $headerstring='';
1.647     www      7076:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 7077: 	$headerstring.=
                   7078: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   7079:     }
                   7080:     return $headerstring;
                   7081: }
                   7082: 
1.341     albertel 7083: =pod
                   7084: 
1.1064    raeburn  7085: =item * &print_suppression()
                   7086: 
                   7087: In course context returns css which causes the body to be blank when media="print",
                   7088: if printout generation is unavailable for the current resource.
                   7089: 
                   7090: This could be because:
                   7091: 
                   7092: (a) printstartdate is in the future
                   7093: 
                   7094: (b) printenddate is in the past
                   7095: 
                   7096: (c) there is an active exam block with "printout"
                   7097: functionality blocked
                   7098: 
                   7099: Users with pav, pfo or evb privileges are exempt.
                   7100: 
                   7101: Inputs: none
                   7102: 
                   7103: =cut
                   7104: 
                   7105: 
                   7106: sub print_suppression {
                   7107:     my $noprint;
                   7108:     if ($env{'request.course.id'}) {
                   7109:         my $scope = $env{'request.course.id'};
                   7110:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7111:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   7112:             return;
                   7113:         }
                   7114:         if ($env{'request.course.sec'} ne '') {
                   7115:             $scope .= "/$env{'request.course.sec'}";
                   7116:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7117:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  7118:                 return;
1.1064    raeburn  7119:             }
                   7120:         }
                   7121:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7122:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065    raeburn  7123:         my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064    raeburn  7124:         if ($blocked) {
                   7125:             my $checkrole = "cm./$cdom/$cnum";
                   7126:             if ($env{'request.course.sec'} ne '') {
                   7127:                 $checkrole .= "/$env{'request.course.sec'}";
                   7128:             }
                   7129:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   7130:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   7131:                 $noprint = 1;
                   7132:             }
                   7133:         }
                   7134:         unless ($noprint) {
                   7135:             my $symb = &Apache::lonnet::symbread();
                   7136:             if ($symb ne '') {
                   7137:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   7138:                 if (ref($navmap)) {
                   7139:                     my $res = $navmap->getBySymb($symb);
                   7140:                     if (ref($res)) {
                   7141:                         if (!$res->resprintable()) {
                   7142:                             $noprint = 1;
                   7143:                         }
                   7144:                     }
                   7145:                 }
                   7146:             }
                   7147:         }
                   7148:         if ($noprint) {
                   7149:             return <<"ENDSTYLE";
                   7150: <style type="text/css" media="print">
                   7151:     body { display:none }
                   7152: </style>
                   7153: ENDSTYLE
                   7154:         }
                   7155:     }
                   7156:     return;
                   7157: }
                   7158: 
                   7159: =pod
                   7160: 
1.341     albertel 7161: =item * &xml_begin()
                   7162: 
                   7163: Returns the needed doctype and <html>
                   7164: 
                   7165: Inputs: none
                   7166: 
                   7167: =cut
                   7168: 
                   7169: sub xml_begin {
                   7170:     my $output='';
                   7171: 
                   7172:     if ($env{'browser.mathml'}) {
                   7173: 	$output='<?xml version="1.0"?>'
                   7174:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7175: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7176:             
                   7177: #	    .'<!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">] >'
                   7178: 	    .'<!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">'
                   7179:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7180: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   7181:     } else {
1.849     bisitz   7182: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   7183:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 7184:     }
                   7185:     return $output;
                   7186: }
1.340     albertel 7187: 
                   7188: =pod
                   7189: 
1.306     albertel 7190: =item * &start_page()
                   7191: 
                   7192: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7193: 
1.648     raeburn  7194: Inputs:
                   7195: 
                   7196: =over 4
                   7197: 
                   7198: $title - optional title for the page
                   7199: 
                   7200: $head_extra - optional extra HTML to incude inside the <head>
                   7201: 
                   7202: $args - additional optional args supported are:
                   7203: 
                   7204: =over 8
                   7205: 
                   7206:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7207:                                     arg on
1.814     bisitz   7208:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7209:              add_entries    -> additional attributes to add to the  <body>
                   7210:              domain         -> force to color decorate a page for a 
1.317     albertel 7211:                                     specific domain
1.648     raeburn  7212:              function       -> force usage of a specific rolish color
1.317     albertel 7213:                                     scheme
1.648     raeburn  7214:              redirect       -> see &headtag()
                   7215:              bgcolor        -> override the default page bg color
                   7216:              js_ready       -> return a string ready for being used in 
1.317     albertel 7217:                                     a javascript writeln
1.648     raeburn  7218:              html_encode    -> return a string ready for being used in 
1.320     albertel 7219:                                     a html attribute
1.648     raeburn  7220:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7221:                                     $forcereg arg
1.648     raeburn  7222:              frameset       -> if true will start with a <frameset>
1.330     albertel 7223:                                     rather than <body>
1.648     raeburn  7224:              skip_phases    -> hash ref of 
1.338     albertel 7225:                                     head -> skip the <html><head> generation
                   7226:                                     body -> skip all <body> generation
1.648     raeburn  7227:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7228:              inherit_jsmath -> when creating popup window in a page,
                   7229:                                     should it have jsmath forced on by the
                   7230:                                     current page
1.867     kalberla 7231:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7232:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 7233: 
1.648     raeburn  7234: =back
1.460     albertel 7235: 
1.648     raeburn  7236: =back
1.562     albertel 7237: 
1.306     albertel 7238: =cut
                   7239: 
                   7240: sub start_page {
1.309     albertel 7241:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7242:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7243: 
1.315     albertel 7244:     $env{'internal.start_page'}++;
1.338     albertel 7245:     my $result;
1.964     droeschl 7246: 
1.338     albertel 7247:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      7248:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 7249:     }
                   7250:     
                   7251:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7252: 	if ($args->{'frameset'}) {
                   7253: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7254: 						$args->{'add_entries'});
                   7255: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   7256:         } else {
                   7257:             $result .=
                   7258:                 &bodytag($title, 
                   7259:                          $args->{'function'},       $args->{'add_entries'},
                   7260:                          $args->{'only_body'},      $args->{'domain'},
                   7261:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.962     droeschl 7262:                          $args->{'bgcolor'},        $args);
1.831     bisitz   7263:         }
1.330     albertel 7264:     }
1.338     albertel 7265: 
1.315     albertel 7266:     if ($args->{'js_ready'}) {
1.713     kaisler  7267: 		$result = &js_ready($result);
1.315     albertel 7268:     }
1.320     albertel 7269:     if ($args->{'html_encode'}) {
1.713     kaisler  7270: 		$result = &html_encode($result);
                   7271:     }
                   7272: 
1.813     bisitz   7273:     # Preparation for new and consistent functionlist at top of screen
                   7274:     # if ($args->{'functionlist'}) {
                   7275:     #            $result .= &build_functionlist();
                   7276:     #}
                   7277: 
1.964     droeschl 7278:     # Don't add anything more if only_body wanted or in const space
                   7279:     return $result if    $args->{'only_body'} 
                   7280:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   7281: 
                   7282:     #Breadcrumbs
1.758     kaisler  7283:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   7284: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   7285: 		#if any br links exists, add them to the breadcrumbs
                   7286: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   7287: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   7288: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   7289: 			}
                   7290: 		}
                   7291: 
                   7292: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   7293: 		if(exists($args->{'bread_crumbs_component'})){
                   7294: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   7295: 		}else{
                   7296: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   7297: 		}
1.320     albertel 7298:     }
1.315     albertel 7299:     return $result;
1.306     albertel 7300: }
                   7301: 
                   7302: sub end_page {
1.315     albertel 7303:     my ($args) = @_;
                   7304:     $env{'internal.end_page'}++;
1.330     albertel 7305:     my $result;
1.335     albertel 7306:     if ($args->{'discussion'}) {
                   7307: 	my ($target,$parser);
                   7308: 	if (ref($args->{'discussion'})) {
                   7309: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7310: 				$args->{'discussion'}{'parser'});
                   7311: 	}
                   7312: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7313:     }
1.330     albertel 7314:     if ($args->{'frameset'}) {
                   7315: 	$result .= '</frameset>';
                   7316:     } else {
1.635     raeburn  7317: 	$result .= &endbodytag($args);
1.330     albertel 7318:     }
                   7319:     $result .= "\n</html>";
                   7320: 
1.315     albertel 7321:     if ($args->{'js_ready'}) {
1.317     albertel 7322: 	$result = &js_ready($result);
1.315     albertel 7323:     }
1.335     albertel 7324: 
1.320     albertel 7325:     if ($args->{'html_encode'}) {
                   7326: 	$result = &html_encode($result);
                   7327:     }
1.335     albertel 7328: 
1.315     albertel 7329:     return $result;
                   7330: }
                   7331: 
1.1034    www      7332: sub wishlist_window {
                   7333:     return(<<'ENDWISHLIST');
1.1046    raeburn  7334: <script type="text/javascript">
1.1034    www      7335: // <![CDATA[
                   7336: // <!-- BEGIN LON-CAPA Internal
                   7337: function set_wishlistlink(title, path) {
                   7338:     if (!title) {
                   7339:         title = document.title;
                   7340:         title = title.replace(/^LON-CAPA /,'');
                   7341:     }
                   7342:     if (!path) {
                   7343:         path = location.pathname;
                   7344:     }
                   7345:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7346:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7347: }
                   7348: // END LON-CAPA Internal -->
                   7349: // ]]>
                   7350: </script>
                   7351: ENDWISHLIST
                   7352: }
                   7353: 
1.1030    www      7354: sub modal_window {
                   7355:     return(<<'ENDMODAL');
1.1046    raeburn  7356: <script type="text/javascript">
1.1030    www      7357: // <![CDATA[
                   7358: // <!-- BEGIN LON-CAPA Internal
                   7359: var modalWindow = {
                   7360: 	parent:"body",
                   7361: 	windowId:null,
                   7362: 	content:null,
                   7363: 	width:null,
                   7364: 	height:null,
                   7365: 	close:function()
                   7366: 	{
                   7367: 	        $(".LCmodal-window").remove();
                   7368: 	        $(".LCmodal-overlay").remove();
                   7369: 	},
                   7370: 	open:function()
                   7371: 	{
                   7372: 		var modal = "";
                   7373: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7374: 		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;\">";
                   7375: 		modal += this.content;
                   7376: 		modal += "</div>";	
                   7377: 
                   7378: 		$(this.parent).append(modal);
                   7379: 
                   7380: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7381: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7382: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7383: 	}
                   7384: };
1.1031    www      7385: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7386: 	{
                   7387: 		modalWindow.windowId = "myModal";
                   7388: 		modalWindow.width = width;
                   7389: 		modalWindow.height = height;
1.1031    www      7390: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7391: 		modalWindow.open();
                   7392: 	};	
                   7393: // END LON-CAPA Internal -->
                   7394: // ]]>
                   7395: </script>
                   7396: ENDMODAL
                   7397: }
                   7398: 
                   7399: sub modal_link {
1.1052    www      7400:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7401:     unless ($width) { $width=480; }
                   7402:     unless ($height) { $height=400; }
1.1031    www      7403:     unless ($scrolling) { $scrolling='yes'; }
1.1074    raeburn  7404:     my $target_attr;
                   7405:     if (defined($target)) {
                   7406:         $target_attr = 'target="'.$target.'"';
                   7407:     }
                   7408:     return <<"ENDLINK";
                   7409: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
                   7410:            $linktext</a>
                   7411: ENDLINK
1.1030    www      7412: }
                   7413: 
1.1032    www      7414: sub modal_adhoc_script {
                   7415:     my ($funcname,$width,$height,$content)=@_;
                   7416:     return (<<ENDADHOC);
1.1046    raeburn  7417: <script type="text/javascript">
1.1032    www      7418: // <![CDATA[
                   7419:         var $funcname = function()
                   7420:         {
                   7421:                 modalWindow.windowId = "myModal";
                   7422:                 modalWindow.width = $width;
                   7423:                 modalWindow.height = $height;
                   7424:                 modalWindow.content = '$content';
                   7425:                 modalWindow.open();
                   7426:         };  
                   7427: // ]]>
                   7428: </script>
                   7429: ENDADHOC
                   7430: }
                   7431: 
1.1041    www      7432: sub modal_adhoc_inner {
                   7433:     my ($funcname,$width,$height,$content)=@_;
                   7434:     my $innerwidth=$width-20;
                   7435:     $content=&js_ready(
1.1042    www      7436:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7437:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7438:                     $content.
                   7439:                  &end_scrollbox().
                   7440:                &end_page()
                   7441:              );
                   7442:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7443: }
                   7444: 
                   7445: sub modal_adhoc_window {
                   7446:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7447:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7448:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7449: }
                   7450: 
                   7451: sub modal_adhoc_launch {
                   7452:     my ($funcname,$width,$height,$content)=@_;
                   7453:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7454: <script type="text/javascript">
                   7455: // <![CDATA[
                   7456: $funcname();
                   7457: // ]]>
                   7458: </script>
                   7459: ENDLAUNCH
                   7460: }
                   7461: 
                   7462: sub modal_adhoc_close {
                   7463:     return (<<ENDCLOSE);
                   7464: <script type="text/javascript">
                   7465: // <![CDATA[
                   7466: modalWindow.close();
                   7467: // ]]>
                   7468: </script>
                   7469: ENDCLOSE
                   7470: }
                   7471: 
1.1038    www      7472: sub togglebox_script {
                   7473:    return(<<ENDTOGGLE);
                   7474: <script type="text/javascript"> 
                   7475: // <![CDATA[
                   7476: function LCtoggleDisplay(id,hidetext,showtext) {
                   7477:    link = document.getElementById(id + "link").childNodes[0];
                   7478:    with (document.getElementById(id).style) {
                   7479:       if (display == "none" ) {
                   7480:           display = "inline";
                   7481:           link.nodeValue = hidetext;
                   7482:         } else {
                   7483:           display = "none";
                   7484:           link.nodeValue = showtext;
                   7485:        }
                   7486:    }
                   7487: }
                   7488: // ]]>
                   7489: </script>
                   7490: ENDTOGGLE
                   7491: }
                   7492: 
1.1039    www      7493: sub start_togglebox {
                   7494:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7495:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7496:     unless ($showtext) { $showtext=&mt('show'); }
                   7497:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7498:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7499:     return &start_data_table().
                   7500:            &start_data_table_header_row().
                   7501:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7502:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7503:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7504:            &end_data_table_header_row().
                   7505:            '<tr id="'.$id.'" style="display:none""><td>';
                   7506: }
                   7507: 
                   7508: sub end_togglebox {
                   7509:     return '</td></tr>'.&end_data_table();
                   7510: }
                   7511: 
1.1041    www      7512: sub LCprogressbar_script {
1.1045    www      7513:    my ($id)=@_;
1.1041    www      7514:    return(<<ENDPROGRESS);
                   7515: <script type="text/javascript">
                   7516: // <![CDATA[
1.1045    www      7517: \$('#progressbar$id').progressbar({
1.1041    www      7518:   value: 0,
                   7519:   change: function(event, ui) {
                   7520:     var newVal = \$(this).progressbar('option', 'value');
                   7521:     \$('.pblabel', this).text(LCprogressTxt);
                   7522:   }
                   7523: });
                   7524: // ]]>
                   7525: </script>
                   7526: ENDPROGRESS
                   7527: }
                   7528: 
                   7529: sub LCprogressbarUpdate_script {
                   7530:    return(<<ENDPROGRESSUPDATE);
                   7531: <style type="text/css">
                   7532: .ui-progressbar { position:relative; }
                   7533: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7534: </style>
                   7535: <script type="text/javascript">
                   7536: // <![CDATA[
1.1045    www      7537: var LCprogressTxt='---';
                   7538: 
                   7539: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7540:    LCprogressTxt=progresstext;
1.1045    www      7541:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7542: }
                   7543: // ]]>
                   7544: </script>
                   7545: ENDPROGRESSUPDATE
                   7546: }
                   7547: 
1.1042    www      7548: my $LClastpercent;
1.1045    www      7549: my $LCidcnt;
                   7550: my $LCcurrentid;
1.1042    www      7551: 
1.1041    www      7552: sub LCprogressbar {
1.1042    www      7553:     my ($r)=(@_);
                   7554:     $LClastpercent=0;
1.1045    www      7555:     $LCidcnt++;
                   7556:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7557:     my $starting=&mt('Starting');
                   7558:     my $content=(<<ENDPROGBAR);
                   7559: <p>
1.1045    www      7560:   <div id="progressbar$LCcurrentid">
1.1041    www      7561:     <span class="pblabel">$starting</span>
                   7562:   </div>
                   7563: </p>
                   7564: ENDPROGBAR
1.1045    www      7565:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7566: }
                   7567: 
                   7568: sub LCprogressbarUpdate {
1.1042    www      7569:     my ($r,$val,$text)=@_;
                   7570:     unless ($val) { 
                   7571:        if ($LClastpercent) {
                   7572:            $val=$LClastpercent;
                   7573:        } else {
                   7574:            $val=0;
                   7575:        }
                   7576:     }
1.1041    www      7577:     if ($val<0) { $val=0; }
                   7578:     if ($val>100) { $val=0; }
1.1042    www      7579:     $LClastpercent=$val;
1.1041    www      7580:     unless ($text) { $text=$val.'%'; }
                   7581:     $text=&js_ready($text);
1.1044    www      7582:     &r_print($r,<<ENDUPDATE);
1.1041    www      7583: <script type="text/javascript">
                   7584: // <![CDATA[
1.1045    www      7585: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7586: // ]]>
                   7587: </script>
                   7588: ENDUPDATE
1.1035    www      7589: }
                   7590: 
1.1042    www      7591: sub LCprogressbarClose {
                   7592:     my ($r)=@_;
                   7593:     $LClastpercent=0;
1.1044    www      7594:     &r_print($r,<<ENDCLOSE);
1.1042    www      7595: <script type="text/javascript">
                   7596: // <![CDATA[
1.1045    www      7597: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7598: // ]]>
                   7599: </script>
                   7600: ENDCLOSE
1.1044    www      7601: }
                   7602: 
                   7603: sub r_print {
                   7604:     my ($r,$to_print)=@_;
                   7605:     if ($r) {
                   7606:       $r->print($to_print);
                   7607:       $r->rflush();
                   7608:     } else {
                   7609:       print($to_print);
                   7610:     }
1.1042    www      7611: }
                   7612: 
1.320     albertel 7613: sub html_encode {
                   7614:     my ($result) = @_;
                   7615: 
1.322     albertel 7616:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7617:     
                   7618:     return $result;
                   7619: }
1.1044    www      7620: 
1.317     albertel 7621: sub js_ready {
                   7622:     my ($result) = @_;
                   7623: 
1.323     albertel 7624:     $result =~ s/[\n\r]/ /xmsg;
                   7625:     $result =~ s/\\/\\\\/xmsg;
                   7626:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7627:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7628:     
                   7629:     return $result;
                   7630: }
                   7631: 
1.315     albertel 7632: sub validate_page {
                   7633:     if (  exists($env{'internal.start_page'})
1.316     albertel 7634: 	  &&     $env{'internal.start_page'} > 1) {
                   7635: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7636: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7637: 				 $ENV{'request.filename'});
1.315     albertel 7638:     }
                   7639:     if (  exists($env{'internal.end_page'})
1.316     albertel 7640: 	  &&     $env{'internal.end_page'} > 1) {
                   7641: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7642: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7643: 				 $env{'request.filename'});
1.315     albertel 7644:     }
                   7645:     if (     exists($env{'internal.start_page'})
                   7646: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7647: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7648: 				 $env{'request.filename'});
1.315     albertel 7649:     }
                   7650:     if (   ! exists($env{'internal.start_page'})
                   7651: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7652: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7653: 				 $env{'request.filename'});
1.315     albertel 7654:     }
1.306     albertel 7655: }
1.315     albertel 7656: 
1.996     www      7657: 
                   7658: sub start_scrollbox {
1.1075    raeburn  7659:     my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998     raeburn  7660:     unless ($outerwidth) { $outerwidth='520px'; }
                   7661:     unless ($width) { $width='500px'; }
                   7662:     unless ($height) { $height='200px'; }
1.1075    raeburn  7663:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  7664:     if ($id ne '') {
1.1020    raeburn  7665:         $table_id = " id='table_$id'";
                   7666:         $div_id = " id='div_$id'";
1.1018    raeburn  7667:     }
1.1075    raeburn  7668:     if ($bgcolor ne '') {
                   7669:         $tdcol = "background-color: $bgcolor;";
                   7670:     }
                   7671:     return <<"END";
                   7672: <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>
                   7673: END
1.996     www      7674: }
                   7675: 
                   7676: sub end_scrollbox {
1.1036    www      7677:     return '</div></td></tr></table>';
1.996     www      7678: }
                   7679: 
1.318     albertel 7680: sub simple_error_page {
                   7681:     my ($r,$title,$msg) = @_;
                   7682:     my $page =
                   7683: 	&Apache::loncommon::start_page($title).
                   7684: 	&mt($msg).
                   7685: 	&Apache::loncommon::end_page();
                   7686:     if (ref($r)) {
                   7687: 	$r->print($page);
1.327     albertel 7688: 	return;
1.318     albertel 7689:     }
                   7690:     return $page;
                   7691: }
1.347     albertel 7692: 
                   7693: {
1.610     albertel 7694:     my @row_count;
1.961     onken    7695: 
                   7696:     sub start_data_table_count {
                   7697:         unshift(@row_count, 0);
                   7698:         return;
                   7699:     }
                   7700: 
                   7701:     sub end_data_table_count {
                   7702:         shift(@row_count);
                   7703:         return;
                   7704:     }
                   7705: 
1.347     albertel 7706:     sub start_data_table {
1.1018    raeburn  7707: 	my ($add_class,$id) = @_;
1.422     albertel 7708: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7709:         my $table_id;
                   7710:         if (defined($id)) {
                   7711:             $table_id = ' id="'.$id.'"';
                   7712:         }
1.961     onken    7713: 	&start_data_table_count();
1.1018    raeburn  7714: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7715:     }
                   7716: 
                   7717:     sub end_data_table {
1.961     onken    7718: 	&end_data_table_count();
1.389     albertel 7719: 	return '</table>'."\n";;
1.347     albertel 7720:     }
                   7721: 
                   7722:     sub start_data_table_row {
1.974     wenzelju 7723: 	my ($add_class, $id) = @_;
1.610     albertel 7724: 	$row_count[0]++;
                   7725: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7726: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7727:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7728:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7729:     }
1.471     banghart 7730:     
                   7731:     sub continue_data_table_row {
1.974     wenzelju 7732: 	my ($add_class, $id) = @_;
1.610     albertel 7733: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7734: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7735:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7736:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7737:     }
1.347     albertel 7738: 
                   7739:     sub end_data_table_row {
1.389     albertel 7740: 	return '</tr>'."\n";;
1.347     albertel 7741:     }
1.367     www      7742: 
1.421     albertel 7743:     sub start_data_table_empty_row {
1.707     bisitz   7744: #	$row_count[0]++;
1.421     albertel 7745: 	return  '<tr class="LC_empty_row" >'."\n";;
                   7746:     }
                   7747: 
                   7748:     sub end_data_table_empty_row {
                   7749: 	return '</tr>'."\n";;
                   7750:     }
                   7751: 
1.367     www      7752:     sub start_data_table_header_row {
1.389     albertel 7753: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      7754:     }
                   7755: 
                   7756:     sub end_data_table_header_row {
1.389     albertel 7757: 	return '</tr>'."\n";;
1.367     www      7758:     }
1.890     droeschl 7759: 
                   7760:     sub data_table_caption {
                   7761:         my $caption = shift;
                   7762:         return "<caption class=\"LC_caption\">$caption</caption>";
                   7763:     }
1.347     albertel 7764: }
                   7765: 
1.548     albertel 7766: =pod
                   7767: 
                   7768: =item * &inhibit_menu_check($arg)
                   7769: 
                   7770: Checks for a inhibitmenu state and generates output to preserve it
                   7771: 
                   7772: Inputs:         $arg - can be any of
                   7773:                      - undef - in which case the return value is a string 
                   7774:                                to add  into arguments list of a uri
                   7775:                      - 'input' - in which case the return value is a HTML
                   7776:                                  <form> <input> field of type hidden to
                   7777:                                  preserve the value
                   7778:                      - a url - in which case the return value is the url with
                   7779:                                the neccesary cgi args added to preserve the
                   7780:                                inhibitmenu state
                   7781:                      - a ref to a url - no return value, but the string is
                   7782:                                         updated to include the neccessary cgi
                   7783:                                         args to preserve the inhibitmenu state
                   7784: 
                   7785: =cut
                   7786: 
                   7787: sub inhibit_menu_check {
                   7788:     my ($arg) = @_;
                   7789:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   7790:     if ($arg eq 'input') {
                   7791: 	if ($env{'form.inhibitmenu'}) {
                   7792: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   7793: 	} else {
                   7794: 	    return
                   7795: 	}
                   7796:     }
                   7797:     if ($env{'form.inhibitmenu'}) {
                   7798: 	if (ref($arg)) {
                   7799: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7800: 	} elsif ($arg eq '') {
                   7801: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   7802: 	} else {
                   7803: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   7804: 	}
                   7805:     }
                   7806:     if (!ref($arg)) {
                   7807: 	return $arg;
                   7808:     }
                   7809: }
                   7810: 
1.251     albertel 7811: ###############################################
1.182     matthew  7812: 
                   7813: =pod
                   7814: 
1.549     albertel 7815: =back
                   7816: 
                   7817: =head1 User Information Routines
                   7818: 
                   7819: =over 4
                   7820: 
1.405     albertel 7821: =item * &get_users_function()
1.182     matthew  7822: 
                   7823: Used by &bodytag to determine the current users primary role.
                   7824: Returns either 'student','coordinator','admin', or 'author'.
                   7825: 
                   7826: =cut
                   7827: 
                   7828: ###############################################
                   7829: sub get_users_function {
1.815     tempelho 7830:     my $function = 'norole';
1.818     tempelho 7831:     if ($env{'request.role'}=~/^(st)/) {
                   7832:         $function='student';
                   7833:     }
1.907     raeburn  7834:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7835:         $function='coordinator';
                   7836:     }
1.258     albertel 7837:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7838:         $function='admin';
                   7839:     }
1.826     bisitz   7840:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  7841:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  7842:         $function='author';
                   7843:     }
                   7844:     return $function;
1.54      www      7845: }
1.99      www      7846: 
                   7847: ###############################################
                   7848: 
1.233     raeburn  7849: =pod
                   7850: 
1.821     raeburn  7851: =item * &show_course()
                   7852: 
                   7853: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7854: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7855: 
                   7856: Inputs:
                   7857: None
                   7858: 
                   7859: Outputs:
                   7860: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7861: 
                   7862: =cut
                   7863: 
                   7864: ###############################################
                   7865: sub show_course {
                   7866:     my $course = !$env{'user.adv'};
                   7867:     if (!$env{'user.adv'}) {
                   7868:         foreach my $env (keys(%env)) {
                   7869:             next if ($env !~ m/^user\.priv\./);
                   7870:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7871:                 $course = 0;
                   7872:                 last;
                   7873:             }
                   7874:         }
                   7875:     }
                   7876:     return $course;
                   7877: }
                   7878: 
                   7879: ###############################################
                   7880: 
                   7881: =pod
                   7882: 
1.542     raeburn  7883: =item * &check_user_status()
1.274     raeburn  7884: 
                   7885: Determines current status of supplied role for a
                   7886: specific user. Roles can be active, previous or future.
                   7887: 
                   7888: Inputs: 
                   7889: user's domain, user's username, course's domain,
1.375     raeburn  7890: course's number, optional section ID.
1.274     raeburn  7891: 
                   7892: Outputs:
                   7893: role status: active, previous or future. 
                   7894: 
                   7895: =cut
                   7896: 
                   7897: sub check_user_status {
1.412     raeburn  7898:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  7899:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274     raeburn  7900:     my @uroles = keys %userinfo;
                   7901:     my $srchstr;
                   7902:     my $active_chk = 'none';
1.412     raeburn  7903:     my $now = time;
1.274     raeburn  7904:     if (@uroles > 0) {
1.908     raeburn  7905:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7906:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7907:         } else {
1.412     raeburn  7908:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7909:         }
                   7910:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7911:             my $role_end = 0;
                   7912:             my $role_start = 0;
                   7913:             $active_chk = 'active';
1.412     raeburn  7914:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7915:                 $role_end = $1;
                   7916:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7917:                     $role_start = $1;
1.274     raeburn  7918:                 }
                   7919:             }
                   7920:             if ($role_start > 0) {
1.412     raeburn  7921:                 if ($now < $role_start) {
1.274     raeburn  7922:                     $active_chk = 'future';
                   7923:                 }
                   7924:             }
                   7925:             if ($role_end > 0) {
1.412     raeburn  7926:                 if ($now > $role_end) {
1.274     raeburn  7927:                     $active_chk = 'previous';
                   7928:                 }
                   7929:             }
                   7930:         }
                   7931:     }
                   7932:     return $active_chk;
                   7933: }
                   7934: 
                   7935: ###############################################
                   7936: 
                   7937: =pod
                   7938: 
1.405     albertel 7939: =item * &get_sections()
1.233     raeburn  7940: 
                   7941: Determines all the sections for a course including
                   7942: sections with students and sections containing other roles.
1.419     raeburn  7943: Incoming parameters: 
                   7944: 
                   7945: 1. domain
                   7946: 2. course number 
                   7947: 3. reference to array containing roles for which sections should 
                   7948: be gathered (optional).
                   7949: 4. reference to array containing status types for which sections 
                   7950: should be gathered (optional).
                   7951: 
                   7952: If the third argument is undefined, sections are gathered for any role. 
                   7953: If the fourth argument is undefined, sections are gathered for any status.
                   7954: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7955:  
1.374     raeburn  7956: Returns section hash (keys are section IDs, values are
                   7957: number of users in each section), subject to the
1.419     raeburn  7958: optional roles filter, optional status filter 
1.233     raeburn  7959: 
                   7960: =cut
                   7961: 
                   7962: ###############################################
                   7963: sub get_sections {
1.419     raeburn  7964:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7965:     if (!defined($cdom) || !defined($cnum)) {
                   7966:         my $cid =  $env{'request.course.id'};
                   7967: 
                   7968: 	return if (!defined($cid));
                   7969: 
                   7970:         $cdom = $env{'course.'.$cid.'.domain'};
                   7971:         $cnum = $env{'course.'.$cid.'.num'};
                   7972:     }
                   7973: 
                   7974:     my %sectioncount;
1.419     raeburn  7975:     my $now = time;
1.240     albertel 7976: 
1.366     albertel 7977:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7978: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7979: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7980: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7981:         my $start_index = &Apache::loncoursedata::CL_START();
                   7982:         my $end_index = &Apache::loncoursedata::CL_END();
                   7983:         my $status;
1.366     albertel 7984: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7985: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7986: 				                     $data->[$status_index],
                   7987:                                                      $data->[$start_index],
                   7988:                                                      $data->[$end_index]);
                   7989:             if ($stu_status eq 'Active') {
                   7990:                 $status = 'active';
                   7991:             } elsif ($end < $now) {
                   7992:                 $status = 'previous';
                   7993:             } elsif ($start > $now) {
                   7994:                 $status = 'future';
                   7995:             } 
                   7996: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7997:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7998:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7999: 		    $sectioncount{$section}++;
                   8000:                 }
1.240     albertel 8001: 	    }
                   8002: 	}
                   8003:     }
                   8004:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8005:     foreach my $user (sort(keys(%courseroles))) {
                   8006: 	if ($user !~ /^(\w{2})/) { next; }
                   8007: 	my ($role) = ($user =~ /^(\w{2})/);
                   8008: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  8009: 	my ($section,$status);
1.240     albertel 8010: 	if ($role eq 'cr' &&
                   8011: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   8012: 	    $section=$1;
                   8013: 	}
                   8014: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   8015: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  8016:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   8017:         if ($end == -1 && $start == -1) {
                   8018:             next; #deleted role
                   8019:         }
                   8020:         if (!defined($possible_status)) { 
                   8021:             $sectioncount{$section}++;
                   8022:         } else {
                   8023:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   8024:                 $status = 'active';
                   8025:             } elsif ($end < $now) {
                   8026:                 $status = 'future';
                   8027:             } elsif ($start > $now) {
                   8028:                 $status = 'previous';
                   8029:             }
                   8030:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   8031:                 $sectioncount{$section}++;
                   8032:             }
                   8033:         }
1.233     raeburn  8034:     }
1.366     albertel 8035:     return %sectioncount;
1.233     raeburn  8036: }
                   8037: 
1.274     raeburn  8038: ###############################################
1.294     raeburn  8039: 
                   8040: =pod
1.405     albertel 8041: 
                   8042: =item * &get_course_users()
                   8043: 
1.275     raeburn  8044: Retrieves usernames:domains for users in the specified course
                   8045: with specific role(s), and access status. 
                   8046: 
                   8047: Incoming parameters:
1.277     albertel 8048: 1. course domain
                   8049: 2. course number
                   8050: 3. access status: users must have - either active, 
1.275     raeburn  8051: previous, future, or all.
1.277     albertel 8052: 4. reference to array of permissible roles
1.288     raeburn  8053: 5. reference to array of section restrictions (optional)
                   8054: 6. reference to results object (hash of hashes).
                   8055: 7. reference to optional userdata hash
1.609     raeburn  8056: 8. reference to optional statushash
1.630     raeburn  8057: 9. flag if privileged users (except those set to unhide in
                   8058:    course settings) should be excluded    
1.609     raeburn  8059: Keys of top level results hash are roles.
1.275     raeburn  8060: Keys of inner hashes are username:domain, with 
                   8061: values set to access type.
1.288     raeburn  8062: Optional userdata hash returns an array with arguments in the 
                   8063: same order as loncoursedata::get_classlist() for student data.
                   8064: 
1.609     raeburn  8065: Optional statushash returns
                   8066: 
1.288     raeburn  8067: Entries for end, start, section and status are blank because
                   8068: of the possibility of multiple values for non-student roles.
                   8069: 
1.275     raeburn  8070: =cut
1.405     albertel 8071: 
1.275     raeburn  8072: ###############################################
1.405     albertel 8073: 
1.275     raeburn  8074: sub get_course_users {
1.630     raeburn  8075:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  8076:     my %idx = ();
1.419     raeburn  8077:     my %seclists;
1.288     raeburn  8078: 
                   8079:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   8080:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   8081:     $idx{end} = &Apache::loncoursedata::CL_END();
                   8082:     $idx{start} = &Apache::loncoursedata::CL_START();
                   8083:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   8084:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   8085:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   8086:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   8087: 
1.290     albertel 8088:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 8089:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  8090:         my $now = time;
1.277     albertel 8091:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  8092:             my $match = 0;
1.412     raeburn  8093:             my $secmatch = 0;
1.419     raeburn  8094:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  8095:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  8096:             if ($section eq '') {
                   8097:                 $section = 'none';
                   8098:             }
1.291     albertel 8099:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8100:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8101:                     $secmatch = 1;
                   8102:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 8103:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8104:                         $secmatch = 1;
                   8105:                     }
                   8106:                 } else {  
1.419     raeburn  8107: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  8108: 		        $secmatch = 1;
                   8109:                     }
1.290     albertel 8110: 		}
1.412     raeburn  8111:                 if (!$secmatch) {
                   8112:                     next;
                   8113:                 }
1.419     raeburn  8114:             }
1.275     raeburn  8115:             if (defined($$types{'active'})) {
1.288     raeburn  8116:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  8117:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  8118:                     $match = 1;
1.275     raeburn  8119:                 }
                   8120:             }
                   8121:             if (defined($$types{'previous'})) {
1.609     raeburn  8122:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  8123:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  8124:                     $match = 1;
1.275     raeburn  8125:                 }
                   8126:             }
                   8127:             if (defined($$types{'future'})) {
1.609     raeburn  8128:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  8129:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  8130:                     $match = 1;
1.275     raeburn  8131:                 }
                   8132:             }
1.609     raeburn  8133:             if ($match) {
                   8134:                 push(@{$seclists{$student}},$section);
                   8135:                 if (ref($userdata) eq 'HASH') {
                   8136:                     $$userdata{$student} = $$classlist{$student};
                   8137:                 }
                   8138:                 if (ref($statushash) eq 'HASH') {
                   8139:                     $statushash->{$student}{'st'}{$section} = $status;
                   8140:                 }
1.288     raeburn  8141:             }
1.275     raeburn  8142:         }
                   8143:     }
1.412     raeburn  8144:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  8145:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8146:         my $now = time;
1.609     raeburn  8147:         my %displaystatus = ( previous => 'Expired',
                   8148:                               active   => 'Active',
                   8149:                               future   => 'Future',
                   8150:                             );
1.630     raeburn  8151:         my %nothide;
                   8152:         if ($hidepriv) {
                   8153:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   8154:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   8155:                 if ($user !~ /:/) {
                   8156:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   8157:                 } else {
                   8158:                     $nothide{$user} = 1;
                   8159:                 }
                   8160:             }
                   8161:         }
1.439     raeburn  8162:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  8163:             my $match = 0;
1.412     raeburn  8164:             my $secmatch = 0;
1.439     raeburn  8165:             my $status;
1.412     raeburn  8166:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  8167:             $user =~ s/:$//;
1.439     raeburn  8168:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   8169:             if ($end == -1 || $start == -1) {
                   8170:                 next;
                   8171:             }
                   8172:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   8173:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  8174:                 my ($uname,$udom) = split(/:/,$user);
                   8175:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8176:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8177:                         $secmatch = 1;
                   8178:                     } elsif ($usec eq '') {
1.420     albertel 8179:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8180:                             $secmatch = 1;
                   8181:                         }
                   8182:                     } else {
                   8183:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   8184:                             $secmatch = 1;
                   8185:                         }
                   8186:                     }
                   8187:                     if (!$secmatch) {
                   8188:                         next;
                   8189:                     }
1.288     raeburn  8190:                 }
1.419     raeburn  8191:                 if ($usec eq '') {
                   8192:                     $usec = 'none';
                   8193:                 }
1.275     raeburn  8194:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  8195:                     if ($hidepriv) {
                   8196:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   8197:                             (!$nothide{$uname.':'.$udom})) {
                   8198:                             next;
                   8199:                         }
                   8200:                     }
1.503     raeburn  8201:                     if ($end > 0 && $end < $now) {
1.439     raeburn  8202:                         $status = 'previous';
                   8203:                     } elsif ($start > $now) {
                   8204:                         $status = 'future';
                   8205:                     } else {
                   8206:                         $status = 'active';
                   8207:                     }
1.277     albertel 8208:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  8209:                         if ($status eq $type) {
1.420     albertel 8210:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  8211:                                 push(@{$$users{$role}{$user}},$type);
                   8212:                             }
1.288     raeburn  8213:                             $match = 1;
                   8214:                         }
                   8215:                     }
1.419     raeburn  8216:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   8217:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   8218: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   8219:                         }
1.420     albertel 8220:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  8221:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   8222:                         }
1.609     raeburn  8223:                         if (ref($statushash) eq 'HASH') {
                   8224:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   8225:                         }
1.275     raeburn  8226:                     }
                   8227:                 }
                   8228:             }
                   8229:         }
1.290     albertel 8230:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  8231:             if ((defined($cdom)) && (defined($cnum))) {
                   8232:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   8233:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   8234:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  8235:                     next if ($owner eq '');
                   8236:                     my ($ownername,$ownerdom);
                   8237:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   8238:                         $ownername = $1;
                   8239:                         $ownerdom = $2;
                   8240:                     } else {
                   8241:                         $ownername = $owner;
                   8242:                         $ownerdom = $cdom;
                   8243:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  8244:                     }
                   8245:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 8246:                     if (defined($userdata) && 
1.609     raeburn  8247: 			!exists($$userdata{$owner})) {
                   8248: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   8249:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   8250:                             push(@{$seclists{$owner}},'none');
                   8251:                         }
                   8252:                         if (ref($statushash) eq 'HASH') {
                   8253:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  8254:                         }
1.290     albertel 8255: 		    }
1.279     raeburn  8256:                 }
                   8257:             }
                   8258:         }
1.419     raeburn  8259:         foreach my $user (keys(%seclists)) {
                   8260:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   8261:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   8262:         }
1.275     raeburn  8263:     }
                   8264:     return;
                   8265: }
                   8266: 
1.288     raeburn  8267: sub get_user_info {
                   8268:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 8269:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   8270: 	&plainname($uname,$udom,'lastname');
1.291     albertel 8271:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  8272:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  8273:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   8274:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  8275:     return;
                   8276: }
1.275     raeburn  8277: 
1.472     raeburn  8278: ###############################################
                   8279: 
                   8280: =pod
                   8281: 
                   8282: =item * &get_user_quota()
                   8283: 
                   8284: Retrieves quota assigned for storage of portfolio files for a user  
                   8285: 
                   8286: Incoming parameters:
                   8287: 1. user's username
                   8288: 2. user's domain
                   8289: 
                   8290: Returns:
1.536     raeburn  8291: 1. Disk quota (in Mb) assigned to student.
                   8292: 2. (Optional) Type of setting: custom or default
                   8293:    (individually assigned or default for user's 
                   8294:    institutional status).
                   8295: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   8296:    or student - types as defined in localenroll::inst_usertypes 
                   8297:    for user's domain, which determines default quota for user.
                   8298: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  8299: 
                   8300: If a value has been stored in the user's environment, 
1.536     raeburn  8301: it will return that, otherwise it returns the maximal default
                   8302: defined for the user's instituional status(es) in the domain.
1.472     raeburn  8303: 
                   8304: =cut
                   8305: 
                   8306: ###############################################
                   8307: 
                   8308: 
                   8309: sub get_user_quota {
                   8310:     my ($uname,$udom) = @_;
1.536     raeburn  8311:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8312:     if (!defined($udom)) {
                   8313:         $udom = $env{'user.domain'};
                   8314:     }
                   8315:     if (!defined($uname)) {
                   8316:         $uname = $env{'user.name'};
                   8317:     }
                   8318:     if (($udom eq '' || $uname eq '') ||
                   8319:         ($udom eq 'public') && ($uname eq 'public')) {
                   8320:         $quota = 0;
1.536     raeburn  8321:         $quotatype = 'default';
                   8322:         $defquota = 0; 
1.472     raeburn  8323:     } else {
1.536     raeburn  8324:         my $inststatus;
1.472     raeburn  8325:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8326:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8327:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8328:         } else {
1.536     raeburn  8329:             my %userenv = 
                   8330:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8331:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8332:             my ($tmp) = keys(%userenv);
                   8333:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8334:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8335:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8336:             } else {
                   8337:                 undef(%userenv);
                   8338:             }
                   8339:         }
1.536     raeburn  8340:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8341:         if ($quota eq '') {
1.536     raeburn  8342:             $quota = $defquota;
                   8343:             $quotatype = 'default';
                   8344:         } else {
                   8345:             $quotatype = 'custom';
1.472     raeburn  8346:         }
                   8347:     }
1.536     raeburn  8348:     if (wantarray) {
                   8349:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8350:     } else {
                   8351:         return $quota;
                   8352:     }
1.472     raeburn  8353: }
                   8354: 
                   8355: ###############################################
                   8356: 
                   8357: =pod
                   8358: 
                   8359: =item * &default_quota()
                   8360: 
1.536     raeburn  8361: Retrieves default quota assigned for storage of user portfolio files,
                   8362: given an (optional) user's institutional status.
1.472     raeburn  8363: 
                   8364: Incoming parameters:
                   8365: 1. domain
1.536     raeburn  8366: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8367:    status types (e.g., faculty, staff, student etc.)
                   8368:    which apply to the user for whom the default is being retrieved.
                   8369:    If the institutional status string in undefined, the domain
                   8370:    default quota will be returned. 
1.472     raeburn  8371: 
                   8372: Returns:
                   8373: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8374: 2. (Optional) institutional type which determined the value of the
                   8375:    default quota.
1.472     raeburn  8376: 
                   8377: If a value has been stored in the domain's configuration db,
                   8378: it will return that, otherwise it returns 20 (for backwards 
                   8379: compatibility with domains which have not set up a configuration
                   8380: db file; the original statically defined portfolio quota was 20 Mb). 
                   8381: 
1.536     raeburn  8382: If the user's status includes multiple types (e.g., staff and student),
                   8383: the largest default quota which applies to the user determines the
                   8384: default quota returned.
                   8385: 
1.780     raeburn  8386: =back
                   8387: 
1.472     raeburn  8388: =cut
                   8389: 
                   8390: ###############################################
                   8391: 
                   8392: 
                   8393: sub default_quota {
1.536     raeburn  8394:     my ($udom,$inststatus) = @_;
                   8395:     my ($defquota,$settingstatus);
                   8396:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8397:                                             ['quotas'],$udom);
                   8398:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8399:         if ($inststatus ne '') {
1.765     raeburn  8400:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8401:             foreach my $item (@statuses) {
1.711     raeburn  8402:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8403:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8404:                         if ($defquota eq '') {
                   8405:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8406:                             $settingstatus = $item;
                   8407:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8408:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8409:                             $settingstatus = $item;
                   8410:                         }
                   8411:                     }
                   8412:                 } else {
                   8413:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8414:                         if ($defquota eq '') {
                   8415:                             $defquota = $quotahash{'quotas'}{$item};
                   8416:                             $settingstatus = $item;
                   8417:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8418:                             $defquota = $quotahash{'quotas'}{$item};
                   8419:                             $settingstatus = $item;
                   8420:                         }
1.536     raeburn  8421:                     }
                   8422:                 }
                   8423:             }
                   8424:         }
                   8425:         if ($defquota eq '') {
1.711     raeburn  8426:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8427:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8428:             } else {
                   8429:                 $defquota = $quotahash{'quotas'}{'default'};
                   8430:             }
1.536     raeburn  8431:             $settingstatus = 'default';
                   8432:         }
                   8433:     } else {
                   8434:         $settingstatus = 'default';
                   8435:         $defquota = 20;
                   8436:     }
                   8437:     if (wantarray) {
                   8438:         return ($defquota,$settingstatus);
1.472     raeburn  8439:     } else {
1.536     raeburn  8440:         return $defquota;
1.472     raeburn  8441:     }
                   8442: }
                   8443: 
1.384     raeburn  8444: sub get_secgrprole_info {
                   8445:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8446:     my %sections_count = &get_sections($cdom,$cnum);
                   8447:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8448:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8449:     my @groups = sort(keys(%curr_groups));
                   8450:     my $allroles = [];
                   8451:     my $rolehash;
                   8452:     my $accesshash = {
                   8453:                      active => 'Currently has access',
                   8454:                      future => 'Will have future access',
                   8455:                      previous => 'Previously had access',
                   8456:                   };
                   8457:     if ($needroles) {
                   8458:         $rolehash = {'all' => 'all'};
1.385     albertel 8459:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8460: 	if (&Apache::lonnet::error(%user_roles)) {
                   8461: 	    undef(%user_roles);
                   8462: 	}
                   8463:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8464:             my ($role)=split(/\:/,$item,2);
                   8465:             if ($role eq 'cr') { next; }
                   8466:             if ($role =~ /^cr/) {
                   8467:                 $$rolehash{$role} = (split('/',$role))[3];
                   8468:             } else {
                   8469:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8470:             }
                   8471:         }
                   8472:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8473:             push(@{$allroles},$key);
                   8474:         }
                   8475:         push (@{$allroles},'st');
                   8476:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8477:     }
                   8478:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8479: }
                   8480: 
1.555     raeburn  8481: sub user_picker {
1.994     raeburn  8482:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8483:     my $currdom = $dom;
                   8484:     my %curr_selected = (
                   8485:                         srchin => 'dom',
1.580     raeburn  8486:                         srchby => 'lastname',
1.555     raeburn  8487:                       );
                   8488:     my $srchterm;
1.625     raeburn  8489:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8490:         if ($srch->{'srchby'} ne '') {
                   8491:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8492:         }
                   8493:         if ($srch->{'srchin'} ne '') {
                   8494:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8495:         }
                   8496:         if ($srch->{'srchtype'} ne '') {
                   8497:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8498:         }
                   8499:         if ($srch->{'srchdomain'} ne '') {
                   8500:             $currdom = $srch->{'srchdomain'};
                   8501:         }
                   8502:         $srchterm = $srch->{'srchterm'};
                   8503:     }
                   8504:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8505:                     'usr'       => 'Search criteria',
1.563     raeburn  8506:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8507:                     'uname'     => 'username',
                   8508:                     'lastname'  => 'last name',
1.555     raeburn  8509:                     'lastfirst' => 'last name, first name',
1.558     albertel 8510:                     'crs'       => 'in this course',
1.576     raeburn  8511:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8512:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8513:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8514:                     'exact'     => 'is',
                   8515:                     'contains'  => 'contains',
1.569     raeburn  8516:                     'begins'    => 'begins with',
1.571     raeburn  8517:                     'youm'      => "You must include some text to search for.",
                   8518:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8519:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8520:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8521:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8522:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8523:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8524:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8525:                                        );
1.563     raeburn  8526:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8527:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8528: 
                   8529:     my @srchins = ('crs','dom','alc','instd');
                   8530: 
                   8531:     foreach my $option (@srchins) {
                   8532:         # FIXME 'alc' option unavailable until 
                   8533:         #       loncreateuser::print_user_query_page()
                   8534:         #       has been completed.
                   8535:         next if ($option eq 'alc');
1.880     raeburn  8536:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8537:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8538:         if ($curr_selected{'srchin'} eq $option) {
                   8539:             $srchinsel .= ' 
                   8540:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8541:         } else {
                   8542:             $srchinsel .= '
                   8543:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8544:         }
1.555     raeburn  8545:     }
1.563     raeburn  8546:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8547: 
                   8548:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8549:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8550:         if ($curr_selected{'srchby'} eq $option) {
                   8551:             $srchbysel .= '
                   8552:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8553:         } else {
                   8554:             $srchbysel .= '
                   8555:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8556:          }
                   8557:     }
                   8558:     $srchbysel .= "\n  </select>\n";
                   8559: 
                   8560:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8561:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8562:         if ($curr_selected{'srchtype'} eq $option) {
                   8563:             $srchtypesel .= '
                   8564:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8565:         } else {
                   8566:             $srchtypesel .= '
                   8567:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8568:         }
                   8569:     }
                   8570:     $srchtypesel .= "\n  </select>\n";
                   8571: 
1.558     albertel 8572:     my ($newuserscript,$new_user_create);
1.994     raeburn  8573:     my $context_dom = $env{'request.role.domain'};
                   8574:     if ($context eq 'requestcrs') {
                   8575:         if ($env{'form.coursedom'} ne '') { 
                   8576:             $context_dom = $env{'form.coursedom'};
                   8577:         }
                   8578:     }
1.556     raeburn  8579:     if ($forcenewuser) {
1.576     raeburn  8580:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8581:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8582:                 if ($cancreate) {
                   8583:                     $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>';
                   8584:                 } else {
1.799     bisitz   8585:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8586:                     my %usertypetext = (
                   8587:                         official   => 'institutional',
                   8588:                         unofficial => 'non-institutional',
                   8589:                     );
1.799     bisitz   8590:                     $new_user_create = '<p class="LC_warning">'
                   8591:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8592:                                       .' '
                   8593:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8594:                                           ,'<a href="'.$helplink.'">','</a>')
                   8595:                                       .'</p><br />';
1.627     raeburn  8596:                 }
1.576     raeburn  8597:             }
                   8598:         }
                   8599: 
1.556     raeburn  8600:         $newuserscript = <<"ENDSCRIPT";
                   8601: 
1.570     raeburn  8602: function setSearch(createnew,callingForm) {
1.556     raeburn  8603:     if (createnew == 1) {
1.570     raeburn  8604:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8605:             if (callingForm.srchby.options[i].value == 'uname') {
                   8606:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8607:             }
                   8608:         }
1.570     raeburn  8609:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8610:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8611: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8612:             }
                   8613:         }
1.570     raeburn  8614:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8615:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8616:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8617:             }
                   8618:         }
1.570     raeburn  8619:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8620:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8621:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8622:             }
                   8623:         }
                   8624:     }
                   8625: }
                   8626: ENDSCRIPT
1.558     albertel 8627: 
1.556     raeburn  8628:     }
                   8629: 
1.555     raeburn  8630:     my $output = <<"END_BLOCK";
1.556     raeburn  8631: <script type="text/javascript">
1.824     bisitz   8632: // <![CDATA[
1.570     raeburn  8633: function validateEntry(callingForm) {
1.558     albertel 8634: 
1.556     raeburn  8635:     var checkok = 1;
1.558     albertel 8636:     var srchin;
1.570     raeburn  8637:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8638: 	if ( callingForm.srchin[i].checked ) {
                   8639: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8640: 	}
                   8641:     }
                   8642: 
1.570     raeburn  8643:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8644:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8645:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8646:     var srchterm =  callingForm.srchterm.value;
                   8647:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8648:     var msg = "";
                   8649: 
                   8650:     if (srchterm == "") {
                   8651:         checkok = 0;
1.571     raeburn  8652:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8653:     }
                   8654: 
1.569     raeburn  8655:     if (srchtype== 'begins') {
                   8656:         if (srchterm.length < 2) {
                   8657:             checkok = 0;
1.571     raeburn  8658:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8659:         }
                   8660:     }
                   8661: 
1.556     raeburn  8662:     if (srchtype== 'contains') {
                   8663:         if (srchterm.length < 3) {
                   8664:             checkok = 0;
1.571     raeburn  8665:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8666:         }
                   8667:     }
                   8668:     if (srchin == 'instd') {
                   8669:         if (srchdomain == '') {
                   8670:             checkok = 0;
1.571     raeburn  8671:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8672:         }
                   8673:     }
                   8674:     if (srchin == 'dom') {
                   8675:         if (srchdomain == '') {
                   8676:             checkok = 0;
1.571     raeburn  8677:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8678:         }
                   8679:     }
                   8680:     if (srchby == 'lastfirst') {
                   8681:         if (srchterm.indexOf(",") == -1) {
                   8682:             checkok = 0;
1.571     raeburn  8683:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8684:         }
                   8685:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8686:             checkok = 0;
1.571     raeburn  8687:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8688:         }
                   8689:     }
                   8690:     if (checkok == 0) {
1.571     raeburn  8691:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8692:         return;
                   8693:     }
                   8694:     if (checkok == 1) {
1.570     raeburn  8695:         callingForm.submit();
1.556     raeburn  8696:     }
                   8697: }
                   8698: 
                   8699: $newuserscript
                   8700: 
1.824     bisitz   8701: // ]]>
1.556     raeburn  8702: </script>
1.558     albertel 8703: 
                   8704: $new_user_create
                   8705: 
1.555     raeburn  8706: END_BLOCK
1.558     albertel 8707: 
1.876     raeburn  8708:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8709:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8710:                $domform.
                   8711:                &Apache::lonhtmlcommon::row_closure().
                   8712:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8713:                $srchbysel.
                   8714:                $srchtypesel. 
                   8715:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8716:                $srchinsel.
                   8717:                &Apache::lonhtmlcommon::row_closure(1). 
                   8718:                &Apache::lonhtmlcommon::end_pick_box().
                   8719:                '<br />';
1.555     raeburn  8720:     return $output;
                   8721: }
                   8722: 
1.612     raeburn  8723: sub user_rule_check {
1.615     raeburn  8724:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  8725:     my $response;
                   8726:     if (ref($usershash) eq 'HASH') {
                   8727:         foreach my $user (keys(%{$usershash})) {
                   8728:             my ($uname,$udom) = split(/:/,$user);
                   8729:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  8730:             my ($id,$newuser);
1.612     raeburn  8731:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  8732:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  8733:                 $id = $usershash->{$user}->{'id'};
                   8734:             }
                   8735:             my $inst_response;
                   8736:             if (ref($checks) eq 'HASH') {
                   8737:                 if (defined($checks->{'username'})) {
1.615     raeburn  8738:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  8739:                         &Apache::lonnet::get_instuser($udom,$uname);
                   8740:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  8741:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  8742:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   8743:                 }
1.615     raeburn  8744:             } else {
                   8745:                 ($inst_response,%{$inst_results->{$user}}) =
                   8746:                     &Apache::lonnet::get_instuser($udom,$uname);
                   8747:                 return;
1.612     raeburn  8748:             }
1.615     raeburn  8749:             if (!$got_rules->{$udom}) {
1.612     raeburn  8750:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   8751:                                                   ['usercreation'],$udom);
                   8752:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  8753:                     foreach my $item ('username','id') {
1.612     raeburn  8754:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   8755:                             $$curr_rules{$udom}{$item} = 
                   8756:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  8757:                         }
                   8758:                     }
                   8759:                 }
1.615     raeburn  8760:                 $got_rules->{$udom} = 1;  
1.585     raeburn  8761:             }
1.612     raeburn  8762:             foreach my $item (keys(%{$checks})) {
                   8763:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   8764:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   8765:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   8766:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   8767:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   8768:                                 if ($rule_check{$rule}) {
                   8769:                                     $$rulematch{$user}{$item} = $rule;
                   8770:                                     if ($inst_response eq 'ok') {
1.615     raeburn  8771:                                         if (ref($inst_results) eq 'HASH') {
                   8772:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   8773:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   8774:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   8775:                                                 }
1.612     raeburn  8776:                                             }
                   8777:                                         }
1.615     raeburn  8778:                                     }
                   8779:                                     last;
1.585     raeburn  8780:                                 }
                   8781:                             }
                   8782:                         }
                   8783:                     }
                   8784:                 }
                   8785:             }
                   8786:         }
                   8787:     }
1.612     raeburn  8788:     return;
                   8789: }
                   8790: 
                   8791: sub user_rule_formats {
                   8792:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   8793:     my %text = ( 
                   8794:                  'username' => 'Usernames',
                   8795:                  'id'       => 'IDs',
                   8796:                );
                   8797:     my $output;
                   8798:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   8799:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   8800:         if (@{$ruleorder} > 0) {
                   8801:             $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>';
                   8802:             foreach my $rule (@{$ruleorder}) {
                   8803:                 if (ref($curr_rules) eq 'ARRAY') {
                   8804:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   8805:                         if (ref($rules->{$rule}) eq 'HASH') {
                   8806:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   8807:                                         $rules->{$rule}{'desc'}.'</li>';
                   8808:                         }
                   8809:                     }
                   8810:                 }
                   8811:             }
                   8812:             $output .= '</ul>';
                   8813:         }
                   8814:     }
                   8815:     return $output;
                   8816: }
                   8817: 
                   8818: sub instrule_disallow_msg {
1.615     raeburn  8819:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8820:     my $response;
                   8821:     my %text = (
                   8822:                   item   => 'username',
                   8823:                   items  => 'usernames',
                   8824:                   match  => 'matches',
                   8825:                   do     => 'does',
                   8826:                   action => 'a username',
                   8827:                   one    => 'one',
                   8828:                );
                   8829:     if ($count > 1) {
                   8830:         $text{'item'} = 'usernames';
                   8831:         $text{'match'} ='match';
                   8832:         $text{'do'} = 'do';
                   8833:         $text{'action'} = 'usernames',
                   8834:         $text{'one'} = 'ones';
                   8835:     }
                   8836:     if ($checkitem eq 'id') {
                   8837:         $text{'items'} = 'IDs';
                   8838:         $text{'item'} = 'ID';
                   8839:         $text{'action'} = 'an ID';
1.615     raeburn  8840:         if ($count > 1) {
                   8841:             $text{'item'} = 'IDs';
                   8842:             $text{'action'} = 'IDs';
                   8843:         }
1.612     raeburn  8844:     }
1.674     bisitz   8845:     $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  8846:     if ($mode eq 'upload') {
                   8847:         if ($checkitem eq 'username') {
                   8848:             $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'}.");
                   8849:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8850:             $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  8851:         }
1.669     raeburn  8852:     } elsif ($mode eq 'selfcreate') {
                   8853:         if ($checkitem eq 'id') {
                   8854:             $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.");
                   8855:         }
1.615     raeburn  8856:     } else {
                   8857:         if ($checkitem eq 'username') {
                   8858:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8859:         } elsif ($checkitem eq 'id') {
                   8860:             $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.");
                   8861:         }
1.612     raeburn  8862:     }
                   8863:     return $response;
1.585     raeburn  8864: }
                   8865: 
1.624     raeburn  8866: sub personal_data_fieldtitles {
                   8867:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8868:                         id => 'Student/Employee ID',
                   8869:                         permanentemail => 'E-mail address',
                   8870:                         lastname => 'Last Name',
                   8871:                         firstname => 'First Name',
                   8872:                         middlename => 'Middle Name',
                   8873:                         generation => 'Generation',
                   8874:                         gen => 'Generation',
1.765     raeburn  8875:                         inststatus => 'Affiliation',
1.624     raeburn  8876:                    );
                   8877:     return %fieldtitles;
                   8878: }
                   8879: 
1.642     raeburn  8880: sub sorted_inst_types {
                   8881:     my ($dom) = @_;
                   8882:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8883:     my $othertitle = &mt('All users');
                   8884:     if ($env{'request.course.id'}) {
1.668     raeburn  8885:         $othertitle  = &mt('Any users');
1.642     raeburn  8886:     }
                   8887:     my @types;
                   8888:     if (ref($order) eq 'ARRAY') {
                   8889:         @types = @{$order};
                   8890:     }
                   8891:     if (@types == 0) {
                   8892:         if (ref($usertypes) eq 'HASH') {
                   8893:             @types = sort(keys(%{$usertypes}));
                   8894:         }
                   8895:     }
                   8896:     if (keys(%{$usertypes}) > 0) {
                   8897:         $othertitle = &mt('Other users');
                   8898:     }
                   8899:     return ($othertitle,$usertypes,\@types);
                   8900: }
                   8901: 
1.645     raeburn  8902: sub get_institutional_codes {
                   8903:     my ($settings,$allcourses,$LC_code) = @_;
                   8904: # Get complete list of course sections to update
                   8905:     my @currsections = ();
                   8906:     my @currxlists = ();
                   8907:     my $coursecode = $$settings{'internal.coursecode'};
                   8908: 
                   8909:     if ($$settings{'internal.sectionnums'} ne '') {
                   8910:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8911:     }
                   8912: 
                   8913:     if ($$settings{'internal.crosslistings'} ne '') {
                   8914:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8915:     }
                   8916: 
                   8917:     if (@currxlists > 0) {
                   8918:         foreach (@currxlists) {
                   8919:             if (m/^([^:]+):(\w*)$/) {
                   8920:                 unless (grep/^$1$/,@{$allcourses}) {
                   8921:                     push @{$allcourses},$1;
                   8922:                     $$LC_code{$1} = $2;
                   8923:                 }
                   8924:             }
                   8925:         }
                   8926:     }
                   8927:  
                   8928:     if (@currsections > 0) {
                   8929:         foreach (@currsections) {
                   8930:             if (m/^(\w+):(\w*)$/) {
                   8931:                 my $sec = $coursecode.$1;
                   8932:                 my $lc_sec = $2;
                   8933:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8934:                     push @{$allcourses},$sec;
                   8935:                     $$LC_code{$sec} = $lc_sec;
                   8936:                 }
                   8937:             }
                   8938:         }
                   8939:     }
                   8940:     return;
                   8941: }
                   8942: 
1.971     raeburn  8943: sub get_standard_codeitems {
                   8944:     return ('Year','Semester','Department','Number','Section');
                   8945: }
                   8946: 
1.112     bowersj2 8947: =pod
                   8948: 
1.780     raeburn  8949: =head1 Slot Helpers
                   8950: 
                   8951: =over 4
                   8952: 
                   8953: =item * sorted_slots()
                   8954: 
1.1040    raeburn  8955: Sorts an array of slot names in order of an optional sort key,
                   8956: default sort is by slot start time (earliest first). 
1.780     raeburn  8957: 
                   8958: Inputs:
                   8959: 
                   8960: =over 4
                   8961: 
                   8962: slotsarr  - Reference to array of unsorted slot names.
                   8963: 
                   8964: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8965: 
1.1040    raeburn  8966: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   8967: 
1.549     albertel 8968: =back
                   8969: 
1.780     raeburn  8970: Returns:
                   8971: 
                   8972: =over 4
                   8973: 
1.1040    raeburn  8974: sorted   - An array of slot names sorted by a specified sort key 
                   8975:            (default sort key is start time of the slot).
1.780     raeburn  8976: 
                   8977: =back
                   8978: 
                   8979: =cut
                   8980: 
                   8981: 
                   8982: sub sorted_slots {
1.1040    raeburn  8983:     my ($slotsarr,$slots,$sortkey) = @_;
                   8984:     if ($sortkey eq '') {
                   8985:         $sortkey = 'starttime';
                   8986:     }
1.780     raeburn  8987:     my @sorted;
                   8988:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8989:         @sorted =
                   8990:             sort {
                   8991:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  8992:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  8993:                      }
                   8994:                      if (ref($slots->{$a})) { return -1;}
                   8995:                      if (ref($slots->{$b})) { return 1;}
                   8996:                      return 0;
                   8997:                  } @{$slotsarr};
                   8998:     }
                   8999:     return @sorted;
                   9000: }
                   9001: 
1.1040    raeburn  9002: =pod
                   9003: 
                   9004: =item * get_future_slots()
                   9005: 
                   9006: Inputs:
                   9007: 
                   9008: =over 4
                   9009: 
                   9010: cnum - course number
                   9011: 
                   9012: cdom - course domain
                   9013: 
                   9014: now - current UNIX time
                   9015: 
                   9016: symb - optional symb
                   9017: 
                   9018: =back
                   9019: 
                   9020: Returns:
                   9021: 
                   9022: =over 4
                   9023: 
                   9024: sorted_reservable - ref to array of student_schedulable slots currently 
                   9025:                     reservable, ordered by end date of reservation period.
                   9026: 
                   9027: reservable_now - ref to hash of student_schedulable slots currently
                   9028:                  reservable.
                   9029: 
                   9030:     Keys in inner hash are:
                   9031:     (a) symb: either blank or symb to which slot use is restricted.
                   9032:     (b) endreserve: end date of reservation period. 
                   9033: 
                   9034: sorted_future - ref to array of student_schedulable slots reservable in
                   9035:                 the future, ordered by start date of reservation period.
                   9036: 
                   9037: future_reservable - ref to hash of student_schedulable slots reservable
                   9038:                     in the future.
                   9039: 
                   9040:     Keys in inner hash are:
                   9041:     (a) symb: either blank or symb to which slot use is restricted.
                   9042:     (b) startreserve:  start date of reservation period.
                   9043: 
                   9044: =back
                   9045: 
                   9046: =cut
                   9047: 
                   9048: sub get_future_slots {
                   9049:     my ($cnum,$cdom,$now,$symb) = @_;
                   9050:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   9051:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   9052:     foreach my $slot (keys(%slots)) {
                   9053:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   9054:         if ($symb) {
                   9055:             next if (($slots{$slot}->{'symb'} ne '') && 
                   9056:                      ($slots{$slot}->{'symb'} ne $symb));
                   9057:         }
                   9058:         if (($slots{$slot}->{'starttime'} > $now) &&
                   9059:             ($slots{$slot}->{'endtime'} > $now)) {
                   9060:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   9061:                 my $userallowed = 0;
                   9062:                 if ($slots{$slot}->{'allowedsections'}) {
                   9063:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   9064:                     if (!defined($env{'request.role.sec'})
                   9065:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   9066:                         $userallowed=1;
                   9067:                     } else {
                   9068:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   9069:                             $userallowed=1;
                   9070:                         }
                   9071:                     }
                   9072:                     unless ($userallowed) {
                   9073:                         if (defined($env{'request.course.groups'})) {
                   9074:                             my @groups = split(/:/,$env{'request.course.groups'});
                   9075:                             foreach my $group (@groups) {
                   9076:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   9077:                                     $userallowed=1;
                   9078:                                     last;
                   9079:                                 }
                   9080:                             }
                   9081:                         }
                   9082:                     }
                   9083:                 }
                   9084:                 if ($slots{$slot}->{'allowedusers'}) {
                   9085:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   9086:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   9087:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   9088:                         $userallowed = 1;
                   9089:                     }
                   9090:                 }
                   9091:                 next unless($userallowed);
                   9092:             }
                   9093:             my $startreserve = $slots{$slot}->{'startreserve'};
                   9094:             my $endreserve = $slots{$slot}->{'endreserve'};
                   9095:             my $symb = $slots{$slot}->{'symb'};
                   9096:             if (($startreserve < $now) &&
                   9097:                 (!$endreserve || $endreserve > $now)) {
                   9098:                 my $lastres = $endreserve;
                   9099:                 if (!$lastres) {
                   9100:                     $lastres = $slots{$slot}->{'starttime'};
                   9101:                 }
                   9102:                 $reservable_now{$slot} = {
                   9103:                                            symb       => $symb,
                   9104:                                            endreserve => $lastres
                   9105:                                          };
                   9106:             } elsif (($startreserve > $now) &&
                   9107:                      (!$endreserve || $endreserve > $startreserve)) {
                   9108:                 $future_reservable{$slot} = {
                   9109:                                               symb         => $symb,
                   9110:                                               startreserve => $startreserve
                   9111:                                             };
                   9112:             }
                   9113:         }
                   9114:     }
                   9115:     my @unsorted_reservable = keys(%reservable_now);
                   9116:     if (@unsorted_reservable > 0) {
                   9117:         @sorted_reservable = 
                   9118:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   9119:     }
                   9120:     my @unsorted_future = keys(%future_reservable);
                   9121:     if (@unsorted_future > 0) {
                   9122:         @sorted_future =
                   9123:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   9124:     }
                   9125:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   9126: }
1.780     raeburn  9127: 
                   9128: =pod
                   9129: 
1.1057    foxr     9130: =back
                   9131: 
1.549     albertel 9132: =head1 HTTP Helpers
                   9133: 
                   9134: =over 4
                   9135: 
1.648     raeburn  9136: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 9137: 
1.258     albertel 9138: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 9139: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 9140: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 9141: 
                   9142: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   9143: $possible_names is an ref to an array of form element names.  As an example:
                   9144: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 9145: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 9146: 
                   9147: =cut
1.1       albertel 9148: 
1.6       albertel 9149: sub get_unprocessed_cgi {
1.25      albertel 9150:   my ($query,$possible_names)= @_;
1.26      matthew  9151:   # $Apache::lonxml::debug=1;
1.356     albertel 9152:   foreach my $pair (split(/&/,$query)) {
                   9153:     my ($name, $value) = split(/=/,$pair);
1.369     www      9154:     $name = &unescape($name);
1.25      albertel 9155:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   9156:       $value =~ tr/+/ /;
                   9157:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 9158:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 9159:     }
1.16      harris41 9160:   }
1.6       albertel 9161: }
                   9162: 
1.112     bowersj2 9163: =pod
                   9164: 
1.648     raeburn  9165: =item * &cacheheader() 
1.112     bowersj2 9166: 
                   9167: returns cache-controlling header code
                   9168: 
                   9169: =cut
                   9170: 
1.7       albertel 9171: sub cacheheader {
1.258     albertel 9172:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 9173:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   9174:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 9175:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   9176:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 9177:     return $output;
1.7       albertel 9178: }
                   9179: 
1.112     bowersj2 9180: =pod
                   9181: 
1.648     raeburn  9182: =item * &no_cache($r) 
1.112     bowersj2 9183: 
                   9184: specifies header code to not have cache
                   9185: 
                   9186: =cut
                   9187: 
1.9       albertel 9188: sub no_cache {
1.216     albertel 9189:     my ($r) = @_;
                   9190:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 9191: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 9192:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   9193:     $r->no_cache(1);
                   9194:     $r->header_out("Expires" => $date);
                   9195:     $r->header_out("Pragma" => "no-cache");
1.123     www      9196: }
                   9197: 
                   9198: sub content_type {
1.181     albertel 9199:     my ($r,$type,$charset) = @_;
1.299     foxr     9200:     if ($r) {
                   9201: 	#  Note that printout.pl calls this with undef for $r.
                   9202: 	&no_cache($r);
                   9203:     }
1.258     albertel 9204:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 9205:     unless ($charset) {
                   9206: 	$charset=&Apache::lonlocal::current_encoding;
                   9207:     }
                   9208:     if ($charset) { $type.='; charset='.$charset; }
                   9209:     if ($r) {
                   9210: 	$r->content_type($type);
                   9211:     } else {
                   9212: 	print("Content-type: $type\n\n");
                   9213:     }
1.9       albertel 9214: }
1.25      albertel 9215: 
1.112     bowersj2 9216: =pod
                   9217: 
1.648     raeburn  9218: =item * &add_to_env($name,$value) 
1.112     bowersj2 9219: 
1.258     albertel 9220: adds $name to the %env hash with value
1.112     bowersj2 9221: $value, if $name already exists, the entry is converted to an array
                   9222: reference and $value is added to the array.
                   9223: 
                   9224: =cut
                   9225: 
1.25      albertel 9226: sub add_to_env {
                   9227:   my ($name,$value)=@_;
1.258     albertel 9228:   if (defined($env{$name})) {
                   9229:     if (ref($env{$name})) {
1.25      albertel 9230:       #already have multiple values
1.258     albertel 9231:       push(@{ $env{$name} },$value);
1.25      albertel 9232:     } else {
                   9233:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 9234:       my $first=$env{$name};
                   9235:       undef($env{$name});
                   9236:       push(@{ $env{$name} },$first,$value);
1.25      albertel 9237:     }
                   9238:   } else {
1.258     albertel 9239:     $env{$name}=$value;
1.25      albertel 9240:   }
1.31      albertel 9241: }
1.149     albertel 9242: 
                   9243: =pod
                   9244: 
1.648     raeburn  9245: =item * &get_env_multiple($name) 
1.149     albertel 9246: 
1.258     albertel 9247: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 9248: values may be defined and end up as an array ref.
                   9249: 
                   9250: returns an array of values
                   9251: 
                   9252: =cut
                   9253: 
                   9254: sub get_env_multiple {
                   9255:     my ($name) = @_;
                   9256:     my @values;
1.258     albertel 9257:     if (defined($env{$name})) {
1.149     albertel 9258:         # exists is it an array
1.258     albertel 9259:         if (ref($env{$name})) {
                   9260:             @values=@{ $env{$name} };
1.149     albertel 9261:         } else {
1.258     albertel 9262:             $values[0]=$env{$name};
1.149     albertel 9263:         }
                   9264:     }
                   9265:     return(@values);
                   9266: }
                   9267: 
1.660     raeburn  9268: sub ask_for_embedded_content {
                   9269:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  9270:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
                   9271:         %currsubfile,%unused);
                   9272:     my $counter = 0;
                   9273:     my $numnew = 0;
1.987     raeburn  9274:     my $numremref = 0;
                   9275:     my $numinvalid = 0;
                   9276:     my $numpathchg = 0;
                   9277:     my $numexisting = 0;
1.1071    raeburn  9278:     my $numunused = 0;
                   9279:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
                   9280:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
                   9281:     my $heading = &mt('Upload embedded files');
                   9282:     my $buttontext = &mt('Upload');
                   9283: 
1.984     raeburn  9284:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9285:         my $current_path='/';
                   9286:         if ($env{'form.currentpath'}) {
                   9287:             $current_path = $env{'form.currentpath'};
                   9288:         }
                   9289:         if ($actionurl eq '/adm/coursegrp_portfolio') {
                   9290:             $udom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9291:             $uname = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9292:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   9293:         } else {
                   9294:             $udom = $env{'user.domain'};
                   9295:             $uname = $env{'user.name'};
                   9296:             $url = '/userfiles/portfolio';
                   9297:         }
1.987     raeburn  9298:         $toplevel = $url.'/';
1.984     raeburn  9299:         $url .= $current_path;
                   9300:         $getpropath = 1;
1.987     raeburn  9301:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   9302:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      9303:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  9304:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  9305:         $toplevel = $url;
1.984     raeburn  9306:         if ($rest ne '') {
1.987     raeburn  9307:             $url .= $rest;
                   9308:         }
                   9309:     } elsif ($actionurl eq '/adm/coursedocs') {
                   9310:         if (ref($args) eq 'HASH') {
1.1071    raeburn  9311:             $url = $args->{'docs_url'};
                   9312:             $toplevel = $url;
                   9313:         }
                   9314:     } elsif ($actionurl eq '/adm/dependencies') {
                   9315:         if ($env{'request.course.id'} ne '') {
                   9316:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9317:             $cnum =  $env{'course.'.$env{'request.course.id'}.'.num'};
                   9318:             if (ref($args) eq 'HASH') {
                   9319:                 $url = $args->{'docs_url'};
                   9320:                 $title = $args->{'docs_title'};
                   9321:                 $toplevel = "/$url";
                   9322:                 ($path) =  
                   9323:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   9324:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   9325:                 $fileloc =~ s{^/}{};
                   9326:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   9327:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   9328:             }
1.987     raeburn  9329:         }
                   9330:     }
                   9331:     my $now = time();
                   9332:     foreach my $embed_file (keys(%{$allfiles})) {
                   9333:         my $absolutepath;
                   9334:         if ($embed_file =~ m{^\w+://}) {
                   9335:             $newfiles{$embed_file} = 1;
                   9336:             $mapping{$embed_file} = $embed_file;
                   9337:         } else {
                   9338:             if ($embed_file =~ m{^/}) {
                   9339:                 $absolutepath = $embed_file;
                   9340:                 $embed_file =~ s{^(/+)}{};
                   9341:             }
                   9342:             if ($embed_file =~ m{/}) {
                   9343:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9344:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9345:                 my $item = $fname;
                   9346:                 if ($path ne '') {
                   9347:                     $item = $path.'/'.$fname;
                   9348:                     $subdependencies{$path}{$fname} = 1;
                   9349:                 } else {
                   9350:                     $dependencies{$item} = 1;
                   9351:                 }
                   9352:                 if ($absolutepath) {
                   9353:                     $mapping{$item} = $absolutepath;
                   9354:                 } else {
                   9355:                     $mapping{$item} = $embed_file;
                   9356:                 }
                   9357:             } else {
                   9358:                 $dependencies{$embed_file} = 1;
                   9359:                 if ($absolutepath) {
                   9360:                     $mapping{$embed_file} = $absolutepath;
                   9361:                 } else {
                   9362:                     $mapping{$embed_file} = $embed_file;
                   9363:                 }
                   9364:             }
1.984     raeburn  9365:         }
                   9366:     }
1.1071    raeburn  9367:     my $dirptr = 16384;
1.984     raeburn  9368:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  9369:         $currsubfile{$path} = {};
1.984     raeburn  9370:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  9371:             my ($sublistref,$listerror) =
                   9372:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9373:             if (ref($sublistref) eq 'ARRAY') {
                   9374:                 foreach my $line (@{$sublistref}) {
                   9375:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  9376:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  9377:                 }
1.984     raeburn  9378:             }
1.987     raeburn  9379:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9380:             if (opendir(my $dir,$url.'/'.$path)) {
                   9381:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  9382:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   9383:             }
                   9384:         } elsif ($actionurl eq '/adm/dependencies') {
                   9385:             if ($env{'request.course.id'} ne '') {
                   9386:                 my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9387:                 if ($dir ne '') {
                   9388:                     my ($sublistref,$listerror) =
                   9389:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   9390:                     if (ref($sublistref) eq 'ARRAY') {
                   9391:                         foreach my $line (@{$sublistref}) {
                   9392:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   9393:                                 undef,$mtime)=split(/\&/,$line,12);
                   9394:                             unless (($testdir&$dirptr) ||
                   9395:                                     ($file_name =~ /^\.\.?$/)) {
                   9396:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   9397:                             }
                   9398:                         }
                   9399:                     }
                   9400:                 }
1.984     raeburn  9401:             }
                   9402:         }
                   9403:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  9404:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  9405:                 my $item = $path.'/'.$file;
                   9406:                 unless ($mapping{$item} eq $item) {
                   9407:                     $pathchanges{$item} = 1;
                   9408:                 }
                   9409:                 $existing{$item} = 1;
                   9410:                 $numexisting ++;
                   9411:             } else {
                   9412:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9413:             }
                   9414:         }
1.1071    raeburn  9415:         if ($actionurl eq '/adm/dependencies') {
                   9416:             foreach my $path (keys(%currsubfile)) {
                   9417:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   9418:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   9419:                          unless ($subdependencies{$path}{$file}) {
                   9420:                              $unused{$path.'/'.$file} = 1; 
                   9421:                          }
                   9422:                     }
                   9423:                 }
                   9424:             }
                   9425:         }
1.984     raeburn  9426:     }
1.987     raeburn  9427:     my %currfile;
1.984     raeburn  9428:     if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9429:         my ($dirlistref,$listerror) =
                   9430:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9431:         if (ref($dirlistref) eq 'ARRAY') {
                   9432:             foreach my $line (@{$dirlistref}) {
                   9433:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9434:                 $currfile{$file_name} = 1;
                   9435:             }
1.984     raeburn  9436:         }
1.987     raeburn  9437:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9438:         if (opendir(my $dir,$url)) {
1.987     raeburn  9439:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9440:             map {$currfile{$_} = 1;} @dir_list;
                   9441:         }
1.1071    raeburn  9442:     } elsif ($actionurl eq '/adm/dependencies') {
                   9443:         if ($env{'request.course.id'} ne '') {
                   9444:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9445:             if ($dir ne '') {
                   9446:                 my ($dirlistref,$listerror) =
                   9447:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   9448:                 if (ref($dirlistref) eq 'ARRAY') {
                   9449:                     foreach my $line (@{$dirlistref}) {
                   9450:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   9451:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   9452:                         unless (($testdir&$dirptr) ||
                   9453:                                 ($file_name =~ /^\.\.?$/)) {
                   9454:                             $currfile{$file_name} = [$size,$mtime];
                   9455:                         }
                   9456:                     }
                   9457:                 }
                   9458:             }
                   9459:         }
1.984     raeburn  9460:     }
                   9461:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  9462:         if (exists($currfile{$file})) {
1.987     raeburn  9463:             unless ($mapping{$file} eq $file) {
                   9464:                 $pathchanges{$file} = 1;
                   9465:             }
                   9466:             $existing{$file} = 1;
                   9467:             $numexisting ++;
                   9468:         } else {
1.984     raeburn  9469:             $newfiles{$file} = 1;
                   9470:         }
                   9471:     }
1.1071    raeburn  9472:     foreach my $file (keys(%currfile)) {
                   9473:         unless (($file eq $filename) ||
                   9474:                 ($file eq $filename.'.bak') ||
                   9475:                 ($dependencies{$file})) {
                   9476:             $unused{$file} = 1;
                   9477:         }
                   9478:     }
1.984     raeburn  9479:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  9480:         if ($actionurl eq '/adm/dependencies') {
                   9481:             next if ($embed_file =~ m{^\w+://});
                   9482:         }
1.660     raeburn  9483:         $upload_output .= &start_data_table_row().
1.1071    raeburn  9484:                           '<td><img src="'.&icon($embed_file).'" />&nbsp;'.
                   9485:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  9486:         unless ($mapping{$embed_file} eq $embed_file) {
                   9487:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
                   9488:         }
                   9489:         $upload_output .= '</td><td>';
1.1071    raeburn  9490:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.660     raeburn  9491:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
1.987     raeburn  9492:             $numremref++;
1.660     raeburn  9493:         } elsif ($args->{'error_on_invalid_names'}
                   9494:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   9495: 
1.987     raeburn  9496:             $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>';
                   9497:             $numinvalid++;
1.660     raeburn  9498:         } else {
1.1071    raeburn  9499:             $upload_output .= &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  9500:                                                      $embed_file,\%mapping,
1.1071    raeburn  9501:                                                      $allfiles,$codebase,'upload');
                   9502:             $counter ++;
                   9503:             $numnew ++;
1.987     raeburn  9504:         }
                   9505:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9506:     }
                   9507:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  9508:         if ($actionurl eq '/adm/dependencies') {
                   9509:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   9510:             $modify_output .= &start_data_table_row().
                   9511:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   9512:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   9513:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   9514:                               '<td>'.$size.'</td>'.
                   9515:                               '<td>'.$mtime.'</td>'.
                   9516:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   9517:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   9518:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   9519:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   9520:                               &embedded_file_element('upload_embedded',$counter,
                   9521:                                                      $embed_file,\%mapping,
                   9522:                                                      $allfiles,$codebase,'modify').
                   9523:                               '</div></td>'.
                   9524:                               &end_data_table_row()."\n";
                   9525:             $counter ++;
                   9526:         } else {
                   9527:             $upload_output .= &start_data_table_row().
                   9528:                               '<td><span class="LC_filename">'.$embed_file.'</span></td>';
                   9529:                               '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'.
                   9530:                               &Apache::loncommon::end_data_table_row()."\n";
                   9531:         }
                   9532:     }
                   9533:     my $delidx = $counter;
                   9534:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   9535:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   9536:         $delete_output .= &start_data_table_row().
                   9537:                           '<td><img src="'.&icon($oldfile).'" />'.
                   9538:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   9539:                           '<td>'.$size.'</td>'.
                   9540:                           '<td>'.$mtime.'</td>'.
                   9541:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   9542:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   9543:                           &embedded_file_element('upload_embedded',$delidx,
                   9544:                                                  $oldfile,\%mapping,$allfiles,
                   9545:                                                  $codebase,'delete').'</td>'.
                   9546:                           &end_data_table_row()."\n"; 
                   9547:         $numunused ++;
                   9548:         $delidx ++;
1.987     raeburn  9549:     }
                   9550:     if ($upload_output) {
                   9551:         $upload_output = &start_data_table().
                   9552:                          $upload_output.
                   9553:                          &end_data_table()."\n";
                   9554:     }
1.1071    raeburn  9555:     if ($modify_output) {
                   9556:         $modify_output = &start_data_table().
                   9557:                          &start_data_table_header_row().
                   9558:                          '<th>'.&mt('File').'</th>'.
                   9559:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9560:                          '<th>'.&mt('Modified').'</th>'.
                   9561:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   9562:                          &end_data_table_header_row().
                   9563:                          $modify_output.
                   9564:                          &end_data_table()."\n";
                   9565:     }
                   9566:     if ($delete_output) {
                   9567:         $delete_output = &start_data_table().
                   9568:                          &start_data_table_header_row().
                   9569:                          '<th>'.&mt('File').'</th>'.
                   9570:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9571:                          '<th>'.&mt('Modified').'</th>'.
                   9572:                          '<th>'.&mt('Delete?').'</th>'.
                   9573:                          &end_data_table_header_row().
                   9574:                          $delete_output.
                   9575:                          &end_data_table()."\n";
                   9576:     }
1.987     raeburn  9577:     my $applies = 0;
                   9578:     if ($numremref) {
                   9579:         $applies ++;
                   9580:     }
                   9581:     if ($numinvalid) {
                   9582:         $applies ++;
                   9583:     }
                   9584:     if ($numexisting) {
                   9585:         $applies ++;
                   9586:     }
1.1071    raeburn  9587:     if ($counter || $numunused) {
1.987     raeburn  9588:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9589:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  9590:                   $state.'<h3>'.$heading.'</h3>'; 
                   9591:         if ($actionurl eq '/adm/dependencies') {
                   9592:             if ($numnew) {
                   9593:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   9594:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   9595:                            $upload_output.'<br />'."\n";
                   9596:             }
                   9597:             if ($numexisting) {
                   9598:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   9599:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   9600:                            $modify_output.'<br />'."\n";
                   9601:                            $buttontext = &mt('Save changes');
                   9602:             }
                   9603:             if ($numunused) {
                   9604:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   9605:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   9606:                            $delete_output.'<br />'."\n";
                   9607:                            $buttontext = &mt('Save changes');
                   9608:             }
                   9609:         } else {
                   9610:             $output .= $upload_output.'<br />'."\n";
                   9611:         }
                   9612:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   9613:                    $counter.'" />'."\n";
                   9614:         if ($actionurl eq '/adm/dependencies') { 
                   9615:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   9616:                        $numnew.'" />'."\n";
                   9617:         } elsif ($actionurl eq '') {
1.987     raeburn  9618:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9619:         }
                   9620:     } elsif ($applies) {
                   9621:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9622:         if ($applies > 1) {
                   9623:             $output .=  
                   9624:                 &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>';
                   9625:             if ($numremref) {
                   9626:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9627:             }
                   9628:             if ($numinvalid) {
                   9629:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9630:             }
                   9631:             if ($numexisting) {
                   9632:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9633:             }
                   9634:             $output .= '</ul><br />';
                   9635:         } elsif ($numremref) {
                   9636:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   9637:         } elsif ($numinvalid) {
                   9638:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   9639:         } elsif ($numexisting) {
                   9640:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   9641:         }
                   9642:         $output .= $upload_output.'<br />';
                   9643:     }
                   9644:     my ($pathchange_output,$chgcount);
1.1071    raeburn  9645:     $chgcount = $counter;
1.987     raeburn  9646:     if (keys(%pathchanges) > 0) {
                   9647:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  9648:             if ($counter) {
1.987     raeburn  9649:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   9650:                                                   $embed_file,\%mapping,
1.1071    raeburn  9651:                                                   $allfiles,$codebase,'change');
1.987     raeburn  9652:             } else {
                   9653:                 $pathchange_output .= 
                   9654:                     &start_data_table_row().
                   9655:                     '<td><input type ="checkbox" name="namechange" value="'.
                   9656:                     $chgcount.'" checked="checked" /></td>'.
                   9657:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   9658:                     '<td>'.$embed_file.
                   9659:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  9660:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  9661:                     '</td>'.&end_data_table_row();
1.660     raeburn  9662:             }
1.987     raeburn  9663:             $numpathchg ++;
                   9664:             $chgcount ++;
1.660     raeburn  9665:         }
                   9666:     }
1.1071    raeburn  9667:     if ($counter) {
1.987     raeburn  9668:         if ($numpathchg) {
                   9669:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   9670:                        $numpathchg.'" />'."\n";
                   9671:         }
                   9672:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   9673:             ($actionurl eq '/adm/imsimport')) {
                   9674:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   9675:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   9676:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  9677:         } elsif ($actionurl eq '/adm/dependencies') {
                   9678:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  9679:         }
1.1071    raeburn  9680:         $output .=  '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  9681:     } elsif ($numpathchg) {
                   9682:         my %pathchange = ();
                   9683:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   9684:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9685:             $output .= '<p>'.&mt('or').'</p>'; 
                   9686:         } 
                   9687:     }
1.1071    raeburn  9688:     return ($output,$counter,$numpathchg);
1.987     raeburn  9689: }
                   9690: 
                   9691: sub embedded_file_element {
1.1071    raeburn  9692:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  9693:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   9694:                    (ref($codebase) eq 'HASH'));
                   9695:     my $output;
1.1071    raeburn  9696:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  9697:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   9698:     }
                   9699:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   9700:                &escape($embed_file).'" />';
                   9701:     unless (($context eq 'upload_embedded') && 
                   9702:             ($mapping->{$embed_file} eq $embed_file)) {
                   9703:         $output .='
                   9704:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   9705:     }
                   9706:     my $attrib;
                   9707:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   9708:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   9709:     }
                   9710:     $output .=
                   9711:         "\n\t\t".
                   9712:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   9713:         $attrib.'" />';
                   9714:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   9715:         $output .=
                   9716:             "\n\t\t".
                   9717:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   9718:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  9719:     }
1.987     raeburn  9720:     return $output;
1.660     raeburn  9721: }
                   9722: 
1.1071    raeburn  9723: sub get_dependency_details {
                   9724:     my ($currfile,$currsubfile,$embed_file) = @_;
                   9725:     my ($size,$mtime,$showsize,$showmtime);
                   9726:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   9727:         if ($embed_file =~ m{/}) {
                   9728:             my ($path,$fname) = split(/\//,$embed_file);
                   9729:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   9730:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   9731:             }
                   9732:         } else {
                   9733:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   9734:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   9735:             }
                   9736:         }
                   9737:         $showsize = $size/1024.0;
                   9738:         $showsize = sprintf("%.1f",$showsize);
                   9739:         if ($mtime > 0) {
                   9740:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   9741:         }
                   9742:     }
                   9743:     return ($showsize,$showmtime);
                   9744: }
                   9745: 
                   9746: sub ask_embedded_js {
                   9747:     return <<"END";
                   9748: <script type="text/javascript"">
                   9749: // <![CDATA[
                   9750: function toggleBrowse(counter) {
                   9751:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   9752:     var fileid = document.getElementById('embedded_item_'+counter);
                   9753:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   9754:     if (chkboxid.checked == true) {
                   9755:         uploaddivid.style.display='block';
                   9756:     } else {
                   9757:         uploaddivid.style.display='none';
                   9758:         fileid.value = '';
                   9759:     }
                   9760: }
                   9761: // ]]>
                   9762: </script>
                   9763: 
                   9764: END
                   9765: }
                   9766: 
1.661     raeburn  9767: sub upload_embedded {
                   9768:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  9769:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   9770:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  9771:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   9772:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   9773:         my $orig_uploaded_filename =
                   9774:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  9775:         foreach my $type ('orig','ref','attrib','codebase') {
                   9776:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   9777:                 $env{'form.embedded_'.$type.'_'.$i} =
                   9778:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   9779:             }
                   9780:         }
1.661     raeburn  9781:         my ($path,$fname) =
                   9782:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   9783:         # no path, whole string is fname
                   9784:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   9785:         $fname = &Apache::lonnet::clean_filename($fname);
                   9786:         # See if there is anything left
                   9787:         next if ($fname eq '');
                   9788: 
                   9789:         # Check if file already exists as a file or directory.
                   9790:         my ($state,$msg);
                   9791:         if ($context eq 'portfolio') {
                   9792:             my $port_path = $dirpath;
                   9793:             if ($group ne '') {
                   9794:                 $port_path = "groups/$group/$port_path";
                   9795:             }
1.987     raeburn  9796:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   9797:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  9798:                                               $dir_root,$port_path,$disk_quota,
                   9799:                                               $current_disk_usage,$uname,$udom);
                   9800:             if ($state eq 'will_exceed_quota'
1.984     raeburn  9801:                 || $state eq 'file_locked') {
1.661     raeburn  9802:                 $output .= $msg;
                   9803:                 next;
                   9804:             }
                   9805:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   9806:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   9807:             if ($state eq 'exists') {
                   9808:                 $output .= $msg;
                   9809:                 next;
                   9810:             }
                   9811:         }
                   9812:         # Check if extension is valid
                   9813:         if (($fname =~ /\.(\w+)$/) &&
                   9814:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  9815:             $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  9816:             next;
                   9817:         } elsif (($fname =~ /\.(\w+)$/) &&
                   9818:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  9819:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  9820:             next;
                   9821:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.987     raeburn  9822:             $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  9823:             next;
                   9824:         }
                   9825:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   9826:         if ($context eq 'portfolio') {
1.984     raeburn  9827:             my $result;
                   9828:             if ($state eq 'existingfile') {
                   9829:                 $result=
                   9830:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.987     raeburn  9831:                                                     $dirpath.$env{'form.currentpath'}.$path);
1.661     raeburn  9832:             } else {
1.984     raeburn  9833:                 $result=
                   9834:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  9835:                                                     $dirpath.
                   9836:                                                     $env{'form.currentpath'}.$path);
1.984     raeburn  9837:                 if ($result !~ m|^/uploaded/|) {
                   9838:                     $output .= '<span class="LC_error">'
                   9839:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9840:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9841:                                .'</span><br />';
                   9842:                     next;
                   9843:                 } else {
1.987     raeburn  9844:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9845:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  9846:                 }
1.661     raeburn  9847:             }
1.987     raeburn  9848:         } elsif ($context eq 'coursedoc') {
                   9849:             my $result =
                   9850:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc',
                   9851:                                                 $dirpath.'/'.$path);
                   9852:             if ($result !~ m|^/uploaded/|) {
                   9853:                 $output .= '<span class="LC_error">'
                   9854:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   9855:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   9856:                            .'</span><br />';
                   9857:                     next;
                   9858:             } else {
                   9859:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9860:                            $path.$fname.'</span>').'<br />';
                   9861:             }
1.661     raeburn  9862:         } else {
                   9863: # Save the file
                   9864:             my $target = $env{'form.embedded_item_'.$i};
                   9865:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   9866:             my $dest = $fullpath.$fname;
                   9867:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  9868:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  9869:             my $count;
                   9870:             my $filepath = $dir_root;
1.1027    raeburn  9871:             foreach my $subdir (@parts) {
                   9872:                 $filepath .= "/$subdir";
                   9873:                 if (!-e $filepath) {
1.661     raeburn  9874:                     mkdir($filepath,0770);
                   9875:                 }
                   9876:             }
                   9877:             my $fh;
                   9878:             if (!open($fh,'>'.$dest)) {
                   9879:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   9880:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  9881:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   9882:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  9883:                            '</span><br />';
                   9884:             } else {
                   9885:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   9886:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   9887:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  9888:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   9889:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  9890:                               '</span><br />';
                   9891:                 } else {
1.987     raeburn  9892:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   9893:                                $url.'</span>').'<br />';
                   9894:                     unless ($context eq 'testbank') {
                   9895:                         $footer .= &mt('View embedded file: [_1]',
                   9896:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   9897:                     }
                   9898:                 }
                   9899:                 close($fh);
                   9900:             }
                   9901:         }
                   9902:         if ($env{'form.embedded_ref_'.$i}) {
                   9903:             $pathchange{$i} = 1;
                   9904:         }
                   9905:     }
                   9906:     if ($output) {
                   9907:         $output = '<p>'.$output.'</p>';
                   9908:     }
                   9909:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   9910:     $returnflag = 'ok';
1.1071    raeburn  9911:     my $numpathchgs = scalar(keys(%pathchange));
                   9912:     if ($numpathchgs > 0) {
1.987     raeburn  9913:         if ($context eq 'portfolio') {
                   9914:             $output .= '<p>'.&mt('or').'</p>';
                   9915:         } elsif ($context eq 'testbank') {
1.1071    raeburn  9916:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   9917:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  9918:             $returnflag = 'modify_orightml';
                   9919:         }
                   9920:     }
1.1071    raeburn  9921:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  9922: }
                   9923: 
                   9924: sub modify_html_form {
                   9925:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   9926:     my $end = 0;
                   9927:     my $modifyform;
                   9928:     if ($context eq 'upload_embedded') {
                   9929:         return unless (ref($pathchange) eq 'HASH');
                   9930:         if ($env{'form.number_embedded_items'}) {
                   9931:             $end += $env{'form.number_embedded_items'};
                   9932:         }
                   9933:         if ($env{'form.number_pathchange_items'}) {
                   9934:             $end += $env{'form.number_pathchange_items'};
                   9935:         }
                   9936:         if ($end) {
                   9937:             for (my $i=0; $i<$end; $i++) {
                   9938:                 if ($i < $env{'form.number_embedded_items'}) {
                   9939:                     next unless($pathchange->{$i});
                   9940:                 }
                   9941:                 $modifyform .=
                   9942:                     &start_data_table_row().
                   9943:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   9944:                     'checked="checked" /></td>'.
                   9945:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   9946:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   9947:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   9948:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   9949:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   9950:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   9951:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   9952:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   9953:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   9954:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   9955:                     &end_data_table_row();
1.1071    raeburn  9956:             }
1.987     raeburn  9957:         }
                   9958:     } else {
                   9959:         $modifyform = $pathchgtable;
                   9960:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   9961:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   9962:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   9963:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   9964:         }
                   9965:     }
                   9966:     if ($modifyform) {
1.1071    raeburn  9967:         if ($actionurl eq '/adm/dependencies') {
                   9968:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   9969:         }
1.987     raeburn  9970:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   9971:                '<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".
                   9972:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   9973:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   9974:                '</ol></p>'."\n".'<p>'.
                   9975:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   9976:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   9977:                &start_data_table()."\n".
                   9978:                &start_data_table_header_row().
                   9979:                '<th>'.&mt('Change?').'</th>'.
                   9980:                '<th>'.&mt('Current reference').'</th>'.
                   9981:                '<th>'.&mt('Required reference').'</th>'.
                   9982:                &end_data_table_header_row()."\n".
                   9983:                $modifyform.
                   9984:                &end_data_table().'<br />'."\n".$hiddenstate.
                   9985:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   9986:                '</form>'."\n";
                   9987:     }
                   9988:     return;
                   9989: }
                   9990: 
                   9991: sub modify_html_refs {
                   9992:     my ($context,$dirpath,$uname,$udom,$dir_root) = @_;
                   9993:     my $container;
                   9994:     if ($context eq 'portfolio') {
                   9995:         $container = $env{'form.container'};
                   9996:     } elsif ($context eq 'coursedoc') {
                   9997:         $container = $env{'form.primaryurl'};
1.1071    raeburn  9998:     } elsif ($context eq 'manage_dependencies') {
                   9999:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   10000:         $container = "/$container";
1.987     raeburn  10001:     } else {
1.1027    raeburn  10002:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  10003:     }
                   10004:     my (%allfiles,%codebase,$output,$content);
                   10005:     my @changes = &get_env_multiple('form.namechange');
1.1071    raeburn  10006:     unless (@changes > 0) {
                   10007:         if (wantarray) {
                   10008:             return ('',0,0); 
                   10009:         } else {
                   10010:             return;
                   10011:         }
                   10012:     }
                   10013:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
                   10014:         ($context eq 'manage_dependencies')) {
                   10015:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   10016:             if (wantarray) {
                   10017:                 return ('',0,0);
                   10018:             } else {
                   10019:                 return;
                   10020:             }
                   10021:         } 
1.987     raeburn  10022:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  10023:         if ($content eq '-1') {
                   10024:             if (wantarray) {
                   10025:                 return ('',0,0);
                   10026:             } else {
                   10027:                 return;
                   10028:             }
                   10029:         }
1.987     raeburn  10030:     } else {
1.1071    raeburn  10031:         unless ($container =~ /^\Q$dir_root\E/) {
                   10032:             if (wantarray) {
                   10033:                 return ('',0,0);
                   10034:             } else {
                   10035:                 return;
                   10036:             }
                   10037:         } 
1.987     raeburn  10038:         if (open(my $fh,"<$container")) {
                   10039:             $content = join('', <$fh>);
                   10040:             close($fh);
                   10041:         } else {
1.1071    raeburn  10042:             if (wantarray) {
                   10043:                 return ('',0,0);
                   10044:             } else {
                   10045:                 return;
                   10046:             }
1.987     raeburn  10047:         }
                   10048:     }
                   10049:     my ($count,$codebasecount) = (0,0);
                   10050:     my $mm = new File::MMagic;
                   10051:     my $mime_type = $mm->checktype_contents($content);
                   10052:     if ($mime_type eq 'text/html') {
                   10053:         my $parse_result = 
                   10054:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   10055:                                                     \%codebase,\$content);
                   10056:         if ($parse_result eq 'ok') {
                   10057:             foreach my $i (@changes) {
                   10058:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   10059:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   10060:                 if ($allfiles{$ref}) {
                   10061:                     my $newname =  $orig;
                   10062:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  10063:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  10064:                     if ($attrib_regexp =~ /:/) {
                   10065:                         $attrib_regexp =~ s/\:/|/g;
                   10066:                     }
                   10067:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   10068:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   10069:                         $count += $numchg;
                   10070:                     }
                   10071:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  10072:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  10073:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   10074:                         $codebasecount ++;
                   10075:                     }
                   10076:                 }
                   10077:             }
                   10078:             if ($count || $codebasecount) {
                   10079:                 my $saveresult;
1.1071    raeburn  10080:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
                   10081:                     ($context eq 'manage_dependencies')) {
1.987     raeburn  10082:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   10083:                     if ($url eq $container) {
                   10084:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   10085:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10086:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  10087:                                             $fname.'</span>').'</p>';
1.987     raeburn  10088:                     } else {
                   10089:                          $output = '<p class="LC_error">'.
                   10090:                                    &mt('Error: update failed for: [_1].',
                   10091:                                    '<span class="LC_filename">'.
                   10092:                                    $container.'</span>').'</p>';
                   10093:                     }
                   10094:                 } else {
                   10095:                     if (open(my $fh,">$container")) {
                   10096:                         print $fh $content;
                   10097:                         close($fh);
                   10098:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10099:                                   $count,'<span class="LC_filename">'.
                   10100:                                   $container.'</span>').'</p>';
1.661     raeburn  10101:                     } else {
1.987     raeburn  10102:                          $output = '<p class="LC_error">'.
                   10103:                                    &mt('Error: could not update [_1].',
                   10104:                                    '<span class="LC_filename">'.
                   10105:                                    $container.'</span>').'</p>';
1.661     raeburn  10106:                     }
                   10107:                 }
                   10108:             }
1.987     raeburn  10109:         } else {
                   10110:             &logthis('Failed to parse '.$container.
                   10111:                      ' to modify references: '.$parse_result);
1.661     raeburn  10112:         }
                   10113:     }
1.1071    raeburn  10114:     if (wantarray) {
                   10115:         return ($output,$count,$codebasecount);
                   10116:     } else {
                   10117:         return $output;
                   10118:     }
1.661     raeburn  10119: }
                   10120: 
                   10121: sub check_for_existing {
                   10122:     my ($path,$fname,$element) = @_;
                   10123:     my ($state,$msg);
                   10124:     if (-d $path.'/'.$fname) {
                   10125:         $state = 'exists';
                   10126:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10127:     } elsif (-e $path.'/'.$fname) {
                   10128:         $state = 'exists';
                   10129:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10130:     }
                   10131:     if ($state eq 'exists') {
                   10132:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   10133:     }
                   10134:     return ($state,$msg);
                   10135: }
                   10136: 
                   10137: sub check_for_upload {
                   10138:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   10139:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  10140:     my $filesize = length($env{'form.'.$element});
                   10141:     if (!$filesize) {
                   10142:         my $msg = '<span class="LC_error">'.
                   10143:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   10144:                       '<span class="LC_filename">'.$fname.'</span>',
                   10145:                       $filesize).'<br />'.
1.1007    raeburn  10146:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  10147:                   '</span>';
                   10148:         return ('zero_bytes',$msg);
                   10149:     }
                   10150:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  10151:     my $getpropath = 1;
1.1021    raeburn  10152:     my ($dirlistref,$listerror) =
                   10153:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  10154:     my $found_file = 0;
                   10155:     my $locked_file = 0;
1.991     raeburn  10156:     my @lockers;
                   10157:     my $navmap;
                   10158:     if ($env{'request.course.id'}) {
                   10159:         $navmap = Apache::lonnavmaps::navmap->new();
                   10160:     }
1.1021    raeburn  10161:     if (ref($dirlistref) eq 'ARRAY') {
                   10162:         foreach my $line (@{$dirlistref}) {
                   10163:             my ($file_name,$rest)=split(/\&/,$line,2);
                   10164:             if ($file_name eq $fname){
                   10165:                 $file_name = $path.$file_name;
                   10166:                 if ($group ne '') {
                   10167:                     $file_name = $group.$file_name;
                   10168:                 }
                   10169:                 $found_file = 1;
                   10170:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   10171:                     foreach my $lock (@lockers) {
                   10172:                         if (ref($lock) eq 'ARRAY') {
                   10173:                             my ($symb,$crsid) = @{$lock};
                   10174:                             if ($crsid eq $env{'request.course.id'}) {
                   10175:                                 if (ref($navmap)) {
                   10176:                                     my $res = $navmap->getBySymb($symb);
                   10177:                                     foreach my $part (@{$res->parts()}) { 
                   10178:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   10179:                                         unless (($slot_status == $res->RESERVED) ||
                   10180:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   10181:                                             $locked_file = 1;
                   10182:                                         }
1.991     raeburn  10183:                                     }
1.1021    raeburn  10184:                                 } else {
                   10185:                                     $locked_file = 1;
1.991     raeburn  10186:                                 }
                   10187:                             } else {
                   10188:                                 $locked_file = 1;
                   10189:                             }
                   10190:                         }
1.1021    raeburn  10191:                    }
                   10192:                 } else {
                   10193:                     my @info = split(/\&/,$rest);
                   10194:                     my $currsize = $info[6]/1000;
                   10195:                     if ($currsize < $filesize) {
                   10196:                         my $extra = $filesize - $currsize;
                   10197:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   10198:                             my $msg = '<span class="LC_error">'.
                   10199:                                       &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.',
                   10200:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   10201:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   10202:                                                    $disk_quota,$current_disk_usage);
                   10203:                             return ('will_exceed_quota',$msg);
                   10204:                         }
1.984     raeburn  10205:                     }
                   10206:                 }
1.661     raeburn  10207:             }
                   10208:         }
                   10209:     }
                   10210:     if (($current_disk_usage + $filesize) > $disk_quota){
                   10211:         my $msg = '<span class="LC_error">'.
                   10212:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   10213:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   10214:         return ('will_exceed_quota',$msg);
                   10215:     } elsif ($found_file) {
                   10216:         if ($locked_file) {
                   10217:             my $msg = '<span class="LC_error">';
                   10218:             $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>');
                   10219:             $msg .= '</span><br />';
                   10220:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   10221:             return ('file_locked',$msg);
                   10222:         } else {
                   10223:             my $msg = '<span class="LC_error">';
1.984     raeburn  10224:             $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  10225:             $msg .= '</span>';
1.984     raeburn  10226:             return ('existingfile',$msg);
1.661     raeburn  10227:         }
                   10228:     }
                   10229: }
                   10230: 
1.987     raeburn  10231: sub check_for_traversal {
                   10232:     my ($path,$url,$toplevel) = @_;
                   10233:     my @parts=split(/\//,$path);
                   10234:     my $cleanpath;
                   10235:     my $fullpath = $url;
                   10236:     for (my $i=0;$i<@parts;$i++) {
                   10237:         next if ($parts[$i] eq '.');
                   10238:         if ($parts[$i] eq '..') {
                   10239:             $fullpath =~ s{([^/]+/)$}{};
                   10240:         } else {
                   10241:             $fullpath .= $parts[$i].'/';
                   10242:         }
                   10243:     }
                   10244:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   10245:         $cleanpath = $1;
                   10246:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   10247:         my $curr_toprel = $1;
                   10248:         my @parts = split(/\//,$curr_toprel);
                   10249:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   10250:         my @urlparts = split(/\//,$url_toprel);
                   10251:         my $doubledots;
                   10252:         my $startdiff = -1;
                   10253:         for (my $i=0; $i<@urlparts; $i++) {
                   10254:             if ($startdiff == -1) {
                   10255:                 unless ($urlparts[$i] eq $parts[$i]) {
                   10256:                     $startdiff = $i;
                   10257:                     $doubledots .= '../';
                   10258:                 }
                   10259:             } else {
                   10260:                 $doubledots .= '../';
                   10261:             }
                   10262:         }
                   10263:         if ($startdiff > -1) {
                   10264:             $cleanpath = $doubledots;
                   10265:             for (my $i=$startdiff; $i<@parts; $i++) {
                   10266:                 $cleanpath .= $parts[$i].'/';
                   10267:             }
                   10268:         }
                   10269:     }
                   10270:     $cleanpath =~ s{(/)$}{};
                   10271:     return $cleanpath;
                   10272: }
1.31      albertel 10273: 
1.1053    raeburn  10274: sub is_archive_file {
                   10275:     my ($mimetype) = @_;
                   10276:     if (($mimetype eq 'application/octet-stream') ||
                   10277:         ($mimetype eq 'application/x-stuffit') ||
                   10278:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   10279:         return 1;
                   10280:     }
                   10281:     return;
                   10282: }
                   10283: 
                   10284: sub decompress_form {
1.1065    raeburn  10285:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  10286:     my %lt = &Apache::lonlocal::texthash (
                   10287:         this => 'This file is an archive file.',
1.1067    raeburn  10288:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  10289:         itsc => 'Its contents are as follows:',
1.1053    raeburn  10290:         youm => 'You may wish to extract its contents.',
                   10291:         extr => 'Extract contents',
1.1067    raeburn  10292:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   10293:         proa => 'Process automatically?',
1.1053    raeburn  10294:         yes  => 'Yes',
                   10295:         no   => 'No',
1.1067    raeburn  10296:         fold => 'Title for folder containing movie',
                   10297:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  10298:     );
1.1065    raeburn  10299:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  10300:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  10301:     my $info = &list_archive_contents($fileloc,\@paths);
                   10302:     if (@paths) {
                   10303:         foreach my $path (@paths) {
                   10304:             $path =~ s{^/}{};
1.1067    raeburn  10305:             if ($path =~ m{^([^/]+)/$}) {
                   10306:                 $topdir = $1;
                   10307:             }
1.1065    raeburn  10308:             if ($path =~ m{^([^/]+)/}) {
                   10309:                 $toplevel{$1} = $path;
                   10310:             } else {
                   10311:                 $toplevel{$path} = $path;
                   10312:             }
                   10313:         }
                   10314:     }
1.1067    raeburn  10315:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   10316:         my @camtasia = ("$topdir/","$topdir/index.html",
                   10317:                         "$topdir/media/",
                   10318:                         "$topdir/media/$topdir.mp4",
                   10319:                         "$topdir/media/FirstFrame.png",
                   10320:                         "$topdir/media/player.swf",
                   10321:                         "$topdir/media/swfobject.js",
                   10322:                         "$topdir/media/expressInstall.swf");
                   10323:         my @diffs = &compare_arrays(\@paths,\@camtasia);
                   10324:         if (@diffs == 0) {
                   10325:             $is_camtasia = 1;
                   10326:         }
                   10327:     }
                   10328:     my $output;
                   10329:     if ($is_camtasia) {
                   10330:         $output = <<"ENDCAM";
                   10331: <script type="text/javascript" language="Javascript">
                   10332: // <![CDATA[
                   10333: 
                   10334: function camtasiaToggle() {
                   10335:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   10336:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
                   10337:             if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
                   10338: 
                   10339:                 document.getElementById('camtasia_titles').style.display='block';
                   10340:             } else {
                   10341:                 document.getElementById('camtasia_titles').style.display='none';
                   10342:             }
                   10343:         }
                   10344:     }
                   10345:     return;
                   10346: }
                   10347: 
                   10348: // ]]>
                   10349: </script>
                   10350: <p>$lt{'camt'}</p>
                   10351: ENDCAM
1.1065    raeburn  10352:     } else {
1.1067    raeburn  10353:         $output = '<p>'.$lt{'this'};
                   10354:         if ($info eq '') {
                   10355:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   10356:         } else {
                   10357:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   10358:                        '<div><pre>'.$info.'</pre></div>';
                   10359:         }
1.1065    raeburn  10360:     }
1.1067    raeburn  10361:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  10362:     my $duplicates;
                   10363:     my $num = 0;
                   10364:     if (ref($dirlist) eq 'ARRAY') {
                   10365:         foreach my $item (@{$dirlist}) {
                   10366:             if (ref($item) eq 'ARRAY') {
                   10367:                 if (exists($toplevel{$item->[0]})) {
                   10368:                     $duplicates .= 
                   10369:                         &start_data_table_row().
                   10370:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10371:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   10372:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10373:                         'value="1" />'.&mt('Yes').'</label>'.
                   10374:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   10375:                         '<td>'.$item->[0].'</td>';
                   10376:                     if ($item->[2]) {
                   10377:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   10378:                     } else {
                   10379:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   10380:                     }
                   10381:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   10382:                                    '<td>'.
                   10383:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   10384:                                    '</td>'.
                   10385:                                    &end_data_table_row();
                   10386:                     $num ++;
                   10387:                 }
                   10388:             }
                   10389:         }
                   10390:     }
                   10391:     my $itemcount;
                   10392:     if (@paths > 0) {
                   10393:         $itemcount = scalar(@paths);
                   10394:     } else {
                   10395:         $itemcount = 1;
                   10396:     }
1.1067    raeburn  10397:     if ($is_camtasia) {
                   10398:         $output .= $lt{'auto'}.'<br />'.
                   10399:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
                   10400:                    '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
                   10401:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   10402:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   10403:                    $lt{'no'}.'</label></span><br />'.
                   10404:                    '<div id="camtasia_titles" style="display:block">'.
                   10405:                    &Apache::lonhtmlcommon::start_pick_box().
                   10406:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   10407:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   10408:                    &Apache::lonhtmlcommon::row_closure().
                   10409:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   10410:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   10411:                    &Apache::lonhtmlcommon::row_closure(1).
                   10412:                    &Apache::lonhtmlcommon::end_pick_box().
                   10413:                    '</div>';
                   10414:     }
1.1065    raeburn  10415:     $output .= 
                   10416:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  10417:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   10418:         "\n";
1.1065    raeburn  10419:     if ($duplicates ne '') {
                   10420:         $output .= '<p><span class="LC_warning">'.
                   10421:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   10422:                    &start_data_table().
                   10423:                    &start_data_table_header_row().
                   10424:                    '<th>'.&mt('Overwrite?').'</th>'.
                   10425:                    '<th>'.&mt('Name').'</th>'.
                   10426:                    '<th>'.&mt('Type').'</th>'.
                   10427:                    '<th>'.&mt('Size').'</th>'.
                   10428:                    '<th>'.&mt('Last modified').'</th>'.
                   10429:                    &end_data_table_header_row().
                   10430:                    $duplicates.
                   10431:                    &end_data_table().
                   10432:                    '</p>';
                   10433:     }
1.1067    raeburn  10434:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  10435:     if (ref($hiddenelements) eq 'HASH') {
                   10436:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   10437:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   10438:         }
                   10439:     }
                   10440:     $output .= <<"END";
1.1067    raeburn  10441: <br />
1.1053    raeburn  10442: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   10443: </form>
                   10444: $noextract
                   10445: END
                   10446:     return $output;
                   10447: }
                   10448: 
1.1065    raeburn  10449: sub decompression_utility {
                   10450:     my ($program) = @_;
                   10451:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   10452:     my $location;
                   10453:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   10454:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   10455:                          '/usr/sbin/') {
                   10456:             if (-x $dir.$program) {
                   10457:                 $location = $dir.$program;
                   10458:                 last;
                   10459:             }
                   10460:         }
                   10461:     }
                   10462:     return $location;
                   10463: }
                   10464: 
                   10465: sub list_archive_contents {
                   10466:     my ($file,$pathsref) = @_;
                   10467:     my (@cmd,$output);
                   10468:     my $needsregexp;
                   10469:     if ($file =~ /\.zip$/) {
                   10470:         @cmd = (&decompression_utility('unzip'),"-l");
                   10471:         $needsregexp = 1;
                   10472:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   10473:              ($file =~ /\.tgz$/)) {
                   10474:         @cmd = (&decompression_utility('tar'),"-ztf");
                   10475:     } elsif ($file =~ /\.tar\.bz2$/) {
                   10476:         @cmd = (&decompression_utility('tar'),"-jtf");
                   10477:     } elsif ($file =~ m|\.tar$|) {
                   10478:         @cmd = (&decompression_utility('tar'),"-tf");
                   10479:     }
                   10480:     if (@cmd) {
                   10481:         undef($!);
                   10482:         undef($@);
                   10483:         if (open(my $fh,"-|", @cmd, $file)) {
                   10484:             while (my $line = <$fh>) {
                   10485:                 $output .= $line;
                   10486:                 chomp($line);
                   10487:                 my $item;
                   10488:                 if ($needsregexp) {
                   10489:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   10490:                 } else {
                   10491:                     $item = $line;
                   10492:                 }
                   10493:                 if ($item ne '') {
                   10494:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   10495:                         push(@{$pathsref},$item);
                   10496:                     } 
                   10497:                 }
                   10498:             }
                   10499:             close($fh);
                   10500:         }
                   10501:     }
                   10502:     return $output;
                   10503: }
                   10504: 
1.1053    raeburn  10505: sub decompress_uploaded_file {
                   10506:     my ($file,$dir) = @_;
                   10507:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   10508:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   10509:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   10510:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   10511:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   10512:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   10513:     my $decompressed = $env{'cgi.decompressed'};
                   10514:     &Apache::lonnet::delenv('cgi.file');
                   10515:     &Apache::lonnet::delenv('cgi.dir');
                   10516:     &Apache::lonnet::delenv('cgi.decompressed');
                   10517:     return ($decompressed,$result);
                   10518: }
                   10519: 
1.1055    raeburn  10520: sub process_decompression {
                   10521:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   10522:     my ($dir,$error,$warning,$output);
                   10523:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
                   10524:         $error = &mt('File name not a supported archive file type.').
                   10525:                  '<br />'.&mt('File name should end with one of: [_1].',
                   10526:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   10527:     } else {
                   10528:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10529:         if ($docuhome eq 'no_host') {
                   10530:             $error = &mt('Could not determine home server for course.');
                   10531:         } else {
                   10532:             my @ids=&Apache::lonnet::current_machine_ids();
                   10533:             my $currdir = "$dir_root/$destination";
                   10534:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10535:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   10536:                        "$dir_root/$destination";
                   10537:             } else {
                   10538:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   10539:                        "$dir_root/$docudom/$docuname/$destination";
                   10540:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   10541:                     $error = &mt('Archive file not found.');
                   10542:                 }
                   10543:             }
1.1065    raeburn  10544:             my (@to_overwrite,@to_skip);
                   10545:             if ($env{'form.archive_overwrite_total'} > 0) {
                   10546:                 my $total = $env{'form.archive_overwrite_total'};
                   10547:                 for (my $i=0; $i<$total; $i++) {
                   10548:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   10549:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   10550:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   10551:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   10552:                     }
                   10553:                 }
                   10554:             }
                   10555:             my $numskip = scalar(@to_skip);
                   10556:             if (($numskip > 0) && 
                   10557:                 ($numskip == $env{'form.archive_itemcount'})) {
                   10558:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   10559:             } elsif ($dir eq '') {
1.1055    raeburn  10560:                 $error = &mt('Directory containing archive file unavailable.');
                   10561:             } elsif (!$error) {
1.1065    raeburn  10562:                 my ($decompressed,$display);
                   10563:                 if ($numskip > 0) {
                   10564:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   10565:                     mkdir("$dir/$tempdir",0755);
                   10566:                     system("mv $dir/$file $dir/$tempdir/$file");
                   10567:                     ($decompressed,$display) = 
                   10568:                         &decompress_uploaded_file($file,"$dir/$tempdir");
                   10569:                     foreach my $item (@to_skip) {
                   10570:                         if (($item ne '') && ($item !~ /\.\./)) {
                   10571:                             if (-f "$dir/$tempdir/$item") { 
                   10572:                                 unlink("$dir/$tempdir/$item");
                   10573:                             } elsif (-d "$dir/$tempdir/$item") {
                   10574:                                 system("rm -rf $dir/$tempdir/$item");
                   10575:                             }
                   10576:                         }
                   10577:                     }
                   10578:                     system("mv $dir/$tempdir/* $dir");
                   10579:                     rmdir("$dir/$tempdir");   
                   10580:                 } else {
                   10581:                     ($decompressed,$display) = 
                   10582:                         &decompress_uploaded_file($file,$dir);
                   10583:                 }
1.1055    raeburn  10584:                 if ($decompressed eq 'ok') {
1.1065    raeburn  10585:                     $output = '<p class="LC_info">'.
                   10586:                               &mt('Files extracted successfully from archive.').
                   10587:                               '</p>'."\n";
1.1055    raeburn  10588:                     my ($warning,$result,@contents);
                   10589:                     my ($newdirlistref,$newlisterror) =
                   10590:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   10591:                                                  $docuname,1);
                   10592:                     my (%is_dir,%changes,@newitems);
                   10593:                     my $dirptr = 16384;
1.1065    raeburn  10594:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  10595:                         foreach my $dir_line (@{$newdirlistref}) {
                   10596:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065    raeburn  10597:                             unless (($item =~ /^\.+$/) || ($item eq $file) || 
                   10598:                                     ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055    raeburn  10599:                                 push(@newitems,$item);
                   10600:                                 if ($dirptr&$testdir) {
                   10601:                                     $is_dir{$item} = 1;
                   10602:                                 }
                   10603:                                 $changes{$item} = 1;
                   10604:                             }
                   10605:                         }
                   10606:                     }
                   10607:                     if (keys(%changes) > 0) {
                   10608:                         foreach my $item (sort(@newitems)) {
                   10609:                             if ($changes{$item}) {
                   10610:                                 push(@contents,$item);
                   10611:                             }
                   10612:                         }
                   10613:                     }
                   10614:                     if (@contents > 0) {
1.1067    raeburn  10615:                         my $wantform;
                   10616:                         unless ($env{'form.autoextract_camtasia'}) {
                   10617:                             $wantform = 1;
                   10618:                         }
1.1056    raeburn  10619:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  10620:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   10621:                                                                 $currdir,\%is_dir,
                   10622:                                                                 \%children,\%parent,
1.1056    raeburn  10623:                                                                 \@contents,\%dirorder,
                   10624:                                                                 \%titles,$wantform);
1.1055    raeburn  10625:                         if ($datatable ne '') {
                   10626:                             $output .= &archive_options_form('decompressed',$datatable,
                   10627:                                                              $count,$hiddenelem);
1.1065    raeburn  10628:                             my $startcount = 6;
1.1055    raeburn  10629:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  10630:                                                            \%titles,\%children);
1.1055    raeburn  10631:                         }
1.1067    raeburn  10632:                         if ($env{'form.autoextract_camtasia'}) {
                   10633:                             my %displayed;
                   10634:                             my $total = 1;
                   10635:                             $env{'form.archive_directory'} = [];
                   10636:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   10637:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   10638:                                 $path =~ s{/$}{};
                   10639:                                 my $item;
                   10640:                                 if ($path ne '') {
                   10641:                                     $item = "$path/$titles{$i}";
                   10642:                                 } else {
                   10643:                                     $item = $titles{$i};
                   10644:                                 }
                   10645:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   10646:                                 if ($item eq $contents[0]) {
                   10647:                                     push(@{$env{'form.archive_directory'}},$i);
                   10648:                                     $env{'form.archive_'.$i} = 'display';
                   10649:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   10650:                                     $displayed{'folder'} = $i;
                   10651:                                 } elsif ($item eq "$contents[0]/index.html") {
                   10652:                                     $env{'form.archive_'.$i} = 'display';
                   10653:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   10654:                                     $displayed{'web'} = $i;
                   10655:                                 } else {
                   10656:                                     if ($item eq "$contents[0]/media") {
                   10657:                                         push(@{$env{'form.archive_directory'}},$i);
                   10658:                                     }
                   10659:                                     $env{'form.archive_'.$i} = 'dependency';
                   10660:                                 }
                   10661:                                 $total ++;
                   10662:                             }
                   10663:                             for (my $i=1; $i<$total; $i++) {
                   10664:                                 next if ($i == $displayed{'web'});
                   10665:                                 next if ($i == $displayed{'folder'});
                   10666:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   10667:                             }
                   10668:                             $env{'form.phase'} = 'decompress_cleanup';
                   10669:                             $env{'form.archivedelete'} = 1;
                   10670:                             $env{'form.archive_count'} = $total-1;
                   10671:                             $output .=
                   10672:                                 &process_extracted_files('coursedocs',$docudom,
                   10673:                                                          $docuname,$destination,
                   10674:                                                          $dir_root,$hiddenelem);
                   10675:                         }
1.1055    raeburn  10676:                     } else {
                   10677:                         $warning = &mt('No new items extracted from archive file.');
                   10678:                     }
                   10679:                 } else {
                   10680:                     $output = $display;
                   10681:                     $error = &mt('An error occurred during extraction from the archive file.');
                   10682:                 }
                   10683:             }
                   10684:         }
                   10685:     }
                   10686:     if ($error) {
                   10687:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   10688:                    $error.'</p>'."\n";
                   10689:     }
                   10690:     if ($warning) {
                   10691:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   10692:     }
                   10693:     return $output;
                   10694: }
                   10695: 
                   10696: sub get_extracted {
1.1056    raeburn  10697:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   10698:         $titles,$wantform) = @_;
1.1055    raeburn  10699:     my $count = 0;
                   10700:     my $depth = 0;
                   10701:     my $datatable;
1.1056    raeburn  10702:     my @hierarchy;
1.1055    raeburn  10703:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  10704:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   10705:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  10706:     foreach my $item (@{$contents}) {
                   10707:         $count ++;
1.1056    raeburn  10708:         @{$dirorder->{$count}} = @hierarchy;
                   10709:         $titles->{$count} = $item;
1.1055    raeburn  10710:         &archive_hierarchy($depth,$count,$parent,$children);
                   10711:         if ($wantform) {
                   10712:             $datatable .= &archive_row($is_dir->{$item},$item,
                   10713:                                        $currdir,$depth,$count);
                   10714:         }
                   10715:         if ($is_dir->{$item}) {
                   10716:             $depth ++;
1.1056    raeburn  10717:             push(@hierarchy,$count);
                   10718:             $parent->{$depth} = $count;
1.1055    raeburn  10719:             $datatable .=
                   10720:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  10721:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   10722:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  10723:             $depth --;
1.1056    raeburn  10724:             pop(@hierarchy);
1.1055    raeburn  10725:         }
                   10726:     }
                   10727:     return ($count,$datatable);
                   10728: }
                   10729: 
                   10730: sub recurse_extracted_archive {
1.1056    raeburn  10731:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   10732:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  10733:     my $result='';
1.1056    raeburn  10734:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   10735:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   10736:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  10737:         return $result;
                   10738:     }
                   10739:     my $dirptr = 16384;
                   10740:     my ($newdirlistref,$newlisterror) =
                   10741:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   10742:     if (ref($newdirlistref) eq 'ARRAY') {
                   10743:         foreach my $dir_line (@{$newdirlistref}) {
                   10744:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   10745:             unless ($item =~ /^\.+$/) {
                   10746:                 $$count ++;
1.1056    raeburn  10747:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   10748:                 $titles->{$$count} = $item;
1.1055    raeburn  10749:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  10750: 
1.1055    raeburn  10751:                 my $is_dir;
                   10752:                 if ($dirptr&$testdir) {
                   10753:                     $is_dir = 1;
                   10754:                 }
                   10755:                 if ($wantform) {
                   10756:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   10757:                 }
                   10758:                 if ($is_dir) {
                   10759:                     $$depth ++;
1.1056    raeburn  10760:                     push(@{$hierarchy},$$count);
                   10761:                     $parent->{$$depth} = $$count;
1.1055    raeburn  10762:                     $result .=
                   10763:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   10764:                                                    $docuname,$depth,$count,
1.1056    raeburn  10765:                                                    $hierarchy,$dirorder,$children,
                   10766:                                                    $parent,$titles,$wantform);
1.1055    raeburn  10767:                     $$depth --;
1.1056    raeburn  10768:                     pop(@{$hierarchy});
1.1055    raeburn  10769:                 }
                   10770:             }
                   10771:         }
                   10772:     }
                   10773:     return $result;
                   10774: }
                   10775: 
                   10776: sub archive_hierarchy {
                   10777:     my ($depth,$count,$parent,$children) =@_;
                   10778:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   10779:         if (exists($parent->{$depth})) {
                   10780:              $children->{$parent->{$depth}} .= $count.':';
                   10781:         }
                   10782:     }
                   10783:     return;
                   10784: }
                   10785: 
                   10786: sub archive_row {
                   10787:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   10788:     my ($name) = ($item =~ m{([^/]+)$});
                   10789:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  10790:                                        'display'    => 'Add as file',
1.1055    raeburn  10791:                                        'dependency' => 'Include as dependency',
                   10792:                                        'discard'    => 'Discard',
                   10793:                                       );
                   10794:     if ($is_dir) {
1.1059    raeburn  10795:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  10796:     }
1.1056    raeburn  10797:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   10798:     my $offset = 0;
1.1055    raeburn  10799:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  10800:         $offset ++;
1.1065    raeburn  10801:         if ($action ne 'display') {
                   10802:             $offset ++;
                   10803:         }  
1.1055    raeburn  10804:         $output .= '<td><span class="LC_nobreak">'.
                   10805:                    '<label><input type="radio" name="archive_'.$count.
                   10806:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   10807:         my $text = $choices{$action};
                   10808:         if ($is_dir) {
                   10809:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   10810:             if ($action eq 'display') {
1.1059    raeburn  10811:                 $text = &mt('Add as folder');
1.1055    raeburn  10812:             }
1.1056    raeburn  10813:         } else {
                   10814:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   10815: 
                   10816:         }
                   10817:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   10818:         if ($action eq 'dependency') {
                   10819:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   10820:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   10821:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   10822:                        '<option value=""></option>'."\n".
                   10823:                        '</select>'."\n".
                   10824:                        '</div>';
1.1059    raeburn  10825:         } elsif ($action eq 'display') {
                   10826:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   10827:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   10828:                        '</div>';
1.1055    raeburn  10829:         }
1.1056    raeburn  10830:         $output .= '</td>';
1.1055    raeburn  10831:     }
                   10832:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   10833:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   10834:     for (my $i=0; $i<$depth; $i++) {
                   10835:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   10836:     }
                   10837:     if ($is_dir) {
                   10838:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   10839:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   10840:     } else {
                   10841:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   10842:     }
                   10843:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   10844:                &end_data_table_row();
                   10845:     return $output;
                   10846: }
                   10847: 
                   10848: sub archive_options_form {
1.1065    raeburn  10849:     my ($form,$display,$count,$hiddenelem) = @_;
                   10850:     my %lt = &Apache::lonlocal::texthash(
                   10851:                perm => 'Permanently remove archive file?',
                   10852:                hows => 'How should each extracted item be incorporated in the course?',
                   10853:                cont => 'Content actions for all',
                   10854:                addf => 'Add as folder/file',
                   10855:                incd => 'Include as dependency for a displayed file',
                   10856:                disc => 'Discard',
                   10857:                no   => 'No',
                   10858:                yes  => 'Yes',
                   10859:                save => 'Save',
                   10860:     );
                   10861:     my $output = <<"END";
                   10862: <form name="$form" method="post" action="">
                   10863: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   10864: <label>
                   10865:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   10866: </label>
                   10867: &nbsp;
                   10868: <label>
                   10869:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   10870: </span>
                   10871: </p>
                   10872: <input type="hidden" name="phase" value="decompress_cleanup" />
                   10873: <br />$lt{'hows'}
                   10874: <div class="LC_columnSection">
                   10875:   <fieldset>
                   10876:     <legend>$lt{'cont'}</legend>
                   10877:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   10878:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   10879:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   10880:   </fieldset>
                   10881: </div>
                   10882: END
                   10883:     return $output.
1.1055    raeburn  10884:            &start_data_table()."\n".
1.1065    raeburn  10885:            $display."\n".
1.1055    raeburn  10886:            &end_data_table()."\n".
                   10887:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   10888:            $hiddenelem.
1.1065    raeburn  10889:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  10890:            '</form>';
                   10891: }
                   10892: 
                   10893: sub archive_javascript {
1.1056    raeburn  10894:     my ($startcount,$numitems,$titles,$children) = @_;
                   10895:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  10896:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  10897:     my $scripttag = <<START;
                   10898: <script type="text/javascript">
                   10899: // <![CDATA[
                   10900: 
                   10901: function checkAll(form,prefix) {
                   10902:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   10903:     for (var i=0; i < form.elements.length; i++) {
                   10904:         var id = form.elements[i].id;
                   10905:         if ((id != '') && (id != undefined)) {
                   10906:             if (idstr.test(id)) {
                   10907:                 if (form.elements[i].type == 'radio') {
                   10908:                     form.elements[i].checked = true;
1.1056    raeburn  10909:                     var nostart = i-$startcount;
1.1059    raeburn  10910:                     var offset = nostart%7;
                   10911:                     var count = (nostart-offset)/7;    
1.1056    raeburn  10912:                     dependencyCheck(form,count,offset);
1.1055    raeburn  10913:                 }
                   10914:             }
                   10915:         }
                   10916:     }
                   10917: }
                   10918: 
                   10919: function propagateCheck(form,count) {
                   10920:     if (count > 0) {
1.1059    raeburn  10921:         var startelement = $startcount + ((count-1) * 7);
                   10922:         for (var j=1; j<6; j++) {
                   10923:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  10924:                 var item = startelement + j; 
                   10925:                 if (form.elements[item].type == 'radio') {
                   10926:                     if (form.elements[item].checked) {
                   10927:                         containerCheck(form,count,j);
                   10928:                         break;
                   10929:                     }
1.1055    raeburn  10930:                 }
                   10931:             }
                   10932:         }
                   10933:     }
                   10934: }
                   10935: 
                   10936: numitems = $numitems
1.1056    raeburn  10937: var titles = new Array(numitems);
                   10938: var parents = new Array(numitems);
1.1055    raeburn  10939: for (var i=0; i<numitems; i++) {
1.1056    raeburn  10940:     parents[i] = new Array;
1.1055    raeburn  10941: }
1.1059    raeburn  10942: var maintitle = '$maintitle';
1.1055    raeburn  10943: 
                   10944: START
                   10945: 
1.1056    raeburn  10946:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   10947:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  10948:         for (my $i=0; $i<@contents; $i ++) {
                   10949:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   10950:         }
                   10951:     }
                   10952: 
1.1056    raeburn  10953:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   10954:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   10955:     }
                   10956: 
1.1055    raeburn  10957:     $scripttag .= <<END;
                   10958: 
                   10959: function containerCheck(form,count,offset) {
                   10960:     if (count > 0) {
1.1056    raeburn  10961:         dependencyCheck(form,count,offset);
1.1059    raeburn  10962:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  10963:         form.elements[item].checked = true;
                   10964:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   10965:             if (parents[count].length > 0) {
                   10966:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  10967:                     containerCheck(form,parents[count][j],offset);
                   10968:                 }
                   10969:             }
                   10970:         }
                   10971:     }
                   10972: }
                   10973: 
                   10974: function dependencyCheck(form,count,offset) {
                   10975:     if (count > 0) {
1.1059    raeburn  10976:         var chosen = (offset+$startcount)+7*(count-1);
                   10977:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  10978:         var currtype = form.elements[depitem].type;
                   10979:         if (form.elements[chosen].value == 'dependency') {
                   10980:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   10981:             form.elements[depitem].options.length = 0;
                   10982:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   10983:             for (var i=1; i<count; i++) {
1.1059    raeburn  10984:                 var startelement = $startcount + (i-1) * 7;
                   10985:                 for (var j=1; j<6; j++) {
                   10986:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  10987:                         var item = startelement + j;
                   10988:                         if (form.elements[item].type == 'radio') {
                   10989:                             if (form.elements[item].checked) {
                   10990:                                 if (form.elements[item].value == 'display') {
                   10991:                                     var n = form.elements[depitem].options.length;
                   10992:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   10993:                                 }
                   10994:                             }
                   10995:                         }
                   10996:                     }
                   10997:                 }
                   10998:             }
                   10999:         } else {
                   11000:             document.getElementById('arc_depon_'+count).style.display='none';
                   11001:             form.elements[depitem].options.length = 0;
                   11002:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   11003:         }
1.1059    raeburn  11004:         titleCheck(form,count,offset);
1.1056    raeburn  11005:     }
                   11006: }
                   11007: 
                   11008: function propagateSelect(form,count,offset) {
                   11009:     if (count > 0) {
1.1065    raeburn  11010:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  11011:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   11012:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11013:             if (parents[count].length > 0) {
                   11014:                 for (var j=0; j<parents[count].length; j++) {
                   11015:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  11016:                 }
                   11017:             }
                   11018:         }
                   11019:     }
                   11020: }
1.1056    raeburn  11021: 
                   11022: function containerSelect(form,count,offset,picked) {
                   11023:     if (count > 0) {
1.1065    raeburn  11024:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  11025:         if (form.elements[item].type == 'radio') {
                   11026:             if (form.elements[item].value == 'dependency') {
                   11027:                 if (form.elements[item+1].type == 'select-one') {
                   11028:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   11029:                         if (form.elements[item+1].options[i].value == picked) {
                   11030:                             form.elements[item+1].selectedIndex = i;
                   11031:                             break;
                   11032:                         }
                   11033:                     }
                   11034:                 }
                   11035:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11036:                     if (parents[count].length > 0) {
                   11037:                         for (var j=0; j<parents[count].length; j++) {
                   11038:                             containerSelect(form,parents[count][j],offset,picked);
                   11039:                         }
                   11040:                     }
                   11041:                 }
                   11042:             }
                   11043:         }
                   11044:     }
                   11045: }
                   11046: 
1.1059    raeburn  11047: function titleCheck(form,count,offset) {
                   11048:     if (count > 0) {
                   11049:         var chosen = (offset+$startcount)+7*(count-1);
                   11050:         var depitem = $startcount + ((count-1) * 7) + 2;
                   11051:         var currtype = form.elements[depitem].type;
                   11052:         if (form.elements[chosen].value == 'display') {
                   11053:             document.getElementById('arc_title_'+count).style.display='block';
                   11054:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   11055:                 document.getElementById('archive_title_'+count).value=maintitle;
                   11056:             }
                   11057:         } else {
                   11058:             document.getElementById('arc_title_'+count).style.display='none';
                   11059:             if (currtype == 'text') { 
                   11060:                 document.getElementById('archive_title_'+count).value='';
                   11061:             }
                   11062:         }
                   11063:     }
                   11064:     return;
                   11065: }
                   11066: 
1.1055    raeburn  11067: // ]]>
                   11068: </script>
                   11069: END
                   11070:     return $scripttag;
                   11071: }
                   11072: 
                   11073: sub process_extracted_files {
1.1067    raeburn  11074:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  11075:     my $numitems = $env{'form.archive_count'};
                   11076:     return unless ($numitems);
                   11077:     my @ids=&Apache::lonnet::current_machine_ids();
                   11078:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  11079:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  11080:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   11081:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   11082:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   11083:         $pathtocheck = "$dir_root/$destination";
                   11084:         $dir = $dir_root;
                   11085:         $ishome = 1;
                   11086:     } else {
                   11087:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   11088:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   11089:         $dir = "$dir_root/$docudom/$docuname";    
                   11090:     }
                   11091:     my $currdir = "$dir_root/$destination";
                   11092:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   11093:     if ($env{'form.folderpath'}) {
                   11094:         my @items = split('&',$env{'form.folderpath'});
                   11095:         $folders{'0'} = $items[-2];
                   11096:         $containers{'0'}='sequence';
                   11097:     } elsif ($env{'form.pagepath'}) {
                   11098:         my @items = split('&',$env{'form.pagepath'});
                   11099:         $folders{'0'} = $items[-2];
                   11100:         $containers{'0'}='page';
                   11101:     }
                   11102:     my @archdirs = &get_env_multiple('form.archive_directory');
                   11103:     if ($numitems) {
                   11104:         for (my $i=1; $i<=$numitems; $i++) {
                   11105:             my $path = $env{'form.archive_content_'.$i};
                   11106:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   11107:                 my $item = $1;
                   11108:                 $toplevelitems{$item} = $i;
                   11109:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   11110:                     $is_dir{$item} = 1;
                   11111:                 }
                   11112:             }
                   11113:         }
                   11114:     }
1.1067    raeburn  11115:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  11116:     if (keys(%toplevelitems) > 0) {
                   11117:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  11118:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   11119:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  11120:     }
1.1066    raeburn  11121:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  11122:     if ($numitems) {
                   11123:         for (my $i=1; $i<=$numitems; $i++) {
                   11124:             my $path = $env{'form.archive_content_'.$i};
                   11125:             if ($path =~ /^\Q$pathtocheck\E/) {
                   11126:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   11127:                     if ($prefix ne '' && $path ne '') {
                   11128:                         if (-e $prefix.$path) {
1.1066    raeburn  11129:                             if ((@archdirs > 0) && 
                   11130:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   11131:                                 $todeletedir{$prefix.$path} = 1;
                   11132:                             } else {
                   11133:                                 $todelete{$prefix.$path} = 1;
                   11134:                             }
1.1055    raeburn  11135:                         }
                   11136:                     }
                   11137:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  11138:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  11139:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  11140:                     $docstitle = $env{'form.archive_title_'.$i};
                   11141:                     if ($docstitle eq '') {
                   11142:                         $docstitle = $title;
                   11143:                     }
1.1055    raeburn  11144:                     $outer = 0;
1.1056    raeburn  11145:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   11146:                         if (@{$dirorder{$i}} > 0) {
                   11147:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  11148:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   11149:                                     $outer = $item;
                   11150:                                     last;
                   11151:                                 }
                   11152:                             }
                   11153:                         }
                   11154:                     }
                   11155:                     my ($errtext,$fatal) = 
                   11156:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   11157:                                                '/'.$folders{$outer}.'.'.
                   11158:                                                $containers{$outer});
                   11159:                     next if ($fatal);
                   11160:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   11161:                         if ($context eq 'coursedocs') {
1.1056    raeburn  11162:                             $mapinner{$i} = time;
1.1055    raeburn  11163:                             $folders{$i} = 'default_'.$mapinner{$i};
                   11164:                             $containers{$i} = 'sequence';
                   11165:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11166:                                       $folders{$i}.'.'.$containers{$i};
                   11167:                             my $newidx = &LONCAPA::map::getresidx();
                   11168:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11169:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11170:                             push(@LONCAPA::map::order,$newidx);
                   11171:                             my ($outtext,$errtext) =
                   11172:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11173:                                                         $docuname.'/'.$folders{$outer}.
                   11174:                                                         '.'.$containers{$outer},1);
1.1056    raeburn  11175:                             $newseqid{$i} = $newidx;
1.1067    raeburn  11176:                             unless ($errtext) {
                   11177:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
                   11178:                             }
1.1055    raeburn  11179:                         }
                   11180:                     } else {
                   11181:                         if ($context eq 'coursedocs') {
                   11182:                             my $newidx=&LONCAPA::map::getresidx();
                   11183:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11184:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   11185:                                       $title;
                   11186:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   11187:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   11188:                             }
                   11189:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11190:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   11191:                             }
                   11192:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11193:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  11194:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067    raeburn  11195:                                 unless ($ishome) {
                   11196:                                     my $fetch = "$newdest{$i}/$title";
                   11197:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   11198:                                     $prompttofetch{$fetch} = 1;
                   11199:                                 }
1.1055    raeburn  11200:                             }
                   11201:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11202:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11203:                             push(@LONCAPA::map::order, $newidx);
                   11204:                             my ($outtext,$errtext)=
                   11205:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11206:                                                         $docuname.'/'.$folders{$outer}.
                   11207:                                                         '.'.$containers{$outer},1);
1.1067    raeburn  11208:                             unless ($errtext) {
                   11209:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   11210:                                     $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
                   11211:                                 }
                   11212:                             }
1.1055    raeburn  11213:                         }
                   11214:                     }
                   11215:                 } elsif ($env{'form.archive_'.$i} eq 'dependency') {
1.1056    raeburn  11216:                     my ($title) = ($path =~ m{/([^/]+)$});
                   11217:                     $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   11218:                     if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   11219:                         if (ref($dirorder{$i}) eq 'ARRAY') {
1.1067    raeburn  11220:                             my ($itemidx,$fullpath,$relpath);
1.1056    raeburn  11221:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   11222:                                 if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   11223:                                     my $container = $dirorder{$referrer{$i}}->[-1];
                   11224:                                     for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
                   11225:                                         if ($dirorder{$i}->[$j] eq $container) {
                   11226:                                             $itemidx = $j;
                   11227:                                         }
                   11228:                                     }
                   11229:                                 }
                   11230:                             }
                   11231:                             if ($itemidx ne '') {
                   11232:                                 if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   11233:                                     if ($mapinner{$referrer{$i}}) {
                   11234:                                         $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   11235:                                         for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11236:                                             if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11237:                                                 unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11238:                                                     $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067    raeburn  11239:                                                     $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056    raeburn  11240:                                                     if (!-e $fullpath) {
                   11241:                                                         mkdir($fullpath,0755);
                   11242:                                                     }
                   11243:                                                 }
                   11244:                                             } else {
                   11245:                                                 last;
                   11246:                                             }
                   11247:                                         }
                   11248:                                     }
                   11249:                                 } elsif ($newdest{$referrer{$i}}) {
                   11250:                                     $fullpath = $newdest{$referrer{$i}};
                   11251:                                     for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11252:                                         if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   11253:                                             $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   11254:                                             last;
                   11255:                                         } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11256:                                             unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11257:                                                 $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1067    raeburn  11258:                                                 $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
1.1056    raeburn  11259:                                                 if (!-e $fullpath) {
                   11260:                                                     mkdir($fullpath,0755);
                   11261:                                                 }
                   11262:                                             }
                   11263:                                         } else {
                   11264:                                             last;
                   11265:                                         }
                   11266:                                     }
                   11267:                                 }
                   11268:                                 if ($fullpath ne '') {
1.1067    raeburn  11269:                                     if (-e "$prefix$path") {
                   11270:                                         system("mv $prefix$path $fullpath/$title");
                   11271:                                     }
                   11272:                                     if (-e "$fullpath/$title") {
                   11273:                                         my $showpath;
                   11274:                                         if ($relpath ne '') {
                   11275:                                             $showpath = "$relpath/$title";
                   11276:                                         } else {
                   11277:                                             $showpath = "/$title";
                   11278:                                         } 
                   11279:                                         $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
                   11280:                                     } 
                   11281:                                     unless ($ishome) {
                   11282:                                         my $fetch = "$fullpath/$title";
                   11283:                                         $fetch =~ s/^\Q$prefix$dir\E//; 
                   11284:                                         $prompttofetch{$fetch} = 1;
                   11285:                                     }
1.1056    raeburn  11286:                                 }
1.1055    raeburn  11287:                             }
                   11288:                         }
1.1056    raeburn  11289:                     } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   11290:                         $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   11291:                                         $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  11292:                     }
                   11293:                 }
                   11294:             } else {
                   11295:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   11296:             }
                   11297:         }
                   11298:         if (keys(%todelete)) {
                   11299:             foreach my $key (keys(%todelete)) {
                   11300:                 unlink($key);
1.1066    raeburn  11301:             }
                   11302:         }
                   11303:         if (keys(%todeletedir)) {
                   11304:             foreach my $key (keys(%todeletedir)) {
                   11305:                 rmdir($key);
                   11306:             }
                   11307:         }
                   11308:         foreach my $dir (sort(keys(%is_dir))) {
                   11309:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   11310:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  11311:             }
                   11312:         }
1.1067    raeburn  11313:         if ($result ne '') {
                   11314:             $output .= '<ul>'."\n".
                   11315:                        $result."\n".
                   11316:                        '</ul>';
                   11317:         }
                   11318:         unless ($ishome) {
                   11319:             my $replicationfail;
                   11320:             foreach my $item (keys(%prompttofetch)) {
                   11321:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   11322:                 unless ($fetchresult eq 'ok') {
                   11323:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   11324:                 }
                   11325:             }
                   11326:             if ($replicationfail) {
                   11327:                 $output .= '<p class="LC_error">'.
                   11328:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   11329:                            $replicationfail.
                   11330:                            '</ul></p>';
                   11331:             }
                   11332:         }
1.1055    raeburn  11333:     } else {
                   11334:         $warning = &mt('No items found in archive.');
                   11335:     }
                   11336:     if ($error) {
                   11337:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   11338:                    $error.'</p>'."\n";
                   11339:     }
                   11340:     if ($warning) {
                   11341:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   11342:     }
                   11343:     return $output;
                   11344: }
                   11345: 
1.1066    raeburn  11346: sub cleanup_empty_dirs {
                   11347:     my ($path) = @_;
                   11348:     if (($path ne '') && (-d $path)) {
                   11349:         if (opendir(my $dirh,$path)) {
                   11350:             my @dircontents = grep(!/^\./,readdir($dirh));
                   11351:             my $numitems = 0;
                   11352:             foreach my $item (@dircontents) {
                   11353:                 if (-d "$path/$item") {
                   11354:                     &recurse_dirs("$path/$item");
                   11355:                     if (-e "$path/$item") {
                   11356:                         $numitems ++;
                   11357:                     }
                   11358:                 } else {
                   11359:                     $numitems ++;
                   11360:                 }
                   11361:             }
                   11362:             if ($numitems == 0) {
                   11363:                 rmdir($path);
                   11364:             }
                   11365:             closedir($dirh);
                   11366:         }
                   11367:     }
                   11368:     return;
                   11369: }
                   11370: 
1.41      ng       11371: =pod
1.45      matthew  11372: 
1.1068    raeburn  11373: =item &get_folder_hierarchy()
                   11374: 
                   11375: Provides hierarchy of names of folders/sub-folders containing the current
                   11376: item,
                   11377: 
                   11378: Inputs: 3
                   11379:      - $navmap - navmaps object
                   11380: 
                   11381:      - $map - url for map (either the trigger itself, or map containing
                   11382:                            the resource, which is the trigger).
                   11383: 
                   11384:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   11385: 
                   11386: Outputs: 1 @pathitems - array of folder/subfolder names.
                   11387: 
                   11388: =cut
                   11389: 
                   11390: sub get_folder_hierarchy {
                   11391:     my ($navmap,$map,$showitem) = @_;
                   11392:     my @pathitems;
                   11393:     if (ref($navmap)) {
                   11394:         my $mapres = $navmap->getResourceByUrl($map);
                   11395:         if (ref($mapres)) {
                   11396:             my $pcslist = $mapres->map_hierarchy();
                   11397:             if ($pcslist ne '') {
                   11398:                 my @pcs = split(/,/,$pcslist);
                   11399:                 foreach my $pc (@pcs) {
                   11400:                     if ($pc == 1) {
                   11401:                         push(@pathitems,&mt('Main Course Documents'));
                   11402:                     } else {
                   11403:                         my $res = $navmap->getByMapPc($pc);
                   11404:                         if (ref($res)) {
                   11405:                             my $title = $res->compTitle();
                   11406:                             $title =~ s/\W+/_/g;
                   11407:                             if ($title ne '') {
                   11408:                                 push(@pathitems,$title);
                   11409:                             }
                   11410:                         }
                   11411:                     }
                   11412:                 }
                   11413:             }
1.1071    raeburn  11414:             if ($showitem) {
                   11415:                 if ($mapres->{ID} eq '0.0') {
                   11416:                     push(@pathitems,&mt('Main Course Documents'));
                   11417:                 } else {
                   11418:                     my $maptitle = $mapres->compTitle();
                   11419:                     $maptitle =~ s/\W+/_/g;
                   11420:                     if ($maptitle ne '') {
                   11421:                         push(@pathitems,$maptitle);
                   11422:                     }
1.1068    raeburn  11423:                 }
                   11424:             }
                   11425:         }
                   11426:     }
                   11427:     return @pathitems;
                   11428: }
                   11429: 
                   11430: =pod
                   11431: 
1.1015    raeburn  11432: =item * &get_turnedin_filepath()
                   11433: 
                   11434: Determines path in a user's portfolio file for storage of files uploaded
                   11435: to a specific essayresponse or dropbox item.
                   11436: 
                   11437: Inputs: 3 required + 1 optional.
                   11438: $symb is symb for resource, $uname and $udom are for current user (required).
                   11439: $caller is optional (can be "submission", if routine is called when storing
                   11440: an upoaded file when "Submit Answer" button was pressed).
                   11441: 
                   11442: Returns array containing $path and $multiresp. 
                   11443: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   11444: than one file upload item.  Callers of routine should append partid as a 
                   11445: subdirectory to $path in cases where $multiresp is 1.
                   11446: 
                   11447: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   11448: 
                   11449: =cut
                   11450: 
                   11451: sub get_turnedin_filepath {
                   11452:     my ($symb,$uname,$udom,$caller) = @_;
                   11453:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   11454:     my $turnindir;
                   11455:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   11456:     $turnindir = $userhash{'turnindir'};
                   11457:     my ($path,$multiresp);
                   11458:     if ($turnindir eq '') {
                   11459:         if ($caller eq 'submission') {
                   11460:             $turnindir = &mt('turned in');
                   11461:             $turnindir =~ s/\W+/_/g;
                   11462:             my %newhash = (
                   11463:                             'turnindir' => $turnindir,
                   11464:                           );
                   11465:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   11466:         }
                   11467:     }
                   11468:     if ($turnindir ne '') {
                   11469:         $path = '/'.$turnindir.'/';
                   11470:         my ($multipart,$turnin,@pathitems);
                   11471:         my $navmap = Apache::lonnavmaps::navmap->new();
                   11472:         if (defined($navmap)) {
                   11473:             my $mapres = $navmap->getResourceByUrl($map);
                   11474:             if (ref($mapres)) {
                   11475:                 my $pcslist = $mapres->map_hierarchy();
                   11476:                 if ($pcslist ne '') {
                   11477:                     foreach my $pc (split(/,/,$pcslist)) {
                   11478:                         my $res = $navmap->getByMapPc($pc);
                   11479:                         if (ref($res)) {
                   11480:                             my $title = $res->compTitle();
                   11481:                             $title =~ s/\W+/_/g;
                   11482:                             if ($title ne '') {
                   11483:                                 push(@pathitems,$title);
                   11484:                             }
                   11485:                         }
                   11486:                     }
                   11487:                 }
                   11488:                 my $maptitle = $mapres->compTitle();
                   11489:                 $maptitle =~ s/\W+/_/g;
                   11490:                 if ($maptitle ne '') {
                   11491:                     push(@pathitems,$maptitle);
                   11492:                 }
                   11493:                 unless ($env{'request.state'} eq 'construct') {
                   11494:                     my $res = $navmap->getBySymb($symb);
                   11495:                     if (ref($res)) {
                   11496:                         my $partlist = $res->parts();
                   11497:                         my $totaluploads = 0;
                   11498:                         if (ref($partlist) eq 'ARRAY') {
                   11499:                             foreach my $part (@{$partlist}) {
                   11500:                                 my @types = $res->responseType($part);
                   11501:                                 my @ids = $res->responseIds($part);
                   11502:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   11503:                                     if ($types[$i] eq 'essay') {
                   11504:                                         my $partid = $part.'_'.$ids[$i];
                   11505:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   11506:                                             $totaluploads ++;
                   11507:                                         }
                   11508:                                     }
                   11509:                                 }
                   11510:                             }
                   11511:                             if ($totaluploads > 1) {
                   11512:                                 $multiresp = 1;
                   11513:                             }
                   11514:                         }
                   11515:                     }
                   11516:                 }
                   11517:             } else {
                   11518:                 return;
                   11519:             }
                   11520:         } else {
                   11521:             return;
                   11522:         }
                   11523:         my $restitle=&Apache::lonnet::gettitle($symb);
                   11524:         $restitle =~ s/\W+/_/g;
                   11525:         if ($restitle eq '') {
                   11526:             $restitle = ($resurl =~ m{/[^/]+$});
                   11527:             if ($restitle eq '') {
                   11528:                 $restitle = time;
                   11529:             }
                   11530:         }
                   11531:         push(@pathitems,$restitle);
                   11532:         $path .= join('/',@pathitems);
                   11533:     }
                   11534:     return ($path,$multiresp);
                   11535: }
                   11536: 
                   11537: =pod
                   11538: 
1.464     albertel 11539: =back
1.41      ng       11540: 
1.112     bowersj2 11541: =head1 CSV Upload/Handling functions
1.38      albertel 11542: 
1.41      ng       11543: =over 4
                   11544: 
1.648     raeburn  11545: =item * &upfile_store($r)
1.41      ng       11546: 
                   11547: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 11548: needs $env{'form.upfile'}
1.41      ng       11549: returns $datatoken to be put into hidden field
                   11550: 
                   11551: =cut
1.31      albertel 11552: 
                   11553: sub upfile_store {
                   11554:     my $r=shift;
1.258     albertel 11555:     $env{'form.upfile'}=~s/\r/\n/gs;
                   11556:     $env{'form.upfile'}=~s/\f/\n/gs;
                   11557:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   11558:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 11559: 
1.258     albertel 11560:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   11561: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 11562:     {
1.158     raeburn  11563:         my $datafile = $r->dir_config('lonDaemons').
                   11564:                            '/tmp/'.$datatoken.'.tmp';
                   11565:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 11566:             print $fh $env{'form.upfile'};
1.158     raeburn  11567:             close($fh);
                   11568:         }
1.31      albertel 11569:     }
                   11570:     return $datatoken;
                   11571: }
                   11572: 
1.56      matthew  11573: =pod
                   11574: 
1.648     raeburn  11575: =item * &load_tmp_file($r)
1.41      ng       11576: 
                   11577: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 11578: needs $env{'form.datatoken'},
                   11579: sets $env{'form.upfile'} to the contents of the file
1.41      ng       11580: 
                   11581: =cut
1.31      albertel 11582: 
                   11583: sub load_tmp_file {
                   11584:     my $r=shift;
                   11585:     my @studentdata=();
                   11586:     {
1.158     raeburn  11587:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 11588:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  11589:         if ( open(my $fh,"<$studentfile") ) {
                   11590:             @studentdata=<$fh>;
                   11591:             close($fh);
                   11592:         }
1.31      albertel 11593:     }
1.258     albertel 11594:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 11595: }
                   11596: 
1.56      matthew  11597: =pod
                   11598: 
1.648     raeburn  11599: =item * &upfile_record_sep()
1.41      ng       11600: 
                   11601: Separate uploaded file into records
                   11602: returns array of records,
1.258     albertel 11603: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       11604: 
                   11605: =cut
1.31      albertel 11606: 
                   11607: sub upfile_record_sep {
1.258     albertel 11608:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 11609:     } else {
1.248     albertel 11610: 	my @records;
1.258     albertel 11611: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 11612: 	    if ($line=~/^\s*$/) { next; }
                   11613: 	    push(@records,$line);
                   11614: 	}
                   11615: 	return @records;
1.31      albertel 11616:     }
                   11617: }
                   11618: 
1.56      matthew  11619: =pod
                   11620: 
1.648     raeburn  11621: =item * &record_sep($record)
1.41      ng       11622: 
1.258     albertel 11623: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       11624: 
                   11625: =cut
                   11626: 
1.263     www      11627: sub takeleft {
                   11628:     my $index=shift;
                   11629:     return substr('0000'.$index,-4,4);
                   11630: }
                   11631: 
1.31      albertel 11632: sub record_sep {
                   11633:     my $record=shift;
                   11634:     my %components=();
1.258     albertel 11635:     if ($env{'form.upfiletype'} eq 'xml') {
                   11636:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 11637:         my $i=0;
1.356     albertel 11638:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 11639:             $field=~s/^(\"|\')//;
                   11640:             $field=~s/(\"|\')$//;
1.263     www      11641:             $components{&takeleft($i)}=$field;
1.31      albertel 11642:             $i++;
                   11643:         }
1.258     albertel 11644:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 11645:         my $i=0;
1.356     albertel 11646:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 11647:             $field=~s/^(\"|\')//;
                   11648:             $field=~s/(\"|\')$//;
1.263     www      11649:             $components{&takeleft($i)}=$field;
1.31      albertel 11650:             $i++;
                   11651:         }
                   11652:     } else {
1.561     www      11653:         my $separator=',';
1.480     banghart 11654:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      11655:             $separator=';';
1.480     banghart 11656:         }
1.31      albertel 11657:         my $i=0;
1.561     www      11658: # the character we are looking for to indicate the end of a quote or a record 
                   11659:         my $looking_for=$separator;
                   11660: # do not add the characters to the fields
                   11661:         my $ignore=0;
                   11662: # we just encountered a separator (or the beginning of the record)
                   11663:         my $just_found_separator=1;
                   11664: # store the field we are working on here
                   11665:         my $field='';
                   11666: # work our way through all characters in record
                   11667:         foreach my $character ($record=~/(.)/g) {
                   11668:             if ($character eq $looking_for) {
                   11669:                if ($character ne $separator) {
                   11670: # Found the end of a quote, again looking for separator
                   11671:                   $looking_for=$separator;
                   11672:                   $ignore=1;
                   11673:                } else {
                   11674: # Found a separator, store away what we got
                   11675:                   $components{&takeleft($i)}=$field;
                   11676: 	          $i++;
                   11677:                   $just_found_separator=1;
                   11678:                   $ignore=0;
                   11679:                   $field='';
                   11680:                }
                   11681:                next;
                   11682:             }
                   11683: # single or double quotation marks after a separator indicate beginning of a quote
                   11684: # we are now looking for the end of the quote and need to ignore separators
                   11685:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   11686:                $looking_for=$character;
                   11687:                next;
                   11688:             }
                   11689: # ignore would be true after we reached the end of a quote
                   11690:             if ($ignore) { next; }
                   11691:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   11692:             $field.=$character;
                   11693:             $just_found_separator=0; 
1.31      albertel 11694:         }
1.561     www      11695: # catch the very last entry, since we never encountered the separator
                   11696:         $components{&takeleft($i)}=$field;
1.31      albertel 11697:     }
                   11698:     return %components;
                   11699: }
                   11700: 
1.144     matthew  11701: ######################################################
                   11702: ######################################################
                   11703: 
1.56      matthew  11704: =pod
                   11705: 
1.648     raeburn  11706: =item * &upfile_select_html()
1.41      ng       11707: 
1.144     matthew  11708: Return HTML code to select a file from the users machine and specify 
                   11709: the file type.
1.41      ng       11710: 
                   11711: =cut
                   11712: 
1.144     matthew  11713: ######################################################
                   11714: ######################################################
1.31      albertel 11715: sub upfile_select_html {
1.144     matthew  11716:     my %Types = (
                   11717:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 11718:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  11719:                  space => &mt('Space separated'),
                   11720:                  tab   => &mt('Tabulator separated'),
                   11721: #                 xml   => &mt('HTML/XML'),
                   11722:                  );
                   11723:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  11724:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  11725:     foreach my $type (sort(keys(%Types))) {
                   11726:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   11727:     }
                   11728:     $Str .= "</select>\n";
                   11729:     return $Str;
1.31      albertel 11730: }
                   11731: 
1.301     albertel 11732: sub get_samples {
                   11733:     my ($records,$toget) = @_;
                   11734:     my @samples=({});
                   11735:     my $got=0;
                   11736:     foreach my $rec (@$records) {
                   11737: 	my %temp = &record_sep($rec);
                   11738: 	if (! grep(/\S/, values(%temp))) { next; }
                   11739: 	if (%temp) {
                   11740: 	    $samples[$got]=\%temp;
                   11741: 	    $got++;
                   11742: 	    if ($got == $toget) { last; }
                   11743: 	}
                   11744:     }
                   11745:     return \@samples;
                   11746: }
                   11747: 
1.144     matthew  11748: ######################################################
                   11749: ######################################################
                   11750: 
1.56      matthew  11751: =pod
                   11752: 
1.648     raeburn  11753: =item * &csv_print_samples($r,$records)
1.41      ng       11754: 
                   11755: Prints a table of sample values from each column uploaded $r is an
                   11756: Apache Request ref, $records is an arrayref from
                   11757: &Apache::loncommon::upfile_record_sep
                   11758: 
                   11759: =cut
                   11760: 
1.144     matthew  11761: ######################################################
                   11762: ######################################################
1.31      albertel 11763: sub csv_print_samples {
                   11764:     my ($r,$records) = @_;
1.662     bisitz   11765:     my $samples = &get_samples($records,5);
1.301     albertel 11766: 
1.594     raeburn  11767:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   11768:               &start_data_table_header_row());
1.356     albertel 11769:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   11770:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  11771:     $r->print(&end_data_table_header_row());
1.301     albertel 11772:     foreach my $hash (@$samples) {
1.594     raeburn  11773: 	$r->print(&start_data_table_row());
1.356     albertel 11774: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 11775: 	    $r->print('<td>');
1.356     albertel 11776: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 11777: 	    $r->print('</td>');
                   11778: 	}
1.594     raeburn  11779: 	$r->print(&end_data_table_row());
1.31      albertel 11780:     }
1.594     raeburn  11781:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 11782: }
                   11783: 
1.144     matthew  11784: ######################################################
                   11785: ######################################################
                   11786: 
1.56      matthew  11787: =pod
                   11788: 
1.648     raeburn  11789: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       11790: 
                   11791: Prints a table to create associations between values and table columns.
1.144     matthew  11792: 
1.41      ng       11793: $r is an Apache Request ref,
                   11794: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  11795: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       11796: 
                   11797: =cut
                   11798: 
1.144     matthew  11799: ######################################################
                   11800: ######################################################
1.31      albertel 11801: sub csv_print_select_table {
                   11802:     my ($r,$records,$d) = @_;
1.301     albertel 11803:     my $i=0;
                   11804:     my $samples = &get_samples($records,1);
1.144     matthew  11805:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  11806: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  11807:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  11808:               '<th>'.&mt('Column').'</th>'.
                   11809:               &end_data_table_header_row()."\n");
1.356     albertel 11810:     foreach my $array_ref (@$d) {
                   11811: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  11812: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 11813: 
1.875     bisitz   11814: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  11815: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 11816: 	$r->print('<option value="none"></option>');
1.356     albertel 11817: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   11818: 	    $r->print('<option value="'.$sample.'"'.
                   11819:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   11820:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 11821: 	}
1.594     raeburn  11822: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 11823: 	$i++;
                   11824:     }
1.594     raeburn  11825:     $r->print(&end_data_table());
1.31      albertel 11826:     $i--;
                   11827:     return $i;
                   11828: }
1.56      matthew  11829: 
1.144     matthew  11830: ######################################################
                   11831: ######################################################
                   11832: 
1.56      matthew  11833: =pod
1.31      albertel 11834: 
1.648     raeburn  11835: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       11836: 
                   11837: Prints a table of sample values from the upload and can make associate samples to internal names.
                   11838: 
                   11839: $r is an Apache Request ref,
                   11840: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   11841: $d is an array of 2 element arrays (internal name, displayed name)
                   11842: 
                   11843: =cut
                   11844: 
1.144     matthew  11845: ######################################################
                   11846: ######################################################
1.31      albertel 11847: sub csv_samples_select_table {
                   11848:     my ($r,$records,$d) = @_;
                   11849:     my $i=0;
1.144     matthew  11850:     #
1.662     bisitz   11851:     my $max_samples = 5;
                   11852:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  11853:     $r->print(&start_data_table().
                   11854:               &start_data_table_header_row().'<th>'.
                   11855:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   11856:               &end_data_table_header_row());
1.301     albertel 11857: 
                   11858:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  11859: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  11860: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 11861: 	foreach my $option (@$d) {
                   11862: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  11863: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 11864:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  11865:                       $display.'</option>');
1.31      albertel 11866: 	}
                   11867: 	$r->print('</select></td><td>');
1.662     bisitz   11868: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 11869: 	    if (defined($samples->[$line]{$key})) { 
                   11870: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   11871: 	    }
                   11872: 	}
1.594     raeburn  11873: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 11874: 	$i++;
                   11875:     }
1.594     raeburn  11876:     $r->print(&end_data_table());
1.31      albertel 11877:     $i--;
                   11878:     return($i);
1.115     matthew  11879: }
                   11880: 
1.144     matthew  11881: ######################################################
                   11882: ######################################################
                   11883: 
1.115     matthew  11884: =pod
                   11885: 
1.648     raeburn  11886: =item * &clean_excel_name($name)
1.115     matthew  11887: 
                   11888: Returns a replacement for $name which does not contain any illegal characters.
                   11889: 
                   11890: =cut
                   11891: 
1.144     matthew  11892: ######################################################
                   11893: ######################################################
1.115     matthew  11894: sub clean_excel_name {
                   11895:     my ($name) = @_;
                   11896:     $name =~ s/[:\*\?\/\\]//g;
                   11897:     if (length($name) > 31) {
                   11898:         $name = substr($name,0,31);
                   11899:     }
                   11900:     return $name;
1.25      albertel 11901: }
1.84      albertel 11902: 
1.85      albertel 11903: =pod
                   11904: 
1.648     raeburn  11905: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 11906: 
                   11907: Returns either 1 or undef
                   11908: 
                   11909: 1 if the part is to be hidden, undef if it is to be shown
                   11910: 
                   11911: Arguments are:
                   11912: 
                   11913: $id the id of the part to be checked
                   11914: $symb, optional the symb of the resource to check
                   11915: $udom, optional the domain of the user to check for
                   11916: $uname, optional the username of the user to check for
                   11917: 
                   11918: =cut
1.84      albertel 11919: 
                   11920: sub check_if_partid_hidden {
                   11921:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 11922:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 11923: 					 $symb,$udom,$uname);
1.141     albertel 11924:     my $truth=1;
                   11925:     #if the string starts with !, then the list is the list to show not hide
                   11926:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 11927:     my @hiddenlist=split(/,/,$hiddenparts);
                   11928:     foreach my $checkid (@hiddenlist) {
1.141     albertel 11929: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 11930:     }
1.141     albertel 11931:     return !$truth;
1.84      albertel 11932: }
1.127     matthew  11933: 
1.138     matthew  11934: 
                   11935: ############################################################
                   11936: ############################################################
                   11937: 
                   11938: =pod
                   11939: 
1.157     matthew  11940: =back 
                   11941: 
1.138     matthew  11942: =head1 cgi-bin script and graphing routines
                   11943: 
1.157     matthew  11944: =over 4
                   11945: 
1.648     raeburn  11946: =item * &get_cgi_id()
1.138     matthew  11947: 
                   11948: Inputs: none
                   11949: 
                   11950: Returns an id which can be used to pass environment variables
                   11951: to various cgi-bin scripts.  These environment variables will
                   11952: be removed from the users environment after a given time by
                   11953: the routine &Apache::lonnet::transfer_profile_to_env.
                   11954: 
                   11955: =cut
                   11956: 
                   11957: ############################################################
                   11958: ############################################################
1.152     albertel 11959: my $uniq=0;
1.136     matthew  11960: sub get_cgi_id {
1.154     albertel 11961:     $uniq=($uniq+1)%100000;
1.280     albertel 11962:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  11963: }
                   11964: 
1.127     matthew  11965: ############################################################
                   11966: ############################################################
                   11967: 
                   11968: =pod
                   11969: 
1.648     raeburn  11970: =item * &DrawBarGraph()
1.127     matthew  11971: 
1.138     matthew  11972: Facilitates the plotting of data in a (stacked) bar graph.
                   11973: Puts plot definition data into the users environment in order for 
                   11974: graph.png to plot it.  Returns an <img> tag for the plot.
                   11975: The bars on the plot are labeled '1','2',...,'n'.
                   11976: 
                   11977: Inputs:
                   11978: 
                   11979: =over 4
                   11980: 
                   11981: =item $Title: string, the title of the plot
                   11982: 
                   11983: =item $xlabel: string, text describing the X-axis of the plot
                   11984: 
                   11985: =item $ylabel: string, text describing the Y-axis of the plot
                   11986: 
                   11987: =item $Max: scalar, the maximum Y value to use in the plot
                   11988: If $Max is < any data point, the graph will not be rendered.
                   11989: 
1.140     matthew  11990: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  11991: they are plotted.  If undefined, default values will be used.
                   11992: 
1.178     matthew  11993: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   11994: 
1.138     matthew  11995: =item @Values: An array of array references.  Each array reference holds data
                   11996: to be plotted in a stacked bar chart.
                   11997: 
1.239     matthew  11998: =item If the final element of @Values is a hash reference the key/value
                   11999: pairs will be added to the graph definition.
                   12000: 
1.138     matthew  12001: =back
                   12002: 
                   12003: Returns:
                   12004: 
                   12005: An <img> tag which references graph.png and the appropriate identifying
                   12006: information for the plot.
                   12007: 
1.127     matthew  12008: =cut
                   12009: 
                   12010: ############################################################
                   12011: ############################################################
1.134     matthew  12012: sub DrawBarGraph {
1.178     matthew  12013:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  12014:     #
                   12015:     if (! defined($colors)) {
                   12016:         $colors = ['#33ff00', 
                   12017:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   12018:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   12019:                   ]; 
                   12020:     }
1.228     matthew  12021:     my $extra_settings = {};
                   12022:     if (ref($Values[-1]) eq 'HASH') {
                   12023:         $extra_settings = pop(@Values);
                   12024:     }
1.127     matthew  12025:     #
1.136     matthew  12026:     my $identifier = &get_cgi_id();
                   12027:     my $id = 'cgi.'.$identifier;        
1.129     matthew  12028:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  12029:         return '';
                   12030:     }
1.225     matthew  12031:     #
                   12032:     my @Labels;
                   12033:     if (defined($labels)) {
                   12034:         @Labels = @$labels;
                   12035:     } else {
                   12036:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   12037:             push (@Labels,$i+1);
                   12038:         }
                   12039:     }
                   12040:     #
1.129     matthew  12041:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  12042:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  12043:     my %ValuesHash;
                   12044:     my $NumSets=1;
                   12045:     foreach my $array (@Values) {
                   12046:         next if (! ref($array));
1.136     matthew  12047:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  12048:             join(',',@$array);
1.129     matthew  12049:     }
1.127     matthew  12050:     #
1.136     matthew  12051:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  12052:     if ($NumBars < 3) {
                   12053:         $width = 120+$NumBars*32;
1.220     matthew  12054:         $xskip = 1;
1.225     matthew  12055:         $bar_width = 30;
                   12056:     } elsif ($NumBars < 5) {
                   12057:         $width = 120+$NumBars*20;
                   12058:         $xskip = 1;
                   12059:         $bar_width = 20;
1.220     matthew  12060:     } elsif ($NumBars < 10) {
1.136     matthew  12061:         $width = 120+$NumBars*15;
                   12062:         $xskip = 1;
                   12063:         $bar_width = 15;
                   12064:     } elsif ($NumBars <= 25) {
                   12065:         $width = 120+$NumBars*11;
                   12066:         $xskip = 5;
                   12067:         $bar_width = 8;
                   12068:     } elsif ($NumBars <= 50) {
                   12069:         $width = 120+$NumBars*8;
                   12070:         $xskip = 5;
                   12071:         $bar_width = 4;
                   12072:     } else {
                   12073:         $width = 120+$NumBars*8;
                   12074:         $xskip = 5;
                   12075:         $bar_width = 4;
                   12076:     }
                   12077:     #
1.137     matthew  12078:     $Max = 1 if ($Max < 1);
                   12079:     if ( int($Max) < $Max ) {
                   12080:         $Max++;
                   12081:         $Max = int($Max);
                   12082:     }
1.127     matthew  12083:     $Title  = '' if (! defined($Title));
                   12084:     $xlabel = '' if (! defined($xlabel));
                   12085:     $ylabel = '' if (! defined($ylabel));
1.369     www      12086:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   12087:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   12088:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  12089:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  12090:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   12091:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   12092:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   12093:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12094:     $ValuesHash{$id.'.height'}   = $height;
                   12095:     $ValuesHash{$id.'.width'}    = $width;
                   12096:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   12097:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   12098:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  12099:     #
1.228     matthew  12100:     # Deal with other parameters
                   12101:     while (my ($key,$value) = each(%$extra_settings)) {
                   12102:         $ValuesHash{$id.'.'.$key} = $value;
                   12103:     }
                   12104:     #
1.646     raeburn  12105:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  12106:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12107: }
                   12108: 
                   12109: ############################################################
                   12110: ############################################################
                   12111: 
                   12112: =pod
                   12113: 
1.648     raeburn  12114: =item * &DrawXYGraph()
1.137     matthew  12115: 
1.138     matthew  12116: Facilitates the plotting of data in an XY graph.
                   12117: Puts plot definition data into the users environment in order for 
                   12118: graph.png to plot it.  Returns an <img> tag for the plot.
                   12119: 
                   12120: Inputs:
                   12121: 
                   12122: =over 4
                   12123: 
                   12124: =item $Title: string, the title of the plot
                   12125: 
                   12126: =item $xlabel: string, text describing the X-axis of the plot
                   12127: 
                   12128: =item $ylabel: string, text describing the Y-axis of the plot
                   12129: 
                   12130: =item $Max: scalar, the maximum Y value to use in the plot
                   12131: If $Max is < any data point, the graph will not be rendered.
                   12132: 
                   12133: =item $colors: Array ref containing the hex color codes for the data to be 
                   12134: plotted in.  If undefined, default values will be used.
                   12135: 
                   12136: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12137: 
                   12138: =item $Ydata: Array ref containing Array refs.  
1.185     www      12139: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  12140: 
                   12141: =item %Values: hash indicating or overriding any default values which are 
                   12142: passed to graph.png.  
                   12143: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12144: 
                   12145: =back
                   12146: 
                   12147: Returns:
                   12148: 
                   12149: An <img> tag which references graph.png and the appropriate identifying
                   12150: information for the plot.
                   12151: 
1.137     matthew  12152: =cut
                   12153: 
                   12154: ############################################################
                   12155: ############################################################
                   12156: sub DrawXYGraph {
                   12157:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   12158:     #
                   12159:     # Create the identifier for the graph
                   12160:     my $identifier = &get_cgi_id();
                   12161:     my $id = 'cgi.'.$identifier;
                   12162:     #
                   12163:     $Title  = '' if (! defined($Title));
                   12164:     $xlabel = '' if (! defined($xlabel));
                   12165:     $ylabel = '' if (! defined($ylabel));
                   12166:     my %ValuesHash = 
                   12167:         (
1.369     www      12168:          $id.'.title'  => &escape($Title),
                   12169:          $id.'.xlabel' => &escape($xlabel),
                   12170:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  12171:          $id.'.y_max_value'=> $Max,
                   12172:          $id.'.labels'     => join(',',@$Xlabels),
                   12173:          $id.'.PlotType'   => 'XY',
                   12174:          );
                   12175:     #
                   12176:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12177:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12178:     }
                   12179:     #
                   12180:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   12181:         return '';
                   12182:     }
                   12183:     my $NumSets=1;
1.138     matthew  12184:     foreach my $array (@{$Ydata}){
1.137     matthew  12185:         next if (! ref($array));
                   12186:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   12187:     }
1.138     matthew  12188:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  12189:     #
                   12190:     # Deal with other parameters
                   12191:     while (my ($key,$value) = each(%Values)) {
                   12192:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  12193:     }
                   12194:     #
1.646     raeburn  12195:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  12196:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12197: }
                   12198: 
                   12199: ############################################################
                   12200: ############################################################
                   12201: 
                   12202: =pod
                   12203: 
1.648     raeburn  12204: =item * &DrawXYYGraph()
1.138     matthew  12205: 
                   12206: Facilitates the plotting of data in an XY graph with two Y axes.
                   12207: Puts plot definition data into the users environment in order for 
                   12208: graph.png to plot it.  Returns an <img> tag for the plot.
                   12209: 
                   12210: Inputs:
                   12211: 
                   12212: =over 4
                   12213: 
                   12214: =item $Title: string, the title of the plot
                   12215: 
                   12216: =item $xlabel: string, text describing the X-axis of the plot
                   12217: 
                   12218: =item $ylabel: string, text describing the Y-axis of the plot
                   12219: 
                   12220: =item $colors: Array ref containing the hex color codes for the data to be 
                   12221: plotted in.  If undefined, default values will be used.
                   12222: 
                   12223: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12224: 
                   12225: =item $Ydata1: The first data set
                   12226: 
                   12227: =item $Min1: The minimum value of the left Y-axis
                   12228: 
                   12229: =item $Max1: The maximum value of the left Y-axis
                   12230: 
                   12231: =item $Ydata2: The second data set
                   12232: 
                   12233: =item $Min2: The minimum value of the right Y-axis
                   12234: 
                   12235: =item $Max2: The maximum value of the left Y-axis
                   12236: 
                   12237: =item %Values: hash indicating or overriding any default values which are 
                   12238: passed to graph.png.  
                   12239: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12240: 
                   12241: =back
                   12242: 
                   12243: Returns:
                   12244: 
                   12245: An <img> tag which references graph.png and the appropriate identifying
                   12246: information for the plot.
1.136     matthew  12247: 
                   12248: =cut
                   12249: 
                   12250: ############################################################
                   12251: ############################################################
1.137     matthew  12252: sub DrawXYYGraph {
                   12253:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   12254:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  12255:     #
                   12256:     # Create the identifier for the graph
                   12257:     my $identifier = &get_cgi_id();
                   12258:     my $id = 'cgi.'.$identifier;
                   12259:     #
                   12260:     $Title  = '' if (! defined($Title));
                   12261:     $xlabel = '' if (! defined($xlabel));
                   12262:     $ylabel = '' if (! defined($ylabel));
                   12263:     my %ValuesHash = 
                   12264:         (
1.369     www      12265:          $id.'.title'  => &escape($Title),
                   12266:          $id.'.xlabel' => &escape($xlabel),
                   12267:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  12268:          $id.'.labels' => join(',',@$Xlabels),
                   12269:          $id.'.PlotType' => 'XY',
                   12270:          $id.'.NumSets' => 2,
1.137     matthew  12271:          $id.'.two_axes' => 1,
                   12272:          $id.'.y1_max_value' => $Max1,
                   12273:          $id.'.y1_min_value' => $Min1,
                   12274:          $id.'.y2_max_value' => $Max2,
                   12275:          $id.'.y2_min_value' => $Min2,
1.136     matthew  12276:          );
                   12277:     #
1.137     matthew  12278:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12279:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12280:     }
                   12281:     #
                   12282:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   12283:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  12284:         return '';
                   12285:     }
                   12286:     my $NumSets=1;
1.137     matthew  12287:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  12288:         next if (! ref($array));
                   12289:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  12290:     }
                   12291:     #
                   12292:     # Deal with other parameters
                   12293:     while (my ($key,$value) = each(%Values)) {
                   12294:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  12295:     }
                   12296:     #
1.646     raeburn  12297:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 12298:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  12299: }
                   12300: 
                   12301: ############################################################
                   12302: ############################################################
                   12303: 
                   12304: =pod
                   12305: 
1.157     matthew  12306: =back 
                   12307: 
1.139     matthew  12308: =head1 Statistics helper routines?  
                   12309: 
                   12310: Bad place for them but what the hell.
                   12311: 
1.157     matthew  12312: =over 4
                   12313: 
1.648     raeburn  12314: =item * &chartlink()
1.139     matthew  12315: 
                   12316: Returns a link to the chart for a specific student.  
                   12317: 
                   12318: Inputs:
                   12319: 
                   12320: =over 4
                   12321: 
                   12322: =item $linktext: The text of the link
                   12323: 
                   12324: =item $sname: The students username
                   12325: 
                   12326: =item $sdomain: The students domain
                   12327: 
                   12328: =back
                   12329: 
1.157     matthew  12330: =back
                   12331: 
1.139     matthew  12332: =cut
                   12333: 
                   12334: ############################################################
                   12335: ############################################################
                   12336: sub chartlink {
                   12337:     my ($linktext, $sname, $sdomain) = @_;
                   12338:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      12339:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 12340:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  12341:        '">'.$linktext.'</a>';
1.153     matthew  12342: }
                   12343: 
                   12344: #######################################################
                   12345: #######################################################
                   12346: 
                   12347: =pod
                   12348: 
                   12349: =head1 Course Environment Routines
1.157     matthew  12350: 
                   12351: =over 4
1.153     matthew  12352: 
1.648     raeburn  12353: =item * &restore_course_settings()
1.153     matthew  12354: 
1.648     raeburn  12355: =item * &store_course_settings()
1.153     matthew  12356: 
                   12357: Restores/Store indicated form parameters from the course environment.
                   12358: Will not overwrite existing values of the form parameters.
                   12359: 
                   12360: Inputs: 
                   12361: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   12362: 
                   12363: a hash ref describing the data to be stored.  For example:
                   12364:    
                   12365: %Save_Parameters = ('Status' => 'scalar',
                   12366:     'chartoutputmode' => 'scalar',
                   12367:     'chartoutputdata' => 'scalar',
                   12368:     'Section' => 'array',
1.373     raeburn  12369:     'Group' => 'array',
1.153     matthew  12370:     'StudentData' => 'array',
                   12371:     'Maps' => 'array');
                   12372: 
                   12373: Returns: both routines return nothing
                   12374: 
1.631     raeburn  12375: =back
                   12376: 
1.153     matthew  12377: =cut
                   12378: 
                   12379: #######################################################
                   12380: #######################################################
                   12381: sub store_course_settings {
1.496     albertel 12382:     return &store_settings($env{'request.course.id'},@_);
                   12383: }
                   12384: 
                   12385: sub store_settings {
1.153     matthew  12386:     # save to the environment
                   12387:     # appenv the same items, just to be safe
1.300     albertel 12388:     my $udom  = $env{'user.domain'};
                   12389:     my $uname = $env{'user.name'};
1.496     albertel 12390:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12391:     my %SaveHash;
                   12392:     my %AppHash;
                   12393:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 12394:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 12395:         my $envname = 'environment.'.$basename;
1.258     albertel 12396:         if (exists($env{'form.'.$setting})) {
1.153     matthew  12397:             # Save this value away
                   12398:             if ($type eq 'scalar' &&
1.258     albertel 12399:                 (! exists($env{$envname}) || 
                   12400:                  $env{$envname} ne $env{'form.'.$setting})) {
                   12401:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   12402:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  12403:             } elsif ($type eq 'array') {
                   12404:                 my $stored_form;
1.258     albertel 12405:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  12406:                     $stored_form = join(',',
                   12407:                                         map {
1.369     www      12408:                                             &escape($_);
1.258     albertel 12409:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  12410:                 } else {
                   12411:                     $stored_form = 
1.369     www      12412:                         &escape($env{'form.'.$setting});
1.153     matthew  12413:                 }
                   12414:                 # Determine if the array contents are the same.
1.258     albertel 12415:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  12416:                     $SaveHash{$basename} = $stored_form;
                   12417:                     $AppHash{$envname}   = $stored_form;
                   12418:                 }
                   12419:             }
                   12420:         }
                   12421:     }
                   12422:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 12423:                                           $udom,$uname);
1.153     matthew  12424:     if ($put_result !~ /^(ok|delayed)/) {
                   12425:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   12426:                                  'got error:'.$put_result);
                   12427:     }
                   12428:     # Make sure these settings stick around in this session, too
1.646     raeburn  12429:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  12430:     return;
                   12431: }
                   12432: 
                   12433: sub restore_course_settings {
1.499     albertel 12434:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 12435: }
                   12436: 
                   12437: sub restore_settings {
                   12438:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12439:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 12440:         next if (exists($env{'form.'.$setting}));
1.496     albertel 12441:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  12442:             '.'.$setting;
1.258     albertel 12443:         if (exists($env{$envname})) {
1.153     matthew  12444:             if ($type eq 'scalar') {
1.258     albertel 12445:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  12446:             } elsif ($type eq 'array') {
1.258     albertel 12447:                 $env{'form.'.$setting} = [ 
1.153     matthew  12448:                                            map { 
1.369     www      12449:                                                &unescape($_); 
1.258     albertel 12450:                                            } split(',',$env{$envname})
1.153     matthew  12451:                                            ];
                   12452:             }
                   12453:         }
                   12454:     }
1.127     matthew  12455: }
                   12456: 
1.618     raeburn  12457: #######################################################
                   12458: #######################################################
                   12459: 
                   12460: =pod
                   12461: 
                   12462: =head1 Domain E-mail Routines  
                   12463: 
                   12464: =over 4
                   12465: 
1.648     raeburn  12466: =item * &build_recipient_list()
1.618     raeburn  12467: 
1.884     raeburn  12468: Build recipient lists for five types of e-mail:
1.766     raeburn  12469: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  12470: (d) Help requests, (e) Course requests needing approval,  generated by
                   12471: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   12472: loncoursequeueadmin.pm respectively.
1.618     raeburn  12473: 
                   12474: Inputs:
1.619     raeburn  12475: defmail (scalar - email address of default recipient), 
1.618     raeburn  12476: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  12477: defdom (domain for which to retrieve configuration settings),
                   12478: origmail (scalar - email address of recipient from loncapa.conf, 
                   12479: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  12480: 
1.655     raeburn  12481: Returns: comma separated list of addresses to which to send e-mail.
                   12482: 
                   12483: =back
1.618     raeburn  12484: 
                   12485: =cut
                   12486: 
                   12487: ############################################################
                   12488: ############################################################
                   12489: sub build_recipient_list {
1.619     raeburn  12490:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  12491:     my @recipients;
                   12492:     my $otheremails;
                   12493:     my %domconfig =
                   12494:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   12495:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  12496:         if (exists($domconfig{'contacts'}{$mailing})) {
                   12497:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   12498:                 my @contacts = ('adminemail','supportemail');
                   12499:                 foreach my $item (@contacts) {
                   12500:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   12501:                         my $addr = $domconfig{'contacts'}{$item}; 
                   12502:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12503:                             push(@recipients,$addr);
                   12504:                         }
1.619     raeburn  12505:                     }
1.766     raeburn  12506:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  12507:                 }
                   12508:             }
1.766     raeburn  12509:         } elsif ($origmail ne '') {
                   12510:             push(@recipients,$origmail);
1.618     raeburn  12511:         }
1.619     raeburn  12512:     } elsif ($origmail ne '') {
                   12513:         push(@recipients,$origmail);
1.618     raeburn  12514:     }
1.688     raeburn  12515:     if (defined($defmail)) {
                   12516:         if ($defmail ne '') {
                   12517:             push(@recipients,$defmail);
                   12518:         }
1.618     raeburn  12519:     }
                   12520:     if ($otheremails) {
1.619     raeburn  12521:         my @others;
                   12522:         if ($otheremails =~ /,/) {
                   12523:             @others = split(/,/,$otheremails);
1.618     raeburn  12524:         } else {
1.619     raeburn  12525:             push(@others,$otheremails);
                   12526:         }
                   12527:         foreach my $addr (@others) {
                   12528:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12529:                 push(@recipients,$addr);
                   12530:             }
1.618     raeburn  12531:         }
                   12532:     }
1.619     raeburn  12533:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  12534:     return $recipientlist;
                   12535: }
                   12536: 
1.127     matthew  12537: ############################################################
                   12538: ############################################################
1.154     albertel 12539: 
1.655     raeburn  12540: =pod
                   12541: 
                   12542: =head1 Course Catalog Routines
                   12543: 
                   12544: =over 4
                   12545: 
                   12546: =item * &gather_categories()
                   12547: 
                   12548: Converts category definitions - keys of categories hash stored in  
                   12549: coursecategories in configuration.db on the primary library server in a 
                   12550: domain - to an array.  Also generates javascript and idx hash used to 
                   12551: generate Domain Coordinator interface for editing Course Categories.
                   12552: 
                   12553: Inputs:
1.663     raeburn  12554: 
1.655     raeburn  12555: categories (reference to hash of category definitions).
1.663     raeburn  12556: 
1.655     raeburn  12557: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12558:       categories and subcategories).
1.663     raeburn  12559: 
1.655     raeburn  12560: idx (reference to hash of counters used in Domain Coordinator interface for 
                   12561:       editing Course Categories).
1.663     raeburn  12562: 
1.655     raeburn  12563: jsarray (reference to array of categories used to create Javascript arrays for
                   12564:          Domain Coordinator interface for editing Course Categories).
                   12565: 
                   12566: Returns: nothing
                   12567: 
                   12568: Side effects: populates cats, idx and jsarray. 
                   12569: 
                   12570: =cut
                   12571: 
                   12572: sub gather_categories {
                   12573:     my ($categories,$cats,$idx,$jsarray) = @_;
                   12574:     my %counters;
                   12575:     my $num = 0;
                   12576:     foreach my $item (keys(%{$categories})) {
                   12577:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   12578:         if ($container eq '' && $depth == 0) {
                   12579:             $cats->[$depth][$categories->{$item}] = $cat;
                   12580:         } else {
                   12581:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   12582:         }
                   12583:         my ($escitem,$tail) = split(/:/,$item,2);
                   12584:         if ($counters{$tail} eq '') {
                   12585:             $counters{$tail} = $num;
                   12586:             $num ++;
                   12587:         }
                   12588:         if (ref($idx) eq 'HASH') {
                   12589:             $idx->{$item} = $counters{$tail};
                   12590:         }
                   12591:         if (ref($jsarray) eq 'ARRAY') {
                   12592:             push(@{$jsarray->[$counters{$tail}]},$item);
                   12593:         }
                   12594:     }
                   12595:     return;
                   12596: }
                   12597: 
                   12598: =pod
                   12599: 
                   12600: =item * &extract_categories()
                   12601: 
                   12602: Used to generate breadcrumb trails for course categories.
                   12603: 
                   12604: Inputs:
1.663     raeburn  12605: 
1.655     raeburn  12606: categories (reference to hash of category definitions).
1.663     raeburn  12607: 
1.655     raeburn  12608: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12609:       categories and subcategories).
1.663     raeburn  12610: 
1.655     raeburn  12611: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  12612: 
1.655     raeburn  12613: allitems (reference to hash - key is category key 
                   12614:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  12615: 
1.655     raeburn  12616: idx (reference to hash of counters used in Domain Coordinator interface for
                   12617:       editing Course Categories).
1.663     raeburn  12618: 
1.655     raeburn  12619: jsarray (reference to array of categories used to create Javascript arrays for
                   12620:          Domain Coordinator interface for editing Course Categories).
                   12621: 
1.665     raeburn  12622: subcats (reference to hash of arrays containing all subcategories within each 
                   12623:          category, -recursive)
                   12624: 
1.655     raeburn  12625: Returns: nothing
                   12626: 
                   12627: Side effects: populates trails and allitems hash references.
                   12628: 
                   12629: =cut
                   12630: 
                   12631: sub extract_categories {
1.665     raeburn  12632:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  12633:     if (ref($categories) eq 'HASH') {
                   12634:         &gather_categories($categories,$cats,$idx,$jsarray);
                   12635:         if (ref($cats->[0]) eq 'ARRAY') {
                   12636:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   12637:                 my $name = $cats->[0][$i];
                   12638:                 my $item = &escape($name).'::0';
                   12639:                 my $trailstr;
                   12640:                 if ($name eq 'instcode') {
                   12641:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  12642:                 } elsif ($name eq 'communities') {
                   12643:                     $trailstr = &mt('Communities');
1.655     raeburn  12644:                 } else {
                   12645:                     $trailstr = $name;
                   12646:                 }
                   12647:                 if ($allitems->{$item} eq '') {
                   12648:                     push(@{$trails},$trailstr);
                   12649:                     $allitems->{$item} = scalar(@{$trails})-1;
                   12650:                 }
                   12651:                 my @parents = ($name);
                   12652:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   12653:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   12654:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  12655:                         if (ref($subcats) eq 'HASH') {
                   12656:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   12657:                         }
                   12658:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   12659:                     }
                   12660:                 } else {
                   12661:                     if (ref($subcats) eq 'HASH') {
                   12662:                         $subcats->{$item} = [];
1.655     raeburn  12663:                     }
                   12664:                 }
                   12665:             }
                   12666:         }
                   12667:     }
                   12668:     return;
                   12669: }
                   12670: 
                   12671: =pod
                   12672: 
                   12673: =item *&recurse_categories()
                   12674: 
                   12675: Recursively used to generate breadcrumb trails for course categories.
                   12676: 
                   12677: Inputs:
1.663     raeburn  12678: 
1.655     raeburn  12679: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12680:       categories and subcategories).
1.663     raeburn  12681: 
1.655     raeburn  12682: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  12683: 
                   12684: category (current course category, for which breadcrumb trail is being generated).
                   12685: 
                   12686: trails (reference to array of breadcrumb trails for each category).
                   12687: 
1.655     raeburn  12688: allitems (reference to hash - key is category key
                   12689:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  12690: 
1.655     raeburn  12691: parents (array containing containers directories for current category, 
                   12692:          back to top level). 
                   12693: 
                   12694: Returns: nothing
                   12695: 
                   12696: Side effects: populates trails and allitems hash references
                   12697: 
                   12698: =cut
                   12699: 
                   12700: sub recurse_categories {
1.665     raeburn  12701:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  12702:     my $shallower = $depth - 1;
                   12703:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   12704:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   12705:             my $name = $cats->[$depth]{$category}[$k];
                   12706:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   12707:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   12708:             if ($allitems->{$item} eq '') {
                   12709:                 push(@{$trails},$trailstr);
                   12710:                 $allitems->{$item} = scalar(@{$trails})-1;
                   12711:             }
                   12712:             my $deeper = $depth+1;
                   12713:             push(@{$parents},$category);
1.665     raeburn  12714:             if (ref($subcats) eq 'HASH') {
                   12715:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   12716:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   12717:                     my $higher;
                   12718:                     if ($j > 0) {
                   12719:                         $higher = &escape($parents->[$j]).':'.
                   12720:                                   &escape($parents->[$j-1]).':'.$j;
                   12721:                     } else {
                   12722:                         $higher = &escape($parents->[$j]).'::'.$j;
                   12723:                     }
                   12724:                     push(@{$subcats->{$higher}},$subcat);
                   12725:                 }
                   12726:             }
                   12727:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   12728:                                 $subcats);
1.655     raeburn  12729:             pop(@{$parents});
                   12730:         }
                   12731:     } else {
                   12732:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   12733:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   12734:         if ($allitems->{$item} eq '') {
                   12735:             push(@{$trails},$trailstr);
                   12736:             $allitems->{$item} = scalar(@{$trails})-1;
                   12737:         }
                   12738:     }
                   12739:     return;
                   12740: }
                   12741: 
1.663     raeburn  12742: =pod
                   12743: 
                   12744: =item *&assign_categories_table()
                   12745: 
                   12746: Create a datatable for display of hierarchical categories in a domain,
                   12747: with checkboxes to allow a course to be categorized. 
                   12748: 
                   12749: Inputs:
                   12750: 
                   12751: cathash - reference to hash of categories defined for the domain (from
                   12752:           configuration.db)
                   12753: 
                   12754: currcat - scalar with an & separated list of categories assigned to a course. 
                   12755: 
1.919     raeburn  12756: type    - scalar contains course type (Course or Community).
                   12757: 
1.663     raeburn  12758: Returns: $output (markup to be displayed) 
                   12759: 
                   12760: =cut
                   12761: 
                   12762: sub assign_categories_table {
1.919     raeburn  12763:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  12764:     my $output;
                   12765:     if (ref($cathash) eq 'HASH') {
                   12766:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   12767:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   12768:         $maxdepth = scalar(@cats);
                   12769:         if (@cats > 0) {
                   12770:             my $itemcount = 0;
                   12771:             if (ref($cats[0]) eq 'ARRAY') {
                   12772:                 my @currcategories;
                   12773:                 if ($currcat ne '') {
                   12774:                     @currcategories = split('&',$currcat);
                   12775:                 }
1.919     raeburn  12776:                 my $table;
1.663     raeburn  12777:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   12778:                     my $parent = $cats[0][$i];
1.919     raeburn  12779:                     next if ($parent eq 'instcode');
                   12780:                     if ($type eq 'Community') {
                   12781:                         next unless ($parent eq 'communities');
                   12782:                     } else {
                   12783:                         next if ($parent eq 'communities');
                   12784:                     }
1.663     raeburn  12785:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12786:                     my $item = &escape($parent).'::0';
                   12787:                     my $checked = '';
                   12788:                     if (@currcategories > 0) {
                   12789:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   12790:                             $checked = ' checked="checked"';
1.663     raeburn  12791:                         }
                   12792:                     }
1.919     raeburn  12793:                     my $parent_title = $parent;
                   12794:                     if ($parent eq 'communities') {
                   12795:                         $parent_title = &mt('Communities');
                   12796:                     }
                   12797:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   12798:                               '<input type="checkbox" name="usecategory" value="'.
                   12799:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   12800:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  12801:                     my $depth = 1;
                   12802:                     push(@path,$parent);
1.919     raeburn  12803:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  12804:                     pop(@path);
1.919     raeburn  12805:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  12806:                     $itemcount ++;
                   12807:                 }
1.919     raeburn  12808:                 if ($itemcount) {
                   12809:                     $output = &Apache::loncommon::start_data_table().
                   12810:                               $table.
                   12811:                               &Apache::loncommon::end_data_table();
                   12812:                 }
1.663     raeburn  12813:             }
                   12814:         }
                   12815:     }
                   12816:     return $output;
                   12817: }
                   12818: 
                   12819: =pod
                   12820: 
                   12821: =item *&assign_category_rows()
                   12822: 
                   12823: Create a datatable row for display of nested categories in a domain,
                   12824: with checkboxes to allow a course to be categorized,called recursively.
                   12825: 
                   12826: Inputs:
                   12827: 
                   12828: itemcount - track row number for alternating colors
                   12829: 
                   12830: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   12831:       categories and subcategories.
                   12832: 
                   12833: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   12834: 
                   12835: parent - parent of current category item
                   12836: 
                   12837: path - Array containing all categories back up through the hierarchy from the
                   12838:        current category to the top level.
                   12839: 
                   12840: currcategories - reference to array of current categories assigned to the course
                   12841: 
                   12842: Returns: $output (markup to be displayed).
                   12843: 
                   12844: =cut
                   12845: 
                   12846: sub assign_category_rows {
                   12847:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   12848:     my ($text,$name,$item,$chgstr);
                   12849:     if (ref($cats) eq 'ARRAY') {
                   12850:         my $maxdepth = scalar(@{$cats});
                   12851:         if (ref($cats->[$depth]) eq 'HASH') {
                   12852:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   12853:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   12854:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   12855:                 $text .= '<td><table class="LC_datatable">';
                   12856:                 for (my $j=0; $j<$numchildren; $j++) {
                   12857:                     $name = $cats->[$depth]{$parent}[$j];
                   12858:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   12859:                     my $deeper = $depth+1;
                   12860:                     my $checked = '';
                   12861:                     if (ref($currcategories) eq 'ARRAY') {
                   12862:                         if (@{$currcategories} > 0) {
                   12863:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   12864:                                 $checked = ' checked="checked"';
1.663     raeburn  12865:                             }
                   12866:                         }
                   12867:                     }
1.664     raeburn  12868:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   12869:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  12870:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   12871:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   12872:                              '</td><td>';
1.663     raeburn  12873:                     if (ref($path) eq 'ARRAY') {
                   12874:                         push(@{$path},$name);
                   12875:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   12876:                         pop(@{$path});
                   12877:                     }
                   12878:                     $text .= '</td></tr>';
                   12879:                 }
                   12880:                 $text .= '</table></td>';
                   12881:             }
                   12882:         }
                   12883:     }
                   12884:     return $text;
                   12885: }
                   12886: 
1.655     raeburn  12887: ############################################################
                   12888: ############################################################
                   12889: 
                   12890: 
1.443     albertel 12891: sub commit_customrole {
1.664     raeburn  12892:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  12893:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 12894:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   12895:                          ($end?', ending '.localtime($end):'').': <b>'.
                   12896:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  12897:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 12898:                  '</b><br />';
                   12899:     return $output;
                   12900: }
                   12901: 
                   12902: sub commit_standardrole {
1.541     raeburn  12903:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   12904:     my ($output,$logmsg,$linefeed);
                   12905:     if ($context eq 'auto') {
                   12906:         $linefeed = "\n";
                   12907:     } else {
                   12908:         $linefeed = "<br />\n";
                   12909:     }  
1.443     albertel 12910:     if ($three eq 'st') {
1.541     raeburn  12911:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   12912:                                          $one,$two,$sec,$context);
                   12913:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  12914:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   12915:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 12916:         } else {
1.541     raeburn  12917:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 12918:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12919:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   12920:             if ($context eq 'auto') {
                   12921:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   12922:             } else {
                   12923:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   12924:                &mt('Add to classlist').': <b>ok</b>';
                   12925:             }
                   12926:             $output .= $linefeed;
1.443     albertel 12927:         }
                   12928:     } else {
                   12929:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   12930:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  12931:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  12932:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  12933:         if ($context eq 'auto') {
                   12934:             $output .= $result.$linefeed;
                   12935:         } else {
                   12936:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   12937:         }
1.443     albertel 12938:     }
                   12939:     return $output;
                   12940: }
                   12941: 
                   12942: sub commit_studentrole {
1.541     raeburn  12943:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  12944:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  12945:     if ($context eq 'auto') {
                   12946:         $linefeed = "\n";
                   12947:     } else {
                   12948:         $linefeed = '<br />'."\n";
                   12949:     }
1.443     albertel 12950:     if (defined($one) && defined($two)) {
                   12951:         my $cid=$one.'_'.$two;
                   12952:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   12953:         my $secchange = 0;
                   12954:         my $expire_role_result;
                   12955:         my $modify_section_result;
1.628     raeburn  12956:         if ($oldsec ne '-1') { 
                   12957:             if ($oldsec ne $sec) {
1.443     albertel 12958:                 $secchange = 1;
1.628     raeburn  12959:                 my $now = time;
1.443     albertel 12960:                 my $uurl='/'.$cid;
                   12961:                 $uurl=~s/\_/\//g;
                   12962:                 if ($oldsec) {
                   12963:                     $uurl.='/'.$oldsec;
                   12964:                 }
1.626     raeburn  12965:                 $oldsecurl = $uurl;
1.628     raeburn  12966:                 $expire_role_result = 
1.652     raeburn  12967:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  12968:                 if ($env{'request.course.sec'} ne '') { 
                   12969:                     if ($expire_role_result eq 'refused') {
                   12970:                         my @roles = ('st');
                   12971:                         my @statuses = ('previous');
                   12972:                         my @roledoms = ($one);
                   12973:                         my $withsec = 1;
                   12974:                         my %roleshash = 
                   12975:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   12976:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   12977:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   12978:                             my ($oldstart,$oldend) = 
                   12979:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   12980:                             if ($oldend > 0 && $oldend <= $now) {
                   12981:                                 $expire_role_result = 'ok';
                   12982:                             }
                   12983:                         }
                   12984:                     }
                   12985:                 }
1.443     albertel 12986:                 $result = $expire_role_result;
                   12987:             }
                   12988:         }
                   12989:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  12990:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 12991:             if ($modify_section_result =~ /^ok/) {
                   12992:                 if ($secchange == 1) {
1.628     raeburn  12993:                     if ($sec eq '') {
                   12994:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   12995:                     } else {
                   12996:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   12997:                     }
1.443     albertel 12998:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  12999:                     if ($sec eq '') {
                   13000:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   13001:                     } else {
                   13002:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13003:                     }
1.443     albertel 13004:                 } else {
1.628     raeburn  13005:                     if ($sec eq '') {
                   13006:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   13007:                     } else {
                   13008:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13009:                     }
1.443     albertel 13010:                 }
                   13011:             } else {
1.628     raeburn  13012:                 if ($secchange) {       
                   13013:                     $$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;
                   13014:                 } else {
                   13015:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   13016:                 }
1.443     albertel 13017:             }
                   13018:             $result = $modify_section_result;
                   13019:         } elsif ($secchange == 1) {
1.628     raeburn  13020:             if ($oldsec eq '') {
                   13021:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   13022:             } else {
                   13023:                 $$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;
                   13024:             }
1.626     raeburn  13025:             if ($expire_role_result eq 'refused') {
                   13026:                 my $newsecurl = '/'.$cid;
                   13027:                 $newsecurl =~ s/\_/\//g;
                   13028:                 if ($sec ne '') {
                   13029:                     $newsecurl.='/'.$sec;
                   13030:                 }
                   13031:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   13032:                     if ($sec eq '') {
                   13033:                         $$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;
                   13034:                     } else {
                   13035:                         $$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;
                   13036:                     }
                   13037:                 }
                   13038:             }
1.443     albertel 13039:         }
                   13040:     } else {
1.626     raeburn  13041:         $$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 13042:         $result = "error: incomplete course id\n";
                   13043:     }
                   13044:     return $result;
                   13045: }
                   13046: 
                   13047: ############################################################
                   13048: ############################################################
                   13049: 
1.566     albertel 13050: sub check_clone {
1.578     raeburn  13051:     my ($args,$linefeed) = @_;
1.566     albertel 13052:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   13053:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   13054:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   13055:     my $clonemsg;
                   13056:     my $can_clone = 0;
1.944     raeburn  13057:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  13058:     if ($lctype ne 'community') {
                   13059:         $lctype = 'course';
                   13060:     }
1.566     albertel 13061:     if ($clonehome eq 'no_host') {
1.944     raeburn  13062:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13063:             $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'});
                   13064:         } else {
                   13065:             $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'});
                   13066:         }     
1.566     albertel 13067:     } else {
                   13068: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  13069:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13070:             if ($clonedesc{'type'} ne 'Community') {
                   13071:                  $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'});
                   13072:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13073:             }
                   13074:         }
1.882     raeburn  13075: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   13076:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 13077: 	    $can_clone = 1;
                   13078: 	} else {
                   13079: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   13080: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   13081: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  13082:             if (grep(/^\*$/,@cloners)) {
                   13083:                 $can_clone = 1;
                   13084:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   13085:                 $can_clone = 1;
                   13086:             } else {
1.908     raeburn  13087:                 my $ccrole = 'cc';
1.944     raeburn  13088:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13089:                     $ccrole = 'co';
                   13090:                 }
1.578     raeburn  13091: 	        my %roleshash =
                   13092: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   13093: 					 $args->{'ccdomain'},
1.908     raeburn  13094:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  13095: 					 [$args->{'clonedomain'}]);
1.908     raeburn  13096: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  13097:                     $can_clone = 1;
                   13098:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   13099:                     $can_clone = 1;
                   13100:                 } else {
1.944     raeburn  13101:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13102:                         $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'});
                   13103:                     } else {
                   13104:                         $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'});
                   13105:                     }
1.578     raeburn  13106: 	        }
1.566     albertel 13107: 	    }
1.578     raeburn  13108:         }
1.566     albertel 13109:     }
                   13110:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13111: }
                   13112: 
1.444     albertel 13113: sub construct_course {
1.885     raeburn  13114:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 13115:     my $outcome;
1.541     raeburn  13116:     my $linefeed =  '<br />'."\n";
                   13117:     if ($context eq 'auto') {
                   13118:         $linefeed = "\n";
                   13119:     }
1.566     albertel 13120: 
                   13121: #
                   13122: # Are we cloning?
                   13123: #
                   13124:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13125:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  13126: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 13127: 	if ($context ne 'auto') {
1.578     raeburn  13128:             if ($clonemsg ne '') {
                   13129: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   13130:             }
1.566     albertel 13131: 	}
                   13132: 	$outcome .= $clonemsg.$linefeed;
                   13133: 
                   13134:         if (!$can_clone) {
                   13135: 	    return (0,$outcome);
                   13136: 	}
                   13137:     }
                   13138: 
1.444     albertel 13139: #
                   13140: # Open course
                   13141: #
                   13142:     my $crstype = lc($args->{'crstype'});
                   13143:     my %cenv=();
                   13144:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   13145:                                              $args->{'cdescr'},
                   13146:                                              $args->{'curl'},
                   13147:                                              $args->{'course_home'},
                   13148:                                              $args->{'nonstandard'},
                   13149:                                              $args->{'crscode'},
                   13150:                                              $args->{'ccuname'}.':'.
                   13151:                                              $args->{'ccdomain'},
1.882     raeburn  13152:                                              $args->{'crstype'},
1.885     raeburn  13153:                                              $cnum,$context,$category);
1.444     albertel 13154: 
                   13155:     # Note: The testing routines depend on this being output; see 
                   13156:     # Utils::Course. This needs to at least be output as a comment
                   13157:     # if anyone ever decides to not show this, and Utils::Course::new
                   13158:     # will need to be suitably modified.
1.541     raeburn  13159:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  13160:     if ($$courseid =~ /^error:/) {
                   13161:         return (0,$outcome);
                   13162:     }
                   13163: 
1.444     albertel 13164: #
                   13165: # Check if created correctly
                   13166: #
1.479     albertel 13167:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 13168:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  13169:     if ($crsuhome eq 'no_host') {
                   13170:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   13171:         return (0,$outcome);
                   13172:     }
1.541     raeburn  13173:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 13174: 
1.444     albertel 13175: #
1.566     albertel 13176: # Do the cloning
                   13177: #   
                   13178:     if ($can_clone && $cloneid) {
                   13179: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   13180: 	if ($context ne 'auto') {
                   13181: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   13182: 	}
                   13183: 	$outcome .= $clonemsg.$linefeed;
                   13184: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 13185: # Copy all files
1.637     www      13186: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 13187: # Restore URL
1.566     albertel 13188: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 13189: # Restore title
1.566     albertel 13190: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  13191: # Restore creation date, creator and creation context.
                   13192:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   13193:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   13194:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 13195: # Mark as cloned
1.566     albertel 13196: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      13197: # Need to clone grading mode
                   13198:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   13199:         $cenv{'grading'}=$newenv{'grading'};
                   13200: # Do not clone these environment entries
                   13201:         &Apache::lonnet::del('environment',
                   13202:                   ['default_enrollment_start_date',
                   13203:                    'default_enrollment_end_date',
                   13204:                    'question.email',
                   13205:                    'policy.email',
                   13206:                    'comment.email',
                   13207:                    'pch.users.denied',
1.725     raeburn  13208:                    'plc.users.denied',
                   13209:                    'hidefromcat',
                   13210:                    'categories'],
1.638     www      13211:                    $$crsudom,$$crsunum);
1.444     albertel 13212:     }
1.566     albertel 13213: 
1.444     albertel 13214: #
                   13215: # Set environment (will override cloned, if existing)
                   13216: #
                   13217:     my @sections = ();
                   13218:     my @xlists = ();
                   13219:     if ($args->{'crstype'}) {
                   13220:         $cenv{'type'}=$args->{'crstype'};
                   13221:     }
                   13222:     if ($args->{'crsid'}) {
                   13223:         $cenv{'courseid'}=$args->{'crsid'};
                   13224:     }
                   13225:     if ($args->{'crscode'}) {
                   13226:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   13227:     }
                   13228:     if ($args->{'crsquota'} ne '') {
                   13229:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   13230:     } else {
                   13231:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   13232:     }
                   13233:     if ($args->{'ccuname'}) {
                   13234:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   13235:                                         ':'.$args->{'ccdomain'};
                   13236:     } else {
                   13237:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   13238:     }
                   13239:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   13240:     if ($args->{'crssections'}) {
                   13241:         $cenv{'internal.sectionnums'} = '';
                   13242:         if ($args->{'crssections'} =~ m/,/) {
                   13243:             @sections = split/,/,$args->{'crssections'};
                   13244:         } else {
                   13245:             $sections[0] = $args->{'crssections'};
                   13246:         }
                   13247:         if (@sections > 0) {
                   13248:             foreach my $item (@sections) {
                   13249:                 my ($sec,$gp) = split/:/,$item;
                   13250:                 my $class = $args->{'crscode'}.$sec;
                   13251:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   13252:                 $cenv{'internal.sectionnums'} .= $item.',';
                   13253:                 unless ($addcheck eq 'ok') {
                   13254:                     push @badclasses, $class;
                   13255:                 }
                   13256:             }
                   13257:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   13258:         }
                   13259:     }
                   13260: # do not hide course coordinator from staff listing, 
                   13261: # even if privileged
                   13262:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13263: # add crosslistings
                   13264:     if ($args->{'crsxlist'}) {
                   13265:         $cenv{'internal.crosslistings'}='';
                   13266:         if ($args->{'crsxlist'} =~ m/,/) {
                   13267:             @xlists = split/,/,$args->{'crsxlist'};
                   13268:         } else {
                   13269:             $xlists[0] = $args->{'crsxlist'};
                   13270:         }
                   13271:         if (@xlists > 0) {
                   13272:             foreach my $item (@xlists) {
                   13273:                 my ($xl,$gp) = split/:/,$item;
                   13274:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   13275:                 $cenv{'internal.crosslistings'} .= $item.',';
                   13276:                 unless ($addcheck eq 'ok') {
                   13277:                     push @badclasses, $xl;
                   13278:                 }
                   13279:             }
                   13280:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   13281:         }
                   13282:     }
                   13283:     if ($args->{'autoadds'}) {
                   13284:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   13285:     }
                   13286:     if ($args->{'autodrops'}) {
                   13287:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   13288:     }
                   13289: # check for notification of enrollment changes
                   13290:     my @notified = ();
                   13291:     if ($args->{'notify_owner'}) {
                   13292:         if ($args->{'ccuname'} ne '') {
                   13293:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   13294:         }
                   13295:     }
                   13296:     if ($args->{'notify_dc'}) {
                   13297:         if ($uname ne '') { 
1.630     raeburn  13298:             push(@notified,$uname.':'.$udom);
1.444     albertel 13299:         }
                   13300:     }
                   13301:     if (@notified > 0) {
                   13302:         my $notifylist;
                   13303:         if (@notified > 1) {
                   13304:             $notifylist = join(',',@notified);
                   13305:         } else {
                   13306:             $notifylist = $notified[0];
                   13307:         }
                   13308:         $cenv{'internal.notifylist'} = $notifylist;
                   13309:     }
                   13310:     if (@badclasses > 0) {
                   13311:         my %lt=&Apache::lonlocal::texthash(
                   13312:                 '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',
                   13313:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   13314:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   13315:         );
1.541     raeburn  13316:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   13317:                            ' ('.$lt{'adby'}.')';
                   13318:         if ($context eq 'auto') {
                   13319:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 13320:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  13321:             foreach my $item (@badclasses) {
                   13322:                 if ($context eq 'auto') {
                   13323:                     $outcome .= " - $item\n";
                   13324:                 } else {
                   13325:                     $outcome .= "<li>$item</li>\n";
                   13326:                 }
                   13327:             }
                   13328:             if ($context eq 'auto') {
                   13329:                 $outcome .= $linefeed;
                   13330:             } else {
1.566     albertel 13331:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  13332:             }
                   13333:         } 
1.444     albertel 13334:     }
                   13335:     if ($args->{'no_end_date'}) {
                   13336:         $args->{'endaccess'} = 0;
                   13337:     }
                   13338:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   13339:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   13340:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   13341:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   13342:     if ($args->{'showphotos'}) {
                   13343:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   13344:     }
                   13345:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   13346:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   13347:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   13348:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  13349:             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'); 
                   13350:             if ($context eq 'auto') {
                   13351:                 $outcome .= $krb_msg;
                   13352:             } else {
1.566     albertel 13353:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  13354:             }
                   13355:             $outcome .= $linefeed;
1.444     albertel 13356:         }
                   13357:     }
                   13358:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   13359:        if ($args->{'setpolicy'}) {
                   13360:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13361:        }
                   13362:        if ($args->{'setcontent'}) {
                   13363:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13364:        }
                   13365:     }
                   13366:     if ($args->{'reshome'}) {
                   13367: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   13368: 	$cenv{'reshome'}=~s/\/+$/\//;
                   13369:     }
                   13370: #
                   13371: # course has keyed access
                   13372: #
                   13373:     if ($args->{'setkeys'}) {
                   13374:        $cenv{'keyaccess'}='yes';
                   13375:     }
                   13376: # if specified, key authority is not course, but user
                   13377: # only active if keyaccess is yes
                   13378:     if ($args->{'keyauth'}) {
1.487     albertel 13379: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   13380: 	$user = &LONCAPA::clean_username($user);
                   13381: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     13382: 	if ($user ne '' && $domain ne '') {
1.487     albertel 13383: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 13384: 	}
                   13385:     }
                   13386: 
                   13387:     if ($args->{'disresdis'}) {
                   13388:         $cenv{'pch.roles.denied'}='st';
                   13389:     }
                   13390:     if ($args->{'disablechat'}) {
                   13391:         $cenv{'plc.roles.denied'}='st';
                   13392:     }
                   13393: 
                   13394:     # Record we've not yet viewed the Course Initialization Helper for this 
                   13395:     # course
                   13396:     $cenv{'course.helper.not.run'} = 1;
                   13397:     #
                   13398:     # Use new Randomseed
                   13399:     #
                   13400:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   13401:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   13402:     #
                   13403:     # The encryption code and receipt prefix for this course
                   13404:     #
                   13405:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   13406:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   13407:     #
                   13408:     # By default, use standard grading
                   13409:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   13410: 
1.541     raeburn  13411:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   13412:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13413: #
                   13414: # Open all assignments
                   13415: #
                   13416:     if ($args->{'openall'}) {
                   13417:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   13418:        my %storecontent = ($storeunder         => time,
                   13419:                            $storeunder.'.type' => 'date_start');
                   13420:        
                   13421:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  13422:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13423:    }
                   13424: #
                   13425: # Set first page
                   13426: #
                   13427:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   13428: 	    || ($cloneid)) {
1.445     albertel 13429: 	use LONCAPA::map;
1.444     albertel 13430: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 13431: 
                   13432: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   13433:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   13434: 
1.444     albertel 13435:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   13436:         my $title; my $url;
                   13437:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   13438: 	    $title=&mt('Syllabus');
1.444     albertel 13439:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   13440:         } else {
1.963     raeburn  13441:             $title=&mt('Table of Contents');
1.444     albertel 13442:             $url='/adm/navmaps';
                   13443:         }
1.445     albertel 13444: 
                   13445:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   13446: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   13447: 
                   13448: 	if ($errtext) { $fatal=2; }
1.541     raeburn  13449:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 13450:     }
1.566     albertel 13451: 
                   13452:     return (1,$outcome);
1.444     albertel 13453: }
                   13454: 
                   13455: ############################################################
                   13456: ############################################################
                   13457: 
1.953     droeschl 13458: #SD
                   13459: # only Community and Course, or anything else?
1.378     raeburn  13460: sub course_type {
                   13461:     my ($cid) = @_;
                   13462:     if (!defined($cid)) {
                   13463:         $cid = $env{'request.course.id'};
                   13464:     }
1.404     albertel 13465:     if (defined($env{'course.'.$cid.'.type'})) {
                   13466:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  13467:     } else {
                   13468:         return 'Course';
1.377     raeburn  13469:     }
                   13470: }
1.156     albertel 13471: 
1.406     raeburn  13472: sub group_term {
                   13473:     my $crstype = &course_type();
                   13474:     my %names = (
                   13475:                   'Course' => 'group',
1.865     raeburn  13476:                   'Community' => 'group',
1.406     raeburn  13477:                 );
                   13478:     return $names{$crstype};
                   13479: }
                   13480: 
1.902     raeburn  13481: sub course_types {
                   13482:     my @types = ('official','unofficial','community');
                   13483:     my %typename = (
                   13484:                          official   => 'Official course',
                   13485:                          unofficial => 'Unofficial course',
                   13486:                          community  => 'Community',
                   13487:                    );
                   13488:     return (\@types,\%typename);
                   13489: }
                   13490: 
1.156     albertel 13491: sub icon {
                   13492:     my ($file)=@_;
1.505     albertel 13493:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 13494:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 13495:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 13496:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   13497: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   13498: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13499: 	            $curfext.".gif") {
                   13500: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13501: 		$curfext.".gif";
                   13502: 	}
                   13503:     }
1.249     albertel 13504:     return &lonhttpdurl($iconname);
1.154     albertel 13505: } 
1.84      albertel 13506: 
1.575     albertel 13507: sub lonhttpdurl {
1.692     www      13508: #
                   13509: # Had been used for "small fry" static images on separate port 8080.
                   13510: # Modify here if lightweight http functionality desired again.
                   13511: # Currently eliminated due to increasing firewall issues.
                   13512: #
1.575     albertel 13513:     my ($url)=@_;
1.692     www      13514:     return $url;
1.215     albertel 13515: }
                   13516: 
1.213     albertel 13517: sub connection_aborted {
                   13518:     my ($r)=@_;
                   13519:     $r->print(" ");$r->rflush();
                   13520:     my $c = $r->connection;
                   13521:     return $c->aborted();
                   13522: }
                   13523: 
1.221     foxr     13524: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     13525: #    strings as 'strings'.
                   13526: sub escape_single {
1.221     foxr     13527:     my ($input) = @_;
1.223     albertel 13528:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     13529:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   13530:     return $input;
                   13531: }
1.223     albertel 13532: 
1.222     foxr     13533: #  Same as escape_single, but escape's "'s  This 
                   13534: #  can be used for  "strings"
                   13535: sub escape_double {
                   13536:     my ($input) = @_;
                   13537:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   13538:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   13539:     return $input;
                   13540: }
1.223     albertel 13541:  
1.222     foxr     13542: #   Escapes the last element of a full URL.
                   13543: sub escape_url {
                   13544:     my ($url)   = @_;
1.238     raeburn  13545:     my @urlslices = split(/\//, $url,-1);
1.369     www      13546:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 13547:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     13548: }
1.462     albertel 13549: 
1.820     raeburn  13550: sub compare_arrays {
                   13551:     my ($arrayref1,$arrayref2) = @_;
                   13552:     my (@difference,%count);
                   13553:     @difference = ();
                   13554:     %count = ();
                   13555:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   13556:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   13557:         foreach my $element (keys(%count)) {
                   13558:             if ($count{$element} == 1) {
                   13559:                 push(@difference,$element);
                   13560:             }
                   13561:         }
                   13562:     }
                   13563:     return @difference;
                   13564: }
                   13565: 
1.817     bisitz   13566: # -------------------------------------------------------- Initialize user login
1.462     albertel 13567: sub init_user_environment {
1.463     albertel 13568:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 13569:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   13570: 
                   13571:     my $public=($username eq 'public' && $domain eq 'public');
                   13572: 
                   13573: # See if old ID present, if so, remove
                   13574: 
1.1062    raeburn  13575:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 13576:     my $now=time;
                   13577: 
                   13578:     if ($public) {
                   13579: 	my $max_public=100;
                   13580: 	my $oldest;
                   13581: 	my $oldest_time=0;
                   13582: 	for(my $next=1;$next<=$max_public;$next++) {
                   13583: 	    if (-e $lonids."/publicuser_$next.id") {
                   13584: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   13585: 		if ($mtime<$oldest_time || !$oldest_time) {
                   13586: 		    $oldest_time=$mtime;
                   13587: 		    $oldest=$next;
                   13588: 		}
                   13589: 	    } else {
                   13590: 		$cookie="publicuser_$next";
                   13591: 		last;
                   13592: 	    }
                   13593: 	}
                   13594: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   13595:     } else {
1.463     albertel 13596: 	# if this isn't a robot, kill any existing non-robot sessions
                   13597: 	if (!$args->{'robot'}) {
                   13598: 	    opendir(DIR,$lonids);
                   13599: 	    while ($filename=readdir(DIR)) {
                   13600: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   13601: 		    unlink($lonids.'/'.$filename);
                   13602: 		}
1.462     albertel 13603: 	    }
1.463     albertel 13604: 	    closedir(DIR);
1.462     albertel 13605: 	}
                   13606: # Give them a new cookie
1.463     albertel 13607: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      13608: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 13609: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 13610:     
                   13611: # Initialize roles
                   13612: 
1.1062    raeburn  13613: 	($userroles,$firstaccenv,$timerintenv) = 
                   13614:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 13615:     }
                   13616: # ------------------------------------ Check browser type and MathML capability
                   13617: 
                   13618:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   13619:         $clientunicode,$clientos) = &decode_user_agent($r);
                   13620: 
                   13621: # ------------------------------------------------------------- Get environment
                   13622: 
                   13623:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   13624:     my ($tmp) = keys(%userenv);
                   13625:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   13626:     } else {
                   13627: 	undef(%userenv);
                   13628:     }
                   13629:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   13630: 	$form->{'interface'}=$userenv{'interface'};
                   13631:     }
                   13632:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   13633: 
                   13634: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   13635:     foreach my $option ('interface','localpath','localres') {
                   13636:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 13637:     }
                   13638: # --------------------------------------------------------- Write first profile
                   13639: 
                   13640:     {
                   13641: 	my %initial_env = 
                   13642: 	    ("user.name"          => $username,
                   13643: 	     "user.domain"        => $domain,
                   13644: 	     "user.home"          => $authhost,
                   13645: 	     "browser.type"       => $clientbrowser,
                   13646: 	     "browser.version"    => $clientversion,
                   13647: 	     "browser.mathml"     => $clientmathml,
                   13648: 	     "browser.unicode"    => $clientunicode,
                   13649: 	     "browser.os"         => $clientos,
                   13650: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   13651: 	     "request.course.fn"  => '',
                   13652: 	     "request.course.uri" => '',
                   13653: 	     "request.course.sec" => '',
                   13654: 	     "request.role"       => 'cm',
                   13655: 	     "request.role.adv"   => $env{'user.adv'},
                   13656: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   13657: 
                   13658:         if ($form->{'localpath'}) {
                   13659: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   13660: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   13661:         }
                   13662: 	
                   13663: 	if ($form->{'interface'}) {
                   13664: 	    $form->{'interface'}=~s/\W//gs;
                   13665: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   13666: 	    $env{'browser.interface'}=$form->{'interface'};
                   13667: 	}
                   13668: 
1.981     raeburn  13669:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  13670:         my %domdef;
                   13671:         unless ($domain eq 'public') {
                   13672:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   13673:         }
1.980     raeburn  13674: 
1.724     raeburn  13675:         foreach my $tool ('aboutme','blog','portfolio') {
                   13676:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  13677:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   13678:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  13679:         }
                   13680: 
1.864     raeburn  13681:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  13682:             $userenv{'canrequest.'.$crstype} =
                   13683:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  13684:                                                   'reload','requestcourses',
                   13685:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  13686:         }
                   13687: 
1.462     albertel 13688: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  13689: 
1.462     albertel 13690: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   13691: 		 &GDBM_WRCREAT(),0640)) {
                   13692: 	    &_add_to_env(\%disk_env,\%initial_env);
                   13693: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   13694: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  13695:             if (ref($firstaccenv) eq 'HASH') {
                   13696:                 &_add_to_env(\%disk_env,$firstaccenv);
                   13697:             }
                   13698:             if (ref($timerintenv) eq 'HASH') {
                   13699:                 &_add_to_env(\%disk_env,$timerintenv);
                   13700:             }
1.463     albertel 13701: 	    if (ref($args->{'extra_env'})) {
                   13702: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   13703: 	    }
1.462     albertel 13704: 	    untie(%disk_env);
                   13705: 	} else {
1.705     tempelho 13706: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   13707: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 13708: 	    return 'error: '.$!;
                   13709: 	}
                   13710:     }
                   13711:     $env{'request.role'}='cm';
                   13712:     $env{'request.role.adv'}=$env{'user.adv'};
                   13713:     $env{'browser.type'}=$clientbrowser;
                   13714: 
                   13715:     return $cookie;
                   13716: 
                   13717: }
                   13718: 
                   13719: sub _add_to_env {
                   13720:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  13721:     if (ref($env_data) eq 'HASH') {
                   13722:         while (my ($key,$value) = each(%$env_data)) {
                   13723: 	    $idf->{$prefix.$key} = $value;
                   13724: 	    $env{$prefix.$key}   = $value;
                   13725:         }
1.462     albertel 13726:     }
                   13727: }
                   13728: 
1.685     tempelho 13729: # --- Get the symbolic name of a problem and the url
                   13730: sub get_symb {
                   13731:     my ($request,$silent) = @_;
1.726     raeburn  13732:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 13733:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   13734:     if ($symb eq '') {
                   13735:         if (!$silent) {
1.1071    raeburn  13736:             if (ref($request)) { 
                   13737:                 $request->print("Unable to handle ambiguous references:$url:.");
                   13738:             }
1.685     tempelho 13739:             return ();
                   13740:         }
                   13741:     }
                   13742:     &Apache::lonenc::check_decrypt(\$symb);
                   13743:     return ($symb);
                   13744: }
                   13745: 
                   13746: # --------------------------------------------------------------Get annotation
                   13747: 
                   13748: sub get_annotation {
                   13749:     my ($symb,$enc) = @_;
                   13750: 
                   13751:     my $key = $symb;
                   13752:     if (!$enc) {
                   13753:         $key =
                   13754:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   13755:     }
                   13756:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   13757:     return $annotation{$key};
                   13758: }
                   13759: 
                   13760: sub clean_symb {
1.731     raeburn  13761:     my ($symb,$delete_enc) = @_;
1.685     tempelho 13762: 
                   13763:     &Apache::lonenc::check_decrypt(\$symb);
                   13764:     my $enc = $env{'request.enc'};
1.731     raeburn  13765:     if ($delete_enc) {
1.730     raeburn  13766:         delete($env{'request.enc'});
                   13767:     }
1.685     tempelho 13768: 
                   13769:     return ($symb,$enc);
                   13770: }
1.462     albertel 13771: 
1.990     raeburn  13772: sub build_release_hashes {
                   13773:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   13774:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   13775:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   13776:                   (ref($randomizetry) eq 'HASH'));
                   13777:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   13778:         my ($item,$name,$value) = split(/:/,$key);
                   13779:         if ($item eq 'parameter') {
                   13780:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   13781:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   13782:                     push(@{$checkparms->{$name}},$value);
                   13783:                 }
                   13784:             } else {
                   13785:                 push(@{$checkparms->{$name}},$value);
                   13786:             }
                   13787:         } elsif ($item eq 'resourcetag') {
                   13788:             if ($name eq 'responsetype') {
                   13789:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   13790:             }
                   13791:         } elsif ($item eq 'course') {
                   13792:             if ($name eq 'crstype') {
                   13793:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   13794:             }
                   13795:         }
                   13796:     }
                   13797:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   13798:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   13799:     return;
                   13800: }
                   13801: 
1.41      ng       13802: =pod
                   13803: 
                   13804: =back
                   13805: 
1.112     bowersj2 13806: =cut
1.41      ng       13807: 
1.112     bowersj2 13808: 1;
                   13809: __END__;
1.41      ng       13810: 

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