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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1210  ! raeburn     4: # $Id: loncommon.pm,v 1.1209 2015/03/09 19:09:34 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.1108    raeburn    70: use Apache::lonuserutils();
1.1110    raeburn    71: use Apache::lonuserstate();
1.1182    raeburn    72: use Apache::courseclassifier();
1.479     albertel   73: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    74: use DateTime::TimeZone;
1.687     raeburn    75: use DateTime::Locale::Catalog;
1.1091    foxr       76: use Text::Aspell;
1.1094    raeburn    77: use Authen::Captcha;
                     78: use Captcha::reCAPTCHA;
1.1174    raeburn    79: use Crypt::DES;
                     80: use DynaLoader; # for Crypt::DES version
1.117     www        81: 
1.517     raeburn    82: # ---------------------------------------------- Designs
                     83: use vars qw(%defaultdesign);
                     84: 
1.22      www        85: my $readit;
                     86: 
1.517     raeburn    87: 
1.157     matthew    88: ##
                     89: ## Global Variables
                     90: ##
1.46      matthew    91: 
1.643     foxr       92: 
                     93: # ----------------------------------------------- SSI with retries:
                     94: #
                     95: 
                     96: =pod
                     97: 
1.648     raeburn    98: =head1 Server Side include with retries:
1.643     foxr       99: 
                    100: =over 4
                    101: 
1.648     raeburn   102: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      103: 
                    104: Performs an ssi with some number of retries.  Retries continue either
                    105: until the result is ok or until the retry count supplied by the
                    106: caller is exhausted.  
                    107: 
                    108: Inputs:
1.648     raeburn   109: 
                    110: =over 4
                    111: 
1.643     foxr      112: resource   - Identifies the resource to insert.
1.648     raeburn   113: 
1.643     foxr      114: retries    - Count of the number of retries allowed.
1.648     raeburn   115: 
1.643     foxr      116: form       - Hash that identifies the rendering options.
                    117: 
1.648     raeburn   118: =back
                    119: 
                    120: Returns:
                    121: 
                    122: =over 4
                    123: 
1.643     foxr      124: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   125: 
1.643     foxr      126: response   - The response from the last attempt (which may or may not have been successful.
                    127: 
1.648     raeburn   128: =back
                    129: 
                    130: =back
                    131: 
1.643     foxr      132: =cut
                    133: 
                    134: sub ssi_with_retries {
                    135:     my ($resource, $retries, %form) = @_;
                    136: 
                    137: 
                    138:     my $ok = 0;			# True if we got a good response.
                    139:     my $content;
                    140:     my $response;
                    141: 
                    142:     # Try to get the ssi done. within the retries count:
                    143: 
                    144:     do {
                    145: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    146: 	$ok      = $response->is_success;
1.650     www       147:         if (!$ok) {
                    148:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    149:         }
1.643     foxr      150: 	$retries--;
                    151:     } while (!$ok && ($retries > 0));
                    152: 
                    153:     if (!$ok) {
                    154: 	$content = '';		# On error return an empty content.
                    155:     }
                    156:     return ($content, $response);
                    157: 
                    158: }
                    159: 
                    160: 
                    161: 
1.20      www       162: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  163: my %language;
1.124     www       164: my %supported_language;
1.1088    foxr      165: my %supported_codes;
1.1048    foxr      166: my %latex_language;		# For choosing hyphenation in <transl..>
                    167: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  168: my %cprtag;
1.192     taceyjo1  169: my %scprtag;
1.351     www       170: my %fe; my %fd; my %fm;
1.41      ng        171: my %category_extensions;
1.12      harris41  172: 
1.46      matthew   173: # ---------------------------------------------- Thesaurus variables
1.144     matthew   174: #
                    175: # %Keywords:
                    176: #      A hash used by &keyword to determine if a word is considered a keyword.
                    177: # $thesaurus_db_file 
                    178: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   179: 
                    180: my %Keywords;
                    181: my $thesaurus_db_file;
                    182: 
1.144     matthew   183: #
                    184: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    185: # thesaurus.tab, and filecategories.tab.
                    186: #
1.18      www       187: BEGIN {
1.46      matthew   188:     # Variable initialization
                    189:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    190:     #
1.22      www       191:     unless ($readit) {
1.12      harris41  192: # ------------------------------------------------------------------- languages
                    193:     {
1.158     raeburn   194:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    195:                                    '/language.tab';
                    196:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  197:             while (my $line = <$fh>) {
                    198:                 next if ($line=~/^\#/);
                    199:                 chomp($line);
1.1088    foxr      200:                 my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   201:                 $language{$key}=$val.' - '.$enc;
                    202:                 if ($sup) {
                    203:                     $supported_language{$key}=$sup;
1.1088    foxr      204: 		    $supported_codes{$key}   = $code;
1.158     raeburn   205:                 }
1.1048    foxr      206: 		if ($latex) {
                    207: 		    $latex_language_bykey{$key} = $latex;
1.1088    foxr      208: 		    $latex_language{$code} = $latex;
1.1048    foxr      209: 		}
1.158     raeburn   210:             }
                    211:             close($fh);
                    212:         }
1.12      harris41  213:     }
                    214: # ------------------------------------------------------------------ copyrights
                    215:     {
1.158     raeburn   216:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    217:                                   '/copyright.tab';
                    218:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  219:             while (my $line = <$fh>) {
                    220:                 next if ($line=~/^\#/);
                    221:                 chomp($line);
                    222:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   223:                 $cprtag{$key}=$val;
                    224:             }
                    225:             close($fh);
                    226:         }
1.12      harris41  227:     }
1.351     www       228: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  229:     {
                    230:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    231:                                   '/source_copyright.tab';
                    232:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  233:             while (my $line = <$fh>) {
                    234:                 next if ($line =~ /^\#/);
                    235:                 chomp($line);
                    236:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  237:                 $scprtag{$key}=$val;
                    238:             }
                    239:             close($fh);
                    240:         }
                    241:     }
1.63      www       242: 
1.517     raeburn   243: # -------------------------------------------------------------- default domain designs
1.63      www       244:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   245:     my $designfile = $designdir.'/default.tab';
                    246:     if ( open (my $fh,"<$designfile") ) {
                    247:         while (my $line = <$fh>) {
                    248:             next if ($line =~ /^\#/);
                    249:             chomp($line);
                    250:             my ($key,$val)=(split(/\=/,$line));
                    251:             if ($val) { $defaultdesign{$key}=$val; }
                    252:         }
                    253:         close($fh);
1.63      www       254:     }
                    255: 
1.15      harris41  256: # ------------------------------------------------------------- file categories
                    257:     {
1.158     raeburn   258:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    259:                                   '/filecategories.tab';
                    260:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  261: 	    while (my $line = <$fh>) {
                    262: 		next if ($line =~ /^\#/);
                    263: 		chomp($line);
                    264:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   265:                 push @{$category_extensions{lc($category)}},$extension;
                    266:             }
                    267:             close($fh);
                    268:         }
                    269: 
1.15      harris41  270:     }
1.12      harris41  271: # ------------------------------------------------------------------ file types
                    272:     {
1.158     raeburn   273:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    274:                '/filetypes.tab';
                    275:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  276:             while (my $line = <$fh>) {
                    277: 		next if ($line =~ /^\#/);
                    278: 		chomp($line);
                    279:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   280:                 if ($descr ne '') {
                    281:                     $fe{$ending}=lc($emb);
                    282:                     $fd{$ending}=$descr;
1.351     www       283:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   284:                 }
                    285:             }
                    286:             close($fh);
                    287:         }
1.12      harris41  288:     }
1.22      www       289:     &Apache::lonnet::logthis(
1.705     tempelho  290:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       291:     $readit=1;
1.46      matthew   292:     }  # end of unless($readit) 
1.32      matthew   293:     
                    294: }
1.112     bowersj2  295: 
1.42      matthew   296: ###############################################################
                    297: ##           HTML and Javascript Helper Functions            ##
                    298: ###############################################################
                    299: 
                    300: =pod 
                    301: 
1.112     bowersj2  302: =head1 HTML and Javascript Functions
1.42      matthew   303: 
1.112     bowersj2  304: =over 4
                    305: 
1.648     raeburn   306: =item * &browser_and_searcher_javascript()
1.112     bowersj2  307: 
                    308: X<browsing, javascript>X<searching, javascript>Returns a string
                    309: containing javascript with two functions, C<openbrowser> and
                    310: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    311: tags.
1.42      matthew   312: 
1.648     raeburn   313: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   314: 
                    315: inputs: formname, elementname, only, omit
                    316: 
                    317: formname and elementname indicate the name of the html form and name of
                    318: the element that the results of the browsing selection are to be placed in. 
                    319: 
                    320: Specifying 'only' will restrict the browser to displaying only files
1.185     www       321: with the given extension.  Can be a comma separated list.
1.42      matthew   322: 
                    323: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       324: with the given extension.  Can be a comma separated list.
1.42      matthew   325: 
1.648     raeburn   326: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   327: 
                    328: Inputs: formname, elementname
                    329: 
                    330: formname and elementname specify the name of the html form and the name
                    331: of the element the selection from the search results will be placed in.
1.542     raeburn   332: 
1.42      matthew   333: =cut
                    334: 
                    335: sub browser_and_searcher_javascript {
1.199     albertel  336:     my ($mode)=@_;
                    337:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  338:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   339:     return <<END;
1.219     albertel  340: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   341:     var editbrowser = null;
1.135     albertel  342:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       343:         var url = '$resurl/?';
1.42      matthew   344:         if (editbrowser == null) {
                    345:             url += 'launch=1&';
                    346:         }
                    347:         url += 'catalogmode=interactive&';
1.199     albertel  348:         url += 'mode=$mode&';
1.611     albertel  349:         url += 'inhibitmenu=yes&';
1.42      matthew   350:         url += 'form=' + formname + '&';
                    351:         if (only != null) {
                    352:             url += 'only=' + only + '&';
1.217     albertel  353:         } else {
                    354:             url += 'only=&';
                    355: 	}
1.42      matthew   356:         if (omit != null) {
                    357:             url += 'omit=' + omit + '&';
1.217     albertel  358:         } else {
                    359:             url += 'omit=&';
                    360: 	}
1.135     albertel  361:         if (titleelement != null) {
                    362:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  363:         } else {
                    364: 	    url += 'titleelement=&';
                    365: 	}
1.42      matthew   366:         url += 'element=' + elementname + '';
                    367:         var title = 'Browser';
1.435     albertel  368:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   369:         options += ',width=700,height=600';
                    370:         editbrowser = open(url,title,options,'1');
                    371:         editbrowser.focus();
                    372:     }
                    373:     var editsearcher;
1.135     albertel  374:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   375:         var url = '/adm/searchcat?';
                    376:         if (editsearcher == null) {
                    377:             url += 'launch=1&';
                    378:         }
                    379:         url += 'catalogmode=interactive&';
1.199     albertel  380:         url += 'mode=$mode&';
1.42      matthew   381:         url += 'form=' + formname + '&';
1.135     albertel  382:         if (titleelement != null) {
                    383:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  384:         } else {
                    385: 	    url += 'titleelement=&';
                    386: 	}
1.42      matthew   387:         url += 'element=' + elementname + '';
                    388:         var title = 'Search';
1.435     albertel  389:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   390:         options += ',width=700,height=600';
                    391:         editsearcher = open(url,title,options,'1');
                    392:         editsearcher.focus();
                    393:     }
1.219     albertel  394: // END LON-CAPA Internal -->
1.42      matthew   395: END
1.170     www       396: }
                    397: 
                    398: sub lastresurl {
1.258     albertel  399:     if ($env{'environment.lastresurl'}) {
                    400: 	return $env{'environment.lastresurl'}
1.170     www       401:     } else {
                    402: 	return '/res';
                    403:     }
                    404: }
                    405: 
                    406: sub storeresurl {
                    407:     my $resurl=&Apache::lonnet::clutter(shift);
                    408:     unless ($resurl=~/^\/res/) { return 0; }
                    409:     $resurl=~s/\/$//;
                    410:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   411:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       412:     return 1;
1.42      matthew   413: }
                    414: 
1.74      www       415: sub studentbrowser_javascript {
1.111     www       416:    unless (
1.258     albertel  417:             (($env{'request.course.id'}) && 
1.302     albertel  418:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    419: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    420: 					  '/'.$env{'request.course.sec'})
                    421: 	      ))
1.258     albertel  422:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       423:           ) { return ''; }  
1.74      www       424:    return (<<'ENDSTDBRW');
1.776     bisitz    425: <script type="text/javascript" language="Javascript">
1.824     bisitz    426: // <![CDATA[
1.74      www       427:     var stdeditbrowser;
1.999     www       428:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74      www       429:         var url = '/adm/pickstudent?';
                    430:         var filter;
1.558     albertel  431: 	if (!ignorefilter) {
                    432: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    433: 	}
1.74      www       434:         if (filter != null) {
                    435:            if (filter != '') {
                    436:                url += 'filter='+filter+'&';
                    437: 	   }
                    438:         }
                    439:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       440:                                     '&udomelement='+udom+
                    441:                                     '&clicker='+clicker;
1.111     www       442: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   443:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       444:         var title = 'Student_Browser';
1.74      www       445:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    446:         options += ',width=700,height=600';
                    447:         stdeditbrowser = open(url,title,options,'1');
                    448:         stdeditbrowser.focus();
                    449:     }
1.824     bisitz    450: // ]]>
1.74      www       451: </script>
                    452: ENDSTDBRW
                    453: }
1.42      matthew   454: 
1.1003    www       455: sub resourcebrowser_javascript {
                    456:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       457:    return (<<'ENDRESBRW');
1.1003    www       458: <script type="text/javascript" language="Javascript">
                    459: // <![CDATA[
                    460:     var reseditbrowser;
1.1004    www       461:     function openresbrowser(formname,reslink) {
1.1005    www       462:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       463:         var title = 'Resource_Browser';
                    464:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       465:         options += ',width=700,height=500';
1.1004    www       466:         reseditbrowser = open(url,title,options,'1');
                    467:         reseditbrowser.focus();
1.1003    www       468:     }
                    469: // ]]>
                    470: </script>
1.1004    www       471: ENDRESBRW
1.1003    www       472: }
                    473: 
1.74      www       474: sub selectstudent_link {
1.999     www       475:    my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
                    476:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    477:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    478:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  479:    if ($env{'request.course.id'}) {  
1.302     albertel  480:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    481: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    482: 					'/'.$env{'request.course.sec'})) {
1.111     www       483: 	   return '';
                    484:        }
1.999     www       485:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793     raeburn   486:        if ($courseadvonly)  {
                    487:            $callargs .= ",'',1,1";
                    488:        }
                    489:        return '<span class="LC_nobreak">'.
                    490:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    491:               &mt('Select User').'</a></span>';
1.74      www       492:    }
1.258     albertel  493:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       494:        $callargs .= ",'',1"; 
1.793     raeburn   495:        return '<span class="LC_nobreak">'.
                    496:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    497:               &mt('Select User').'</a></span>';
1.111     www       498:    }
                    499:    return '';
1.91      www       500: }
                    501: 
1.1004    www       502: sub selectresource_link {
                    503:    my ($form,$reslink,$arg)=@_;
                    504:    
                    505:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    506:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    507:    unless ($env{'request.course.id'}) { return $arg; }
                    508:    return '<span class="LC_nobreak">'.
                    509:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    510:               $arg.'</a></span>';
                    511: }
                    512: 
                    513: 
                    514: 
1.653     raeburn   515: sub authorbrowser_javascript {
                    516:     return <<"ENDAUTHORBRW";
1.776     bisitz    517: <script type="text/javascript" language="JavaScript">
1.824     bisitz    518: // <![CDATA[
1.653     raeburn   519: var stdeditbrowser;
                    520: 
                    521: function openauthorbrowser(formname,udom) {
                    522:     var url = '/adm/pickauthor?';
                    523:     url += 'form='+formname+'&roledom='+udom;
                    524:     var title = 'Author_Browser';
                    525:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    526:     options += ',width=700,height=600';
                    527:     stdeditbrowser = open(url,title,options,'1');
                    528:     stdeditbrowser.focus();
                    529: }
                    530: 
1.824     bisitz    531: // ]]>
1.653     raeburn   532: </script>
                    533: ENDAUTHORBRW
                    534: }
                    535: 
1.91      www       536: sub coursebrowser_javascript {
1.1116    raeburn   537:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
                    538:         $credits_element) = @_;
1.932     raeburn   539:     my $wintitle = 'Course_Browser';
1.931     raeburn   540:     if ($crstype eq 'Community') {
1.932     raeburn   541:         $wintitle = 'Community_Browser';
1.909     raeburn   542:     }
1.876     raeburn   543:     my $id_functions = &javascript_index_functions();
                    544:     my $output = '
1.776     bisitz    545: <script type="text/javascript" language="JavaScript">
1.824     bisitz    546: // <![CDATA[
1.468     raeburn   547:     var stdeditbrowser;'."\n";
1.876     raeburn   548: 
                    549:     $output .= <<"ENDSTDBRW";
1.909     raeburn   550:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       551:         var url = '/adm/pickcourse?';
1.895     raeburn   552:         var formid = getFormIdByName(formname);
1.876     raeburn   553:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  554:         if (domainfilter != null) {
                    555:            if (domainfilter != '') {
                    556:                url += 'domainfilter='+domainfilter+'&';
                    557: 	   }
                    558:         }
1.91      www       559:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  560: 	                            '&cdomelement='+udom+
                    561:                                     '&cnameelement='+desc;
1.468     raeburn   562:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   563:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   564:                 url += '&roleelement='+extra_element;
                    565:                 if (domainfilter == null || domainfilter == '') {
                    566:                     url += '&domainfilter='+extra_element;
                    567:                 }
1.234     raeburn   568:             }
1.468     raeburn   569:             else {
                    570:                 if (formname == 'portform') {
                    571:                     url += '&setroles='+extra_element;
1.800     raeburn   572:                 } else {
                    573:                     if (formname == 'rules') {
                    574:                         url += '&fixeddom='+extra_element; 
                    575:                     }
1.468     raeburn   576:                 }
                    577:             }     
1.230     raeburn   578:         }
1.909     raeburn   579:         if (type != null && type != '') {
                    580:             url += '&type='+type;
                    581:         }
                    582:         if (type_elem != null && type_elem != '') {
                    583:             url += '&typeelement='+type_elem;
                    584:         }
1.872     raeburn   585:         if (formname == 'ccrs') {
                    586:             var ownername = document.forms[formid].ccuname.value;
                    587:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    588:             url += '&cloner='+ownername+':'+ownerdom;
                    589:         }
1.293     raeburn   590:         if (multflag !=null && multflag != '') {
                    591:             url += '&multiple='+multflag;
                    592:         }
1.909     raeburn   593:         var title = '$wintitle';
1.91      www       594:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    595:         options += ',width=700,height=600';
                    596:         stdeditbrowser = open(url,title,options,'1');
                    597:         stdeditbrowser.focus();
                    598:     }
1.876     raeburn   599: $id_functions
                    600: ENDSTDBRW
1.1116    raeburn   601:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    602:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    603:                                       $credits_element);
1.876     raeburn   604:     }
                    605:     $output .= '
                    606: // ]]>
                    607: </script>';
                    608:     return $output;
                    609: }
                    610: 
                    611: sub javascript_index_functions {
                    612:     return <<"ENDJS";
                    613: 
                    614: function getFormIdByName(formname) {
                    615:     for (var i=0;i<document.forms.length;i++) {
                    616:         if (document.forms[i].name == formname) {
                    617:             return i;
                    618:         }
                    619:     }
                    620:     return -1;
                    621: }
                    622: 
                    623: function getIndexByName(formid,item) {
                    624:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    625:         if (document.forms[formid].elements[i].name == item) {
                    626:             return i;
                    627:         }
                    628:     }
                    629:     return -1;
                    630: }
1.468     raeburn   631: 
1.876     raeburn   632: function getDomainFromSelectbox(formname,udom) {
                    633:     var userdom;
                    634:     var formid = getFormIdByName(formname);
                    635:     if (formid > -1) {
                    636:         var domid = getIndexByName(formid,udom);
                    637:         if (domid > -1) {
                    638:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    639:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    640:             }
                    641:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    642:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   643:             }
                    644:         }
                    645:     }
1.876     raeburn   646:     return userdom;
                    647: }
                    648: 
                    649: ENDJS
1.468     raeburn   650: 
1.876     raeburn   651: }
                    652: 
1.1017    raeburn   653: sub javascript_array_indexof {
1.1018    raeburn   654:     return <<ENDJS;
1.1017    raeburn   655: <script type="text/javascript" language="JavaScript">
                    656: // <![CDATA[
                    657: 
                    658: if (!Array.prototype.indexOf) {
                    659:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    660:         "use strict";
                    661:         if (this === void 0 || this === null) {
                    662:             throw new TypeError();
                    663:         }
                    664:         var t = Object(this);
                    665:         var len = t.length >>> 0;
                    666:         if (len === 0) {
                    667:             return -1;
                    668:         }
                    669:         var n = 0;
                    670:         if (arguments.length > 0) {
                    671:             n = Number(arguments[1]);
1.1088    foxr      672:             if (n !== n) { // shortcut for verifying if it is NaN
1.1017    raeburn   673:                 n = 0;
                    674:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    675:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    676:             }
                    677:         }
                    678:         if (n >= len) {
                    679:             return -1;
                    680:         }
                    681:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    682:         for (; k < len; k++) {
                    683:             if (k in t && t[k] === searchElement) {
                    684:                 return k;
                    685:             }
                    686:         }
                    687:         return -1;
                    688:     }
                    689: }
                    690: 
                    691: // ]]>
                    692: </script>
                    693: 
                    694: ENDJS
                    695: 
                    696: }
                    697: 
1.876     raeburn   698: sub userbrowser_javascript {
                    699:     my $id_functions = &javascript_index_functions();
                    700:     return <<"ENDUSERBRW";
                    701: 
1.888     raeburn   702: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   703:     var url = '/adm/pickuser?';
                    704:     var userdom = getDomainFromSelectbox(formname,udom);
                    705:     if (userdom != null) {
                    706:        if (userdom != '') {
                    707:            url += 'srchdom='+userdom+'&';
                    708:        }
                    709:     }
                    710:     url += 'form=' + formname + '&unameelement='+uname+
                    711:                                 '&udomelement='+udom+
                    712:                                 '&ulastelement='+ulast+
                    713:                                 '&ufirstelement='+ufirst+
                    714:                                 '&uemailelement='+uemail+
1.881     raeburn   715:                                 '&hideudomelement='+hideudom+
                    716:                                 '&coursedom='+crsdom;
1.888     raeburn   717:     if ((caller != null) && (caller != undefined)) {
                    718:         url += '&caller='+caller;
                    719:     }
1.876     raeburn   720:     var title = 'User_Browser';
                    721:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    722:     options += ',width=700,height=600';
                    723:     var stdeditbrowser = open(url,title,options,'1');
                    724:     stdeditbrowser.focus();
                    725: }
                    726: 
1.888     raeburn   727: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   728:     var formid = getFormIdByName(formname);
                    729:     if (formid > -1) {
1.888     raeburn   730:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   731:         var domid = getIndexByName(formid,udom);
                    732:         var hidedomid = getIndexByName(formid,origdom);
                    733:         if (hidedomid > -1) {
                    734:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   735:             var unameval = document.forms[formid].elements[unameid].value;
                    736:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    737:                 if (domid > -1) {
                    738:                     var slct = document.forms[formid].elements[domid];
                    739:                     if (slct.type == 'select-one') {
                    740:                         var i;
                    741:                         for (i=0;i<slct.length;i++) {
                    742:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    743:                         }
                    744:                     }
                    745:                     if (slct.type == 'hidden') {
                    746:                         slct.value = fixeddom;
1.876     raeburn   747:                     }
                    748:                 }
1.468     raeburn   749:             }
                    750:         }
                    751:     }
1.876     raeburn   752:     return;
                    753: }
                    754: 
                    755: $id_functions
                    756: ENDUSERBRW
1.468     raeburn   757: }
                    758: 
                    759: sub setsec_javascript {
1.1116    raeburn   760:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   761:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    762:         $communityrolestr);
                    763:     if ($role_element ne '') {
                    764:         my @allroles = ('st','ta','ep','in','ad');
                    765:         foreach my $crstype ('Course','Community') {
                    766:             if ($crstype eq 'Community') {
                    767:                 foreach my $role (@allroles) {
                    768:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    769:                 }
                    770:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    771:             } else {
                    772:                 foreach my $role (@allroles) {
                    773:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    774:                 }
                    775:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    776:             }
                    777:         }
                    778:         $rolestr = '"'.join('","',@allroles).'"';
                    779:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    780:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    781:     }
1.468     raeburn   782:     my $setsections = qq|
                    783: function setSect(sectionlist) {
1.629     raeburn   784:     var sectionsArray = new Array();
                    785:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    786:         sectionsArray = sectionlist.split(",");
                    787:     }
1.468     raeburn   788:     var numSections = sectionsArray.length;
                    789:     document.$formname.$sec_element.length = 0;
                    790:     if (numSections == 0) {
                    791:         document.$formname.$sec_element.multiple=false;
                    792:         document.$formname.$sec_element.size=1;
                    793:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    794:     } else {
                    795:         if (numSections == 1) {
                    796:             document.$formname.$sec_element.multiple=false;
                    797:             document.$formname.$sec_element.size=1;
                    798:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    799:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    800:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    801:         } else {
                    802:             for (var i=0; i<numSections; i++) {
                    803:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    804:             }
                    805:             document.$formname.$sec_element.multiple=true
                    806:             if (numSections < 3) {
                    807:                 document.$formname.$sec_element.size=numSections;
                    808:             } else {
                    809:                 document.$formname.$sec_element.size=3;
                    810:             }
                    811:             document.$formname.$sec_element.options[0].selected = false
                    812:         }
                    813:     }
1.91      www       814: }
1.905     raeburn   815: 
                    816: function setRole(crstype) {
1.468     raeburn   817: |;
1.905     raeburn   818:     if ($role_element eq '') {
                    819:         $setsections .= '    return;
                    820: }
                    821: ';
                    822:     } else {
                    823:         $setsections .= qq|
                    824:     var elementLength = document.$formname.$role_element.length;
                    825:     var allroles = Array($rolestr);
                    826:     var courserolenames = Array($courserolestr);
                    827:     var communityrolenames = Array($communityrolestr);
                    828:     if (elementLength != undefined) {
                    829:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    830:             if (crstype == 'Course') {
                    831:                 return;
                    832:             } else {
                    833:                 allroles[5] = 'co';
                    834:                 for (var i=0; i<6; i++) {
                    835:                     document.$formname.$role_element.options[i].value = allroles[i];
                    836:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    837:                 }
                    838:             }
                    839:         } else {
                    840:             if (crstype == 'Community') {
                    841:                 return;
                    842:             } else {
                    843:                 allroles[5] = 'cc';
                    844:                 for (var i=0; i<6; i++) {
                    845:                     document.$formname.$role_element.options[i].value = allroles[i];
                    846:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    847:                 }
                    848:             }
                    849:         }
                    850:     }
                    851:     return;
                    852: }
                    853: |;
                    854:     }
1.1116    raeburn   855:     if ($credits_element) {
                    856:         $setsections .= qq|
                    857: function setCredits(defaultcredits) {
                    858:     document.$formname.$credits_element.value = defaultcredits;
                    859:     return;
                    860: }
                    861: |;
                    862:     }
1.468     raeburn   863:     return $setsections;
                    864: }
                    865: 
1.91      www       866: sub selectcourse_link {
1.909     raeburn   867:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    868:        $typeelement) = @_;
                    869:    my $type = $selecttype;
1.871     raeburn   870:    my $linktext = &mt('Select Course');
                    871:    if ($selecttype eq 'Community') {
1.909     raeburn   872:        $linktext = &mt('Select Community');
1.906     raeburn   873:    } elsif ($selecttype eq 'Course/Community') {
                    874:        $linktext = &mt('Select Course/Community');
1.909     raeburn   875:        $type = '';
1.1019    raeburn   876:    } elsif ($selecttype eq 'Select') {
                    877:        $linktext = &mt('Select');
                    878:        $type = '';
1.871     raeburn   879:    }
1.787     bisitz    880:    return '<span class="LC_nobreak">'
                    881:          ."<a href='"
                    882:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    883:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   884:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   885:          ."'>".$linktext.'</a>'
1.787     bisitz    886:          .'</span>';
1.74      www       887: }
1.42      matthew   888: 
1.653     raeburn   889: sub selectauthor_link {
                    890:    my ($form,$udom)=@_;
                    891:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    892:           &mt('Select Author').'</a>';
                    893: }
                    894: 
1.876     raeburn   895: sub selectuser_link {
1.881     raeburn   896:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   897:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   898:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   899:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   900:            ');">'.$linktext.'</a>';
1.876     raeburn   901: }
                    902: 
1.273     raeburn   903: sub check_uncheck_jscript {
                    904:     my $jscript = <<"ENDSCRT";
                    905: function checkAll(field) {
                    906:     if (field.length > 0) {
                    907:         for (i = 0; i < field.length; i++) {
1.1093    raeburn   908:             if (!field[i].disabled) { 
                    909:                 field[i].checked = true;
                    910:             }
1.273     raeburn   911:         }
                    912:     } else {
1.1093    raeburn   913:         if (!field.disabled) { 
                    914:             field.checked = true;
                    915:         }
1.273     raeburn   916:     }
                    917: }
                    918:  
                    919: function uncheckAll(field) {
                    920:     if (field.length > 0) {
                    921:         for (i = 0; i < field.length; i++) {
                    922:             field[i].checked = false ;
1.543     albertel  923:         }
                    924:     } else {
1.273     raeburn   925:         field.checked = false ;
                    926:     }
                    927: }
                    928: ENDSCRT
                    929:     return $jscript;
                    930: }
                    931: 
1.656     www       932: sub select_timezone {
1.659     raeburn   933:    my ($name,$selected,$onchange,$includeempty)=@_;
                    934:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    935:    if ($includeempty) {
                    936:        $output .= '<option value=""';
                    937:        if (($selected eq '') || ($selected eq 'local')) {
                    938:            $output .= ' selected="selected" ';
                    939:        }
                    940:        $output .= '> </option>';
                    941:    }
1.657     raeburn   942:    my @timezones = DateTime::TimeZone->all_names;
                    943:    foreach my $tzone (@timezones) {
                    944:        $output.= '<option value="'.$tzone.'"';
                    945:        if ($tzone eq $selected) {
                    946:            $output.=' selected="selected"';
                    947:        }
                    948:        $output.=">$tzone</option>\n";
1.656     www       949:    }
                    950:    $output.="</select>";
                    951:    return $output;
                    952: }
1.273     raeburn   953: 
1.687     raeburn   954: sub select_datelocale {
                    955:     my ($name,$selected,$onchange,$includeempty)=@_;
                    956:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    957:     if ($includeempty) {
                    958:         $output .= '<option value=""';
                    959:         if ($selected eq '') {
                    960:             $output .= ' selected="selected" ';
                    961:         }
                    962:         $output .= '> </option>';
                    963:     }
                    964:     my (@possibles,%locale_names);
                    965:     my @locales = DateTime::Locale::Catalog::Locales;
                    966:     foreach my $locale (@locales) {
                    967:         if (ref($locale) eq 'HASH') {
                    968:             my $id = $locale->{'id'};
                    969:             if ($id ne '') {
                    970:                 my $en_terr = $locale->{'en_territory'};
                    971:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   972:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   973:                 if (grep(/^en$/,@languages) || !@languages) {
                    974:                     if ($en_terr ne '') {
                    975:                         $locale_names{$id} = '('.$en_terr.')';
                    976:                     } elsif ($native_terr ne '') {
                    977:                         $locale_names{$id} = $native_terr;
                    978:                     }
                    979:                 } else {
                    980:                     if ($native_terr ne '') {
                    981:                         $locale_names{$id} = $native_terr.' ';
                    982:                     } elsif ($en_terr ne '') {
                    983:                         $locale_names{$id} = '('.$en_terr.')';
                    984:                     }
                    985:                 }
                    986:                 push (@possibles,$id);
                    987:             }
                    988:         }
                    989:     }
                    990:     foreach my $item (sort(@possibles)) {
                    991:         $output.= '<option value="'.$item.'"';
                    992:         if ($item eq $selected) {
                    993:             $output.=' selected="selected"';
                    994:         }
                    995:         $output.=">$item";
                    996:         if ($locale_names{$item} ne '') {
                    997:             $output.="  $locale_names{$item}</option>\n";
                    998:         }
                    999:         $output.="</option>\n";
                   1000:     }
                   1001:     $output.="</select>";
                   1002:     return $output;
                   1003: }
                   1004: 
1.792     raeburn  1005: sub select_language {
                   1006:     my ($name,$selected,$includeempty) = @_;
                   1007:     my %langchoices;
                   1008:     if ($includeempty) {
1.1117    raeburn  1009:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1010:     }
                   1011:     foreach my $id (&languageids()) {
                   1012:         my $code = &supportedlanguagecode($id);
                   1013:         if ($code) {
                   1014:             $langchoices{$code} = &plainlanguagedescription($id);
                   1015:         }
                   1016:     }
1.1117    raeburn  1017:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970     raeburn  1018:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn  1019: }
                   1020: 
1.42      matthew  1021: =pod
1.36      matthew  1022: 
1.1088    foxr     1023: 
                   1024: =item * &list_languages()
                   1025: 
                   1026: Returns an array reference that is suitable for use in language prompters.
                   1027: Each array element is itself a two element array.  The first element
                   1028: is the language code.  The second element a descsriptiuon of the 
                   1029: language itself.  This is suitable for use in e.g.
                   1030: &Apache::edit::select_arg (once dereferenced that is).
                   1031: 
                   1032: =cut 
                   1033: 
                   1034: sub list_languages {
                   1035:     my @lang_choices;
                   1036: 
                   1037:     foreach my $id (&languageids()) {
                   1038: 	my $code = &supportedlanguagecode($id);
                   1039: 	if ($code) {
                   1040: 	    my $selector    = $supported_codes{$id};
                   1041: 	    my $description = &plainlanguagedescription($id);
                   1042: 	    push (@lang_choices, [$selector, $description]);
                   1043: 	}
                   1044:     }
                   1045:     return \@lang_choices;
                   1046: }
                   1047: 
                   1048: =pod
                   1049: 
1.648     raeburn  1050: =item * &linked_select_forms(...)
1.36      matthew  1051: 
                   1052: linked_select_forms returns a string containing a <script></script> block
                   1053: and html for two <select> menus.  The select menus will be linked in that
                   1054: changing the value of the first menu will result in new values being placed
                   1055: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1056: order unless a defined order is provided.
1.36      matthew  1057: 
                   1058: linked_select_forms takes the following ordered inputs:
                   1059: 
                   1060: =over 4
                   1061: 
1.112     bowersj2 1062: =item * $formname, the name of the <form> tag
1.36      matthew  1063: 
1.112     bowersj2 1064: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1065: 
1.112     bowersj2 1066: =item * $firstdefault, the default value for the first menu
1.36      matthew  1067: 
1.112     bowersj2 1068: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1069: 
1.112     bowersj2 1070: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1071: 
1.112     bowersj2 1072: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1073: 
1.609     raeburn  1074: =item * $menuorder, the order of values in the first menu
                   1075: 
1.1115    raeburn  1076: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1077:         event for the first <select> tag
                   1078: 
                   1079: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1080:         event for the second <select> tag
                   1081: 
1.41      ng       1082: =back 
                   1083: 
1.36      matthew  1084: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1085: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1086: values for the first select menu.  The text that coincides with the 
1.41      ng       1087: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1088: and text for the second menu are given in the hash pointed to by 
                   1089: $menu{$choice1}->{'select2'}.  
                   1090: 
1.112     bowersj2 1091:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1092:                        default => "B3",
                   1093:                        select2 => { 
                   1094:                            B1 => "Choice B1",
                   1095:                            B2 => "Choice B2",
                   1096:                            B3 => "Choice B3",
                   1097:                            B4 => "Choice B4"
1.609     raeburn  1098:                            },
                   1099:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1100:                    },
                   1101:                A2 => { text =>"Choice A2" ,
                   1102:                        default => "C2",
                   1103:                        select2 => { 
                   1104:                            C1 => "Choice C1",
                   1105:                            C2 => "Choice C2",
                   1106:                            C3 => "Choice C3"
1.609     raeburn  1107:                            },
                   1108:                        order => ['C2','C1','C3'],
1.112     bowersj2 1109:                    },
                   1110:                A3 => { text =>"Choice A3" ,
                   1111:                        default => "D6",
                   1112:                        select2 => { 
                   1113:                            D1 => "Choice D1",
                   1114:                            D2 => "Choice D2",
                   1115:                            D3 => "Choice D3",
                   1116:                            D4 => "Choice D4",
                   1117:                            D5 => "Choice D5",
                   1118:                            D6 => "Choice D6",
                   1119:                            D7 => "Choice D7"
1.609     raeburn  1120:                            },
                   1121:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1122:                    }
                   1123:                );
1.36      matthew  1124: 
                   1125: =cut
                   1126: 
                   1127: sub linked_select_forms {
                   1128:     my ($formname,
                   1129:         $middletext,
                   1130:         $firstdefault,
                   1131:         $firstselectname,
                   1132:         $secondselectname, 
1.609     raeburn  1133:         $hashref,
                   1134:         $menuorder,
1.1115    raeburn  1135:         $onchangefirst,
                   1136:         $onchangesecond
1.36      matthew  1137:         ) = @_;
                   1138:     my $second = "document.$formname.$secondselectname";
                   1139:     my $first = "document.$formname.$firstselectname";
                   1140:     # output the javascript to do the changing
                   1141:     my $result = '';
1.776     bisitz   1142:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1143:     $result.="// <![CDATA[\n";
1.36      matthew  1144:     $result.="var select2data = new Object();\n";
                   1145:     $" = '","';
                   1146:     my $debug = '';
                   1147:     foreach my $s1 (sort(keys(%$hashref))) {
                   1148:         $result.="select2data.d_$s1 = new Object();\n";        
                   1149:         $result.="select2data.d_$s1.def = new String('".
                   1150:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1151:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1152:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1153:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1154:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1155:         }
1.36      matthew  1156:         $result.="\"@s2values\");\n";
                   1157:         $result.="select2data.d_$s1.texts = new Array(";        
                   1158:         my @s2texts;
                   1159:         foreach my $value (@s2values) {
                   1160:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1161:         }
                   1162:         $result.="\"@s2texts\");\n";
                   1163:     }
                   1164:     $"=' ';
                   1165:     $result.= <<"END";
                   1166: 
                   1167: function select1_changed() {
                   1168:     // Determine new choice
                   1169:     var newvalue = "d_" + $first.value;
                   1170:     // update select2
                   1171:     var values     = select2data[newvalue].values;
                   1172:     var texts      = select2data[newvalue].texts;
                   1173:     var select2def = select2data[newvalue].def;
                   1174:     var i;
                   1175:     // out with the old
                   1176:     for (i = 0; i < $second.options.length; i++) {
                   1177:         $second.options[i] = null;
                   1178:     }
                   1179:     // in with the nuclear
                   1180:     for (i=0;i<values.length; i++) {
                   1181:         $second.options[i] = new Option(values[i]);
1.143     matthew  1182:         $second.options[i].value = values[i];
1.36      matthew  1183:         $second.options[i].text = texts[i];
                   1184:         if (values[i] == select2def) {
                   1185:             $second.options[i].selected = true;
                   1186:         }
                   1187:     }
                   1188: }
1.824     bisitz   1189: // ]]>
1.36      matthew  1190: </script>
                   1191: END
                   1192:     # output the initial values for the selection lists
1.1115    raeburn  1193:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1194:     my @order = sort(keys(%{$hashref}));
                   1195:     if (ref($menuorder) eq 'ARRAY') {
                   1196:         @order = @{$menuorder};
                   1197:     }
                   1198:     foreach my $value (@order) {
1.36      matthew  1199:         $result.="    <option value=\"$value\" ";
1.253     albertel 1200:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1201:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1202:     }
                   1203:     $result .= "</select>\n";
                   1204:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1205:     $result .= $middletext;
1.1115    raeburn  1206:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1207:     if ($onchangesecond) {
                   1208:         $result .= ' onchange="'.$onchangesecond.'"';
                   1209:     }
                   1210:     $result .= ">\n";
1.36      matthew  1211:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1212:     
                   1213:     my @secondorder = sort(keys(%select2));
                   1214:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1215:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1216:     }
                   1217:     foreach my $value (@secondorder) {
1.36      matthew  1218:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1219:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1220:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1221:     }
                   1222:     $result .= "</select>\n";
                   1223:     #    return $debug;
                   1224:     return $result;
                   1225: }   #  end of sub linked_select_forms {
                   1226: 
1.45      matthew  1227: =pod
1.44      bowersj2 1228: 
1.973     raeburn  1229: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1230: 
1.112     bowersj2 1231: Returns a string corresponding to an HTML link to the given help
                   1232: $topic, where $topic corresponds to the name of a .tex file in
                   1233: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1234: spaces. 
                   1235: 
                   1236: $text will optionally be linked to the same topic, allowing you to
                   1237: link text in addition to the graphic. If you do not want to link
                   1238: text, but wish to specify one of the later parameters, pass an
                   1239: empty string. 
                   1240: 
                   1241: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1242: the link will not open a new window. If false, the link will open
                   1243: a new window using Javascript. (Default is false.) 
                   1244: 
                   1245: $width and $height are optional numerical parameters that will
                   1246: override the width and height of the popped up window, which may
1.973     raeburn  1247: be useful for certain help topics with big pictures included.
                   1248: 
                   1249: $imgid is the id of the img tag used for the help icon. This may be
                   1250: used in a javascript call to switch the image src.  See 
                   1251: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1252: 
                   1253: =cut
                   1254: 
                   1255: sub help_open_topic {
1.973     raeburn  1256:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1257:     $text = "" if (not defined $text);
1.44      bowersj2 1258:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1259:     $width = 500 if (not defined $width);
1.44      bowersj2 1260:     $height = 400 if (not defined $height);
                   1261:     my $filename = $topic;
                   1262:     $filename =~ s/ /_/g;
                   1263: 
1.48      bowersj2 1264:     my $template = "";
                   1265:     my $link;
1.572     banghart 1266:     
1.159     www      1267:     $topic=~s/\W/\_/g;
1.44      bowersj2 1268: 
1.572     banghart 1269:     if (!$stayOnPage) {
1.1033    www      1270: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1271:     } elsif ($stayOnPage eq 'popup') {
                   1272:         $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 1273:     } else {
1.48      bowersj2 1274: 	$link = "/adm/help/${filename}.hlp";
                   1275:     }
                   1276: 
                   1277:     # Add the text
1.755     neumanie 1278:     if ($text ne "") {	
1.763     bisitz   1279: 	$template.='<span class="LC_help_open_topic">'
                   1280:                   .'<a target="_top" href="'.$link.'">'
                   1281:                   .$text.'</a>';
1.48      bowersj2 1282:     }
                   1283: 
1.763     bisitz   1284:     # (Always) Add the graphic
1.179     matthew  1285:     my $title = &mt('Online Help');
1.667     raeburn  1286:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1287:     if ($imgid ne '') {
                   1288:         $imgid = ' id="'.$imgid.'"';
                   1289:     }
1.763     bisitz   1290:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1291:               .'<img src="'.$helpicon.'" border="0"'
                   1292:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1293:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1294:               .' /></a>';
                   1295:     if ($text ne "") {	
                   1296:         $template.='</span>';
                   1297:     }
1.44      bowersj2 1298:     return $template;
                   1299: 
1.106     bowersj2 1300: }
                   1301: 
                   1302: # This is a quicky function for Latex cheatsheet editing, since it 
                   1303: # appears in at least four places
                   1304: sub helpLatexCheatsheet {
1.1037    www      1305:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1306:     my $out;
1.106     bowersj2 1307:     my $addOther = '';
1.732     raeburn  1308:     if ($topic) {
1.1037    www      1309: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1310:     }
                   1311:     $out = '<span>' # Start cheatsheet
                   1312: 	  .$addOther
                   1313:           .'<span>'
1.1037    www      1314: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1315: 	  .'</span> <span>'
1.1037    www      1316: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1317: 	  .'</span>';
1.732     raeburn  1318:     unless ($not_author) {
1.1186    kruse    1319:         $out .= '<span>'
                   1320:                .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
                   1321:                .'</span> <span>'
                   1322:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763     bisitz   1323: 	       .'</span>';
1.732     raeburn  1324:     }
1.763     bisitz   1325:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1326:     return $out;
1.172     www      1327: }
                   1328: 
1.430     albertel 1329: sub general_help {
                   1330:     my $helptopic='Student_Intro';
                   1331:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1332: 	$helptopic='Authoring_Intro';
1.907     raeburn  1333:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1334: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1335:     } elsif ($env{'request.role'}=~/^dc/) {
                   1336:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1337:     }
                   1338:     return $helptopic;
                   1339: }
                   1340: 
                   1341: sub update_help_link {
                   1342:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1343:     my $origurl = $ENV{'REQUEST_URI'};
                   1344:     $origurl=~s|^/~|/priv/|;
                   1345:     my $timestamp = time;
                   1346:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1347:         $$datum = &escape($$datum);
                   1348:     }
                   1349: 
                   1350:     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";
                   1351:     my $output .= <<"ENDOUTPUT";
                   1352: <script type="text/javascript">
1.824     bisitz   1353: // <![CDATA[
1.430     albertel 1354: banner_link = '$banner_link';
1.824     bisitz   1355: // ]]>
1.430     albertel 1356: </script>
                   1357: ENDOUTPUT
                   1358:     return $output;
                   1359: }
                   1360: 
                   1361: # now just updates the help link and generates a blue icon
1.193     raeburn  1362: sub help_open_menu {
1.430     albertel 1363:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1364: 	= @_;    
1.949     droeschl 1365:     $stayOnPage = 1;
1.430     albertel 1366:     my $output;
                   1367:     if ($component_help) {
                   1368: 	if (!$text) {
                   1369: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1370: 				       $width,$height);
                   1371: 	} else {
                   1372: 	    my $help_text;
                   1373: 	    $help_text=&unescape($topic);
                   1374: 	    $output='<table><tr><td>'.
                   1375: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1376: 				 $width,$height).'</td></tr></table>';
                   1377: 	}
                   1378:     }
                   1379:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1380:     return $output.$banner_link;
                   1381: }
                   1382: 
                   1383: sub top_nav_help {
                   1384:     my ($text) = @_;
1.436     albertel 1385:     $text = &mt($text);
1.949     droeschl 1386:     my $stay_on_page = 1;
                   1387: 
1.1168    raeburn  1388:     my ($link,$banner_link);
                   1389:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1390:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1391: 	                         : "javascript:helpMenu('open')";
                   1392:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1393:     }
1.201     raeburn  1394:     my $title = &mt('Get help');
1.1168    raeburn  1395:     if ($link) {
                   1396:         return <<"END";
1.436     albertel 1397: $banner_link
1.1159    raeburn  1398: <a href="$link" title="$title">$text</a>
1.436     albertel 1399: END
1.1168    raeburn  1400:     } else {
                   1401:         return '&nbsp;'.$text.'&nbsp;';
                   1402:     }
1.436     albertel 1403: }
                   1404: 
                   1405: sub help_menu_js {
1.1154    raeburn  1406:     my ($httphost) = @_;
1.949     droeschl 1407:     my $stayOnPage = 1;
1.436     albertel 1408:     my $width = 620;
                   1409:     my $height = 600;
1.430     albertel 1410:     my $helptopic=&general_help();
1.1154    raeburn  1411:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1412:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1413:     my $start_page =
                   1414:         &Apache::loncommon::start_page('Help Menu', undef,
                   1415: 				       {'frameset'    => 1,
                   1416: 					'js_ready'    => 1,
1.1154    raeburn  1417:                                         'use_absolute' => $httphost,
1.331     albertel 1418: 					'add_entries' => {
1.1168    raeburn  1419: 					    'border' => '0', 
1.579     raeburn  1420: 					    'rows'   => "110,*",},});
1.331     albertel 1421:     my $end_page =
                   1422:         &Apache::loncommon::end_page({'frameset' => 1,
                   1423: 				      'js_ready' => 1,});
                   1424: 
1.436     albertel 1425:     my $template .= <<"ENDTEMPLATE";
                   1426: <script type="text/javascript">
1.877     bisitz   1427: // <![CDATA[
1.253     albertel 1428: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1429: var banner_link = '';
1.243     raeburn  1430: function helpMenu(target) {
                   1431:     var caller = this;
                   1432:     if (target == 'open') {
                   1433:         var newWindow = null;
                   1434:         try {
1.262     albertel 1435:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1436:         }
                   1437:         catch(error) {
                   1438:             writeHelp(caller);
                   1439:             return;
                   1440:         }
                   1441:         if (newWindow) {
                   1442:             caller = newWindow;
                   1443:         }
1.193     raeburn  1444:     }
1.243     raeburn  1445:     writeHelp(caller);
                   1446:     return;
                   1447: }
                   1448: function writeHelp(caller) {
1.1168    raeburn  1449:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1450:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1451:     caller.document.close();
                   1452:     caller.focus();
1.193     raeburn  1453: }
1.877     bisitz   1454: // END LON-CAPA Internal -->
1.253     albertel 1455: // ]]>
1.436     albertel 1456: </script>
1.193     raeburn  1457: ENDTEMPLATE
                   1458:     return $template;
                   1459: }
                   1460: 
1.172     www      1461: sub help_open_bug {
                   1462:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1463:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1464:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1465:     $text = "" if (not defined $text);
                   1466: 	$stayOnPage=1;
1.184     albertel 1467:     $width = 600 if (not defined $width);
                   1468:     $height = 600 if (not defined $height);
1.172     www      1469: 
                   1470:     $topic=~s/\W+/\+/g;
                   1471:     my $link='';
                   1472:     my $template='';
1.379     albertel 1473:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1474: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1475:     if (!$stayOnPage)
                   1476:     {
                   1477: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1478:     }
                   1479:     else
                   1480:     {
                   1481: 	$link = $url;
                   1482:     }
                   1483:     # Add the text
                   1484:     if ($text ne "")
                   1485:     {
                   1486: 	$template .= 
                   1487:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1488:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1489:     }
                   1490: 
                   1491:     # Add the graphic
1.179     matthew  1492:     my $title = &mt('Report a Bug');
1.215     albertel 1493:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1494:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1495:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1496: ENDTEMPLATE
                   1497:     if ($text ne '') { $template.='</td></tr></table>' };
                   1498:     return $template;
                   1499: 
                   1500: }
                   1501: 
                   1502: sub help_open_faq {
                   1503:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1504:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1505:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1506:     $text = "" if (not defined $text);
                   1507: 	$stayOnPage=1;
                   1508:     $width = 350 if (not defined $width);
                   1509:     $height = 400 if (not defined $height);
                   1510: 
                   1511:     $topic=~s/\W+/\+/g;
                   1512:     my $link='';
                   1513:     my $template='';
                   1514:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1515:     if (!$stayOnPage)
                   1516:     {
                   1517: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1518:     }
                   1519:     else
                   1520:     {
                   1521: 	$link = $url;
                   1522:     }
                   1523: 
                   1524:     # Add the text
                   1525:     if ($text ne "")
                   1526:     {
                   1527: 	$template .= 
1.173     www      1528:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1529:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1530:     }
                   1531: 
                   1532:     # Add the graphic
1.179     matthew  1533:     my $title = &mt('View the FAQ');
1.215     albertel 1534:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1535:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1536:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1537: ENDTEMPLATE
                   1538:     if ($text ne '') { $template.='</td></tr></table>' };
                   1539:     return $template;
                   1540: 
1.44      bowersj2 1541: }
1.37      matthew  1542: 
1.180     matthew  1543: ###############################################################
                   1544: ###############################################################
                   1545: 
1.45      matthew  1546: =pod
                   1547: 
1.648     raeburn  1548: =item * &change_content_javascript():
1.256     matthew  1549: 
                   1550: This and the next function allow you to create small sections of an
                   1551: otherwise static HTML page that you can update on the fly with
                   1552: Javascript, even in Netscape 4.
                   1553: 
                   1554: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1555: must be written to the HTML page once. It will prove the Javascript
                   1556: function "change(name, content)". Calling the change function with the
                   1557: name of the section 
                   1558: you want to update, matching the name passed to C<changable_area>, and
                   1559: the new content you want to put in there, will put the content into
                   1560: that area.
                   1561: 
                   1562: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1563: to contain room for the original contents. You need to "make space"
                   1564: for whatever changes you wish to make, and be B<sure> to check your
                   1565: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1566: it's adequate for updating a one-line status display, but little more.
                   1567: This script will set the space to 100% width, so you only need to
                   1568: worry about height in Netscape 4.
                   1569: 
                   1570: Modern browsers are much less limiting, and if you can commit to the
                   1571: user not using Netscape 4, this feature may be used freely with
                   1572: pretty much any HTML.
                   1573: 
                   1574: =cut
                   1575: 
                   1576: sub change_content_javascript {
                   1577:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1578:     if ($env{'browser.type'} eq 'netscape' &&
                   1579: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1580: 	return (<<NETSCAPE4);
                   1581: 	function change(name, content) {
                   1582: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1583: 	    doc.open();
                   1584: 	    doc.write(content);
                   1585: 	    doc.close();
                   1586: 	}
                   1587: NETSCAPE4
                   1588:     } else {
                   1589: 	# Otherwise, we need to use semi-standards-compliant code
                   1590: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1591: 	# is really scary, and every useful browser supports it
                   1592: 	return (<<DOMBASED);
                   1593: 	function change(name, content) {
                   1594: 	    element = document.getElementById(name);
                   1595: 	    element.innerHTML = content;
                   1596: 	}
                   1597: DOMBASED
                   1598:     }
                   1599: }
                   1600: 
                   1601: =pod
                   1602: 
1.648     raeburn  1603: =item * &changable_area($name,$origContent):
1.256     matthew  1604: 
                   1605: This provides a "changable area" that can be modified on the fly via
                   1606: the Javascript code provided in C<change_content_javascript>. $name is
                   1607: the name you will use to reference the area later; do not repeat the
                   1608: same name on a given HTML page more then once. $origContent is what
                   1609: the area will originally contain, which can be left blank.
                   1610: 
                   1611: =cut
                   1612: 
                   1613: sub changable_area {
                   1614:     my ($name, $origContent) = @_;
                   1615: 
1.258     albertel 1616:     if ($env{'browser.type'} eq 'netscape' &&
                   1617: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1618: 	# If this is netscape 4, we need to use the Layer tag
                   1619: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1620:     } else {
                   1621: 	return "<span id='$name'>$origContent</span>";
                   1622:     }
                   1623: }
                   1624: 
                   1625: =pod
                   1626: 
1.648     raeburn  1627: =item * &viewport_geometry_js 
1.590     raeburn  1628: 
                   1629: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1630: 
                   1631: =cut
                   1632: 
                   1633: 
                   1634: sub viewport_geometry_js { 
                   1635:     return <<"GEOMETRY";
                   1636: var Geometry = {};
                   1637: function init_geometry() {
                   1638:     if (Geometry.init) { return };
                   1639:     Geometry.init=1;
                   1640:     if (window.innerHeight) {
                   1641:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1642:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1643:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1644:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1645:     }
                   1646:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1647:         Geometry.getViewportHeight =
                   1648:             function() { return document.documentElement.clientHeight; };
                   1649:         Geometry.getViewportWidth =
                   1650:             function() { return document.documentElement.clientWidth; };
                   1651: 
                   1652:         Geometry.getHorizontalScroll =
                   1653:             function() { return document.documentElement.scrollLeft; };
                   1654:         Geometry.getVerticalScroll =
                   1655:             function() { return document.documentElement.scrollTop; };
                   1656:     }
                   1657:     else if (document.body.clientHeight) {
                   1658:         Geometry.getViewportHeight =
                   1659:             function() { return document.body.clientHeight; };
                   1660:         Geometry.getViewportWidth =
                   1661:             function() { return document.body.clientWidth; };
                   1662:         Geometry.getHorizontalScroll =
                   1663:             function() { return document.body.scrollLeft; };
                   1664:         Geometry.getVerticalScroll =
                   1665:             function() { return document.body.scrollTop; };
                   1666:     }
                   1667: }
                   1668: 
                   1669: GEOMETRY
                   1670: }
                   1671: 
                   1672: =pod
                   1673: 
1.648     raeburn  1674: =item * &viewport_size_js()
1.590     raeburn  1675: 
                   1676: 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. 
                   1677: 
                   1678: =cut
                   1679: 
                   1680: sub viewport_size_js {
                   1681:     my $geometry = &viewport_geometry_js();
                   1682:     return <<"DIMS";
                   1683: 
                   1684: $geometry
                   1685: 
                   1686: function getViewportDims(width,height) {
                   1687:     init_geometry();
                   1688:     width.value = Geometry.getViewportWidth();
                   1689:     height.value = Geometry.getViewportHeight();
                   1690:     return;
                   1691: }
                   1692: 
                   1693: DIMS
                   1694: }
                   1695: 
                   1696: =pod
                   1697: 
1.648     raeburn  1698: =item * &resize_textarea_js()
1.565     albertel 1699: 
                   1700: emits the needed javascript to resize a textarea to be as big as possible
                   1701: 
                   1702: creates a function resize_textrea that takes two IDs first should be
                   1703: the id of the element to resize, second should be the id of a div that
                   1704: surrounds everything that comes after the textarea, this routine needs
                   1705: to be attached to the <body> for the onload and onresize events.
                   1706: 
1.648     raeburn  1707: =back
1.565     albertel 1708: 
                   1709: =cut
                   1710: 
                   1711: sub resize_textarea_js {
1.590     raeburn  1712:     my $geometry = &viewport_geometry_js();
1.565     albertel 1713:     return <<"RESIZE";
                   1714:     <script type="text/javascript">
1.824     bisitz   1715: // <![CDATA[
1.590     raeburn  1716: $geometry
1.565     albertel 1717: 
1.588     albertel 1718: function getX(element) {
                   1719:     var x = 0;
                   1720:     while (element) {
                   1721: 	x += element.offsetLeft;
                   1722: 	element = element.offsetParent;
                   1723:     }
                   1724:     return x;
                   1725: }
                   1726: function getY(element) {
                   1727:     var y = 0;
                   1728:     while (element) {
                   1729: 	y += element.offsetTop;
                   1730: 	element = element.offsetParent;
                   1731:     }
                   1732:     return y;
                   1733: }
                   1734: 
                   1735: 
1.565     albertel 1736: function resize_textarea(textarea_id,bottom_id) {
                   1737:     init_geometry();
                   1738:     var textarea        = document.getElementById(textarea_id);
                   1739:     //alert(textarea);
                   1740: 
1.588     albertel 1741:     var textarea_top    = getY(textarea);
1.565     albertel 1742:     var textarea_height = textarea.offsetHeight;
                   1743:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1744:     var bottom_top      = getY(bottom);
1.565     albertel 1745:     var bottom_height   = bottom.offsetHeight;
                   1746:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1747:     var fudge           = 23;
1.565     albertel 1748:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1749:     if (new_height < 300) {
                   1750: 	new_height = 300;
                   1751:     }
                   1752:     textarea.style.height=new_height+'px';
                   1753: }
1.824     bisitz   1754: // ]]>
1.565     albertel 1755: </script>
                   1756: RESIZE
                   1757: 
                   1758: }
                   1759: 
1.1205    golterma 1760: sub colorfuleditor_js {
                   1761:     return <<"COLORFULEDIT"
                   1762: <script type="text/javascript">
                   1763: // <![CDATA[>
                   1764:     function fold_box(curDepth, lastresource){
                   1765: 
                   1766:     // we need a list because there can be several blocks you need to fold in one tag
                   1767:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1768:     // but there is only one folding button per tag
                   1769:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1770: 
                   1771:         if(block.item(0).style.display == 'none'){
                   1772: 
                   1773:             foldbutton.value = '@{[&mt("Hide")]}';
                   1774:             for (i = 0; i < block.length; i++){
                   1775:                 block.item(i).style.display = '';
                   1776:             }
                   1777:         }else{
                   1778: 
                   1779:             foldbutton.value = '@{[&mt("Show")]}';
                   1780:             for (i = 0; i < block.length; i++){
                   1781:                 // block.item(i).style.visibility = 'collapse';
                   1782:                 block.item(i).style.display = 'none';
                   1783:             }
                   1784:         };
                   1785:         saveState(lastresource);
                   1786:     }
                   1787: 
                   1788:     function saveState (lastresource) {
                   1789: 
                   1790:         var tag_list = getTagList();
                   1791:         if(tag_list != null){
                   1792:             var timestamp = new Date().getTime();
                   1793:             var key = lastresource;
                   1794: 
                   1795:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1796:             // starting with timestamp
                   1797:             var value = timestamp+';';
                   1798: 
                   1799:             // building the list of key-value pairs
                   1800:             for(var i = 0; i < tag_list.length; i++){
                   1801:                 value += tag_list[i]+',';
                   1802:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1803:             }
                   1804: 
                   1805:             // only iterate whole storage if nothing to override
                   1806:             if(localStorage.getItem(key) == null){        
                   1807: 
                   1808:                 // prevent storage from growing large
                   1809:                 if(localStorage.length > 50){
                   1810:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1811:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1812:                     var oldest_key;
                   1813:                     
                   1814:                     for(var i = 1; i < localStorage.length; i++){
                   1815:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1816:                             oldest_key = localStorage.key(i);
                   1817:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1818:                         }
                   1819:                     }
                   1820:                     localStorage.removeItem(oldest_key);
                   1821:                 }
                   1822:             }
                   1823:             localStorage.setItem(key,value);
                   1824:         }
                   1825:     }
                   1826: 
                   1827:     // restore folding status of blocks (on page load)
                   1828:     function restoreState (lastresource) {
                   1829:         if(localStorage.getItem(lastresource) != null){
                   1830:             var key = lastresource;
                   1831:             var value = localStorage.getItem(key);
                   1832:             var regex_delTimestamp = /^\d+;/;
                   1833: 
                   1834:             value.replace(regex_delTimestamp, '');
                   1835: 
                   1836:             var valueArr = value.split(';');
                   1837:             var pairs;
                   1838:             var elements;
                   1839:             for (var i = 0; i < valueArr.length; i++){
                   1840:                 pairs = valueArr[i].split(',');
                   1841:                 elements = document.getElementsByName(pairs[0]);
                   1842: 
                   1843:                 for (var j = 0; j < elements.length; j++){  
                   1844:                     elements[j].style.display = pairs[1];
                   1845:                     if (pairs[1] == "none"){
                   1846:                         var regex_id = /([_\\d]+)\$/;
                   1847:                         regex_id.exec(pairs[0]);
                   1848:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1849:                     }
                   1850:                 }
                   1851:             }
                   1852:         }
                   1853:     }
                   1854: 
                   1855:     function getTagList () {
                   1856:         
                   1857:         var stringToSearch = document.lonhomework.innerHTML;
                   1858: 
                   1859:         var ret = new Array();
                   1860:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1861:         var tag_list = stringToSearch.match(regex_findBlock);
                   1862: 
                   1863:         if(tag_list != null){
                   1864:             for(var i = 0; i < tag_list.length; i++){            
                   1865:                 ret.push(tag_list[i].replace(/"/, ''));
                   1866:             }
                   1867:         }
                   1868:         return ret;
                   1869:     }
                   1870: 
                   1871:     function saveScrollPosition (resource) {
                   1872:         var tag_list = getTagList();
                   1873: 
                   1874:         // we dont always want to jump to the first block
                   1875:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1876:         if(\$(window).scrollTop() > 170){
                   1877:             if(tag_list != null){
                   1878:                 var result;
                   1879:                 for(var i = 0; i < tag_list.length; i++){
                   1880:                     if(isElementInViewport(tag_list[i])){
                   1881:                         result += tag_list[i]+';';
                   1882:                     }
                   1883:                 }
                   1884:                 sessionStorage.setItem('anchor_'+resource, result);
                   1885:             }
                   1886:         } else {
                   1887:             // we dont need to save zero, just delete the item to leave everything tidy
                   1888:             sessionStorage.removeItem('anchor_'+resource);
                   1889:         }
                   1890:     }
                   1891: 
                   1892:     function restoreScrollPosition(resource){
                   1893: 
                   1894:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1895:         if(elem != null){
                   1896:             var tag_list = elem.split(';');
                   1897:             var elem_list;
                   1898: 
                   1899:             for(var i = 0; i < tag_list.length; i++){
                   1900:                 elem_list = document.getElementsByName(tag_list[i]);
                   1901:                 
                   1902:                 if(elem_list.length > 0){
                   1903:                     elem = elem_list[0];
                   1904:                     break;
                   1905:                 }
                   1906:             }
                   1907:             elem.scrollIntoView();
                   1908:         }
                   1909:     }
                   1910: 
                   1911:     function isElementInViewport(el) {
                   1912: 
                   1913:         // change to last element instead of first
                   1914:         var elem = document.getElementsByName(el);
                   1915:         var rect = elem[0].getBoundingClientRect();
                   1916: 
                   1917:         return (
                   1918:             rect.top >= 0 &&
                   1919:             rect.left >= 0 &&
                   1920:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1921:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1922:         );
                   1923:     }
                   1924:     
                   1925:     function autosize(depth){
                   1926:         var cmInst = window['cm'+depth];
                   1927:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1928: 
                   1929:         // is fixed size, switching to dynamic
                   1930:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1931:             cmInst.setSize("","auto");
                   1932:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1933:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1934: 
                   1935:         // is dynamic size, switching to fixed
                   1936:         } else {
                   1937:             cmInst.setSize("","300px");
                   1938:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1939:             sessionStorage.removeItem("autosized_"+depth);
                   1940:         }
                   1941:     }
                   1942: 
                   1943: 
                   1944: 
                   1945: // ]]>
                   1946: </script>
                   1947: COLORFULEDIT
                   1948: }
                   1949: 
                   1950: sub xmleditor_js {
                   1951:     return <<XMLEDIT
                   1952: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1953: <script type="text/javascript">
                   1954: // <![CDATA[>
                   1955: 
                   1956:     function saveScrollPosition (resource) {
                   1957: 
                   1958:         var scrollPos = \$(window).scrollTop();
                   1959:         sessionStorage.setItem(resource,scrollPos);
                   1960:     }
                   1961: 
                   1962:     function restoreScrollPosition(resource){
                   1963: 
                   1964:         var scrollPos = sessionStorage.getItem(resource);
                   1965:         \$(window).scrollTop(scrollPos);
                   1966:     }
                   1967: 
                   1968:     // unless internet explorer
                   1969:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1970: 
                   1971:         \$(document).ready(function() {
                   1972:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1973:         });
                   1974:     }
                   1975: 
                   1976:     // inserts text at cursor position into codemirror (xml editor only)
                   1977:     function insertText(text){
                   1978:         cm.focus();
                   1979:         var curPos = cm.getCursor();
                   1980:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1981:     }
                   1982: // ]]>
                   1983: </script>
                   1984: XMLEDIT
                   1985: }
                   1986: 
                   1987: sub insert_folding_button {
                   1988:     my $curDepth = $Apache::lonxml::curdepth;
                   1989:     my $lastresource = $env{'request.ambiguous'};
                   1990: 
                   1991:     return "<input type=\"button\" id=\"folding_btn_$curDepth\" 
                   1992:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1993: }
                   1994: 
1.565     albertel 1995: =pod
                   1996: 
1.256     matthew  1997: =head1 Excel and CSV file utility routines
                   1998: 
                   1999: =cut
                   2000: 
                   2001: ###############################################################
                   2002: ###############################################################
                   2003: 
                   2004: =pod
                   2005: 
1.1162    raeburn  2006: =over 4
                   2007: 
1.648     raeburn  2008: =item * &csv_translate($text) 
1.37      matthew  2009: 
1.185     www      2010: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2011: format.
                   2012: 
                   2013: =cut
                   2014: 
1.180     matthew  2015: ###############################################################
                   2016: ###############################################################
1.37      matthew  2017: sub csv_translate {
                   2018:     my $text = shift;
                   2019:     $text =~ s/\"/\"\"/g;
1.209     albertel 2020:     $text =~ s/\n/ /g;
1.37      matthew  2021:     return $text;
                   2022: }
1.180     matthew  2023: 
                   2024: ###############################################################
                   2025: ###############################################################
                   2026: 
                   2027: =pod
                   2028: 
1.648     raeburn  2029: =item * &define_excel_formats()
1.180     matthew  2030: 
                   2031: Define some commonly used Excel cell formats.
                   2032: 
                   2033: Currently supported formats:
                   2034: 
                   2035: =over 4
                   2036: 
                   2037: =item header
                   2038: 
                   2039: =item bold
                   2040: 
                   2041: =item h1
                   2042: 
                   2043: =item h2
                   2044: 
                   2045: =item h3
                   2046: 
1.256     matthew  2047: =item h4
                   2048: 
                   2049: =item i
                   2050: 
1.180     matthew  2051: =item date
                   2052: 
                   2053: =back
                   2054: 
                   2055: Inputs: $workbook
                   2056: 
                   2057: Returns: $format, a hash reference.
                   2058: 
1.1057    foxr     2059: 
1.180     matthew  2060: =cut
                   2061: 
                   2062: ###############################################################
                   2063: ###############################################################
                   2064: sub define_excel_formats {
                   2065:     my ($workbook) = @_;
                   2066:     my $format;
                   2067:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2068:                                                 bottom    => 1,
                   2069:                                                 align     => 'center');
                   2070:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2071:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2072:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2073:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2074:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2075:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2076:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2077:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2078:     return $format;
                   2079: }
                   2080: 
                   2081: ###############################################################
                   2082: ###############################################################
1.113     bowersj2 2083: 
                   2084: =pod
                   2085: 
1.648     raeburn  2086: =item * &create_workbook()
1.255     matthew  2087: 
                   2088: Create an Excel worksheet.  If it fails, output message on the
                   2089: request object and return undefs.
                   2090: 
                   2091: Inputs: Apache request object
                   2092: 
                   2093: Returns (undef) on failure, 
                   2094:     Excel worksheet object, scalar with filename, and formats 
                   2095:     from &Apache::loncommon::define_excel_formats on success
                   2096: 
                   2097: =cut
                   2098: 
                   2099: ###############################################################
                   2100: ###############################################################
                   2101: sub create_workbook {
                   2102:     my ($r) = @_;
                   2103:         #
                   2104:     # Create the excel spreadsheet
                   2105:     my $filename = '/prtspool/'.
1.258     albertel 2106:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2107:         time.'_'.rand(1000000000).'.xls';
                   2108:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2109:     if (! defined($workbook)) {
                   2110:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2111:         $r->print(
                   2112:             '<p class="LC_error">'
                   2113:            .&mt('Problems occurred in creating the new Excel file.')
                   2114:            .' '.&mt('This error has been logged.')
                   2115:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2116:            .'</p>'
                   2117:         );
1.255     matthew  2118:         return (undef);
                   2119:     }
                   2120:     #
1.1014    foxr     2121:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2122:     #
                   2123:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2124:     return ($workbook,$filename,$format);
                   2125: }
                   2126: 
                   2127: ###############################################################
                   2128: ###############################################################
                   2129: 
                   2130: =pod
                   2131: 
1.648     raeburn  2132: =item * &create_text_file()
1.113     bowersj2 2133: 
1.542     raeburn  2134: Create a file to write to and eventually make available to the user.
1.256     matthew  2135: If file creation fails, outputs an error message on the request object and 
                   2136: return undefs.
1.113     bowersj2 2137: 
1.256     matthew  2138: Inputs: Apache request object, and file suffix
1.113     bowersj2 2139: 
1.256     matthew  2140: Returns (undef) on failure, 
                   2141:     Filehandle and filename on success.
1.113     bowersj2 2142: 
                   2143: =cut
                   2144: 
1.256     matthew  2145: ###############################################################
                   2146: ###############################################################
                   2147: sub create_text_file {
                   2148:     my ($r,$suffix) = @_;
                   2149:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2150:     my $fh;
                   2151:     my $filename = '/prtspool/'.
1.258     albertel 2152:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2153:         time.'_'.rand(1000000000).'.'.$suffix;
                   2154:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2155:     if (! defined($fh)) {
                   2156:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2157:         $r->print(
                   2158:             '<p class="LC_error">'
                   2159:            .&mt('Problems occurred in creating the output file.')
                   2160:            .' '.&mt('This error has been logged.')
                   2161:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2162:            .'</p>'
                   2163:         );
1.113     bowersj2 2164:     }
1.256     matthew  2165:     return ($fh,$filename)
1.113     bowersj2 2166: }
                   2167: 
                   2168: 
1.256     matthew  2169: =pod 
1.113     bowersj2 2170: 
                   2171: =back
                   2172: 
                   2173: =cut
1.37      matthew  2174: 
                   2175: ###############################################################
1.33      matthew  2176: ##        Home server <option> list generating code          ##
                   2177: ###############################################################
1.35      matthew  2178: 
1.169     www      2179: # ------------------------------------------
                   2180: 
                   2181: sub domain_select {
                   2182:     my ($name,$value,$multiple)=@_;
                   2183:     my %domains=map { 
1.514     albertel 2184: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2185:     } &Apache::lonnet::all_domains();
1.169     www      2186:     if ($multiple) {
                   2187: 	$domains{''}=&mt('Any domain');
1.550     albertel 2188: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2189: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2190:     } else {
1.550     albertel 2191: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2192: 	return &select_form($name,$value,\%domains);
1.169     www      2193:     }
                   2194: }
                   2195: 
1.282     albertel 2196: #-------------------------------------------
                   2197: 
                   2198: =pod
                   2199: 
1.519     raeburn  2200: =head1 Routines for form select boxes
                   2201: 
                   2202: =over 4
                   2203: 
1.648     raeburn  2204: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2205: 
                   2206: Returns a string containing a <select> element int multiple mode
                   2207: 
                   2208: 
                   2209: Args:
                   2210:   $name - name of the <select> element
1.506     raeburn  2211:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2212:   $size - number of rows long the select element is
1.283     albertel 2213:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2214:           (shown text should already have been &mt())
1.506     raeburn  2215:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2216: 
1.282     albertel 2217: =cut
                   2218: 
                   2219: #-------------------------------------------
1.169     www      2220: sub multiple_select_form {
1.284     albertel 2221:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2222:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2223:     my $output='';
1.191     matthew  2224:     if (! defined($size)) {
                   2225:         $size = 4;
1.283     albertel 2226:         if (scalar(keys(%$hash))<4) {
                   2227:             $size = scalar(keys(%$hash));
1.191     matthew  2228:         }
                   2229:     }
1.734     bisitz   2230:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2231:     my @order;
1.506     raeburn  2232:     if (ref($order) eq 'ARRAY')  {
                   2233:         @order = @{$order};
                   2234:     } else {
                   2235:         @order = sort(keys(%$hash));
1.501     banghart 2236:     }
                   2237:     if (exists($$hash{'select_form_order'})) {
                   2238:         @order = @{$$hash{'select_form_order'}};
                   2239:     }
                   2240:         
1.284     albertel 2241:     foreach my $key (@order) {
1.356     albertel 2242:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2243:         $output.='selected="selected" ' if ($selected{$key});
                   2244:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2245:     }
                   2246:     $output.="</select>\n";
                   2247:     return $output;
                   2248: }
                   2249: 
1.88      www      2250: #-------------------------------------------
                   2251: 
                   2252: =pod
                   2253: 
1.970     raeburn  2254: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      2255: 
                   2256: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2257: allow a user to select options from a ref to a hash containing:
                   2258: option_name => displayed text. An optional $onchange can include
                   2259: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   2260: 
1.88      www      2261: See lonrights.pm for an example invocation and use.
                   2262: 
                   2263: =cut
                   2264: 
                   2265: #-------------------------------------------
                   2266: sub select_form {
1.970     raeburn  2267:     my ($def,$name,$hashref,$onchange) = @_;
                   2268:     return unless (ref($hashref) eq 'HASH');
                   2269:     if ($onchange) {
                   2270:         $onchange = ' onchange="'.$onchange.'"';
                   2271:     }
                   2272:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 2273:     my @keys;
1.970     raeburn  2274:     if (exists($hashref->{'select_form_order'})) {
                   2275: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2276:     } else {
1.970     raeburn  2277: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2278:     }
1.356     albertel 2279:     foreach my $key (@keys) {
                   2280:         $selectform.=
                   2281: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2282:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2283:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2284:     }
                   2285:     $selectform.="</select>";
                   2286:     return $selectform;
                   2287: }
                   2288: 
1.475     www      2289: # For display filters
                   2290: 
                   2291: sub display_filter {
1.1074    raeburn  2292:     my ($context) = @_;
1.475     www      2293:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2294:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2295:     my $phraseinput = 'hidden';
                   2296:     my $includeinput = 'hidden';
                   2297:     my ($checked,$includetypestext);
                   2298:     if ($env{'form.displayfilter'} eq 'containing') {
                   2299:         $phraseinput = 'text'; 
                   2300:         if ($context eq 'parmslog') {
                   2301:             $includeinput = 'checkbox';
                   2302:             if ($env{'form.includetypes'}) {
                   2303:                 $checked = ' checked="checked"';
                   2304:             }
                   2305:             $includetypestext = &mt('Include parameter types');
                   2306:         }
                   2307:     } else {
                   2308:         $includetypestext = '&nbsp;';
                   2309:     }
                   2310:     my ($additional,$secondid,$thirdid);
                   2311:     if ($context eq 'parmslog') {
                   2312:         $additional = 
                   2313:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2314:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2315:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2316:             '</label>';
                   2317:         $secondid = 'includetypes';
                   2318:         $thirdid = 'includetypestext';
                   2319:     }
                   2320:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2321:                                                     '$secondid','$thirdid')";
                   2322:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2323: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2324: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2325: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2326:            &mt('Filter: [_1]',
1.477     www      2327: 	   &select_form($env{'form.displayfilter'},
                   2328: 			'displayfilter',
1.970     raeburn  2329: 			{'currentfolder' => 'Current folder/page',
1.477     www      2330: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2331: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2332: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2333:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2334:                          '" />'.$additional;
                   2335: }
                   2336: 
                   2337: sub display_filter_js {
                   2338:     my $includetext = &mt('Include parameter types');
                   2339:     return <<"ENDJS";
                   2340:   
                   2341: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2342:     var firstType = 'hidden';
                   2343:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2344:         firstType = 'text';
                   2345:     }
                   2346:     firstObject = document.getElementById(firstid);
                   2347:     if (typeof(firstObject) == 'object') {
                   2348:         if (firstObject.type != firstType) {
                   2349:             changeInputType(firstObject,firstType);
                   2350:         }
                   2351:     }
                   2352:     if (context == 'parmslog') {
                   2353:         var secondType = 'hidden';
                   2354:         if (firstType == 'text') {
                   2355:             secondType = 'checkbox';
                   2356:         }
                   2357:         secondObject = document.getElementById(secondid);  
                   2358:         if (typeof(secondObject) == 'object') {
                   2359:             if (secondObject.type != secondType) {
                   2360:                 changeInputType(secondObject,secondType);
                   2361:             }
                   2362:         }
                   2363:         var textItem = document.getElementById(thirdid);
                   2364:         var currtext = textItem.innerHTML;
                   2365:         var newtext;
                   2366:         if (firstType == 'text') {
                   2367:             newtext = '$includetext';
                   2368:         } else {
                   2369:             newtext = '&nbsp;';
                   2370:         }
                   2371:         if (currtext != newtext) {
                   2372:             textItem.innerHTML = newtext;
                   2373:         }
                   2374:     }
                   2375:     return;
                   2376: }
                   2377: 
                   2378: function changeInputType(oldObject,newType) {
                   2379:     var newObject = document.createElement('input');
                   2380:     newObject.type = newType;
                   2381:     if (oldObject.size) {
                   2382:         newObject.size = oldObject.size;
                   2383:     }
                   2384:     if (oldObject.value) {
                   2385:         newObject.value = oldObject.value;
                   2386:     }
                   2387:     if (oldObject.name) {
                   2388:         newObject.name = oldObject.name;
                   2389:     }
                   2390:     if (oldObject.id) {
                   2391:         newObject.id = oldObject.id;
                   2392:     }
                   2393:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2394:     return;
                   2395: }
                   2396: 
                   2397: ENDJS
1.475     www      2398: }
                   2399: 
1.167     www      2400: sub gradeleveldescription {
                   2401:     my $gradelevel=shift;
                   2402:     my %gradelevels=(0 => 'Not specified',
                   2403: 		     1 => 'Grade 1',
                   2404: 		     2 => 'Grade 2',
                   2405: 		     3 => 'Grade 3',
                   2406: 		     4 => 'Grade 4',
                   2407: 		     5 => 'Grade 5',
                   2408: 		     6 => 'Grade 6',
                   2409: 		     7 => 'Grade 7',
                   2410: 		     8 => 'Grade 8',
                   2411: 		     9 => 'Grade 9',
                   2412: 		     10 => 'Grade 10',
                   2413: 		     11 => 'Grade 11',
                   2414: 		     12 => 'Grade 12',
                   2415: 		     13 => 'Grade 13',
                   2416: 		     14 => '100 Level',
                   2417: 		     15 => '200 Level',
                   2418: 		     16 => '300 Level',
                   2419: 		     17 => '400 Level',
                   2420: 		     18 => 'Graduate Level');
                   2421:     return &mt($gradelevels{$gradelevel});
                   2422: }
                   2423: 
1.163     www      2424: sub select_level_form {
                   2425:     my ($deflevel,$name)=@_;
                   2426:     unless ($deflevel) { $deflevel=0; }
1.167     www      2427:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2428:     for (my $i=0; $i<=18; $i++) {
                   2429:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2430:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2431:                 ">".&gradeleveldescription($i)."</option>\n";
                   2432:     }
                   2433:     $selectform.="</select>";
                   2434:     return $selectform;
1.163     www      2435: }
1.167     www      2436: 
1.35      matthew  2437: #-------------------------------------------
                   2438: 
1.45      matthew  2439: =pod
                   2440: 
1.1121    raeburn  2441: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms)
1.35      matthew  2442: 
                   2443: Returns a string containing a <select name='$name' size='1'> form to 
                   2444: allow a user to select the domain to preform an operation in.  
                   2445: See loncreateuser.pm for an example invocation and use.
                   2446: 
1.90      www      2447: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2448: selected");
                   2449: 
1.743     raeburn  2450: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2451: 
1.910     raeburn  2452: 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.
                   2453: 
1.1121    raeburn  2454: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2455: 
                   2456: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563     raeburn  2457: 
1.35      matthew  2458: =cut
                   2459: 
                   2460: #-------------------------------------------
1.34      matthew  2461: sub select_dom_form {
1.1121    raeburn  2462:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872     raeburn  2463:     if ($onchange) {
1.874     raeburn  2464:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2465:     }
1.1121    raeburn  2466:     my (@domains,%exclude);
1.910     raeburn  2467:     if (ref($incdoms) eq 'ARRAY') {
                   2468:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2469:     } else {
                   2470:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2471:     }
1.90      www      2472:     if ($includeempty) { @domains=('',@domains); }
1.1121    raeburn  2473:     if (ref($excdoms) eq 'ARRAY') {
                   2474:         map { $exclude{$_} = 1; } @{$excdoms}; 
                   2475:     }
1.743     raeburn  2476:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2477:     foreach my $dom (@domains) {
1.1121    raeburn  2478:         next if ($exclude{$dom});
1.356     albertel 2479:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2480:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2481:         if ($showdomdesc) {
                   2482:             if ($dom ne '') {
                   2483:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2484:                 if ($domdesc ne '') {
                   2485:                     $selectdomain .= ' ('.$domdesc.')';
                   2486:                 }
                   2487:             } 
                   2488:         }
                   2489:         $selectdomain .= "</option>\n";
1.34      matthew  2490:     }
                   2491:     $selectdomain.="</select>";
                   2492:     return $selectdomain;
                   2493: }
                   2494: 
1.35      matthew  2495: #-------------------------------------------
                   2496: 
1.45      matthew  2497: =pod
                   2498: 
1.648     raeburn  2499: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2500: 
1.586     raeburn  2501: input: 4 arguments (two required, two optional) - 
                   2502:     $domain - domain of new user
                   2503:     $name - name of form element
                   2504:     $default - Value of 'default' causes a default item to be first 
                   2505:                             option, and selected by default. 
                   2506:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2507:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2508: output: returns 2 items: 
1.586     raeburn  2509: (a) form element which contains either:
                   2510:    (i) <select name="$name">
                   2511:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2512:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2513:        </select>
                   2514:        form item if there are multiple library servers in $domain, or
                   2515:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2516:        if there is only one library server in $domain.
                   2517: 
                   2518: (b) number of library servers found.
                   2519: 
                   2520: See loncreateuser.pm for example of use.
1.35      matthew  2521: 
                   2522: =cut
                   2523: 
                   2524: #-------------------------------------------
1.586     raeburn  2525: sub home_server_form_item {
                   2526:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2527:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2528:     my $result;
                   2529:     my $numlib = keys(%servers);
                   2530:     if ($numlib > 1) {
                   2531:         $result .= '<select name="'.$name.'" />'."\n";
                   2532:         if ($default) {
1.804     bisitz   2533:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2534:                        '</option>'."\n";
                   2535:         }
                   2536:         foreach my $hostid (sort(keys(%servers))) {
                   2537:             $result.= '<option value="'.$hostid.'">'.
                   2538: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2539:         }
                   2540:         $result .= '</select>'."\n";
                   2541:     } elsif ($numlib == 1) {
                   2542:         my $hostid;
                   2543:         foreach my $item (keys(%servers)) {
                   2544:             $hostid = $item;
                   2545:         }
                   2546:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2547:                    $hostid.'" />';
                   2548:                    if (!$hide) {
                   2549:                        $result .= $hostid.' '.$servers{$hostid};
                   2550:                    }
                   2551:                    $result .= "\n";
                   2552:     } elsif ($default) {
                   2553:         $result .= '<input type="hidden" name="'.$name.
                   2554:                    '" value="default" />';
                   2555:                    if (!$hide) {
                   2556:                        $result .= &mt('default');
                   2557:                    }
                   2558:                    $result .= "\n";
1.33      matthew  2559:     }
1.586     raeburn  2560:     return ($result,$numlib);
1.33      matthew  2561: }
1.112     bowersj2 2562: 
                   2563: =pod
                   2564: 
1.534     albertel 2565: =back 
                   2566: 
1.112     bowersj2 2567: =cut
1.87      matthew  2568: 
                   2569: ###############################################################
1.112     bowersj2 2570: ##                  Decoding User Agent                      ##
1.87      matthew  2571: ###############################################################
                   2572: 
                   2573: =pod
                   2574: 
1.112     bowersj2 2575: =head1 Decoding the User Agent
                   2576: 
                   2577: =over 4
                   2578: 
                   2579: =item * &decode_user_agent()
1.87      matthew  2580: 
                   2581: Inputs: $r
                   2582: 
                   2583: Outputs:
                   2584: 
                   2585: =over 4
                   2586: 
1.112     bowersj2 2587: =item * $httpbrowser
1.87      matthew  2588: 
1.112     bowersj2 2589: =item * $clientbrowser
1.87      matthew  2590: 
1.112     bowersj2 2591: =item * $clientversion
1.87      matthew  2592: 
1.112     bowersj2 2593: =item * $clientmathml
1.87      matthew  2594: 
1.112     bowersj2 2595: =item * $clientunicode
1.87      matthew  2596: 
1.112     bowersj2 2597: =item * $clientos
1.87      matthew  2598: 
1.1137    raeburn  2599: =item * $clientmobile
                   2600: 
1.1141    raeburn  2601: =item * $clientinfo
                   2602: 
1.1194    raeburn  2603: =item * $clientosversion
                   2604: 
1.87      matthew  2605: =back
                   2606: 
1.157     matthew  2607: =back 
                   2608: 
1.87      matthew  2609: =cut
                   2610: 
                   2611: ###############################################################
                   2612: ###############################################################
                   2613: sub decode_user_agent {
1.247     albertel 2614:     my ($r)=@_;
1.87      matthew  2615:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2616:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2617:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2618:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2619:     my $clientbrowser='unknown';
                   2620:     my $clientversion='0';
                   2621:     my $clientmathml='';
                   2622:     my $clientunicode='0';
1.1137    raeburn  2623:     my $clientmobile=0;
1.1194    raeburn  2624:     my $clientosversion='';
1.87      matthew  2625:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1193    raeburn  2626:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2627: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2628: 	    $clientbrowser=$bname;
                   2629:             $httpbrowser=~/$vreg/i;
                   2630: 	    $clientversion=$1;
                   2631:             $clientmathml=($clientversion>=$minv);
                   2632:             $clientunicode=($clientversion>=$univ);
                   2633: 	}
                   2634:     }
                   2635:     my $clientos='unknown';
1.1141    raeburn  2636:     my $clientinfo;
1.87      matthew  2637:     if (($httpbrowser=~/linux/i) ||
                   2638:         ($httpbrowser=~/unix/i) ||
                   2639:         ($httpbrowser=~/ux/i) ||
                   2640:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2641:     if (($httpbrowser=~/vax/i) ||
                   2642:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2643:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2644:     if (($httpbrowser=~/mac/i) ||
                   2645:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194    raeburn  2646:     if ($httpbrowser=~/win/i) {
                   2647:         $clientos='win';
                   2648:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2649:             $clientosversion = $1;
                   2650:         }
                   2651:     }
1.87      matthew  2652:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137    raeburn  2653:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2654:         $clientmobile=lc($1);
                   2655:     }
1.1141    raeburn  2656:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2657:         $clientinfo = 'firefox-'.$1;
                   2658:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2659:         $clientinfo = 'chromeframe-'.$1;
                   2660:     }
1.87      matthew  2661:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194    raeburn  2662:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2663:             $clientosversion);
1.87      matthew  2664: }
                   2665: 
1.32      matthew  2666: ###############################################################
                   2667: ##    Authentication changing form generation subroutines    ##
                   2668: ###############################################################
                   2669: ##
                   2670: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2671: ## hash, and have reasonable default values.
                   2672: ##
                   2673: ##    formname = the name given in the <form> tag.
1.35      matthew  2674: #-------------------------------------------
                   2675: 
1.45      matthew  2676: =pod
                   2677: 
1.112     bowersj2 2678: =head1 Authentication Routines
                   2679: 
                   2680: =over 4
                   2681: 
1.648     raeburn  2682: =item * &authform_xxxxxx()
1.35      matthew  2683: 
                   2684: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2685: handle some of the conveniences required for authentication forms.  
                   2686: This is not an optimal method, but it works.  
                   2687: 
                   2688: =over 4
                   2689: 
1.112     bowersj2 2690: =item * authform_header
1.35      matthew  2691: 
1.112     bowersj2 2692: =item * authform_authorwarning
1.35      matthew  2693: 
1.112     bowersj2 2694: =item * authform_nochange
1.35      matthew  2695: 
1.112     bowersj2 2696: =item * authform_kerberos
1.35      matthew  2697: 
1.112     bowersj2 2698: =item * authform_internal
1.35      matthew  2699: 
1.112     bowersj2 2700: =item * authform_filesystem
1.35      matthew  2701: 
                   2702: =back
                   2703: 
1.648     raeburn  2704: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2705: 
1.35      matthew  2706: =cut
                   2707: 
                   2708: #-------------------------------------------
1.32      matthew  2709: sub authform_header{  
                   2710:     my %in = (
                   2711:         formname => 'cu',
1.80      albertel 2712:         kerb_def_dom => '',
1.32      matthew  2713:         @_,
                   2714:     );
                   2715:     $in{'formname'} = 'document.' . $in{'formname'};
                   2716:     my $result='';
1.80      albertel 2717: 
                   2718: #---------------------------------------------- Code for upper case translation
                   2719:     my $Javascript_toUpperCase;
                   2720:     unless ($in{kerb_def_dom}) {
                   2721:         $Javascript_toUpperCase =<<"END";
                   2722:         switch (choice) {
                   2723:            case 'krb': currentform.elements[choicearg].value =
                   2724:                currentform.elements[choicearg].value.toUpperCase();
                   2725:                break;
                   2726:            default:
                   2727:         }
                   2728: END
                   2729:     } else {
                   2730:         $Javascript_toUpperCase = "";
                   2731:     }
                   2732: 
1.165     raeburn  2733:     my $radioval = "'nochange'";
1.591     raeburn  2734:     if (defined($in{'curr_authtype'})) {
                   2735:         if ($in{'curr_authtype'} ne '') {
                   2736:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2737:         }
1.174     matthew  2738:     }
1.165     raeburn  2739:     my $argfield = 'null';
1.591     raeburn  2740:     if (defined($in{'mode'})) {
1.165     raeburn  2741:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2742:             if (defined($in{'curr_autharg'})) {
                   2743:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2744:                     $argfield = "'$in{'curr_autharg'}'";
                   2745:                 }
                   2746:             }
                   2747:         }
                   2748:     }
                   2749: 
1.32      matthew  2750:     $result.=<<"END";
                   2751: var current = new Object();
1.165     raeburn  2752: current.radiovalue = $radioval;
                   2753: current.argfield = $argfield;
1.32      matthew  2754: 
                   2755: function changed_radio(choice,currentform) {
                   2756:     var choicearg = choice + 'arg';
                   2757:     // If a radio button in changed, we need to change the argfield
                   2758:     if (current.radiovalue != choice) {
                   2759:         current.radiovalue = choice;
                   2760:         if (current.argfield != null) {
                   2761:             currentform.elements[current.argfield].value = '';
                   2762:         }
                   2763:         if (choice == 'nochange') {
                   2764:             current.argfield = null;
                   2765:         } else {
                   2766:             current.argfield = choicearg;
                   2767:             switch(choice) {
                   2768:                 case 'krb': 
                   2769:                     currentform.elements[current.argfield].value = 
                   2770:                         "$in{'kerb_def_dom'}";
                   2771:                 break;
                   2772:               default:
                   2773:                 break;
                   2774:             }
                   2775:         }
                   2776:     }
                   2777:     return;
                   2778: }
1.22      www      2779: 
1.32      matthew  2780: function changed_text(choice,currentform) {
                   2781:     var choicearg = choice + 'arg';
                   2782:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2783:         $Javascript_toUpperCase
1.32      matthew  2784:         // clear old field
                   2785:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2786:             currentform.elements[current.argfield].value = '';
                   2787:         }
                   2788:         current.argfield = choicearg;
                   2789:     }
                   2790:     set_auth_radio_buttons(choice,currentform);
                   2791:     return;
1.20      www      2792: }
1.32      matthew  2793: 
                   2794: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2795:     var numauthchoices = currentform.login.length;
                   2796:     if (typeof numauthchoices  == "undefined") {
                   2797:         return;
                   2798:     } 
1.32      matthew  2799:     var i=0;
1.986     raeburn  2800:     while (i < numauthchoices) {
1.32      matthew  2801:         if (currentform.login[i].value == newvalue) { break; }
                   2802:         i++;
                   2803:     }
1.986     raeburn  2804:     if (i == numauthchoices) {
1.32      matthew  2805:         return;
                   2806:     }
                   2807:     current.radiovalue = newvalue;
                   2808:     currentform.login[i].checked = true;
                   2809:     return;
                   2810: }
                   2811: END
                   2812:     return $result;
                   2813: }
                   2814: 
1.1106    raeburn  2815: sub authform_authorwarning {
1.32      matthew  2816:     my $result='';
1.144     matthew  2817:     $result='<i>'.
                   2818:         &mt('As a general rule, only authors or co-authors should be '.
                   2819:             'filesystem authenticated '.
                   2820:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2821:     return $result;
                   2822: }
                   2823: 
1.1106    raeburn  2824: sub authform_nochange {
1.32      matthew  2825:     my %in = (
                   2826:               formname => 'document.cu',
                   2827:               kerb_def_dom => 'MSU.EDU',
                   2828:               @_,
                   2829:           );
1.1106    raeburn  2830:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586     raeburn  2831:     my $result;
1.1104    raeburn  2832:     if (!$authnum) {
1.1105    raeburn  2833:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2834:     } else {
                   2835:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2836:                   '<input type="radio" name="login" value="nochange" '.
                   2837:                   'checked="checked" onclick="'.
1.281     albertel 2838:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2839: 	    '</label>';
1.586     raeburn  2840:     }
1.32      matthew  2841:     return $result;
                   2842: }
                   2843: 
1.591     raeburn  2844: sub authform_kerberos {
1.32      matthew  2845:     my %in = (
                   2846:               formname => 'document.cu',
                   2847:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2848:               kerb_def_auth => 'krb4',
1.32      matthew  2849:               @_,
                   2850:               );
1.586     raeburn  2851:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2852:         $autharg,$jscall);
1.1106    raeburn  2853:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2854:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2855:        $check5 = ' checked="checked"';
1.80      albertel 2856:     } else {
1.772     bisitz   2857:        $check4 = ' checked="checked"';
1.80      albertel 2858:     }
1.165     raeburn  2859:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2860:     if (defined($in{'curr_authtype'})) {
                   2861:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2862:             $krbcheck = ' checked="checked"';
1.623     raeburn  2863:             if (defined($in{'mode'})) {
                   2864:                 if ($in{'mode'} eq 'modifyuser') {
                   2865:                     $krbcheck = '';
                   2866:                 }
                   2867:             }
1.591     raeburn  2868:             if (defined($in{'curr_kerb_ver'})) {
                   2869:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2870:                     $check5 = ' checked="checked"';
1.591     raeburn  2871:                     $check4 = '';
                   2872:                 } else {
1.772     bisitz   2873:                     $check4 = ' checked="checked"';
1.591     raeburn  2874:                     $check5 = '';
                   2875:                 }
1.586     raeburn  2876:             }
1.591     raeburn  2877:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2878:                 $krbarg = $in{'curr_autharg'};
                   2879:             }
1.586     raeburn  2880:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2881:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2882:                     $result = 
                   2883:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2884:         $in{'curr_autharg'},$krbver);
                   2885:                 } else {
                   2886:                     $result =
                   2887:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2888:                 }
                   2889:                 return $result; 
                   2890:             }
                   2891:         }
                   2892:     } else {
                   2893:         if ($authnum == 1) {
1.784     bisitz   2894:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2895:         }
                   2896:     }
1.586     raeburn  2897:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2898:         return;
1.587     raeburn  2899:     } elsif ($authtype eq '') {
1.591     raeburn  2900:         if (defined($in{'mode'})) {
1.587     raeburn  2901:             if ($in{'mode'} eq 'modifycourse') {
                   2902:                 if ($authnum == 1) {
1.1104    raeburn  2903:                     $authtype = '<input type="radio" name="login" value="krb" />';
1.587     raeburn  2904:                 }
                   2905:             }
                   2906:         }
1.586     raeburn  2907:     }
                   2908:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2909:     if ($authtype eq '') {
                   2910:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2911:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2912:                     $krbcheck.' />';
                   2913:     }
                   2914:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106    raeburn  2915:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2916:          $in{'curr_authtype'} eq 'krb5') ||
1.1106    raeburn  2917:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2918:          $in{'curr_authtype'} eq 'krb4')) {
                   2919:         $result .= &mt
1.144     matthew  2920:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2921:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2922:          '<label>'.$authtype,
1.281     albertel 2923:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2924:              'value="'.$krbarg.'" '.
1.144     matthew  2925:              'onchange="'.$jscall.'" />',
1.281     albertel 2926:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2927:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2928: 	 '</label>');
1.586     raeburn  2929:     } elsif ($can_assign{'krb4'}) {
                   2930:         $result .= &mt
                   2931:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2932:          '[_3] Version 4 [_4]',
                   2933:          '<label>'.$authtype,
                   2934:          '</label><input type="text" size="10" name="krbarg" '.
                   2935:              'value="'.$krbarg.'" '.
                   2936:              'onchange="'.$jscall.'" />',
                   2937:          '<label><input type="hidden" name="krbver" value="4" />',
                   2938:          '</label>');
                   2939:     } elsif ($can_assign{'krb5'}) {
                   2940:         $result .= &mt
                   2941:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2942:          '[_3] Version 5 [_4]',
                   2943:          '<label>'.$authtype,
                   2944:          '</label><input type="text" size="10" name="krbarg" '.
                   2945:              'value="'.$krbarg.'" '.
                   2946:              'onchange="'.$jscall.'" />',
                   2947:          '<label><input type="hidden" name="krbver" value="5" />',
                   2948:          '</label>');
                   2949:     }
1.32      matthew  2950:     return $result;
                   2951: }
                   2952: 
1.1106    raeburn  2953: sub authform_internal {
1.586     raeburn  2954:     my %in = (
1.32      matthew  2955:                 formname => 'document.cu',
                   2956:                 kerb_def_dom => 'MSU.EDU',
                   2957:                 @_,
                   2958:                 );
1.586     raeburn  2959:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  2960:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  2961:     if (defined($in{'curr_authtype'})) {
                   2962:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2963:             if ($can_assign{'int'}) {
1.772     bisitz   2964:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2965:                 if (defined($in{'mode'})) {
                   2966:                     if ($in{'mode'} eq 'modifyuser') {
                   2967:                         $intcheck = '';
                   2968:                     }
                   2969:                 }
1.591     raeburn  2970:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2971:                     $intarg = $in{'curr_autharg'};
                   2972:                 }
                   2973:             } else {
                   2974:                 $result = &mt('Currently internally authenticated.');
                   2975:                 return $result;
1.165     raeburn  2976:             }
                   2977:         }
1.586     raeburn  2978:     } else {
                   2979:         if ($authnum == 1) {
1.784     bisitz   2980:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2981:         }
                   2982:     }
                   2983:     if (!$can_assign{'int'}) {
                   2984:         return;
1.587     raeburn  2985:     } elsif ($authtype eq '') {
1.591     raeburn  2986:         if (defined($in{'mode'})) {
1.587     raeburn  2987:             if ($in{'mode'} eq 'modifycourse') {
                   2988:                 if ($authnum == 1) {
1.1104    raeburn  2989:                     $authtype = '<input type="radio" name="login" value="int" />';
1.587     raeburn  2990:                 }
                   2991:             }
                   2992:         }
1.165     raeburn  2993:     }
1.586     raeburn  2994:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2995:     if ($authtype eq '') {
                   2996:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2997:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2998:     }
1.605     bisitz   2999:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  3000:                $intarg.'" onchange="'.$jscall.'" />';
                   3001:     $result = &mt
1.144     matthew  3002:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3003:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   3004:     $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  3005:     return $result;
                   3006: }
                   3007: 
1.1104    raeburn  3008: sub authform_local {
1.32      matthew  3009:     my %in = (
                   3010:               formname => 'document.cu',
                   3011:               kerb_def_dom => 'MSU.EDU',
                   3012:               @_,
                   3013:               );
1.586     raeburn  3014:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  3015:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  3016:     if (defined($in{'curr_authtype'})) {
                   3017:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3018:             if ($can_assign{'loc'}) {
1.772     bisitz   3019:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3020:                 if (defined($in{'mode'})) {
                   3021:                     if ($in{'mode'} eq 'modifyuser') {
                   3022:                         $loccheck = '';
                   3023:                     }
                   3024:                 }
1.591     raeburn  3025:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3026:                     $locarg = $in{'curr_autharg'};
                   3027:                 }
                   3028:             } else {
                   3029:                 $result = &mt('Currently using local (institutional) authentication.');
                   3030:                 return $result;
1.165     raeburn  3031:             }
                   3032:         }
1.586     raeburn  3033:     } else {
                   3034:         if ($authnum == 1) {
1.784     bisitz   3035:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3036:         }
                   3037:     }
                   3038:     if (!$can_assign{'loc'}) {
                   3039:         return;
1.587     raeburn  3040:     } elsif ($authtype eq '') {
1.591     raeburn  3041:         if (defined($in{'mode'})) {
1.587     raeburn  3042:             if ($in{'mode'} eq 'modifycourse') {
                   3043:                 if ($authnum == 1) {
1.1104    raeburn  3044:                     $authtype = '<input type="radio" name="login" value="loc" />';
1.587     raeburn  3045:                 }
                   3046:             }
                   3047:         }
1.165     raeburn  3048:     }
1.586     raeburn  3049:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3050:     if ($authtype eq '') {
                   3051:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3052:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   3053:                     $jscall.'" />';
                   3054:     }
                   3055:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   3056:                $locarg.'" onchange="'.$jscall.'" />';
                   3057:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3058:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3059:     return $result;
                   3060: }
                   3061: 
1.1106    raeburn  3062: sub authform_filesystem {
1.32      matthew  3063:     my %in = (
                   3064:               formname => 'document.cu',
                   3065:               kerb_def_dom => 'MSU.EDU',
                   3066:               @_,
                   3067:               );
1.586     raeburn  3068:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  3069:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  3070:     if (defined($in{'curr_authtype'})) {
                   3071:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3072:             if ($can_assign{'fsys'}) {
1.772     bisitz   3073:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3074:                 if (defined($in{'mode'})) {
                   3075:                     if ($in{'mode'} eq 'modifyuser') {
                   3076:                         $fsyscheck = '';
                   3077:                     }
                   3078:                 }
1.586     raeburn  3079:             } else {
                   3080:                 $result = &mt('Currently Filesystem Authenticated.');
                   3081:                 return $result;
                   3082:             }           
                   3083:         }
                   3084:     } else {
                   3085:         if ($authnum == 1) {
1.784     bisitz   3086:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3087:         }
                   3088:     }
                   3089:     if (!$can_assign{'fsys'}) {
                   3090:         return;
1.587     raeburn  3091:     } elsif ($authtype eq '') {
1.591     raeburn  3092:         if (defined($in{'mode'})) {
1.587     raeburn  3093:             if ($in{'mode'} eq 'modifycourse') {
                   3094:                 if ($authnum == 1) {
1.1104    raeburn  3095:                     $authtype = '<input type="radio" name="login" value="fsys" />';
1.587     raeburn  3096:                 }
                   3097:             }
                   3098:         }
1.586     raeburn  3099:     }
                   3100:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3101:     if ($authtype eq '') {
                   3102:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3103:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   3104:                     $jscall.'" />';
                   3105:     }
                   3106:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   3107:                ' onchange="'.$jscall.'" />';
                   3108:     $result = &mt
1.144     matthew  3109:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 3110:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  3111:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   3112:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  3113:                   'onchange="'.$jscall.'" />');
1.32      matthew  3114:     return $result;
                   3115: }
                   3116: 
1.586     raeburn  3117: sub get_assignable_auth {
                   3118:     my ($dom) = @_;
                   3119:     if ($dom eq '') {
                   3120:         $dom = $env{'request.role.domain'};
                   3121:     }
                   3122:     my %can_assign = (
                   3123:                           krb4 => 1,
                   3124:                           krb5 => 1,
                   3125:                           int  => 1,
                   3126:                           loc  => 1,
                   3127:                      );
                   3128:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3129:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3130:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3131:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3132:             my $context;
                   3133:             if ($env{'request.role'} =~ /^au/) {
                   3134:                 $context = 'author';
                   3135:             } elsif ($env{'request.role'} =~ /^dc/) {
                   3136:                 $context = 'domain';
                   3137:             } elsif ($env{'request.course.id'}) {
                   3138:                 $context = 'course';
                   3139:             }
                   3140:             if ($context) {
                   3141:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3142:                    %can_assign = %{$authhash->{$context}}; 
                   3143:                 }
                   3144:             }
                   3145:         }
                   3146:     }
                   3147:     my $authnum = 0;
                   3148:     foreach my $key (keys(%can_assign)) {
                   3149:         if ($can_assign{$key}) {
                   3150:             $authnum ++;
                   3151:         }
                   3152:     }
                   3153:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3154:         $authnum --;
                   3155:     }
                   3156:     return ($authnum,%can_assign);
                   3157: }
                   3158: 
1.80      albertel 3159: ###############################################################
                   3160: ##    Get Kerberos Defaults for Domain                 ##
                   3161: ###############################################################
                   3162: ##
                   3163: ## Returns default kerberos version and an associated argument
                   3164: ## as listed in file domain.tab. If not listed, provides
                   3165: ## appropriate default domain and kerberos version.
                   3166: ##
                   3167: #-------------------------------------------
                   3168: 
                   3169: =pod
                   3170: 
1.648     raeburn  3171: =item * &get_kerberos_defaults()
1.80      albertel 3172: 
                   3173: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3174: version and domain. If not found, it defaults to version 4 and the 
                   3175: domain of the server.
1.80      albertel 3176: 
1.648     raeburn  3177: =over 4
                   3178: 
1.80      albertel 3179: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3180: 
1.648     raeburn  3181: =back
                   3182: 
                   3183: =back
                   3184: 
1.80      albertel 3185: =cut
                   3186: 
                   3187: #-------------------------------------------
                   3188: sub get_kerberos_defaults {
                   3189:     my $domain=shift;
1.641     raeburn  3190:     my ($krbdef,$krbdefdom);
                   3191:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3192:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3193:         $krbdef = $domdefaults{'auth_def'};
                   3194:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3195:     } else {
1.80      albertel 3196:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3197:         my $krbdefdom=$1;
                   3198:         $krbdefdom=~tr/a-z/A-Z/;
                   3199:         $krbdef = "krb4";
                   3200:     }
                   3201:     return ($krbdef,$krbdefdom);
                   3202: }
1.112     bowersj2 3203: 
1.32      matthew  3204: 
1.46      matthew  3205: ###############################################################
                   3206: ##                Thesaurus Functions                        ##
                   3207: ###############################################################
1.20      www      3208: 
1.46      matthew  3209: =pod
1.20      www      3210: 
1.112     bowersj2 3211: =head1 Thesaurus Functions
                   3212: 
                   3213: =over 4
                   3214: 
1.648     raeburn  3215: =item * &initialize_keywords()
1.46      matthew  3216: 
                   3217: Initializes the package variable %Keywords if it is empty.  Uses the
                   3218: package variable $thesaurus_db_file.
                   3219: 
                   3220: =cut
                   3221: 
                   3222: ###################################################
                   3223: 
                   3224: sub initialize_keywords {
                   3225:     return 1 if (scalar keys(%Keywords));
                   3226:     # If we are here, %Keywords is empty, so fill it up
                   3227:     #   Make sure the file we need exists...
                   3228:     if (! -e $thesaurus_db_file) {
                   3229:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3230:                                  " failed because it does not exist");
                   3231:         return 0;
                   3232:     }
                   3233:     #   Set up the hash as a database
                   3234:     my %thesaurus_db;
                   3235:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3236:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3237:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3238:                                  $thesaurus_db_file);
                   3239:         return 0;
                   3240:     } 
                   3241:     #  Get the average number of appearances of a word.
                   3242:     my $avecount = $thesaurus_db{'average.count'};
                   3243:     #  Put keywords (those that appear > average) into %Keywords
                   3244:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3245:         my ($count,undef) = split /:/,$data;
                   3246:         $Keywords{$word}++ if ($count > $avecount);
                   3247:     }
                   3248:     untie %thesaurus_db;
                   3249:     # Remove special values from %Keywords.
1.356     albertel 3250:     foreach my $value ('total.count','average.count') {
                   3251:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3252:   }
1.46      matthew  3253:     return 1;
                   3254: }
                   3255: 
                   3256: ###################################################
                   3257: 
                   3258: =pod
                   3259: 
1.648     raeburn  3260: =item * &keyword($word)
1.46      matthew  3261: 
                   3262: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3263: than the average number of times in the thesaurus database.  Calls 
                   3264: &initialize_keywords
                   3265: 
                   3266: =cut
                   3267: 
                   3268: ###################################################
1.20      www      3269: 
                   3270: sub keyword {
1.46      matthew  3271:     return if (!&initialize_keywords());
                   3272:     my $word=lc(shift());
                   3273:     $word=~s/\W//g;
                   3274:     return exists($Keywords{$word});
1.20      www      3275: }
1.46      matthew  3276: 
                   3277: ###############################################################
                   3278: 
                   3279: =pod 
1.20      www      3280: 
1.648     raeburn  3281: =item * &get_related_words()
1.46      matthew  3282: 
1.160     matthew  3283: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3284: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3285: will be returned.  The order of the words returned is determined by the
                   3286: database which holds them.
                   3287: 
                   3288: Uses global $thesaurus_db_file.
                   3289: 
1.1057    foxr     3290: 
1.46      matthew  3291: =cut
                   3292: 
                   3293: ###############################################################
                   3294: sub get_related_words {
                   3295:     my $keyword = shift;
                   3296:     my %thesaurus_db;
                   3297:     if (! -e $thesaurus_db_file) {
                   3298:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3299:                                  "failed because the file does not exist");
                   3300:         return ();
                   3301:     }
                   3302:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3303:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3304:         return ();
                   3305:     } 
                   3306:     my @Words=();
1.429     www      3307:     my $count=0;
1.46      matthew  3308:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3309: 	# The first element is the number of times
                   3310: 	# the word appears.  We do not need it now.
1.429     www      3311: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3312: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3313: 	my $threshold=$mostfrequentcount/10;
                   3314:         foreach my $possibleword (@RelatedWords) {
                   3315:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3316:             if ($wordcount>$threshold) {
                   3317: 		push(@Words,$word);
                   3318:                 $count++;
                   3319:                 if ($count>10) { last; }
                   3320: 	    }
1.20      www      3321:         }
                   3322:     }
1.46      matthew  3323:     untie %thesaurus_db;
                   3324:     return @Words;
1.14      harris41 3325: }
1.1090    foxr     3326: ###############################################################
                   3327: #
                   3328: #  Spell checking
                   3329: #
                   3330: 
                   3331: =pod
                   3332: 
1.1142    raeburn  3333: =back
                   3334: 
1.1090    foxr     3335: =head1 Spell checking
                   3336: 
                   3337: =over 4
                   3338: 
                   3339: =item * &check_spelling($wordlist $language)
                   3340: 
                   3341: Takes a string containing words and feeds it to an external
                   3342: spellcheck program via a pipeline. Returns a string containing
                   3343: them mis-spelled words.
                   3344: 
                   3345: Parameters:
                   3346: 
                   3347: =over 4
                   3348: 
                   3349: =item - $wordlist
                   3350: 
                   3351: String that will be fed into the spellcheck program.
                   3352: 
                   3353: =item - $language
                   3354: 
                   3355: Language string that specifies the language for which the spell
                   3356: check will be performed.
                   3357: 
                   3358: =back
                   3359: 
                   3360: =back
                   3361: 
                   3362: Note: This sub assumes that aspell is installed.
                   3363: 
                   3364: 
                   3365: =cut
                   3366: 
1.46      matthew  3367: 
1.1090    foxr     3368: sub check_spelling {
                   3369:     my ($wordlist, $language) = @_;
1.1091    foxr     3370:     my @misspellings;
                   3371:     
                   3372:     # Generate the speller and set the langauge.
                   3373:     # if explicitly selected:
1.1090    foxr     3374: 
1.1091    foxr     3375:     my $speller = Text::Aspell->new;
1.1090    foxr     3376:     if ($language) {
1.1091    foxr     3377: 	$speller->set_option('lang', $language);
1.1090    foxr     3378:     }
                   3379: 
1.1091    foxr     3380:     # Turn the word list into an array of words by splittingon whitespace
1.1090    foxr     3381: 
1.1091    foxr     3382:     my @words = split(/\s+/, $wordlist);
1.1090    foxr     3383: 
1.1091    foxr     3384:     foreach my $word (@words) {
                   3385: 	if(! $speller->check($word)) {
                   3386: 	    push(@misspellings, $word);
1.1090    foxr     3387: 	}
                   3388:     }
1.1091    foxr     3389:     return join(' ', @misspellings);
                   3390:     
1.1090    foxr     3391: }
                   3392: 
1.61      www      3393: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3394: =pod
                   3395: 
1.112     bowersj2 3396: =head1 User Name Functions
                   3397: 
                   3398: =over 4
                   3399: 
1.648     raeburn  3400: =item * &plainname($uname,$udom,$first)
1.81      albertel 3401: 
1.112     bowersj2 3402: Takes a users logon name and returns it as a string in
1.226     albertel 3403: "first middle last generation" form 
                   3404: if $first is set to 'lastname' then it returns it as
                   3405: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3406: 
                   3407: =cut
1.61      www      3408: 
1.295     www      3409: 
1.81      albertel 3410: ###############################################################
1.61      www      3411: sub plainname {
1.226     albertel 3412:     my ($uname,$udom,$first)=@_;
1.537     albertel 3413:     return if (!defined($uname) || !defined($udom));
1.295     www      3414:     my %names=&getnames($uname,$udom);
1.226     albertel 3415:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3416: 					  $names{'middlename'},
                   3417: 					  $names{'lastname'},
                   3418: 					  $names{'generation'},$first);
                   3419:     $name=~s/^\s+//;
1.62      www      3420:     $name=~s/\s+$//;
                   3421:     $name=~s/\s+/ /g;
1.353     albertel 3422:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3423:     return $name;
1.61      www      3424: }
1.66      www      3425: 
                   3426: # -------------------------------------------------------------------- Nickname
1.81      albertel 3427: =pod
                   3428: 
1.648     raeburn  3429: =item * &nickname($uname,$udom)
1.81      albertel 3430: 
                   3431: Gets a users name and returns it as a string as
                   3432: 
                   3433: "&quot;nickname&quot;"
1.66      www      3434: 
1.81      albertel 3435: if the user has a nickname or
                   3436: 
                   3437: "first middle last generation"
                   3438: 
                   3439: if the user does not
                   3440: 
                   3441: =cut
1.66      www      3442: 
                   3443: sub nickname {
                   3444:     my ($uname,$udom)=@_;
1.537     albertel 3445:     return if (!defined($uname) || !defined($udom));
1.295     www      3446:     my %names=&getnames($uname,$udom);
1.68      albertel 3447:     my $name=$names{'nickname'};
1.66      www      3448:     if ($name) {
                   3449:        $name='&quot;'.$name.'&quot;'; 
                   3450:     } else {
                   3451:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3452: 	     $names{'lastname'}.' '.$names{'generation'};
                   3453:        $name=~s/\s+$//;
                   3454:        $name=~s/\s+/ /g;
                   3455:     }
                   3456:     return $name;
                   3457: }
                   3458: 
1.295     www      3459: sub getnames {
                   3460:     my ($uname,$udom)=@_;
1.537     albertel 3461:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3462:     if ($udom eq 'public' && $uname eq 'public') {
                   3463: 	return ('lastname' => &mt('Public'));
                   3464:     }
1.295     www      3465:     my $id=$uname.':'.$udom;
                   3466:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3467:     if ($cached) {
                   3468: 	return %{$names};
                   3469:     } else {
                   3470: 	my %loadnames=&Apache::lonnet::get('environment',
                   3471:                     ['firstname','middlename','lastname','generation','nickname'],
                   3472: 					 $udom,$uname);
                   3473: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3474: 	return %loadnames;
                   3475:     }
                   3476: }
1.61      www      3477: 
1.542     raeburn  3478: # -------------------------------------------------------------------- getemails
1.648     raeburn  3479: 
1.542     raeburn  3480: =pod
                   3481: 
1.648     raeburn  3482: =item * &getemails($uname,$udom)
1.542     raeburn  3483: 
                   3484: Gets a user's email information and returns it as a hash with keys:
                   3485: notification, critnotification, permanentemail
                   3486: 
                   3487: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3488: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3489:  
1.648     raeburn  3490: 
1.542     raeburn  3491: =cut
                   3492: 
1.648     raeburn  3493: 
1.466     albertel 3494: sub getemails {
                   3495:     my ($uname,$udom)=@_;
                   3496:     if ($udom eq 'public' && $uname eq 'public') {
                   3497: 	return;
                   3498:     }
1.467     www      3499:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3500:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3501:     my $id=$uname.':'.$udom;
                   3502:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3503:     if ($cached) {
                   3504: 	return %{$names};
                   3505:     } else {
                   3506: 	my %loadnames=&Apache::lonnet::get('environment',
                   3507:                     			   ['notification','critnotification',
                   3508: 					    'permanentemail'],
                   3509: 					   $udom,$uname);
                   3510: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3511: 	return %loadnames;
                   3512:     }
                   3513: }
                   3514: 
1.551     albertel 3515: sub flush_email_cache {
                   3516:     my ($uname,$udom)=@_;
                   3517:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3518:     if (!$uname) { $uname=$env{'user.name'};   }
                   3519:     return if ($udom eq 'public' && $uname eq 'public');
                   3520:     my $id=$uname.':'.$udom;
                   3521:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3522: }
                   3523: 
1.728     raeburn  3524: # -------------------------------------------------------------------- getlangs
                   3525: 
                   3526: =pod
                   3527: 
                   3528: =item * &getlangs($uname,$udom)
                   3529: 
                   3530: Gets a user's language preference and returns it as a hash with key:
                   3531: language.
                   3532: 
                   3533: =cut
                   3534: 
                   3535: 
                   3536: sub getlangs {
                   3537:     my ($uname,$udom) = @_;
                   3538:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3539:     if (!$uname) { $uname=$env{'user.name'};   }
                   3540:     my $id=$uname.':'.$udom;
                   3541:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3542:     if ($cached) {
                   3543:         return %{$langs};
                   3544:     } else {
                   3545:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3546:                                            $udom,$uname);
                   3547:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3548:         return %loadlangs;
                   3549:     }
                   3550: }
                   3551: 
                   3552: sub flush_langs_cache {
                   3553:     my ($uname,$udom)=@_;
                   3554:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3555:     if (!$uname) { $uname=$env{'user.name'};   }
                   3556:     return if ($udom eq 'public' && $uname eq 'public');
                   3557:     my $id=$uname.':'.$udom;
                   3558:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3559: }
                   3560: 
1.61      www      3561: # ------------------------------------------------------------------ Screenname
1.81      albertel 3562: 
                   3563: =pod
                   3564: 
1.648     raeburn  3565: =item * &screenname($uname,$udom)
1.81      albertel 3566: 
                   3567: Gets a users screenname and returns it as a string
                   3568: 
                   3569: =cut
1.61      www      3570: 
                   3571: sub screenname {
                   3572:     my ($uname,$udom)=@_;
1.258     albertel 3573:     if ($uname eq $env{'user.name'} &&
                   3574: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3575:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3576:     return $names{'screenname'};
1.62      www      3577: }
                   3578: 
1.212     albertel 3579: 
1.802     bisitz   3580: # ------------------------------------------------------------- Confirm Wrapper
                   3581: =pod
                   3582: 
1.1142    raeburn  3583: =item * &confirmwrapper($message)
1.802     bisitz   3584: 
                   3585: Wrap messages about completion of operation in box
                   3586: 
                   3587: =cut
                   3588: 
                   3589: sub confirmwrapper {
                   3590:     my ($message)=@_;
                   3591:     if ($message) {
                   3592:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3593:                .$message."\n"
                   3594:                .'</div>'."\n";
                   3595:     } else {
                   3596:         return $message;
                   3597:     }
                   3598: }
                   3599: 
1.62      www      3600: # ------------------------------------------------------------- Message Wrapper
                   3601: 
                   3602: sub messagewrapper {
1.369     www      3603:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3604:     return 
1.441     albertel 3605:         '<a href="/adm/email?compose=individual&amp;'.
                   3606:         'recname='.$username.'&amp;recdom='.$domain.
                   3607: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3608:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3609: }
1.802     bisitz   3610: 
1.74      www      3611: # --------------------------------------------------------------- Notes Wrapper
                   3612: 
                   3613: sub noteswrapper {
                   3614:     my ($link,$un,$do)=@_;
                   3615:     return 
1.896     amueller 3616: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3617: }
1.802     bisitz   3618: 
1.62      www      3619: # ------------------------------------------------------------- Aboutme Wrapper
                   3620: 
                   3621: sub aboutmewrapper {
1.1070    raeburn  3622:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3623:     if (!defined($username)  && !defined($domain)) {
                   3624:         return;
                   3625:     }
1.1096    raeburn  3626:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3627: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3628: }
                   3629: 
                   3630: # ------------------------------------------------------------ Syllabus Wrapper
                   3631: 
                   3632: sub syllabuswrapper {
1.707     bisitz   3633:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3634:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3635: }
1.14      harris41 3636: 
1.802     bisitz   3637: # -----------------------------------------------------------------------------
                   3638: 
1.208     matthew  3639: sub track_student_link {
1.887     raeburn  3640:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3641:     my $link ="/adm/trackstudent?";
1.208     matthew  3642:     my $title = 'View recent activity';
                   3643:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3644:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3645:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3646:         $title .= ' of this student';
1.268     albertel 3647:     } 
1.208     matthew  3648:     if (defined($target) && $target !~ /^\s*$/) {
                   3649:         $target = qq{target="$target"};
                   3650:     } else {
                   3651:         $target = '';
                   3652:     }
1.268     albertel 3653:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3654:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3655:     $title = &mt($title);
                   3656:     $linktext = &mt($linktext);
1.448     albertel 3657:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3658: 	&help_open_topic('View_recent_activity');
1.208     matthew  3659: }
                   3660: 
1.781     raeburn  3661: sub slot_reservations_link {
                   3662:     my ($linktext,$sname,$sdom,$target) = @_;
                   3663:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3664:     my $title = 'View slot reservation history';
                   3665:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3666:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3667:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3668:         $title .= ' of this student';
                   3669:     }
                   3670:     if (defined($target) && $target !~ /^\s*$/) {
                   3671:         $target = qq{target="$target"};
                   3672:     } else {
                   3673:         $target = '';
                   3674:     }
                   3675:     $title = &mt($title);
                   3676:     $linktext = &mt($linktext);
                   3677:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3678: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3679: 
                   3680: }
                   3681: 
1.508     www      3682: # ===================================================== Display a student photo
                   3683: 
                   3684: 
1.509     albertel 3685: sub student_image_tag {
1.508     www      3686:     my ($domain,$user)=@_;
                   3687:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3688:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3689: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3690:     } else {
                   3691: 	return '';
                   3692:     }
                   3693: }
                   3694: 
1.112     bowersj2 3695: =pod
                   3696: 
                   3697: =back
                   3698: 
                   3699: =head1 Access .tab File Data
                   3700: 
                   3701: =over 4
                   3702: 
1.648     raeburn  3703: =item * &languageids() 
1.112     bowersj2 3704: 
                   3705: returns list of all language ids
                   3706: 
                   3707: =cut
                   3708: 
1.14      harris41 3709: sub languageids {
1.16      harris41 3710:     return sort(keys(%language));
1.14      harris41 3711: }
                   3712: 
1.112     bowersj2 3713: =pod
                   3714: 
1.648     raeburn  3715: =item * &languagedescription() 
1.112     bowersj2 3716: 
                   3717: returns description of a specified language id
                   3718: 
                   3719: =cut
                   3720: 
1.14      harris41 3721: sub languagedescription {
1.125     www      3722:     my $code=shift;
                   3723:     return  ($supported_language{$code}?'* ':'').
                   3724:             $language{$code}.
1.126     www      3725: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3726: }
                   3727: 
1.1048    foxr     3728: =pod
                   3729: 
                   3730: =item * &plainlanguagedescription
                   3731: 
                   3732: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3733: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3734: 
                   3735: =cut
                   3736: 
1.145     www      3737: sub plainlanguagedescription {
                   3738:     my $code=shift;
                   3739:     return $language{$code};
                   3740: }
                   3741: 
1.1048    foxr     3742: =pod
                   3743: 
                   3744: =item * &supportedlanguagecode
                   3745: 
                   3746: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3747: code.
                   3748: 
                   3749: =cut
                   3750: 
1.145     www      3751: sub supportedlanguagecode {
                   3752:     my $code=shift;
                   3753:     return $supported_language{$code};
1.97      www      3754: }
                   3755: 
1.112     bowersj2 3756: =pod
                   3757: 
1.1048    foxr     3758: =item * &latexlanguage()
                   3759: 
                   3760: Given a language key code returns the correspondnig language to use
                   3761: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3762: is no supported hyphenation for the language code.
                   3763: 
                   3764: =cut
                   3765: 
                   3766: sub latexlanguage {
                   3767:     my $code = shift;
                   3768:     return $latex_language{$code};
                   3769: }
                   3770: 
                   3771: =pod
                   3772: 
                   3773: =item * &latexhyphenation()
                   3774: 
                   3775: Same as above but what's supplied is the language as it might be stored
                   3776: in the metadata.
                   3777: 
                   3778: =cut
                   3779: 
                   3780: sub latexhyphenation {
                   3781:     my $key = shift;
                   3782:     return $latex_language_bykey{$key};
                   3783: }
                   3784: 
                   3785: =pod
                   3786: 
1.648     raeburn  3787: =item * &copyrightids() 
1.112     bowersj2 3788: 
                   3789: returns list of all copyrights
                   3790: 
                   3791: =cut
                   3792: 
                   3793: sub copyrightids {
                   3794:     return sort(keys(%cprtag));
                   3795: }
                   3796: 
                   3797: =pod
                   3798: 
1.648     raeburn  3799: =item * &copyrightdescription() 
1.112     bowersj2 3800: 
                   3801: returns description of a specified copyright id
                   3802: 
                   3803: =cut
                   3804: 
                   3805: sub copyrightdescription {
1.166     www      3806:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3807: }
1.197     matthew  3808: 
                   3809: =pod
                   3810: 
1.648     raeburn  3811: =item * &source_copyrightids() 
1.192     taceyjo1 3812: 
                   3813: returns list of all source copyrights
                   3814: 
                   3815: =cut
                   3816: 
                   3817: sub source_copyrightids {
                   3818:     return sort(keys(%scprtag));
                   3819: }
                   3820: 
                   3821: =pod
                   3822: 
1.648     raeburn  3823: =item * &source_copyrightdescription() 
1.192     taceyjo1 3824: 
                   3825: returns description of a specified source copyright id
                   3826: 
                   3827: =cut
                   3828: 
                   3829: sub source_copyrightdescription {
                   3830:     return &mt($scprtag{shift(@_)});
                   3831: }
1.112     bowersj2 3832: 
                   3833: =pod
                   3834: 
1.648     raeburn  3835: =item * &filecategories() 
1.112     bowersj2 3836: 
                   3837: returns list of all file categories
                   3838: 
                   3839: =cut
                   3840: 
                   3841: sub filecategories {
                   3842:     return sort(keys(%category_extensions));
                   3843: }
                   3844: 
                   3845: =pod
                   3846: 
1.648     raeburn  3847: =item * &filecategorytypes() 
1.112     bowersj2 3848: 
                   3849: returns list of file types belonging to a given file
                   3850: category
                   3851: 
                   3852: =cut
                   3853: 
                   3854: sub filecategorytypes {
1.356     albertel 3855:     my ($cat) = @_;
                   3856:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3857: }
                   3858: 
                   3859: =pod
                   3860: 
1.648     raeburn  3861: =item * &fileembstyle() 
1.112     bowersj2 3862: 
                   3863: returns embedding style for a specified file type
                   3864: 
                   3865: =cut
                   3866: 
                   3867: sub fileembstyle {
                   3868:     return $fe{lc(shift(@_))};
1.169     www      3869: }
                   3870: 
1.351     www      3871: sub filemimetype {
                   3872:     return $fm{lc(shift(@_))};
                   3873: }
                   3874: 
1.169     www      3875: 
                   3876: sub filecategoryselect {
                   3877:     my ($name,$value)=@_;
1.189     matthew  3878:     return &select_form($value,$name,
1.970     raeburn  3879:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3880: }
                   3881: 
                   3882: =pod
                   3883: 
1.648     raeburn  3884: =item * &filedescription() 
1.112     bowersj2 3885: 
                   3886: returns description for a specified file type
                   3887: 
                   3888: =cut
                   3889: 
                   3890: sub filedescription {
1.188     matthew  3891:     my $file_description = $fd{lc(shift())};
                   3892:     $file_description =~ s:([\[\]]):~$1:g;
                   3893:     return &mt($file_description);
1.112     bowersj2 3894: }
                   3895: 
                   3896: =pod
                   3897: 
1.648     raeburn  3898: =item * &filedescriptionex() 
1.112     bowersj2 3899: 
                   3900: returns description for a specified file type with
                   3901: extra formatting
                   3902: 
                   3903: =cut
                   3904: 
                   3905: sub filedescriptionex {
                   3906:     my $ex=shift;
1.188     matthew  3907:     my $file_description = $fd{lc($ex)};
                   3908:     $file_description =~ s:([\[\]]):~$1:g;
                   3909:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3910: }
                   3911: 
                   3912: # End of .tab access
                   3913: =pod
                   3914: 
                   3915: =back
                   3916: 
                   3917: =cut
                   3918: 
                   3919: # ------------------------------------------------------------------ File Types
                   3920: sub fileextensions {
                   3921:     return sort(keys(%fe));
                   3922: }
                   3923: 
1.97      www      3924: # ----------------------------------------------------------- Display Languages
                   3925: # returns a hash with all desired display languages
                   3926: #
                   3927: 
                   3928: sub display_languages {
                   3929:     my %languages=();
1.695     raeburn  3930:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3931: 	$languages{$lang}=1;
1.97      www      3932:     }
                   3933:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3934:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3935: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3936: 	    $languages{$lang}=1;
1.97      www      3937:         }
                   3938:     }
                   3939:     return %languages;
1.14      harris41 3940: }
                   3941: 
1.582     albertel 3942: sub languages {
                   3943:     my ($possible_langs) = @_;
1.695     raeburn  3944:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3945:     if (!ref($possible_langs)) {
                   3946: 	if( wantarray ) {
                   3947: 	    return @preferred_langs;
                   3948: 	} else {
                   3949: 	    return $preferred_langs[0];
                   3950: 	}
                   3951:     }
                   3952:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3953:     my @preferred_possibilities;
                   3954:     foreach my $preferred_lang (@preferred_langs) {
                   3955: 	if (exists($possibilities{$preferred_lang})) {
                   3956: 	    push(@preferred_possibilities, $preferred_lang);
                   3957: 	}
                   3958:     }
                   3959:     if( wantarray ) {
                   3960: 	return @preferred_possibilities;
                   3961:     }
                   3962:     return $preferred_possibilities[0];
                   3963: }
                   3964: 
1.742     raeburn  3965: sub user_lang {
                   3966:     my ($touname,$toudom,$fromcid) = @_;
                   3967:     my @userlangs;
                   3968:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3969:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3970:                     $env{'course.'.$fromcid.'.languages'}));
                   3971:     } else {
                   3972:         my %langhash = &getlangs($touname,$toudom);
                   3973:         if ($langhash{'languages'} ne '') {
                   3974:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3975:         } else {
                   3976:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3977:             if ($domdefs{'lang_def'} ne '') {
                   3978:                 @userlangs = ($domdefs{'lang_def'});
                   3979:             }
                   3980:         }
                   3981:     }
                   3982:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3983:     my $user_lh = Apache::localize->get_handle(@languages);
                   3984:     return $user_lh;
                   3985: }
                   3986: 
                   3987: 
1.112     bowersj2 3988: ###############################################################
                   3989: ##               Student Answer Attempts                     ##
                   3990: ###############################################################
                   3991: 
                   3992: =pod
                   3993: 
                   3994: =head1 Alternate Problem Views
                   3995: 
                   3996: =over 4
                   3997: 
1.648     raeburn  3998: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199    raeburn  3999:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4000: 
                   4001: Return string with previous attempt on problem. Arguments:
                   4002: 
                   4003: =over 4
                   4004: 
                   4005: =item * $symb: Problem, including path
                   4006: 
                   4007: =item * $username: username of the desired student
                   4008: 
                   4009: =item * $domain: domain of the desired student
1.14      harris41 4010: 
1.112     bowersj2 4011: =item * $course: Course ID
1.14      harris41 4012: 
1.112     bowersj2 4013: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4014:     something
1.14      harris41 4015: 
1.112     bowersj2 4016: =item * $regexp: if string matches this regexp, the string will be
                   4017:     sent to $gradesub
1.14      harris41 4018: 
1.112     bowersj2 4019: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4020: 
1.1199    raeburn  4021: =item * $usec: section of the desired student
                   4022: 
                   4023: =item * $identifier: counter for student (multiple students one problem) or 
                   4024:     problem (one student; whole sequence).
                   4025: 
1.112     bowersj2 4026: =back
1.14      harris41 4027: 
1.112     bowersj2 4028: The output string is a table containing all desired attempts, if any.
1.16      harris41 4029: 
1.112     bowersj2 4030: =cut
1.1       albertel 4031: 
                   4032: sub get_previous_attempt {
1.1199    raeburn  4033:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4034:   my $prevattempts='';
1.43      ng       4035:   no strict 'refs';
1.1       albertel 4036:   if ($symb) {
1.3       albertel 4037:     my (%returnhash)=
                   4038:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4039:     if ($returnhash{'version'}) {
                   4040:       my %lasthash=();
                   4041:       my $version;
                   4042:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 4043:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   4044: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 4045:         }
1.1       albertel 4046:       }
1.596     albertel 4047:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4048:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1199    raeburn  4049:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4050:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4051:       foreach my $key (sort(keys(%lasthash))) {
                   4052: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4053: 	if ($#parts > 0) {
1.31      albertel 4054: 	  my $data=$parts[-1];
1.989     raeburn  4055:           next if ($data eq 'foilorder');
1.31      albertel 4056: 	  pop(@parts);
1.1010    www      4057:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4058:           if ($data eq 'type') {
                   4059:               unless ($showsurv) {
                   4060:                   my $id = join(',',@parts);
                   4061:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4062:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4063:                       $lasthidden{$ign.'.'.$id} = 1;
                   4064:                   }
1.945     raeburn  4065:               }
1.1199    raeburn  4066:               if ($identifier ne '') {
                   4067:                   my $id = join(',',@parts);
                   4068:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4069:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4070:                       $hidestatus{$ign.'.'.$id} = 1;
                   4071:                   }
                   4072:               }
                   4073:           } elsif ($data eq 'regrader') {
                   4074:               if (($identifier ne '') && (@parts)) {
1.1200    raeburn  4075:                   my $id = join(',',@parts);
                   4076:                   $regraded{$ign.'.'.$id} = 1;
1.1199    raeburn  4077:               }
1.1010    www      4078:           } 
1.31      albertel 4079: 	} else {
1.41      ng       4080: 	  if ($#parts == 0) {
                   4081: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4082: 	  } else {
                   4083: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4084: 	  }
1.31      albertel 4085: 	}
1.16      harris41 4086:       }
1.596     albertel 4087:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4088:       if ($getattempt eq '') {
1.1199    raeburn  4089:         my (%solved,%resets,%probstatus);
1.1200    raeburn  4090:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4091:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4092:                 foreach my $id (keys(%regraded)) {
                   4093:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4094:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4095:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4096:                         push(@{$resets{$id}},$version);
1.1199    raeburn  4097:                     }
                   4098:                 }
                   4099:             }
1.1200    raeburn  4100:         }
                   4101: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199    raeburn  4102:             my (@hidden,@unsolved);
1.945     raeburn  4103:             if (%typeparts) {
                   4104:                 foreach my $id (keys(%typeparts)) {
1.1199    raeburn  4105:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || 
                   4106:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4107:                         push(@hidden,$id);
1.1199    raeburn  4108:                     } elsif ($identifier ne '') {
                   4109:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4110:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4111:                                 ($hidestatus{$id})) {
1.1200    raeburn  4112:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199    raeburn  4113:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4114:                                 push(@{$solved{$id}},$version);
                   4115:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4116:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4117:                                 my $skip;
                   4118:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4119:                                     foreach my $reset (@{$resets{$id}}) {
                   4120:                                         if ($reset > $solved{$id}[-1]) {
                   4121:                                             $skip=1;
                   4122:                                             last;
                   4123:                                         }
                   4124:                                     }
                   4125:                                 }
                   4126:                                 unless ($skip) {
                   4127:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4128:                                     push(@unsolved,$partslist);
                   4129:                                 }
                   4130:                             }
                   4131:                         }
1.945     raeburn  4132:                     }
                   4133:                 }
                   4134:             }
                   4135:             $prevattempts.=&start_data_table_row().
1.1199    raeburn  4136:                            '<td>'.&mt('Transaction [_1]',$version);
                   4137:             if (@unsolved) {
                   4138:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4139:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4140:                                  &mt('Hide').'</label></span>';
                   4141:             }
                   4142:             $prevattempts .= '</td>';
1.945     raeburn  4143:             if (@hidden) {
                   4144:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4145:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4146:                     my $hide;
                   4147:                     foreach my $id (@hidden) {
                   4148:                         if ($key =~ /^\Q$id\E/) {
                   4149:                             $hide = 1;
                   4150:                             last;
                   4151:                         }
                   4152:                     }
                   4153:                     if ($hide) {
                   4154:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4155:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4156:                             my $value = &format_previous_attempt_value($key,
                   4157:                                              $returnhash{$version.':'.$key});
1.1173    kruse    4158:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  4159:                         } else {
                   4160:                             $prevattempts.='<td>&nbsp;</td>';
                   4161:                         }
                   4162:                     } else {
                   4163:                         if ($key =~ /\./) {
                   4164:                             my $value = &format_previous_attempt_value($key,
                   4165:                                               $returnhash{$version.':'.$key});
1.1173    kruse    4166:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  4167:                         } else {
                   4168:                             $prevattempts.='<td>&nbsp;</td>';
                   4169:                         }
                   4170:                     }
                   4171:                 }
                   4172:             } else {
                   4173: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4174:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4175: 		    my $value = &format_previous_attempt_value($key,
                   4176: 			            $returnhash{$version.':'.$key});
1.1173    kruse    4177: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  4178: 	        }
                   4179:             }
                   4180: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4181: 	 }
1.1       albertel 4182:       }
1.945     raeburn  4183:       my @currhidden = keys(%lasthidden);
1.596     albertel 4184:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4185:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4186:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4187:           if (%typeparts) {
                   4188:               my $hidden;
                   4189:               foreach my $id (@currhidden) {
                   4190:                   if ($key =~ /^\Q$id\E/) {
                   4191:                       $hidden = 1;
                   4192:                       last;
                   4193:                   }
                   4194:               }
                   4195:               if ($hidden) {
                   4196:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4197:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4198:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4199:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4200:                           $value = &$gradesub($value);
                   4201:                       }
1.1173    kruse    4202:                       $prevattempts.='<td>'. $value.'&nbsp;</td>';
1.945     raeburn  4203:                   } else {
                   4204:                       $prevattempts.='<td>&nbsp;</td>';
                   4205:                   }
                   4206:               } else {
                   4207:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4208:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4209:                       $value = &$gradesub($value);
                   4210:                   }
1.1173    kruse    4211:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  4212:               }
                   4213:           } else {
                   4214: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4215: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4216:                   $value = &$gradesub($value);
                   4217:               }
1.1173    kruse    4218: 	     $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  4219:           }
1.16      harris41 4220:       }
1.596     albertel 4221:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4222:     } else {
1.596     albertel 4223:       $prevattempts=
                   4224: 	  &start_data_table().&start_data_table_row().
                   4225: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4226: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4227:     }
                   4228:   } else {
1.596     albertel 4229:     $prevattempts=
                   4230: 	  &start_data_table().&start_data_table_row().
                   4231: 	  '<td>'.&mt('No data.').'</td>'.
                   4232: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4233:   }
1.10      albertel 4234: }
                   4235: 
1.581     albertel 4236: sub format_previous_attempt_value {
                   4237:     my ($key,$value) = @_;
1.1011    www      4238:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173    kruse    4239:         $value = &Apache::lonlocal::locallocaltime($value);
1.581     albertel 4240:     } elsif (ref($value) eq 'ARRAY') {
1.1173    kruse    4241:         $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988     raeburn  4242:     } elsif ($key =~ /answerstring$/) {
                   4243:         my %answers = &Apache::lonnet::str2hash($value);
1.1173    kruse    4244:         my @answer = %answers;
                   4245:         %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988     raeburn  4246:         my @anskeys = sort(keys(%answers));
                   4247:         if (@anskeys == 1) {
                   4248:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4249:             if ($answer =~ m{\0}) {
                   4250:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4251:             }
                   4252:             my $tag_internal_answer_name = 'INTERNAL';
                   4253:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4254:                 $value = $answer; 
                   4255:             } else {
                   4256:                 $value = $anskeys[0].'='.$answer;
                   4257:             }
                   4258:         } else {
                   4259:             foreach my $ans (@anskeys) {
                   4260:                 my $answer = $answers{$ans};
1.1001    raeburn  4261:                 if ($answer =~ m{\0}) {
                   4262:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4263:                 }
                   4264:                 $value .=  $ans.'='.$answer.'<br />';;
                   4265:             } 
                   4266:         }
1.581     albertel 4267:     } else {
1.1173    kruse    4268:         $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581     albertel 4269:     }
                   4270:     return $value;
                   4271: }
                   4272: 
                   4273: 
1.107     albertel 4274: sub relative_to_absolute {
                   4275:     my ($url,$output)=@_;
                   4276:     my $parser=HTML::TokeParser->new(\$output);
                   4277:     my $token;
                   4278:     my $thisdir=$url;
                   4279:     my @rlinks=();
                   4280:     while ($token=$parser->get_token) {
                   4281: 	if ($token->[0] eq 'S') {
                   4282: 	    if ($token->[1] eq 'a') {
                   4283: 		if ($token->[2]->{'href'}) {
                   4284: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4285: 		}
                   4286: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4287: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4288: 	    } elsif ($token->[1] eq 'base') {
                   4289: 		$thisdir=$token->[2]->{'href'};
                   4290: 	    }
                   4291: 	}
                   4292:     }
                   4293:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4294:     foreach my $link (@rlinks) {
1.726     raeburn  4295: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4296: 		($link=~/^\//) ||
                   4297: 		($link=~/^javascript:/i) ||
                   4298: 		($link=~/^mailto:/i) ||
                   4299: 		($link=~/^\#/)) {
                   4300: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4301: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4302: 	}
                   4303:     }
                   4304: # -------------------------------------------------- Deal with Applet codebases
                   4305:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4306:     return $output;
                   4307: }
                   4308: 
1.112     bowersj2 4309: =pod
                   4310: 
1.648     raeburn  4311: =item * &get_student_view()
1.112     bowersj2 4312: 
                   4313: show a snapshot of what student was looking at
                   4314: 
                   4315: =cut
                   4316: 
1.10      albertel 4317: sub get_student_view {
1.186     albertel 4318:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4319:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4320:   my (%form);
1.10      albertel 4321:   my @elements=('symb','courseid','domain','username');
                   4322:   foreach my $element (@elements) {
1.186     albertel 4323:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4324:   }
1.186     albertel 4325:   if (defined($moreenv)) {
                   4326:       %form=(%form,%{$moreenv});
                   4327:   }
1.236     albertel 4328:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4329:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4330:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4331:   $userview=~s/\<body[^\>]*\>//gi;
                   4332:   $userview=~s/\<\/body\>//gi;
                   4333:   $userview=~s/\<html\>//gi;
                   4334:   $userview=~s/\<\/html\>//gi;
                   4335:   $userview=~s/\<head\>//gi;
                   4336:   $userview=~s/\<\/head\>//gi;
                   4337:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4338:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4339:   if (wantarray) {
                   4340:      return ($userview,$response);
                   4341:   } else {
                   4342:      return $userview;
                   4343:   }
                   4344: }
                   4345: 
                   4346: sub get_student_view_with_retries {
                   4347:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4348: 
                   4349:     my $ok = 0;                 # True if we got a good response.
                   4350:     my $content;
                   4351:     my $response;
                   4352: 
                   4353:     # Try to get the student_view done. within the retries count:
                   4354:     
                   4355:     do {
                   4356:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4357:          $ok      = $response->is_success;
                   4358:          if (!$ok) {
                   4359:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4360:          }
                   4361:          $retries--;
                   4362:     } while (!$ok && ($retries > 0));
                   4363:     
                   4364:     if (!$ok) {
                   4365:        $content = '';          # On error return an empty content.
                   4366:     }
1.651     www      4367:     if (wantarray) {
                   4368:        return ($content, $response);
                   4369:     } else {
                   4370:        return $content;
                   4371:     }
1.11      albertel 4372: }
                   4373: 
1.112     bowersj2 4374: =pod
                   4375: 
1.648     raeburn  4376: =item * &get_student_answers() 
1.112     bowersj2 4377: 
                   4378: show a snapshot of how student was answering problem
                   4379: 
                   4380: =cut
                   4381: 
1.11      albertel 4382: sub get_student_answers {
1.100     sakharuk 4383:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4384:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4385:   my (%moreenv);
1.11      albertel 4386:   my @elements=('symb','courseid','domain','username');
                   4387:   foreach my $element (@elements) {
1.186     albertel 4388:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4389:   }
1.186     albertel 4390:   $moreenv{'grade_target'}='answer';
                   4391:   %moreenv=(%form,%moreenv);
1.497     raeburn  4392:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4393:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4394:   return $userview;
1.1       albertel 4395: }
1.116     albertel 4396: 
                   4397: =pod
                   4398: 
                   4399: =item * &submlink()
                   4400: 
1.242     albertel 4401: Inputs: $text $uname $udom $symb $target
1.116     albertel 4402: 
                   4403: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4404: 
                   4405: =cut
                   4406: 
                   4407: ###############################################
                   4408: sub submlink {
1.242     albertel 4409:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4410:     if (!($uname && $udom)) {
                   4411: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4412: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4413: 	if (!$symb) { $symb=$cursymb; }
                   4414:     }
1.254     matthew  4415:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4416:     $symb=&escape($symb);
1.960     bisitz   4417:     if ($target) { $target=" target=\"$target\""; }
                   4418:     return
                   4419:         '<a href="/adm/grades?command=submission'.
                   4420:         '&amp;symb='.$symb.
                   4421:         '&amp;student='.$uname.
                   4422:         '&amp;userdom='.$udom.'"'.
                   4423:         $target.'>'.$text.'</a>';
1.242     albertel 4424: }
                   4425: ##############################################
                   4426: 
                   4427: =pod
                   4428: 
                   4429: =item * &pgrdlink()
                   4430: 
                   4431: Inputs: $text $uname $udom $symb $target
                   4432: 
                   4433: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4434: 
                   4435: =cut
                   4436: 
                   4437: ###############################################
                   4438: sub pgrdlink {
                   4439:     my $link=&submlink(@_);
                   4440:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4441:     return $link;
                   4442: }
                   4443: ##############################################
                   4444: 
                   4445: =pod
                   4446: 
                   4447: =item * &pprmlink()
                   4448: 
                   4449: Inputs: $text $uname $udom $symb $target
                   4450: 
                   4451: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4452: student and a specific resource
1.242     albertel 4453: 
                   4454: =cut
                   4455: 
                   4456: ###############################################
                   4457: sub pprmlink {
                   4458:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4459:     if (!($uname && $udom)) {
                   4460: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4461: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4462: 	if (!$symb) { $symb=$cursymb; }
                   4463:     }
1.254     matthew  4464:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4465:     $symb=&escape($symb);
1.242     albertel 4466:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4467:     return '<a href="/adm/parmset?command=set&amp;'.
                   4468: 	'symb='.$symb.'&amp;uname='.$uname.
                   4469: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4470: }
                   4471: ##############################################
1.37      matthew  4472: 
1.112     bowersj2 4473: =pod
                   4474: 
                   4475: =back
                   4476: 
                   4477: =cut
                   4478: 
1.37      matthew  4479: ###############################################
1.51      www      4480: 
                   4481: 
                   4482: sub timehash {
1.687     raeburn  4483:     my ($thistime) = @_;
                   4484:     my $timezone = &Apache::lonlocal::gettimezone();
                   4485:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4486:                      ->set_time_zone($timezone);
                   4487:     my $wday = $dt->day_of_week();
                   4488:     if ($wday == 7) { $wday = 0; }
                   4489:     return ( 'second' => $dt->second(),
                   4490:              'minute' => $dt->minute(),
                   4491:              'hour'   => $dt->hour(),
                   4492:              'day'     => $dt->day_of_month(),
                   4493:              'month'   => $dt->month(),
                   4494:              'year'    => $dt->year(),
                   4495:              'weekday' => $wday,
                   4496:              'dayyear' => $dt->day_of_year(),
                   4497:              'dlsav'   => $dt->is_dst() );
1.51      www      4498: }
                   4499: 
1.370     www      4500: sub utc_string {
                   4501:     my ($date)=@_;
1.371     www      4502:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4503: }
                   4504: 
1.51      www      4505: sub maketime {
                   4506:     my %th=@_;
1.687     raeburn  4507:     my ($epoch_time,$timezone,$dt);
                   4508:     $timezone = &Apache::lonlocal::gettimezone();
                   4509:     eval {
                   4510:         $dt = DateTime->new( year   => $th{'year'},
                   4511:                              month  => $th{'month'},
                   4512:                              day    => $th{'day'},
                   4513:                              hour   => $th{'hour'},
                   4514:                              minute => $th{'minute'},
                   4515:                              second => $th{'second'},
                   4516:                              time_zone => $timezone,
                   4517:                          );
                   4518:     };
                   4519:     if (!$@) {
                   4520:         $epoch_time = $dt->epoch;
                   4521:         if ($epoch_time) {
                   4522:             return $epoch_time;
                   4523:         }
                   4524:     }
1.51      www      4525:     return POSIX::mktime(
                   4526:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4527:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4528: }
                   4529: 
                   4530: #########################################
1.51      www      4531: 
                   4532: sub findallcourses {
1.482     raeburn  4533:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4534:     my %roles;
                   4535:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4536:     my %courses;
1.51      www      4537:     my $now=time;
1.482     raeburn  4538:     if (!defined($uname)) {
                   4539:         $uname = $env{'user.name'};
                   4540:     }
                   4541:     if (!defined($udom)) {
                   4542:         $udom = $env{'user.domain'};
                   4543:     }
                   4544:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4545:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4546:         if (!%roles) {
                   4547:             %roles = (
                   4548:                        cc => 1,
1.907     raeburn  4549:                        co => 1,
1.482     raeburn  4550:                        in => 1,
                   4551:                        ep => 1,
                   4552:                        ta => 1,
                   4553:                        cr => 1,
                   4554:                        st => 1,
                   4555:              );
                   4556:         }
                   4557:         foreach my $entry (keys(%roleshash)) {
                   4558:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4559:             if ($trole =~ /^cr/) { 
                   4560:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4561:             } else {
                   4562:                 next if (!exists($roles{$trole}));
                   4563:             }
                   4564:             if ($tend) {
                   4565:                 next if ($tend < $now);
                   4566:             }
                   4567:             if ($tstart) {
                   4568:                 next if ($tstart > $now);
                   4569:             }
1.1058    raeburn  4570:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4571:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4572:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4573:             if ($secpart eq '') {
                   4574:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4575:                 $sec = 'none';
1.1058    raeburn  4576:                 $value .= $cnum.'/';
1.482     raeburn  4577:             } else {
                   4578:                 $cnum = $cnumpart;
                   4579:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4580:                 $value .= $cnum.'/'.$sec;
                   4581:             }
                   4582:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4583:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4584:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4585:                 }
                   4586:             } else {
                   4587:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4588:             }
1.482     raeburn  4589:         }
                   4590:     } else {
                   4591:         foreach my $key (keys(%env)) {
1.483     albertel 4592: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4593:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4594: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4595: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4596: 	        next if (%roles && !exists($roles{$role}));
                   4597: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4598:                 my $active=1;
                   4599:                 if ($starttime) {
                   4600: 		    if ($now<$starttime) { $active=0; }
                   4601:                 }
                   4602:                 if ($endtime) {
                   4603:                     if ($now>$endtime) { $active=0; }
                   4604:                 }
                   4605:                 if ($active) {
1.1058    raeburn  4606:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4607:                     if ($sec eq '') {
                   4608:                         $sec = 'none';
1.1058    raeburn  4609:                     } else {
                   4610:                         $value .= $sec;
                   4611:                     }
                   4612:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4613:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4614:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4615:                         }
                   4616:                     } else {
                   4617:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4618:                     }
1.474     raeburn  4619:                 }
                   4620:             }
1.51      www      4621:         }
                   4622:     }
1.474     raeburn  4623:     return %courses;
1.51      www      4624: }
1.37      matthew  4625: 
1.54      www      4626: ###############################################
1.474     raeburn  4627: 
                   4628: sub blockcheck {
1.1189    raeburn  4629:     my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490     raeburn  4630: 
1.1189    raeburn  4631:     if (defined($udom) && defined($uname)) {
                   4632:         # If uname and udom are for a course, check for blocks in the course.
                   4633:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4634:             my ($startblock,$endblock,$triggerblock) =
                   4635:                 &get_blocks($setters,$activity,$udom,$uname,$url);
                   4636:             return ($startblock,$endblock,$triggerblock);
                   4637:         }
                   4638:     } else {
1.490     raeburn  4639:         $udom = $env{'user.domain'};
                   4640:         $uname = $env{'user.name'};
                   4641:     }
                   4642: 
1.502     raeburn  4643:     my $startblock = 0;
                   4644:     my $endblock = 0;
1.1062    raeburn  4645:     my $triggerblock = '';
1.482     raeburn  4646:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4647: 
1.490     raeburn  4648:     # If uname is for a user, and activity is course-specific, i.e.,
                   4649:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4650: 
1.490     raeburn  4651:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1189    raeburn  4652:          $activity eq 'groups' || $activity eq 'printout') &&
                   4653:         ($env{'request.course.id'})) {
1.490     raeburn  4654:         foreach my $key (keys(%live_courses)) {
                   4655:             if ($key ne $env{'request.course.id'}) {
                   4656:                 delete($live_courses{$key});
                   4657:             }
                   4658:         }
                   4659:     }
                   4660: 
                   4661:     my $otheruser = 0;
                   4662:     my %own_courses;
                   4663:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4664:         # Resource belongs to user other than current user.
                   4665:         $otheruser = 1;
                   4666:         # Gather courses for current user
                   4667:         %own_courses = 
                   4668:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4669:     }
                   4670: 
                   4671:     # Gather active course roles - course coordinator, instructor, 
                   4672:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4673: 
                   4674:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4675:         my ($cdom,$cnum);
                   4676:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4677:             $cdom = $env{'course.'.$course.'.domain'};
                   4678:             $cnum = $env{'course.'.$course.'.num'};
                   4679:         } else {
1.490     raeburn  4680:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4681:         }
                   4682:         my $no_ownblock = 0;
                   4683:         my $no_userblock = 0;
1.533     raeburn  4684:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4685:             # Check if current user has 'evb' priv for this
                   4686:             if (defined($own_courses{$course})) {
                   4687:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4688:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4689:                     if ($sec ne 'none') {
                   4690:                         $checkrole .= '/'.$sec;
                   4691:                     }
                   4692:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4693:                         $no_ownblock = 1;
                   4694:                         last;
                   4695:                     }
                   4696:                 }
                   4697:             }
                   4698:             # if they have 'evb' priv and are currently not playing student
                   4699:             next if (($no_ownblock) &&
                   4700:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4701:         }
1.474     raeburn  4702:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4703:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4704:             if ($sec ne 'none') {
1.482     raeburn  4705:                 $checkrole .= '/'.$sec;
1.474     raeburn  4706:             }
1.490     raeburn  4707:             if ($otheruser) {
                   4708:                 # Resource belongs to user other than current user.
                   4709:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4710:                 my (%allroles,%userroles);
                   4711:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4712:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4713:                         my ($trole,$tdom,$tnum,$tsec);
                   4714:                         if ($entry =~ /^cr/) {
                   4715:                             ($trole,$tdom,$tnum,$tsec) = 
                   4716:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4717:                         } else {
                   4718:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4719:                         }
                   4720:                         my ($spec,$area,$trest);
                   4721:                         $area = '/'.$tdom.'/'.$tnum;
                   4722:                         $trest = $tnum;
                   4723:                         if ($tsec ne '') {
                   4724:                             $area .= '/'.$tsec;
                   4725:                             $trest .= '/'.$tsec;
                   4726:                         }
                   4727:                         $spec = $trole.'.'.$area;
                   4728:                         if ($trole =~ /^cr/) {
                   4729:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4730:                                                               $tdom,$spec,$trest,$area);
                   4731:                         } else {
                   4732:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4733:                                                                 $tdom,$spec,$trest,$area);
                   4734:                         }
                   4735:                     }
                   4736:                     my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   4737:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4738:                         if ($1) {
                   4739:                             $no_userblock = 1;
                   4740:                             last;
                   4741:                         }
1.486     raeburn  4742:                     }
                   4743:                 }
1.490     raeburn  4744:             } else {
                   4745:                 # Resource belongs to current user
                   4746:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4747:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4748:                     $no_ownblock = 1;
                   4749:                     last;
                   4750:                 }
1.474     raeburn  4751:             }
                   4752:         }
                   4753:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4754:         next if (($no_ownblock) &&
1.491     albertel 4755:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4756:         next if ($no_userblock);
1.474     raeburn  4757: 
1.866     kalberla 4758:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4759:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4760:         
1.1062    raeburn  4761:         my ($start,$end,$trigger) = 
                   4762:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4763:         if (($start != 0) && 
                   4764:             (($startblock == 0) || ($startblock > $start))) {
                   4765:             $startblock = $start;
1.1062    raeburn  4766:             if ($trigger ne '') {
                   4767:                 $triggerblock = $trigger;
                   4768:             }
1.502     raeburn  4769:         }
                   4770:         if (($end != 0)  &&
                   4771:             (($endblock == 0) || ($endblock < $end))) {
                   4772:             $endblock = $end;
1.1062    raeburn  4773:             if ($trigger ne '') {
                   4774:                 $triggerblock = $trigger;
                   4775:             }
1.502     raeburn  4776:         }
1.490     raeburn  4777:     }
1.1062    raeburn  4778:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4779: }
                   4780: 
                   4781: sub get_blocks {
1.1062    raeburn  4782:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4783:     my $startblock = 0;
                   4784:     my $endblock = 0;
1.1062    raeburn  4785:     my $triggerblock = '';
1.490     raeburn  4786:     my $course = $cdom.'_'.$cnum;
                   4787:     $setters->{$course} = {};
                   4788:     $setters->{$course}{'staff'} = [];
                   4789:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4790:     $setters->{$course}{'triggers'} = [];
                   4791:     my (@blockers,%triggered);
                   4792:     my $now = time;
                   4793:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4794:     if ($activity eq 'docs') {
                   4795:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4796:         foreach my $block (@blockers) {
                   4797:             if ($block =~ /^firstaccess____(.+)$/) {
                   4798:                 my $item = $1;
                   4799:                 my $type = 'map';
                   4800:                 my $timersymb = $item;
                   4801:                 if ($item eq 'course') {
                   4802:                     $type = 'course';
                   4803:                 } elsif ($item =~ /___\d+___/) {
                   4804:                     $type = 'resource';
                   4805:                 } else {
                   4806:                     $timersymb = &Apache::lonnet::symbread($item);
                   4807:                 }
                   4808:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4809:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4810:                 $triggered{$block} = {
                   4811:                                        start => $start,
                   4812:                                        end   => $end,
                   4813:                                        type  => $type,
                   4814:                                      };
                   4815:             }
                   4816:         }
                   4817:     } else {
                   4818:         foreach my $block (keys(%commblocks)) {
                   4819:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4820:                 my ($start,$end) = ($1,$2);
                   4821:                 if ($start <= time && $end >= time) {
                   4822:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4823:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4824:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4825:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4826:                                     push(@blockers,$block);
                   4827:                                 }
                   4828:                             }
                   4829:                         }
                   4830:                     }
                   4831:                 }
                   4832:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4833:                 my $item = $1;
                   4834:                 my $timersymb = $item; 
                   4835:                 my $type = 'map';
                   4836:                 if ($item eq 'course') {
                   4837:                     $type = 'course';
                   4838:                 } elsif ($item =~ /___\d+___/) {
                   4839:                     $type = 'resource';
                   4840:                 } else {
                   4841:                     $timersymb = &Apache::lonnet::symbread($item);
                   4842:                 }
                   4843:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4844:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4845:                 if ($start && $end) {
                   4846:                     if (($start <= time) && ($end >= time)) {
                   4847:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4848:                             push(@blockers,$block);
                   4849:                             $triggered{$block} = {
                   4850:                                                    start => $start,
                   4851:                                                    end   => $end,
                   4852:                                                    type  => $type,
                   4853:                                                  };
                   4854:                         }
                   4855:                     }
1.490     raeburn  4856:                 }
1.1062    raeburn  4857:             }
                   4858:         }
                   4859:     }
                   4860:     foreach my $blocker (@blockers) {
                   4861:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4862:             &parse_block_record($commblocks{$blocker});
                   4863:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4864:         my ($start,$end,$triggertype);
                   4865:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4866:             ($start,$end) = ($1,$2);
                   4867:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4868:             $start = $triggered{$blocker}{'start'};
                   4869:             $end = $triggered{$blocker}{'end'};
                   4870:             $triggertype = $triggered{$blocker}{'type'};
                   4871:         }
                   4872:         if ($start) {
                   4873:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4874:             if ($triggertype) {
                   4875:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4876:             } else {
                   4877:                 push(@{$$setters{$course}{'triggers'}},0);
                   4878:             }
                   4879:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4880:                 $startblock = $start;
                   4881:                 if ($triggertype) {
                   4882:                     $triggerblock = $blocker;
1.474     raeburn  4883:                 }
                   4884:             }
1.1062    raeburn  4885:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4886:                $endblock = $end;
                   4887:                if ($triggertype) {
                   4888:                    $triggerblock = $blocker;
                   4889:                }
                   4890:             }
1.474     raeburn  4891:         }
                   4892:     }
1.1062    raeburn  4893:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4894: }
                   4895: 
                   4896: sub parse_block_record {
                   4897:     my ($record) = @_;
                   4898:     my ($setuname,$setudom,$title,$blocks);
                   4899:     if (ref($record) eq 'HASH') {
                   4900:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4901:         $title = &unescape($record->{'event'});
                   4902:         $blocks = $record->{'blocks'};
                   4903:     } else {
                   4904:         my @data = split(/:/,$record,3);
                   4905:         if (scalar(@data) eq 2) {
                   4906:             $title = $data[1];
                   4907:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4908:         } else {
                   4909:             ($setuname,$setudom,$title) = @data;
                   4910:         }
                   4911:         $blocks = { 'com' => 'on' };
                   4912:     }
                   4913:     return ($setuname,$setudom,$title,$blocks);
                   4914: }
                   4915: 
1.854     kalberla 4916: sub blocking_status {
1.1189    raeburn  4917:     my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061    raeburn  4918:     my %setters;
1.890     droeschl 4919: 
1.1061    raeburn  4920: # check for active blocking
1.1062    raeburn  4921:     my ($startblock,$endblock,$triggerblock) = 
1.1189    raeburn  4922:         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062    raeburn  4923:     my $blocked = 0;
                   4924:     if ($startblock && $endblock) {
                   4925:         $blocked = 1;
                   4926:     }
1.890     droeschl 4927: 
1.1061    raeburn  4928: # caller just wants to know whether a block is active
                   4929:     if (!wantarray) { return $blocked; }
                   4930: 
                   4931: # build a link to a popup window containing the details
                   4932:     my $querystring  = "?activity=$activity";
                   4933: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062    raeburn  4934:     if ($activity eq 'port') {
                   4935:         $querystring .= "&amp;udom=$udom"      if $udom;
                   4936:         $querystring .= "&amp;uname=$uname"    if $uname;
                   4937:     } elsif ($activity eq 'docs') {
                   4938:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4939:     }
1.1061    raeburn  4940: 
                   4941:     my $output .= <<'END_MYBLOCK';
                   4942: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4943:     var options = "width=" + w + ",height=" + h + ",";
                   4944:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4945:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4946:     var newWin = window.open(url, wdwName, options);
                   4947:     newWin.focus();
                   4948: }
1.890     droeschl 4949: END_MYBLOCK
1.854     kalberla 4950: 
1.1061    raeburn  4951:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4952:   
1.1061    raeburn  4953:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  4954:     my $text = &mt('Communication Blocked');
                   4955:     if ($activity eq 'docs') {
                   4956:         $text = &mt('Content Access Blocked');
1.1063    raeburn  4957:     } elsif ($activity eq 'printout') {
                   4958:         $text = &mt('Printing Blocked');
1.1062    raeburn  4959:     }
1.1061    raeburn  4960:     $output .= <<"END_BLOCK";
1.867     kalberla 4961: <div class='LC_comblock'>
1.869     kalberla 4962:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4963:   title='$text'>
                   4964:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4965:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4966:   title='$text'>$text</a>
1.867     kalberla 4967: </div>
                   4968: 
                   4969: END_BLOCK
1.474     raeburn  4970: 
1.1061    raeburn  4971:     return ($blocked, $output);
1.854     kalberla 4972: }
1.490     raeburn  4973: 
1.60      matthew  4974: ###############################################
                   4975: 
1.682     raeburn  4976: sub check_ip_acc {
1.1201    raeburn  4977:     my ($acc,$clientip)=@_;
1.682     raeburn  4978:     &Apache::lonxml::debug("acc is $acc");
                   4979:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4980:         return 1;
                   4981:     }
                   4982:     my $allowed=0;
1.1201    raeburn  4983:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
1.682     raeburn  4984: 
                   4985:     my $name;
                   4986:     foreach my $pattern (split(',',$acc)) {
                   4987:         $pattern =~ s/^\s*//;
                   4988:         $pattern =~ s/\s*$//;
                   4989:         if ($pattern =~ /\*$/) {
                   4990:             #35.8.*
                   4991:             $pattern=~s/\*//;
                   4992:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4993:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4994:             #35.8.3.[34-56]
                   4995:             my $low=$2;
                   4996:             my $high=$3;
                   4997:             $pattern=$1;
                   4998:             if ($ip =~ /^\Q$pattern\E/) {
                   4999:                 my $last=(split(/\./,$ip))[3];
                   5000:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   5001:             }
                   5002:         } elsif ($pattern =~ /^\*/) {
                   5003:             #*.msu.edu
                   5004:             $pattern=~s/\*//;
                   5005:             if (!defined($name)) {
                   5006:                 use Socket;
                   5007:                 my $netaddr=inet_aton($ip);
                   5008:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5009:             }
                   5010:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5011:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5012:             #127.0.0.1
                   5013:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5014:         } else {
                   5015:             #some.name.com
                   5016:             if (!defined($name)) {
                   5017:                 use Socket;
                   5018:                 my $netaddr=inet_aton($ip);
                   5019:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5020:             }
                   5021:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5022:         }
                   5023:         if ($allowed) { last; }
                   5024:     }
                   5025:     return $allowed;
                   5026: }
                   5027: 
                   5028: ###############################################
                   5029: 
1.60      matthew  5030: =pod
                   5031: 
1.112     bowersj2 5032: =head1 Domain Template Functions
                   5033: 
                   5034: =over 4
                   5035: 
                   5036: =item * &determinedomain()
1.60      matthew  5037: 
                   5038: Inputs: $domain (usually will be undef)
                   5039: 
1.63      www      5040: Returns: Determines which domain should be used for designs
1.60      matthew  5041: 
                   5042: =cut
1.54      www      5043: 
1.60      matthew  5044: ###############################################
1.63      www      5045: sub determinedomain {
                   5046:     my $domain=shift;
1.531     albertel 5047:     if (! $domain) {
1.60      matthew  5048:         # Determine domain if we have not been given one
1.893     raeburn  5049:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5050:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5051:         if ($env{'request.role.domain'}) { 
                   5052:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5053:         }
                   5054:     }
1.63      www      5055:     return $domain;
                   5056: }
                   5057: ###############################################
1.517     raeburn  5058: 
1.518     albertel 5059: sub devalidate_domconfig_cache {
                   5060:     my ($udom)=@_;
                   5061:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5062: }
                   5063: 
                   5064: # ---------------------- Get domain configuration for a domain
                   5065: sub get_domainconf {
                   5066:     my ($udom) = @_;
                   5067:     my $cachetime=1800;
                   5068:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5069:     if (defined($cached)) { return %{$result}; }
                   5070: 
                   5071:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5072: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5073:     my (%designhash,%legacy);
1.518     albertel 5074:     if (keys(%domconfig) > 0) {
                   5075:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5076:             if (keys(%{$domconfig{'login'}})) {
                   5077:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5078:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208    raeburn  5079:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5080:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5081:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5082:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5083:                                         if ($key eq 'loginvia') {
                   5084:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5085:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5086:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5087:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5088: 
                   5089:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5090:                                                 } else {
                   5091:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5092:                                                 }
1.948     raeburn  5093:                                             }
1.1208    raeburn  5094:                                         } elsif ($key eq 'headtag') {
                   5095:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5096:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5097:                                             }
1.946     raeburn  5098:                                         }
1.1208    raeburn  5099:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5100:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5101:                                         }
1.946     raeburn  5102:                                     }
                   5103:                                 }
                   5104:                             }
                   5105:                         } else {
                   5106:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5107:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5108:                                     $domconfig{'login'}{$key}{$img};
                   5109:                             }
1.699     raeburn  5110:                         }
                   5111:                     } else {
                   5112:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5113:                     }
1.632     raeburn  5114:                 }
                   5115:             } else {
                   5116:                 $legacy{'login'} = 1;
1.518     albertel 5117:             }
1.632     raeburn  5118:         } else {
                   5119:             $legacy{'login'} = 1;
1.518     albertel 5120:         }
                   5121:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5122:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5123:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5124:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5125:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5126:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5127:                         }
1.518     albertel 5128:                     }
                   5129:                 }
1.632     raeburn  5130:             } else {
                   5131:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5132:             }
1.632     raeburn  5133:         } else {
                   5134:             $legacy{'rolecolors'} = 1;
1.518     albertel 5135:         }
1.948     raeburn  5136:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5137:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5138:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5139:             }
                   5140:         }
1.632     raeburn  5141:         if (keys(%legacy) > 0) {
                   5142:             my %legacyhash = &get_legacy_domconf($udom);
                   5143:             foreach my $item (keys(%legacyhash)) {
                   5144:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5145:                     if ($legacy{'login'}) { 
                   5146:                         $designhash{$item} = $legacyhash{$item};
                   5147:                     }
                   5148:                 } else {
                   5149:                     if ($legacy{'rolecolors'}) {
                   5150:                         $designhash{$item} = $legacyhash{$item};
                   5151:                     }
1.518     albertel 5152:                 }
                   5153:             }
                   5154:         }
1.632     raeburn  5155:     } else {
                   5156:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5157:     }
                   5158:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5159: 				  $cachetime);
                   5160:     return %designhash;
                   5161: }
                   5162: 
1.632     raeburn  5163: sub get_legacy_domconf {
                   5164:     my ($udom) = @_;
                   5165:     my %legacyhash;
                   5166:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5167:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5168:     if (-e $designfile) {
                   5169:         if ( open (my $fh,"<$designfile") ) {
                   5170:             while (my $line = <$fh>) {
                   5171:                 next if ($line =~ /^\#/);
                   5172:                 chomp($line);
                   5173:                 my ($key,$val)=(split(/\=/,$line));
                   5174:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5175:             }
                   5176:             close($fh);
                   5177:         }
                   5178:     }
1.1026    raeburn  5179:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5180:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5181:     }
                   5182:     return %legacyhash;
                   5183: }
                   5184: 
1.63      www      5185: =pod
                   5186: 
1.112     bowersj2 5187: =item * &domainlogo()
1.63      www      5188: 
                   5189: Inputs: $domain (usually will be undef)
                   5190: 
                   5191: Returns: A link to a domain logo, if the domain logo exists.
                   5192: If the domain logo does not exist, a description of the domain.
                   5193: 
                   5194: =cut
1.112     bowersj2 5195: 
1.63      www      5196: ###############################################
                   5197: sub domainlogo {
1.517     raeburn  5198:     my $domain = &determinedomain(shift);
1.518     albertel 5199:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5200:     # See if there is a logo
                   5201:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5202:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5203:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5204: 	    if ($imgsrc =~ m{^/res/}) {
                   5205: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5206: 		&Apache::lonnet::repcopy($local_name);
                   5207: 	    }
                   5208: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5209:         } 
                   5210:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5211:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5212:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5213:     } else {
1.60      matthew  5214:         return '';
1.59      www      5215:     }
                   5216: }
1.63      www      5217: ##############################################
                   5218: 
                   5219: =pod
                   5220: 
1.112     bowersj2 5221: =item * &designparm()
1.63      www      5222: 
                   5223: Inputs: $which parameter; $domain (usually will be undef)
                   5224: 
                   5225: Returns: value of designparamter $which
                   5226: 
                   5227: =cut
1.112     bowersj2 5228: 
1.397     albertel 5229: 
1.400     albertel 5230: ##############################################
1.397     albertel 5231: sub designparm {
                   5232:     my ($which,$domain)=@_;
                   5233:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5234:         return $env{'environment.color.'.$which};
1.96      www      5235:     }
1.63      www      5236:     $domain=&determinedomain($domain);
1.1016    raeburn  5237:     my %domdesign;
                   5238:     unless ($domain eq 'public') {
                   5239:         %domdesign = &get_domainconf($domain);
                   5240:     }
1.520     raeburn  5241:     my $output;
1.517     raeburn  5242:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5243:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5244:     } else {
1.520     raeburn  5245:         $output = $defaultdesign{$which};
                   5246:     }
                   5247:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5248:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5249:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5250:             if ($output =~ m{^/res/}) {
                   5251:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5252:                 &Apache::lonnet::repcopy($local_name);
                   5253:             }
1.520     raeburn  5254:             $output = &lonhttpdurl($output);
                   5255:         }
1.63      www      5256:     }
1.520     raeburn  5257:     return $output;
1.63      www      5258: }
1.59      www      5259: 
1.822     bisitz   5260: ##############################################
                   5261: =pod
                   5262: 
1.832     bisitz   5263: =item * &authorspace()
                   5264: 
1.1028    raeburn  5265: Inputs: $url (usually will be undef).
1.832     bisitz   5266: 
1.1132    raeburn  5267: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5268:          directory being viewed (or for which action is being taken). 
                   5269:          If $url is provided, and begins /priv/<domain>/<uname>
                   5270:          the path will be that portion of the $context argument.
                   5271:          Otherwise the path will be for the author space of the current
                   5272:          user when the current role is author, or for that of the 
                   5273:          co-author/assistant co-author space when the current role 
                   5274:          is co-author or assistant co-author.
1.832     bisitz   5275: 
                   5276: =cut
                   5277: 
                   5278: sub authorspace {
1.1028    raeburn  5279:     my ($url) = @_;
                   5280:     if ($url ne '') {
                   5281:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5282:            return $1;
                   5283:         }
                   5284:     }
1.832     bisitz   5285:     my $caname = '';
1.1024    www      5286:     my $cadom = '';
1.1028    raeburn  5287:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5288:         ($cadom,$caname) =
1.832     bisitz   5289:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5290:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5291:         $caname = $env{'user.name'};
1.1024    www      5292:         $cadom = $env{'user.domain'};
1.832     bisitz   5293:     }
1.1028    raeburn  5294:     if (($caname ne '') && ($cadom ne '')) {
                   5295:         return "/priv/$cadom/$caname/";
                   5296:     }
                   5297:     return;
1.832     bisitz   5298: }
                   5299: 
                   5300: ##############################################
                   5301: =pod
                   5302: 
1.822     bisitz   5303: =item * &head_subbox()
                   5304: 
                   5305: Inputs: $content (contains HTML code with page functions, etc.)
                   5306: 
                   5307: Returns: HTML div with $content
                   5308:          To be included in page header
                   5309: 
                   5310: =cut
                   5311: 
                   5312: sub head_subbox {
                   5313:     my ($content)=@_;
                   5314:     my $output =
1.993     raeburn  5315:         '<div class="LC_head_subbox">'
1.822     bisitz   5316:        .$content
                   5317:        .'</div>'
                   5318: }
                   5319: 
                   5320: ##############################################
                   5321: =pod
                   5322: 
                   5323: =item * &CSTR_pageheader()
                   5324: 
1.1026    raeburn  5325: Input: (optional) filename from which breadcrumb trail is built.
                   5326:        In most cases no input as needed, as $env{'request.filename'}
                   5327:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5328: 
                   5329: Returns: HTML div with CSTR path and recent box
1.1132    raeburn  5330:          To be included on Authoring Space pages
1.822     bisitz   5331: 
                   5332: =cut
                   5333: 
                   5334: sub CSTR_pageheader {
1.1026    raeburn  5335:     my ($trailfile) = @_;
                   5336:     if ($trailfile eq '') {
                   5337:         $trailfile = $env{'request.filename'};
                   5338:     }
                   5339: 
                   5340: # this is for resources; directories have customtitle, and crumbs
                   5341: # and select recent are created in lonpubdir.pm
                   5342: 
                   5343:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5344:     my ($udom,$uname,$thisdisfn)=
1.1113    raeburn  5345:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5346:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5347:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5348: 
                   5349:     my $parentpath = '';
                   5350:     my $lastitem = '';
                   5351:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5352:         $parentpath = $1;
                   5353:         $lastitem = $2;
                   5354:     } else {
                   5355:         $lastitem = $thisdisfn;
                   5356:     }
1.921     bisitz   5357: 
                   5358:     my $output =
1.822     bisitz   5359:          '<div>'
                   5360:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1132    raeburn  5361:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5362:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5363:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5364:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5365: 
                   5366:     if ($lastitem) {
                   5367:         $output .=
                   5368:              '<span class="LC_filename">'
                   5369:             .$lastitem
                   5370:             .'</span>';
                   5371:     }
                   5372:     $output .=
                   5373:          '<br />'
1.822     bisitz   5374:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5375:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5376:         .'</form>'
                   5377:         .&Apache::lonmenu::constspaceform()
                   5378:         .'</div>';
1.921     bisitz   5379: 
                   5380:     return $output;
1.822     bisitz   5381: }
                   5382: 
1.60      matthew  5383: ###############################################
                   5384: ###############################################
                   5385: 
                   5386: =pod
                   5387: 
1.112     bowersj2 5388: =back
                   5389: 
1.549     albertel 5390: =head1 HTML Helpers
1.112     bowersj2 5391: 
                   5392: =over 4
                   5393: 
                   5394: =item * &bodytag()
1.60      matthew  5395: 
                   5396: Returns a uniform header for LON-CAPA web pages.
                   5397: 
                   5398: Inputs: 
                   5399: 
1.112     bowersj2 5400: =over 4
                   5401: 
                   5402: =item * $title, A title to be displayed on the page.
                   5403: 
                   5404: =item * $function, the current role (can be undef).
                   5405: 
                   5406: =item * $addentries, extra parameters for the <body> tag.
                   5407: 
                   5408: =item * $bodyonly, if defined, only return the <body> tag.
                   5409: 
                   5410: =item * $domain, if defined, force a given domain.
                   5411: 
                   5412: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5413:             text interface only)
1.60      matthew  5414: 
1.814     bisitz   5415: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5416:                      navigational links
1.317     albertel 5417: 
1.338     albertel 5418: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5419: 
1.460     albertel 5420: =item * $args, optional argument valid values are
                   5421:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 5422:             inherit_jsmath -> when creating popup window in a page,
                   5423:                               should it have jsmath forced on by the
                   5424:                               current page
1.460     albertel 5425: 
1.1096    raeburn  5426: =item * $advtoolsref, optional argument, ref to an array containing
                   5427:             inlineremote items to be added in "Functions" menu below
                   5428:             breadcrumbs.
                   5429: 
1.112     bowersj2 5430: =back
                   5431: 
1.60      matthew  5432: Returns: A uniform header for LON-CAPA web pages.  
                   5433: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5434: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5435: other decorations will be returned.
                   5436: 
                   5437: =cut
                   5438: 
1.54      www      5439: sub bodytag {
1.831     bisitz   5440:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096    raeburn  5441:         $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339     albertel 5442: 
1.954     raeburn  5443:     my $public;
                   5444:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5445:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5446:         $public = 1;
                   5447:     }
1.460     albertel 5448:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154    raeburn  5449:     my $httphost = $args->{'use_absolute'};
1.339     albertel 5450: 
1.183     matthew  5451:     $function = &get_users_function() if (!$function);
1.339     albertel 5452:     my $img =    &designparm($function.'.img',$domain);
                   5453:     my $font =   &designparm($function.'.font',$domain);
                   5454:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5455: 
1.803     bisitz   5456:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5457: 		   'bgcolor' => $pgbg,
1.339     albertel 5458: 		   'text'    => $font,
                   5459:                    'alink'   => &designparm($function.'.alink',$domain),
                   5460: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5461: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5462:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5463: 
1.63      www      5464:  # role and realm
1.1178    raeburn  5465:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5466:     if ($realm) {
                   5467:         $realm = '/'.$realm;
                   5468:     }
1.378     raeburn  5469:     if ($role  eq 'ca') {
1.479     albertel 5470:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5471:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5472:     } 
1.55      www      5473: # realm
1.258     albertel 5474:     if ($env{'request.course.id'}) {
1.378     raeburn  5475:         if ($env{'request.role'} !~ /^cr/) {
                   5476:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   5477:         }
1.898     raeburn  5478:         if ($env{'request.course.sec'}) {
                   5479:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5480:         }   
1.359     albertel 5481: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5482:     } else {
                   5483:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5484:     }
1.433     albertel 5485: 
1.359     albertel 5486:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5487: 
1.438     albertel 5488:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5489: 
1.101     www      5490: # construct main body tag
1.359     albertel 5491:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 5492: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 5493: 
1.1131    raeburn  5494:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5495: 
1.1130    raeburn  5496:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5497:         return $bodytag;
1.1130    raeburn  5498:     }
1.359     albertel 5499: 
1.954     raeburn  5500:     if ($public) {
1.433     albertel 5501: 	undef($role);
                   5502:     }
1.359     albertel 5503:     
1.762     bisitz   5504:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5505:     #
                   5506:     # Extra info if you are the DC
                   5507:     my $dc_info = '';
                   5508:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5509:                         $env{'course.'.$env{'request.course.id'}.
                   5510:                                  '.domain'}.'/'})) {
                   5511:         my $cid = $env{'request.course.id'};
1.917     raeburn  5512:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5513:         $dc_info =~ s/\s+$//;
1.359     albertel 5514:     }
                   5515: 
1.898     raeburn  5516:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 5517: 
1.903     droeschl 5518:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5519: 
                   5520:         #    if ($env{'request.state'} eq 'construct') {
                   5521:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5522:         #    }
                   5523: 
1.1130    raeburn  5524:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154    raeburn  5525:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5526: 
1.1130    raeburn  5527:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.359     albertel 5528: 
1.916     droeschl 5529:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  5530:              if ($dc_info) {
                   5531:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5532:              }
1.1130    raeburn  5533:              $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916     droeschl 5534:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5535:             return $bodytag;
                   5536:         }
1.894     droeschl 5537: 
1.927     raeburn  5538:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130    raeburn  5539:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5540:         }
1.916     droeschl 5541: 
1.1130    raeburn  5542:         $bodytag .= $right;
1.852     droeschl 5543: 
1.917     raeburn  5544:         if ($dc_info) {
                   5545:             $dc_info = &dc_courseid_toggle($dc_info);
                   5546:         }
                   5547:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5548: 
1.1169    raeburn  5549:         #if directed to not display the secondary menu, don't.  
1.1168    raeburn  5550:         if ($args->{'no_secondary_menu'}) {
                   5551:             return $bodytag;
                   5552:         }
1.1169    raeburn  5553:         #don't show menus for public users
1.954     raeburn  5554:         if (!$public){
1.1154    raeburn  5555:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5556:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5557:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5558:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5559:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5560:                                 $args->{'bread_crumbs'});
1.1096    raeburn  5561:             } elsif ($forcereg) {
                   5562:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
                   5563:                                                             $args->{'group'});
                   5564:             } else {
                   5565:                 $bodytag .= 
                   5566:                     &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5567:                                                         $forcereg,$args->{'group'},
                   5568:                                                         $args->{'bread_crumbs'},
                   5569:                                                         $advtoolsref);
1.920     raeburn  5570:             }
1.903     droeschl 5571:         }else{
                   5572:             # this is to seperate menu from content when there's no secondary
                   5573:             # menu. Especially needed for public accessible ressources.
                   5574:             $bodytag .= '<hr style="clear:both" />';
                   5575:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5576:         }
1.903     droeschl 5577: 
1.235     raeburn  5578:         return $bodytag;
1.182     matthew  5579: }
                   5580: 
1.917     raeburn  5581: sub dc_courseid_toggle {
                   5582:     my ($dc_info) = @_;
1.980     raeburn  5583:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5584:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5585:            &mt('(More ...)').'</a></span>'.
                   5586:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5587: }
                   5588: 
1.330     albertel 5589: sub make_attr_string {
                   5590:     my ($register,$attr_ref) = @_;
                   5591: 
                   5592:     if ($attr_ref && !ref($attr_ref)) {
                   5593: 	die("addentries Must be a hash ref ".
                   5594: 	    join(':',caller(1))." ".
                   5595: 	    join(':',caller(0))." ");
                   5596:     }
                   5597: 
                   5598:     if ($register) {
1.339     albertel 5599: 	my ($on_load,$on_unload);
                   5600: 	foreach my $key (keys(%{$attr_ref})) {
                   5601: 	    if      (lc($key) eq 'onload') {
                   5602: 		$on_load.=$attr_ref->{$key}.';';
                   5603: 		delete($attr_ref->{$key});
                   5604: 
                   5605: 	    } elsif (lc($key) eq 'onunload') {
                   5606: 		$on_unload.=$attr_ref->{$key}.';';
                   5607: 		delete($attr_ref->{$key});
                   5608: 	    }
                   5609: 	}
1.953     droeschl 5610: 	$attr_ref->{'onload'}  = $on_load;
                   5611: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5612:     }
1.339     albertel 5613: 
1.330     albertel 5614:     my $attr_string;
1.1159    raeburn  5615:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5616: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5617:     }
                   5618:     return $attr_string;
                   5619: }
                   5620: 
                   5621: 
1.182     matthew  5622: ###############################################
1.251     albertel 5623: ###############################################
                   5624: 
                   5625: =pod
                   5626: 
                   5627: =item * &endbodytag()
                   5628: 
                   5629: Returns a uniform footer for LON-CAPA web pages.
                   5630: 
1.635     raeburn  5631: Inputs: 1 - optional reference to an args hash
                   5632: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5633: a 'Continue' link is not displayed if the page contains an
                   5634: internal redirect in the <head></head> section,
                   5635: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5636: 
                   5637: =cut
                   5638: 
                   5639: sub endbodytag {
1.635     raeburn  5640:     my ($args) = @_;
1.1080    raeburn  5641:     my $endbodytag;
                   5642:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5643:         $endbodytag='</body>';
                   5644:     }
1.269     albertel 5645:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5646:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5647:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5648: 	    $endbodytag=
                   5649: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5650: 	        &mt('Continue').'</a>'.
                   5651: 	        $endbodytag;
                   5652:         }
1.315     albertel 5653:     }
1.251     albertel 5654:     return $endbodytag;
                   5655: }
                   5656: 
1.352     albertel 5657: =pod
                   5658: 
                   5659: =item * &standard_css()
                   5660: 
                   5661: Returns a style sheet
                   5662: 
                   5663: Inputs: (all optional)
                   5664:             domain         -> force to color decorate a page for a specific
                   5665:                                domain
                   5666:             function       -> force usage of a specific rolish color scheme
                   5667:             bgcolor        -> override the default page bgcolor
                   5668: 
                   5669: =cut
                   5670: 
1.343     albertel 5671: sub standard_css {
1.345     albertel 5672:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5673:     $function  = &get_users_function() if (!$function);
                   5674:     my $img    = &designparm($function.'.img',   $domain);
                   5675:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5676:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5677:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5678: #second colour for later usage
1.345     albertel 5679:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5680:     my $pgbg_or_bgcolor =
                   5681: 	         $bgcolor ||
1.352     albertel 5682: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5683:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5684:     my $alink  = &designparm($function.'.alink', $domain);
                   5685:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5686:     my $link   = &designparm($function.'.link',  $domain);
                   5687: 
1.602     albertel 5688:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5689:     my $mono                 = 'monospace';
1.850     bisitz   5690:     my $data_table_head      = $sidebg;
                   5691:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5692:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5693:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5694:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5695:     my $mail_new             = '#FFBB77';
                   5696:     my $mail_new_hover       = '#DD9955';
                   5697:     my $mail_read            = '#BBBB77';
                   5698:     my $mail_read_hover      = '#999944';
                   5699:     my $mail_replied         = '#AAAA88';
                   5700:     my $mail_replied_hover   = '#888855';
                   5701:     my $mail_other           = '#99BBBB';
                   5702:     my $mail_other_hover     = '#669999';
1.391     albertel 5703:     my $table_header         = '#DDDDDD';
1.489     raeburn  5704:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5705:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5706:     my $button_hover         = '#BF2317';
1.392     albertel 5707: 
1.608     albertel 5708:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5709:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5710:                                              : '0 3px 0 4px';
1.448     albertel 5711: 
1.523     albertel 5712: 
1.343     albertel 5713:     return <<END;
1.947     droeschl 5714: 
                   5715: /* needed for iframe to allow 100% height in FF */
                   5716: body, html { 
                   5717:     margin: 0;
                   5718:     padding: 0 0.5%;
                   5719:     height: 99%; /* to avoid scrollbars */
                   5720: }
                   5721: 
1.795     www      5722: body {
1.911     bisitz   5723:   font-family: $sans;
                   5724:   line-height:130%;
                   5725:   font-size:0.83em;
                   5726:   color:$font;
1.795     www      5727: }
                   5728: 
1.959     onken    5729: a:focus,
                   5730: a:focus img {
1.795     www      5731:   color: red;
                   5732: }
1.698     harmsja  5733: 
1.911     bisitz   5734: form, .inline {
                   5735:   display: inline;
1.795     www      5736: }
1.721     harmsja  5737: 
1.795     www      5738: .LC_right {
1.911     bisitz   5739:   text-align:right;
1.795     www      5740: }
                   5741: 
                   5742: .LC_middle {
1.911     bisitz   5743:   vertical-align:middle;
1.795     www      5744: }
1.721     harmsja  5745: 
1.1130    raeburn  5746: .LC_floatleft {
                   5747:   float: left;
                   5748: }
                   5749: 
                   5750: .LC_floatright {
                   5751:   float: right;
                   5752: }
                   5753: 
1.911     bisitz   5754: .LC_400Box {
                   5755:   width:400px;
                   5756: }
1.721     harmsja  5757: 
1.947     droeschl 5758: .LC_iframecontainer {
                   5759:     width: 98%;
                   5760:     margin: 0;
                   5761:     position: fixed;
                   5762:     top: 8.5em;
                   5763:     bottom: 0;
                   5764: }
                   5765: 
                   5766: .LC_iframecontainer iframe{
                   5767:     border: none;
                   5768:     width: 100%;
                   5769:     height: 100%;
                   5770: }
                   5771: 
1.778     bisitz   5772: .LC_filename {
                   5773:   font-family: $mono;
                   5774:   white-space:pre;
1.921     bisitz   5775:   font-size: 120%;
1.778     bisitz   5776: }
                   5777: 
                   5778: .LC_fileicon {
                   5779:   border: none;
                   5780:   height: 1.3em;
                   5781:   vertical-align: text-bottom;
                   5782:   margin-right: 0.3em;
                   5783:   text-decoration:none;
                   5784: }
                   5785: 
1.1008    www      5786: .LC_setting {
                   5787:   text-decoration:underline;
                   5788: }
                   5789: 
1.350     albertel 5790: .LC_error {
                   5791:   color: red;
                   5792: }
1.795     www      5793: 
1.1097    bisitz   5794: .LC_warning {
                   5795:   color: darkorange;
                   5796: }
                   5797: 
1.457     albertel 5798: .LC_diff_removed {
1.733     bisitz   5799:   color: red;
1.394     albertel 5800: }
1.532     albertel 5801: 
                   5802: .LC_info,
1.457     albertel 5803: .LC_success,
                   5804: .LC_diff_added {
1.350     albertel 5805:   color: green;
                   5806: }
1.795     www      5807: 
1.802     bisitz   5808: div.LC_confirm_box {
                   5809:   background-color: #FAFAFA;
                   5810:   border: 1px solid $lg_border_color;
                   5811:   margin-right: 0;
                   5812:   padding: 5px;
                   5813: }
                   5814: 
                   5815: div.LC_confirm_box .LC_error img,
                   5816: div.LC_confirm_box .LC_success img {
                   5817:   vertical-align: middle;
                   5818: }
                   5819: 
1.440     albertel 5820: .LC_icon {
1.771     droeschl 5821:   border: none;
1.790     droeschl 5822:   vertical-align: middle;
1.771     droeschl 5823: }
                   5824: 
1.543     albertel 5825: .LC_docs_spacer {
                   5826:   width: 25px;
                   5827:   height: 1px;
1.771     droeschl 5828:   border: none;
1.543     albertel 5829: }
1.346     albertel 5830: 
1.532     albertel 5831: .LC_internal_info {
1.735     bisitz   5832:   color: #999999;
1.532     albertel 5833: }
                   5834: 
1.794     www      5835: .LC_discussion {
1.1050    www      5836:   background: $data_table_dark;
1.911     bisitz   5837:   border: 1px solid black;
                   5838:   margin: 2px;
1.794     www      5839: }
                   5840: 
                   5841: .LC_disc_action_left {
1.1050    www      5842:   background: $sidebg;
1.911     bisitz   5843:   text-align: left;
1.1050    www      5844:   padding: 4px;
                   5845:   margin: 2px;
1.794     www      5846: }
                   5847: 
                   5848: .LC_disc_action_right {
1.1050    www      5849:   background: $sidebg;
1.911     bisitz   5850:   text-align: right;
1.1050    www      5851:   padding: 4px;
                   5852:   margin: 2px;
1.794     www      5853: }
                   5854: 
                   5855: .LC_disc_new_item {
1.911     bisitz   5856:   background: white;
                   5857:   border: 2px solid red;
1.1050    www      5858:   margin: 4px;
                   5859:   padding: 4px;
1.794     www      5860: }
                   5861: 
                   5862: .LC_disc_old_item {
1.911     bisitz   5863:   background: white;
1.1050    www      5864:   margin: 4px;
                   5865:   padding: 4px;
1.794     www      5866: }
                   5867: 
1.458     albertel 5868: table.LC_pastsubmission {
                   5869:   border: 1px solid black;
                   5870:   margin: 2px;
                   5871: }
                   5872: 
1.924     bisitz   5873: table#LC_menubuttons {
1.345     albertel 5874:   width: 100%;
                   5875:   background: $pgbg;
1.392     albertel 5876:   border: 2px;
1.402     albertel 5877:   border-collapse: separate;
1.803     bisitz   5878:   padding: 0;
1.345     albertel 5879: }
1.392     albertel 5880: 
1.801     tempelho 5881: table#LC_title_bar a {
                   5882:   color: $fontmenu;
                   5883: }
1.836     bisitz   5884: 
1.807     droeschl 5885: table#LC_title_bar {
1.819     tempelho 5886:   clear: both;
1.836     bisitz   5887:   display: none;
1.807     droeschl 5888: }
                   5889: 
1.795     www      5890: table#LC_title_bar,
1.933     droeschl 5891: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5892: table#LC_title_bar.LC_with_remote {
1.359     albertel 5893:   width: 100%;
1.392     albertel 5894:   border-color: $pgbg;
                   5895:   border-style: solid;
                   5896:   border-width: $border;
1.379     albertel 5897:   background: $pgbg;
1.801     tempelho 5898:   color: $fontmenu;
1.392     albertel 5899:   border-collapse: collapse;
1.803     bisitz   5900:   padding: 0;
1.819     tempelho 5901:   margin: 0;
1.359     albertel 5902: }
1.795     www      5903: 
1.933     droeschl 5904: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5905:     margin: 0;
                   5906:     padding: 0;
1.933     droeschl 5907:     position: relative;
                   5908:     list-style: none;
1.913     droeschl 5909: }
1.933     droeschl 5910: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5911:     display: inline;
                   5912: }
1.933     droeschl 5913: 
                   5914: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5915:     padding: 0;
1.933     droeschl 5916:     margin: 0;
                   5917:     float: left;
1.913     droeschl 5918: }
1.933     droeschl 5919: .LC_breadcrumb_tools_tools {
                   5920:     padding: 0;
                   5921:     margin: 0;
1.913     droeschl 5922:     float: right;
                   5923: }
                   5924: 
1.359     albertel 5925: table#LC_title_bar td {
                   5926:   background: $tabbg;
                   5927: }
1.795     www      5928: 
1.911     bisitz   5929: table#LC_menubuttons img {
1.803     bisitz   5930:   border: none;
1.346     albertel 5931: }
1.795     www      5932: 
1.842     droeschl 5933: .LC_breadcrumbs_component {
1.911     bisitz   5934:   float: right;
                   5935:   margin: 0 1em;
1.357     albertel 5936: }
1.842     droeschl 5937: .LC_breadcrumbs_component img {
1.911     bisitz   5938:   vertical-align: middle;
1.777     tempelho 5939: }
1.795     www      5940: 
1.383     albertel 5941: td.LC_table_cell_checkbox {
                   5942:   text-align: center;
                   5943: }
1.795     www      5944: 
                   5945: .LC_fontsize_small {
1.911     bisitz   5946:   font-size: 70%;
1.705     tempelho 5947: }
                   5948: 
1.844     bisitz   5949: #LC_breadcrumbs {
1.911     bisitz   5950:   clear:both;
                   5951:   background: $sidebg;
                   5952:   border-bottom: 1px solid $lg_border_color;
                   5953:   line-height: 2.5em;
1.933     droeschl 5954:   overflow: hidden;
1.911     bisitz   5955:   margin: 0;
                   5956:   padding: 0;
1.995     raeburn  5957:   text-align: left;
1.819     tempelho 5958: }
1.862     bisitz   5959: 
1.1098    bisitz   5960: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   5961:   clear:both;
                   5962:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5963:   border: 1px solid $sidebg;
1.1098    bisitz   5964:   margin: 0 0 10px 0;
1.966     bisitz   5965:   padding: 3px;
1.995     raeburn  5966:   text-align: left;
1.822     bisitz   5967: }
                   5968: 
1.795     www      5969: .LC_fontsize_medium {
1.911     bisitz   5970:   font-size: 85%;
1.705     tempelho 5971: }
                   5972: 
1.795     www      5973: .LC_fontsize_large {
1.911     bisitz   5974:   font-size: 120%;
1.705     tempelho 5975: }
                   5976: 
1.346     albertel 5977: .LC_menubuttons_inline_text {
                   5978:   color: $font;
1.698     harmsja  5979:   font-size: 90%;
1.701     harmsja  5980:   padding-left:3px;
1.346     albertel 5981: }
                   5982: 
1.934     droeschl 5983: .LC_menubuttons_inline_text img{
                   5984:   vertical-align: middle;
                   5985: }
                   5986: 
1.1051    www      5987: li.LC_menubuttons_inline_text img {
1.951     onken    5988:   cursor:pointer;
1.1002    droeschl 5989:   text-decoration: none;
1.951     onken    5990: }
                   5991: 
1.526     www      5992: .LC_menubuttons_link {
                   5993:   text-decoration: none;
                   5994: }
1.795     www      5995: 
1.522     albertel 5996: .LC_menubuttons_category {
1.521     www      5997:   color: $font;
1.526     www      5998:   background: $pgbg;
1.521     www      5999:   font-size: larger;
                   6000:   font-weight: bold;
                   6001: }
                   6002: 
1.346     albertel 6003: td.LC_menubuttons_text {
1.911     bisitz   6004:   color: $font;
1.346     albertel 6005: }
1.706     harmsja  6006: 
1.346     albertel 6007: .LC_current_location {
                   6008:   background: $tabbg;
                   6009: }
1.795     www      6010: 
1.938     bisitz   6011: table.LC_data_table {
1.347     albertel 6012:   border: 1px solid #000000;
1.402     albertel 6013:   border-collapse: separate;
1.426     albertel 6014:   border-spacing: 1px;
1.610     albertel 6015:   background: $pgbg;
1.347     albertel 6016: }
1.795     www      6017: 
1.422     albertel 6018: .LC_data_table_dense {
                   6019:   font-size: small;
                   6020: }
1.795     www      6021: 
1.507     raeburn  6022: table.LC_nested_outer {
                   6023:   border: 1px solid #000000;
1.589     raeburn  6024:   border-collapse: collapse;
1.803     bisitz   6025:   border-spacing: 0;
1.507     raeburn  6026:   width: 100%;
                   6027: }
1.795     www      6028: 
1.879     raeburn  6029: table.LC_innerpickbox,
1.507     raeburn  6030: table.LC_nested {
1.803     bisitz   6031:   border: none;
1.589     raeburn  6032:   border-collapse: collapse;
1.803     bisitz   6033:   border-spacing: 0;
1.507     raeburn  6034:   width: 100%;
                   6035: }
1.795     www      6036: 
1.911     bisitz   6037: table.LC_data_table tr th,
                   6038: table.LC_calendar tr th,
1.879     raeburn  6039: table.LC_prior_tries tr th,
                   6040: table.LC_innerpickbox tr th {
1.349     albertel 6041:   font-weight: bold;
                   6042:   background-color: $data_table_head;
1.801     tempelho 6043:   color:$fontmenu;
1.701     harmsja  6044:   font-size:90%;
1.347     albertel 6045: }
1.795     www      6046: 
1.879     raeburn  6047: table.LC_innerpickbox tr th,
                   6048: table.LC_innerpickbox tr td {
                   6049:   vertical-align: top;
                   6050: }
                   6051: 
1.711     raeburn  6052: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6053:   background-color: #CCCCCC;
1.711     raeburn  6054:   font-weight: bold;
                   6055:   text-align: left;
                   6056: }
1.795     www      6057: 
1.912     bisitz   6058: table.LC_data_table tr.LC_odd_row > td {
                   6059:   background-color: $data_table_light;
                   6060:   padding: 2px;
                   6061:   vertical-align: top;
                   6062: }
                   6063: 
1.809     bisitz   6064: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6065:   background-color: $data_table_light;
1.912     bisitz   6066:   vertical-align: top;
                   6067: }
                   6068: 
                   6069: table.LC_data_table tr.LC_even_row > td {
                   6070:   background-color: $data_table_dark;
1.425     albertel 6071:   padding: 2px;
1.900     bisitz   6072:   vertical-align: top;
1.347     albertel 6073: }
1.795     www      6074: 
1.809     bisitz   6075: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6076:   background-color: $data_table_dark;
1.900     bisitz   6077:   vertical-align: top;
1.347     albertel 6078: }
1.795     www      6079: 
1.425     albertel 6080: table.LC_data_table tr.LC_data_table_highlight td {
                   6081:   background-color: $data_table_darker;
                   6082: }
1.795     www      6083: 
1.639     raeburn  6084: table.LC_data_table tr td.LC_leftcol_header {
                   6085:   background-color: $data_table_head;
                   6086:   font-weight: bold;
                   6087: }
1.795     www      6088: 
1.451     albertel 6089: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6090: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6091:   font-weight: bold;
                   6092:   font-style: italic;
                   6093:   text-align: center;
                   6094:   padding: 8px;
1.347     albertel 6095: }
1.795     www      6096: 
1.1114    raeburn  6097: table.LC_data_table tr.LC_empty_row td,
                   6098: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6099:   background-color: $sidebg;
                   6100: }
                   6101: 
                   6102: table.LC_nested tr.LC_empty_row td {
                   6103:   background-color: #FFFFFF;
                   6104: }
                   6105: 
1.890     droeschl 6106: table.LC_caption {
                   6107: }
                   6108: 
1.507     raeburn  6109: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6110:   padding: 4ex
                   6111: }
1.795     www      6112: 
1.507     raeburn  6113: table.LC_nested_outer tr th {
                   6114:   font-weight: bold;
1.801     tempelho 6115:   color:$fontmenu;
1.507     raeburn  6116:   background-color: $data_table_head;
1.701     harmsja  6117:   font-size: small;
1.507     raeburn  6118:   border-bottom: 1px solid #000000;
                   6119: }
1.795     www      6120: 
1.507     raeburn  6121: table.LC_nested_outer tr td.LC_subheader {
                   6122:   background-color: $data_table_head;
                   6123:   font-weight: bold;
                   6124:   font-size: small;
                   6125:   border-bottom: 1px solid #000000;
                   6126:   text-align: right;
1.451     albertel 6127: }
1.795     www      6128: 
1.507     raeburn  6129: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6130:   background-color: #CCCCCC;
1.451     albertel 6131:   font-weight: bold;
                   6132:   font-size: small;
1.507     raeburn  6133:   text-align: center;
                   6134: }
1.795     www      6135: 
1.589     raeburn  6136: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6137: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6138:   text-align: left;
1.451     albertel 6139: }
1.795     www      6140: 
1.507     raeburn  6141: table.LC_nested td {
1.735     bisitz   6142:   background-color: #FFFFFF;
1.451     albertel 6143:   font-size: small;
1.507     raeburn  6144: }
1.795     www      6145: 
1.507     raeburn  6146: table.LC_nested_outer tr th.LC_right_item,
                   6147: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6148: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6149: table.LC_nested tr td.LC_right_item {
1.451     albertel 6150:   text-align: right;
                   6151: }
                   6152: 
1.507     raeburn  6153: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6154:   background-color: #EEEEEE;
1.451     albertel 6155: }
                   6156: 
1.473     raeburn  6157: table.LC_createuser {
                   6158: }
                   6159: 
                   6160: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6161:   font-size: small;
1.473     raeburn  6162: }
                   6163: 
                   6164: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6165:   background-color: #CCCCCC;
1.473     raeburn  6166:   font-weight: bold;
                   6167:   text-align: center;
                   6168: }
                   6169: 
1.349     albertel 6170: table.LC_calendar {
                   6171:   border: 1px solid #000000;
                   6172:   border-collapse: collapse;
1.917     raeburn  6173:   width: 98%;
1.349     albertel 6174: }
1.795     www      6175: 
1.349     albertel 6176: table.LC_calendar_pickdate {
                   6177:   font-size: xx-small;
                   6178: }
1.795     www      6179: 
1.349     albertel 6180: table.LC_calendar tr td {
                   6181:   border: 1px solid #000000;
                   6182:   vertical-align: top;
1.917     raeburn  6183:   width: 14%;
1.349     albertel 6184: }
1.795     www      6185: 
1.349     albertel 6186: table.LC_calendar tr td.LC_calendar_day_empty {
                   6187:   background-color: $data_table_dark;
                   6188: }
1.795     www      6189: 
1.779     bisitz   6190: table.LC_calendar tr td.LC_calendar_day_current {
                   6191:   background-color: $data_table_highlight;
1.777     tempelho 6192: }
1.795     www      6193: 
1.938     bisitz   6194: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6195:   background-color: $mail_new;
                   6196: }
1.795     www      6197: 
1.938     bisitz   6198: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6199:   background-color: $mail_new_hover;
                   6200: }
1.795     www      6201: 
1.938     bisitz   6202: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6203:   background-color: $mail_read;
                   6204: }
1.795     www      6205: 
1.938     bisitz   6206: /*
                   6207: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6208:   background-color: $mail_read_hover;
                   6209: }
1.938     bisitz   6210: */
1.795     www      6211: 
1.938     bisitz   6212: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6213:   background-color: $mail_replied;
                   6214: }
1.795     www      6215: 
1.938     bisitz   6216: /*
                   6217: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6218:   background-color: $mail_replied_hover;
                   6219: }
1.938     bisitz   6220: */
1.795     www      6221: 
1.938     bisitz   6222: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6223:   background-color: $mail_other;
                   6224: }
1.795     www      6225: 
1.938     bisitz   6226: /*
                   6227: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6228:   background-color: $mail_other_hover;
                   6229: }
1.938     bisitz   6230: */
1.494     raeburn  6231: 
1.777     tempelho 6232: table.LC_data_table tr > td.LC_browser_file,
                   6233: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6234:   background: #AAEE77;
1.389     albertel 6235: }
1.795     www      6236: 
1.777     tempelho 6237: table.LC_data_table tr > td.LC_browser_file_locked,
                   6238: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6239:   background: #FFAA99;
1.387     albertel 6240: }
1.795     www      6241: 
1.777     tempelho 6242: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6243:   background: #888888;
1.779     bisitz   6244: }
1.795     www      6245: 
1.777     tempelho 6246: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6247: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6248:   background: #F8F866;
1.777     tempelho 6249: }
1.795     www      6250: 
1.696     bisitz   6251: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6252:   background: #E0E8FF;
1.387     albertel 6253: }
1.696     bisitz   6254: 
1.707     bisitz   6255: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6256:   /* background: #77FF77; */
1.707     bisitz   6257: }
1.795     www      6258: 
1.707     bisitz   6259: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6260:   border-right: 8px solid #FFFF77;
1.707     bisitz   6261: }
1.795     www      6262: 
1.707     bisitz   6263: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6264:   border-right: 8px solid #FFAA77;
1.707     bisitz   6265: }
1.795     www      6266: 
1.707     bisitz   6267: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6268:   border-right: 8px solid #FF7777;
1.707     bisitz   6269: }
1.795     www      6270: 
1.707     bisitz   6271: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6272:   border-right: 8px solid #AAFF77;
1.707     bisitz   6273: }
1.795     www      6274: 
1.707     bisitz   6275: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6276:   border-right: 8px solid #11CC55;
1.707     bisitz   6277: }
                   6278: 
1.388     albertel 6279: span.LC_current_location {
1.701     harmsja  6280:   font-size:larger;
1.388     albertel 6281:   background: $pgbg;
                   6282: }
1.387     albertel 6283: 
1.1029    www      6284: span.LC_current_nav_location {
                   6285:   font-weight:bold;
                   6286:   background: $sidebg;
                   6287: }
                   6288: 
1.395     albertel 6289: span.LC_parm_menu_item {
                   6290:   font-size: larger;
                   6291: }
1.795     www      6292: 
1.395     albertel 6293: span.LC_parm_scope_all {
                   6294:   color: red;
                   6295: }
1.795     www      6296: 
1.395     albertel 6297: span.LC_parm_scope_folder {
                   6298:   color: green;
                   6299: }
1.795     www      6300: 
1.395     albertel 6301: span.LC_parm_scope_resource {
                   6302:   color: orange;
                   6303: }
1.795     www      6304: 
1.395     albertel 6305: span.LC_parm_part {
                   6306:   color: blue;
                   6307: }
1.795     www      6308: 
1.911     bisitz   6309: span.LC_parm_folder,
                   6310: span.LC_parm_symb {
1.395     albertel 6311:   font-size: x-small;
                   6312:   font-family: $mono;
                   6313:   color: #AAAAAA;
                   6314: }
                   6315: 
1.977     bisitz   6316: ul.LC_parm_parmlist li {
                   6317:   display: inline-block;
                   6318:   padding: 0.3em 0.8em;
                   6319:   vertical-align: top;
                   6320:   width: 150px;
                   6321:   border-top:1px solid $lg_border_color;
                   6322: }
                   6323: 
1.795     www      6324: td.LC_parm_overview_level_menu,
                   6325: td.LC_parm_overview_map_menu,
                   6326: td.LC_parm_overview_parm_selectors,
                   6327: td.LC_parm_overview_restrictions  {
1.396     albertel 6328:   border: 1px solid black;
                   6329:   border-collapse: collapse;
                   6330: }
1.795     www      6331: 
1.396     albertel 6332: table.LC_parm_overview_restrictions td {
                   6333:   border-width: 1px 4px 1px 4px;
                   6334:   border-style: solid;
                   6335:   border-color: $pgbg;
                   6336:   text-align: center;
                   6337: }
1.795     www      6338: 
1.396     albertel 6339: table.LC_parm_overview_restrictions th {
                   6340:   background: $tabbg;
                   6341:   border-width: 1px 4px 1px 4px;
                   6342:   border-style: solid;
                   6343:   border-color: $pgbg;
                   6344: }
1.795     www      6345: 
1.398     albertel 6346: table#LC_helpmenu {
1.803     bisitz   6347:   border: none;
1.398     albertel 6348:   height: 55px;
1.803     bisitz   6349:   border-spacing: 0;
1.398     albertel 6350: }
                   6351: 
                   6352: table#LC_helpmenu fieldset legend {
                   6353:   font-size: larger;
                   6354: }
1.795     www      6355: 
1.397     albertel 6356: table#LC_helpmenu_links {
                   6357:   width: 100%;
                   6358:   border: 1px solid black;
                   6359:   background: $pgbg;
1.803     bisitz   6360:   padding: 0;
1.397     albertel 6361:   border-spacing: 1px;
                   6362: }
1.795     www      6363: 
1.397     albertel 6364: table#LC_helpmenu_links tr td {
                   6365:   padding: 1px;
                   6366:   background: $tabbg;
1.399     albertel 6367:   text-align: center;
                   6368:   font-weight: bold;
1.397     albertel 6369: }
1.396     albertel 6370: 
1.795     www      6371: table#LC_helpmenu_links a:link,
                   6372: table#LC_helpmenu_links a:visited,
1.397     albertel 6373: table#LC_helpmenu_links a:active {
                   6374:   text-decoration: none;
                   6375:   color: $font;
                   6376: }
1.795     www      6377: 
1.397     albertel 6378: table#LC_helpmenu_links a:hover {
                   6379:   text-decoration: underline;
                   6380:   color: $vlink;
                   6381: }
1.396     albertel 6382: 
1.417     albertel 6383: .LC_chrt_popup_exists {
                   6384:   border: 1px solid #339933;
                   6385:   margin: -1px;
                   6386: }
1.795     www      6387: 
1.417     albertel 6388: .LC_chrt_popup_up {
                   6389:   border: 1px solid yellow;
                   6390:   margin: -1px;
                   6391: }
1.795     www      6392: 
1.417     albertel 6393: .LC_chrt_popup {
                   6394:   border: 1px solid #8888FF;
                   6395:   background: #CCCCFF;
                   6396: }
1.795     www      6397: 
1.421     albertel 6398: table.LC_pick_box {
                   6399:   border-collapse: separate;
                   6400:   background: white;
                   6401:   border: 1px solid black;
                   6402:   border-spacing: 1px;
                   6403: }
1.795     www      6404: 
1.421     albertel 6405: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6406:   background: $sidebg;
1.421     albertel 6407:   font-weight: bold;
1.900     bisitz   6408:   text-align: left;
1.740     bisitz   6409:   vertical-align: top;
1.421     albertel 6410:   width: 184px;
                   6411:   padding: 8px;
                   6412: }
1.795     www      6413: 
1.579     raeburn  6414: table.LC_pick_box td.LC_pick_box_value {
                   6415:   text-align: left;
                   6416:   padding: 8px;
                   6417: }
1.795     www      6418: 
1.579     raeburn  6419: table.LC_pick_box td.LC_pick_box_select {
                   6420:   text-align: left;
                   6421:   padding: 8px;
                   6422: }
1.795     www      6423: 
1.424     albertel 6424: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6425:   padding: 0;
1.421     albertel 6426:   height: 1px;
                   6427:   background: black;
                   6428: }
1.795     www      6429: 
1.421     albertel 6430: table.LC_pick_box td.LC_pick_box_submit {
                   6431:   text-align: right;
                   6432: }
1.795     www      6433: 
1.579     raeburn  6434: table.LC_pick_box td.LC_evenrow_value {
                   6435:   text-align: left;
                   6436:   padding: 8px;
                   6437:   background-color: $data_table_light;
                   6438: }
1.795     www      6439: 
1.579     raeburn  6440: table.LC_pick_box td.LC_oddrow_value {
                   6441:   text-align: left;
                   6442:   padding: 8px;
                   6443:   background-color: $data_table_light;
                   6444: }
1.795     www      6445: 
1.579     raeburn  6446: span.LC_helpform_receipt_cat {
                   6447:   font-weight: bold;
                   6448: }
1.795     www      6449: 
1.424     albertel 6450: table.LC_group_priv_box {
                   6451:   background: white;
                   6452:   border: 1px solid black;
                   6453:   border-spacing: 1px;
                   6454: }
1.795     www      6455: 
1.424     albertel 6456: table.LC_group_priv_box td.LC_pick_box_title {
                   6457:   background: $tabbg;
                   6458:   font-weight: bold;
                   6459:   text-align: right;
                   6460:   width: 184px;
                   6461: }
1.795     www      6462: 
1.424     albertel 6463: table.LC_group_priv_box td.LC_groups_fixed {
                   6464:   background: $data_table_light;
                   6465:   text-align: center;
                   6466: }
1.795     www      6467: 
1.424     albertel 6468: table.LC_group_priv_box td.LC_groups_optional {
                   6469:   background: $data_table_dark;
                   6470:   text-align: center;
                   6471: }
1.795     www      6472: 
1.424     albertel 6473: table.LC_group_priv_box td.LC_groups_functionality {
                   6474:   background: $data_table_darker;
                   6475:   text-align: center;
                   6476:   font-weight: bold;
                   6477: }
1.795     www      6478: 
1.424     albertel 6479: table.LC_group_priv td {
                   6480:   text-align: left;
1.803     bisitz   6481:   padding: 0;
1.424     albertel 6482: }
                   6483: 
                   6484: .LC_navbuttons {
                   6485:   margin: 2ex 0ex 2ex 0ex;
                   6486: }
1.795     www      6487: 
1.423     albertel 6488: .LC_topic_bar {
                   6489:   font-weight: bold;
                   6490:   background: $tabbg;
1.918     wenzelju 6491:   margin: 1em 0em 1em 2em;
1.805     bisitz   6492:   padding: 3px;
1.918     wenzelju 6493:   font-size: 1.2em;
1.423     albertel 6494: }
1.795     www      6495: 
1.423     albertel 6496: .LC_topic_bar span {
1.918     wenzelju 6497:   left: 0.5em;
                   6498:   position: absolute;
1.423     albertel 6499:   vertical-align: middle;
1.918     wenzelju 6500:   font-size: 1.2em;
1.423     albertel 6501: }
1.795     www      6502: 
1.423     albertel 6503: table.LC_course_group_status {
                   6504:   margin: 20px;
                   6505: }
1.795     www      6506: 
1.423     albertel 6507: table.LC_status_selector td {
                   6508:   vertical-align: top;
                   6509:   text-align: center;
1.424     albertel 6510:   padding: 4px;
                   6511: }
1.795     www      6512: 
1.599     albertel 6513: div.LC_feedback_link {
1.616     albertel 6514:   clear: both;
1.829     kalberla 6515:   background: $sidebg;
1.779     bisitz   6516:   width: 100%;
1.829     kalberla 6517:   padding-bottom: 10px;
                   6518:   border: 1px $tabbg solid;
1.833     kalberla 6519:   height: 22px;
                   6520:   line-height: 22px;
                   6521:   padding-top: 5px;
                   6522: }
                   6523: 
                   6524: div.LC_feedback_link img {
                   6525:   height: 22px;
1.867     kalberla 6526:   vertical-align:middle;
1.829     kalberla 6527: }
                   6528: 
1.911     bisitz   6529: div.LC_feedback_link a {
1.829     kalberla 6530:   text-decoration: none;
1.489     raeburn  6531: }
1.795     www      6532: 
1.867     kalberla 6533: div.LC_comblock {
1.911     bisitz   6534:   display:inline;
1.867     kalberla 6535:   color:$font;
                   6536:   font-size:90%;
                   6537: }
                   6538: 
                   6539: div.LC_feedback_link div.LC_comblock {
                   6540:   padding-left:5px;
                   6541: }
                   6542: 
                   6543: div.LC_feedback_link div.LC_comblock a {
                   6544:   color:$font;
                   6545: }
                   6546: 
1.489     raeburn  6547: span.LC_feedback_link {
1.858     bisitz   6548:   /* background: $feedback_link_bg; */
1.599     albertel 6549:   font-size: larger;
                   6550: }
1.795     www      6551: 
1.599     albertel 6552: span.LC_message_link {
1.858     bisitz   6553:   /* background: $feedback_link_bg; */
1.599     albertel 6554:   font-size: larger;
                   6555:   position: absolute;
                   6556:   right: 1em;
1.489     raeburn  6557: }
1.421     albertel 6558: 
1.515     albertel 6559: table.LC_prior_tries {
1.524     albertel 6560:   border: 1px solid #000000;
                   6561:   border-collapse: separate;
                   6562:   border-spacing: 1px;
1.515     albertel 6563: }
1.523     albertel 6564: 
1.515     albertel 6565: table.LC_prior_tries td {
1.524     albertel 6566:   padding: 2px;
1.515     albertel 6567: }
1.523     albertel 6568: 
                   6569: .LC_answer_correct {
1.795     www      6570:   background: lightgreen;
                   6571:   color: darkgreen;
                   6572:   padding: 6px;
1.523     albertel 6573: }
1.795     www      6574: 
1.523     albertel 6575: .LC_answer_charged_try {
1.797     www      6576:   background: #FFAAAA;
1.795     www      6577:   color: darkred;
                   6578:   padding: 6px;
1.523     albertel 6579: }
1.795     www      6580: 
1.779     bisitz   6581: .LC_answer_not_charged_try,
1.523     albertel 6582: .LC_answer_no_grade,
                   6583: .LC_answer_late {
1.795     www      6584:   background: lightyellow;
1.523     albertel 6585:   color: black;
1.795     www      6586:   padding: 6px;
1.523     albertel 6587: }
1.795     www      6588: 
1.523     albertel 6589: .LC_answer_previous {
1.795     www      6590:   background: lightblue;
                   6591:   color: darkblue;
                   6592:   padding: 6px;
1.523     albertel 6593: }
1.795     www      6594: 
1.779     bisitz   6595: .LC_answer_no_message {
1.777     tempelho 6596:   background: #FFFFFF;
                   6597:   color: black;
1.795     www      6598:   padding: 6px;
1.779     bisitz   6599: }
1.795     www      6600: 
1.779     bisitz   6601: .LC_answer_unknown {
                   6602:   background: orange;
                   6603:   color: black;
1.795     www      6604:   padding: 6px;
1.777     tempelho 6605: }
1.795     www      6606: 
1.529     albertel 6607: span.LC_prior_numerical,
                   6608: span.LC_prior_string,
                   6609: span.LC_prior_custom,
                   6610: span.LC_prior_reaction,
                   6611: span.LC_prior_math {
1.925     bisitz   6612:   font-family: $mono;
1.523     albertel 6613:   white-space: pre;
                   6614: }
                   6615: 
1.525     albertel 6616: span.LC_prior_string {
1.925     bisitz   6617:   font-family: $mono;
1.525     albertel 6618:   white-space: pre;
                   6619: }
                   6620: 
1.523     albertel 6621: table.LC_prior_option {
                   6622:   width: 100%;
                   6623:   border-collapse: collapse;
                   6624: }
1.795     www      6625: 
1.911     bisitz   6626: table.LC_prior_rank,
1.795     www      6627: table.LC_prior_match {
1.528     albertel 6628:   border-collapse: collapse;
                   6629: }
1.795     www      6630: 
1.528     albertel 6631: table.LC_prior_option tr td,
                   6632: table.LC_prior_rank tr td,
                   6633: table.LC_prior_match tr td {
1.524     albertel 6634:   border: 1px solid #000000;
1.515     albertel 6635: }
                   6636: 
1.855     bisitz   6637: .LC_nobreak {
1.544     albertel 6638:   white-space: nowrap;
1.519     raeburn  6639: }
                   6640: 
1.576     raeburn  6641: span.LC_cusr_emph {
                   6642:   font-style: italic;
                   6643: }
                   6644: 
1.633     raeburn  6645: span.LC_cusr_subheading {
                   6646:   font-weight: normal;
                   6647:   font-size: 85%;
                   6648: }
                   6649: 
1.861     bisitz   6650: div.LC_docs_entry_move {
1.859     bisitz   6651:   border: 1px solid #BBBBBB;
1.545     albertel 6652:   background: #DDDDDD;
1.861     bisitz   6653:   width: 22px;
1.859     bisitz   6654:   padding: 1px;
                   6655:   margin: 0;
1.545     albertel 6656: }
                   6657: 
1.861     bisitz   6658: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6659: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6660:   font-size: x-small;
                   6661: }
1.795     www      6662: 
1.861     bisitz   6663: .LC_docs_entry_parameter {
                   6664:   white-space: nowrap;
                   6665: }
                   6666: 
1.544     albertel 6667: .LC_docs_copy {
1.545     albertel 6668:   color: #000099;
1.544     albertel 6669: }
1.795     www      6670: 
1.544     albertel 6671: .LC_docs_cut {
1.545     albertel 6672:   color: #550044;
1.544     albertel 6673: }
1.795     www      6674: 
1.544     albertel 6675: .LC_docs_rename {
1.545     albertel 6676:   color: #009900;
1.544     albertel 6677: }
1.795     www      6678: 
1.544     albertel 6679: .LC_docs_remove {
1.545     albertel 6680:   color: #990000;
                   6681: }
                   6682: 
1.547     albertel 6683: .LC_docs_reinit_warn,
                   6684: .LC_docs_ext_edit {
                   6685:   font-size: x-small;
                   6686: }
                   6687: 
1.545     albertel 6688: table.LC_docs_adddocs td,
                   6689: table.LC_docs_adddocs th {
                   6690:   border: 1px solid #BBBBBB;
                   6691:   padding: 4px;
                   6692:   background: #DDDDDD;
1.543     albertel 6693: }
                   6694: 
1.584     albertel 6695: table.LC_sty_begin {
                   6696:   background: #BBFFBB;
                   6697: }
1.795     www      6698: 
1.584     albertel 6699: table.LC_sty_end {
                   6700:   background: #FFBBBB;
                   6701: }
                   6702: 
1.589     raeburn  6703: table.LC_double_column {
1.803     bisitz   6704:   border-width: 0;
1.589     raeburn  6705:   border-collapse: collapse;
                   6706:   width: 100%;
                   6707:   padding: 2px;
                   6708: }
                   6709: 
                   6710: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6711:   top: 2px;
1.589     raeburn  6712:   left: 2px;
                   6713:   width: 47%;
                   6714:   vertical-align: top;
                   6715: }
                   6716: 
                   6717: table.LC_double_column tr td.LC_right_col {
                   6718:   top: 2px;
1.779     bisitz   6719:   right: 2px;
1.589     raeburn  6720:   width: 47%;
                   6721:   vertical-align: top;
                   6722: }
                   6723: 
1.591     raeburn  6724: div.LC_left_float {
                   6725:   float: left;
                   6726:   padding-right: 5%;
1.597     albertel 6727:   padding-bottom: 4px;
1.591     raeburn  6728: }
                   6729: 
                   6730: div.LC_clear_float_header {
1.597     albertel 6731:   padding-bottom: 2px;
1.591     raeburn  6732: }
                   6733: 
                   6734: div.LC_clear_float_footer {
1.597     albertel 6735:   padding-top: 10px;
1.591     raeburn  6736:   clear: both;
                   6737: }
                   6738: 
1.597     albertel 6739: div.LC_grade_show_user {
1.941     bisitz   6740: /*  border-left: 5px solid $sidebg; */
                   6741:   border-top: 5px solid #000000;
                   6742:   margin: 50px 0 0 0;
1.936     bisitz   6743:   padding: 15px 0 5px 10px;
1.597     albertel 6744: }
1.795     www      6745: 
1.936     bisitz   6746: div.LC_grade_show_user_odd_row {
1.941     bisitz   6747: /*  border-left: 5px solid #000000; */
                   6748: }
                   6749: 
                   6750: div.LC_grade_show_user div.LC_Box {
                   6751:   margin-right: 50px;
1.597     albertel 6752: }
                   6753: 
                   6754: div.LC_grade_submissions,
                   6755: div.LC_grade_message_center,
1.936     bisitz   6756: div.LC_grade_info_links {
1.597     albertel 6757:   margin: 5px;
                   6758:   width: 99%;
                   6759:   background: #FFFFFF;
                   6760: }
1.795     www      6761: 
1.597     albertel 6762: div.LC_grade_submissions_header,
1.936     bisitz   6763: div.LC_grade_message_center_header {
1.705     tempelho 6764:   font-weight: bold;
                   6765:   font-size: large;
1.597     albertel 6766: }
1.795     www      6767: 
1.597     albertel 6768: div.LC_grade_submissions_body,
1.936     bisitz   6769: div.LC_grade_message_center_body {
1.597     albertel 6770:   border: 1px solid black;
                   6771:   width: 99%;
                   6772:   background: #FFFFFF;
                   6773: }
1.795     www      6774: 
1.613     albertel 6775: table.LC_scantron_action {
                   6776:   width: 100%;
                   6777: }
1.795     www      6778: 
1.613     albertel 6779: table.LC_scantron_action tr th {
1.698     harmsja  6780:   font-weight:bold;
                   6781:   font-style:normal;
1.613     albertel 6782: }
1.795     www      6783: 
1.779     bisitz   6784: .LC_edit_problem_header,
1.614     albertel 6785: div.LC_edit_problem_footer {
1.705     tempelho 6786:   font-weight: normal;
                   6787:   font-size:  medium;
1.602     albertel 6788:   margin: 2px;
1.1060    bisitz   6789:   background-color: $sidebg;
1.600     albertel 6790: }
1.795     www      6791: 
1.600     albertel 6792: div.LC_edit_problem_header,
1.602     albertel 6793: div.LC_edit_problem_header div,
1.614     albertel 6794: div.LC_edit_problem_footer,
                   6795: div.LC_edit_problem_footer div,
1.602     albertel 6796: div.LC_edit_problem_editxml_header,
                   6797: div.LC_edit_problem_editxml_header div {
1.600     albertel 6798:   margin-top: 5px;
1.1205    golterma 6799:   z-index: 100;
1.600     albertel 6800: }
1.795     www      6801: 
1.600     albertel 6802: div.LC_edit_problem_header_title {
1.705     tempelho 6803:   font-weight: bold;
                   6804:   font-size: larger;
1.602     albertel 6805:   background: $tabbg;
                   6806:   padding: 3px;
1.1060    bisitz   6807:   margin: 0 0 5px 0;
1.602     albertel 6808: }
1.795     www      6809: 
1.602     albertel 6810: table.LC_edit_problem_header_title {
                   6811:   width: 100%;
1.600     albertel 6812:   background: $tabbg;
1.602     albertel 6813: }
                   6814: 
                   6815: div.LC_edit_problem_discards {
                   6816:   float: left;
1.1205    golterma 6817: }
                   6818: 
                   6819: div.LC_edit_actionbar {
                   6820:     margin: -5px 0px 0px 0px !important;
                   6821:     background-color: $sidebg;
                   6822:     height: 31px;
1.602     albertel 6823: }
1.795     www      6824: 
1.602     albertel 6825: div.LC_edit_problem_saves {
                   6826:   float: right;
                   6827:   padding-bottom: 5px;
1.600     albertel 6828: }
1.795     www      6829: 
1.1124    bisitz   6830: .LC_edit_opt {
                   6831:   padding-left: 1em;
                   6832:   white-space: nowrap;
                   6833: }
                   6834: 
1.1152    golterma 6835: .LC_edit_problem_latexhelper{
                   6836:     text-align: right;
                   6837: }
                   6838: 
                   6839: #LC_edit_problem_colorful div{
                   6840:     margin-left: 40px;
                   6841: }
                   6842: 
1.1205    golterma 6843: #LC_edit_problem_codemirror div{
                   6844:     margin-left: 0px;
                   6845: }
                   6846: 
1.911     bisitz   6847: img.stift {
1.803     bisitz   6848:   border-width: 0;
                   6849:   vertical-align: middle;
1.677     riegler  6850: }
1.680     riegler  6851: 
1.923     bisitz   6852: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6853:   vertical-align: top;
1.777     tempelho 6854: }
1.795     www      6855: 
1.716     raeburn  6856: div.LC_createcourse {
1.911     bisitz   6857:   margin: 10px 10px 10px 10px;
1.716     raeburn  6858: }
                   6859: 
1.917     raeburn  6860: .LC_dccid {
1.1130    raeburn  6861:   float: right;
1.917     raeburn  6862:   margin: 0.2em 0 0 0;
                   6863:   padding: 0;
                   6864:   font-size: 90%;
                   6865:   display:none;
                   6866: }
                   6867: 
1.897     wenzelju 6868: ol.LC_primary_menu a:hover,
1.721     harmsja  6869: ol#LC_MenuBreadcrumbs a:hover,
                   6870: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6871: ul#LC_secondary_menu a:hover,
1.721     harmsja  6872: .LC_FormSectionClearButton input:hover
1.795     www      6873: ul.LC_TabContent   li:hover a {
1.952     onken    6874:   color:$button_hover;
1.911     bisitz   6875:   text-decoration:none;
1.693     droeschl 6876: }
                   6877: 
1.779     bisitz   6878: h1 {
1.911     bisitz   6879:   padding: 0;
                   6880:   line-height:130%;
1.693     droeschl 6881: }
1.698     harmsja  6882: 
1.911     bisitz   6883: h2,
                   6884: h3,
                   6885: h4,
                   6886: h5,
                   6887: h6 {
                   6888:   margin: 5px 0 5px 0;
                   6889:   padding: 0;
                   6890:   line-height:130%;
1.693     droeschl 6891: }
1.795     www      6892: 
                   6893: .LC_hcell {
1.911     bisitz   6894:   padding:3px 15px 3px 15px;
                   6895:   margin: 0;
                   6896:   background-color:$tabbg;
                   6897:   color:$fontmenu;
                   6898:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6899: }
1.795     www      6900: 
1.840     bisitz   6901: .LC_Box > .LC_hcell {
1.911     bisitz   6902:   margin: 0 -10px 10px -10px;
1.835     bisitz   6903: }
                   6904: 
1.721     harmsja  6905: .LC_noBorder {
1.911     bisitz   6906:   border: 0;
1.698     harmsja  6907: }
1.693     droeschl 6908: 
1.721     harmsja  6909: .LC_FormSectionClearButton input {
1.911     bisitz   6910:   background-color:transparent;
                   6911:   border: none;
                   6912:   cursor:pointer;
                   6913:   text-decoration:underline;
1.693     droeschl 6914: }
1.763     bisitz   6915: 
                   6916: .LC_help_open_topic {
1.911     bisitz   6917:   color: #FFFFFF;
                   6918:   background-color: #EEEEFF;
                   6919:   margin: 1px;
                   6920:   padding: 4px;
                   6921:   border: 1px solid #000033;
                   6922:   white-space: nowrap;
                   6923:   /* vertical-align: middle; */
1.759     neumanie 6924: }
1.693     droeschl 6925: 
1.911     bisitz   6926: dl,
                   6927: ul,
                   6928: div,
                   6929: fieldset {
                   6930:   margin: 10px 10px 10px 0;
                   6931:   /* overflow: hidden; */
1.693     droeschl 6932: }
1.795     www      6933: 
1.838     bisitz   6934: fieldset > legend {
1.911     bisitz   6935:   font-weight: bold;
                   6936:   padding: 0 5px 0 5px;
1.838     bisitz   6937: }
                   6938: 
1.813     bisitz   6939: #LC_nav_bar {
1.911     bisitz   6940:   float: left;
1.995     raeburn  6941:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6942:   margin: 0 0 2px 0;
1.807     droeschl 6943: }
                   6944: 
1.916     droeschl 6945: #LC_realm {
                   6946:   margin: 0.2em 0 0 0;
                   6947:   padding: 0;
                   6948:   font-weight: bold;
                   6949:   text-align: center;
1.995     raeburn  6950:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6951: }
                   6952: 
1.911     bisitz   6953: #LC_nav_bar em {
                   6954:   font-weight: bold;
                   6955:   font-style: normal;
1.807     droeschl 6956: }
                   6957: 
1.897     wenzelju 6958: ol.LC_primary_menu {
1.934     droeschl 6959:   margin: 0;
1.1076    raeburn  6960:   padding: 0;
1.807     droeschl 6961: }
                   6962: 
1.852     droeschl 6963: ol#LC_PathBreadcrumbs {
1.911     bisitz   6964:   margin: 0;
1.693     droeschl 6965: }
                   6966: 
1.897     wenzelju 6967: ol.LC_primary_menu li {
1.1076    raeburn  6968:   color: RGB(80, 80, 80);
                   6969:   vertical-align: middle;
                   6970:   text-align: left;
                   6971:   list-style: none;
1.1205    golterma 6972:   position: relative;
1.1076    raeburn  6973:   float: left;
1.1205    golterma 6974:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   6975:   line-height: 1.5em;
1.1076    raeburn  6976: }
                   6977: 
1.1205    golterma 6978: ol.LC_primary_menu li a,
                   6979: ol.LC_primary_menu li p {
1.1076    raeburn  6980:   display: block;
                   6981:   margin: 0;
                   6982:   padding: 0 5px 0 10px;
                   6983:   text-decoration: none;
                   6984: }
                   6985: 
1.1205    golterma 6986: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   6987:   display: inline-block;
                   6988:   width: 95%;
                   6989:   text-align: left;
                   6990: }
                   6991: 
                   6992: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   6993:   display: inline-block;	
                   6994:   width: 5%;
                   6995:   float: right;
                   6996:   text-align: right;
                   6997:   font-size: 70%;
                   6998: }
                   6999: 
                   7000: ol.LC_primary_menu ul {
1.1076    raeburn  7001:   display: none;
1.1205    golterma 7002:   width: 15em;
1.1076    raeburn  7003:   background-color: $data_table_light;
1.1205    golterma 7004:   position: absolute;
                   7005:   top: 100%;
1.1076    raeburn  7006: }
                   7007: 
1.1205    golterma 7008: ol.LC_primary_menu ul ul {
                   7009:   left: 100%;
                   7010:   top: 0;
                   7011: }
                   7012: 
                   7013: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076    raeburn  7014:   display: block;
                   7015:   position: absolute;
                   7016:   margin: 0;
                   7017:   padding: 0;
1.1078    raeburn  7018:   z-index: 2;
1.1076    raeburn  7019: }
                   7020: 
                   7021: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205    golterma 7022: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076    raeburn  7023:   font-size: 90%;
1.911     bisitz   7024:   vertical-align: top;
1.1076    raeburn  7025:   float: none;
1.1079    raeburn  7026:   border-left: 1px solid black;
                   7027:   border-right: 1px solid black;
1.1205    golterma 7028: /* A dark bottom border to visualize different menu options; 
                   7029: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7030:   border-bottom: 1px solid $data_table_dark; 
1.1076    raeburn  7031: }
                   7032: 
1.1205    golterma 7033: ol.LC_primary_menu li li p:hover {
                   7034:   color:$button_hover;
                   7035:   text-decoration:none;
                   7036:   background-color:$data_table_dark;
1.1076    raeburn  7037: }
                   7038: 
                   7039: ol.LC_primary_menu li li a:hover {
                   7040:    color:$button_hover;
                   7041:    background-color:$data_table_dark;
1.693     droeschl 7042: }
                   7043: 
1.1205    golterma 7044: /* Font-size equal to the size of the predecessors*/
                   7045: ol.LC_primary_menu li:hover li li {
                   7046:   font-size: 100%;
                   7047: }
                   7048: 
1.897     wenzelju 7049: ol.LC_primary_menu li img {
1.911     bisitz   7050:   vertical-align: bottom;
1.934     droeschl 7051:   height: 1.1em;
1.1077    raeburn  7052:   margin: 0.2em 0 0 0;
1.693     droeschl 7053: }
                   7054: 
1.897     wenzelju 7055: ol.LC_primary_menu a {
1.911     bisitz   7056:   color: RGB(80, 80, 80);
                   7057:   text-decoration: none;
1.693     droeschl 7058: }
1.795     www      7059: 
1.949     droeschl 7060: ol.LC_primary_menu a.LC_new_message {
                   7061:   font-weight:bold;
                   7062:   color: darkred;
                   7063: }
                   7064: 
1.975     raeburn  7065: ol.LC_docs_parameters {
                   7066:   margin-left: 0;
                   7067:   padding: 0;
                   7068:   list-style: none;
                   7069: }
                   7070: 
                   7071: ol.LC_docs_parameters li {
                   7072:   margin: 0;
                   7073:   padding-right: 20px;
                   7074:   display: inline;
                   7075: }
                   7076: 
1.976     raeburn  7077: ol.LC_docs_parameters li:before {
                   7078:   content: "\\002022 \\0020";
                   7079: }
                   7080: 
                   7081: li.LC_docs_parameters_title {
                   7082:   font-weight: bold;
                   7083: }
                   7084: 
                   7085: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7086:   content: "";
                   7087: }
                   7088: 
1.897     wenzelju 7089: ul#LC_secondary_menu {
1.1107    raeburn  7090:   clear: right;
1.911     bisitz   7091:   color: $fontmenu;
                   7092:   background: $tabbg;
                   7093:   list-style: none;
                   7094:   padding: 0;
                   7095:   margin: 0;
                   7096:   width: 100%;
1.995     raeburn  7097:   text-align: left;
1.1107    raeburn  7098:   float: left;
1.808     droeschl 7099: }
                   7100: 
1.897     wenzelju 7101: ul#LC_secondary_menu li {
1.911     bisitz   7102:   font-weight: bold;
                   7103:   line-height: 1.8em;
1.1107    raeburn  7104:   border-right: 1px solid black;
                   7105:   float: left;
                   7106: }
                   7107: 
                   7108: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7109:   background-color: $data_table_light;
                   7110: }
                   7111: 
                   7112: ul#LC_secondary_menu li a {
1.911     bisitz   7113:   padding: 0 0.8em;
1.1107    raeburn  7114: }
                   7115: 
                   7116: ul#LC_secondary_menu li ul {
                   7117:   display: none;
                   7118: }
                   7119: 
                   7120: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7121:   display: block;
                   7122:   position: absolute;
                   7123:   margin: 0;
                   7124:   padding: 0;
                   7125:   list-style:none;
                   7126:   float: none;
                   7127:   background-color: $data_table_light;
                   7128:   z-index: 2;
                   7129:   margin-left: -1px;
                   7130: }
                   7131: 
                   7132: ul#LC_secondary_menu li ul li {
                   7133:   font-size: 90%;
                   7134:   vertical-align: top;
                   7135:   border-left: 1px solid black;
1.911     bisitz   7136:   border-right: 1px solid black;
1.1119    raeburn  7137:   background-color: $data_table_light;
1.1107    raeburn  7138:   list-style:none;
                   7139:   float: none;
                   7140: }
                   7141: 
                   7142: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7143:   background-color: $data_table_dark;
1.807     droeschl 7144: }
                   7145: 
1.847     tempelho 7146: ul.LC_TabContent {
1.911     bisitz   7147:   display:block;
                   7148:   background: $sidebg;
                   7149:   border-bottom: solid 1px $lg_border_color;
                   7150:   list-style:none;
1.1020    raeburn  7151:   margin: -1px -10px 0 -10px;
1.911     bisitz   7152:   padding: 0;
1.693     droeschl 7153: }
                   7154: 
1.795     www      7155: ul.LC_TabContent li,
                   7156: ul.LC_TabContentBigger li {
1.911     bisitz   7157:   float:left;
1.741     harmsja  7158: }
1.795     www      7159: 
1.897     wenzelju 7160: ul#LC_secondary_menu li a {
1.911     bisitz   7161:   color: $fontmenu;
                   7162:   text-decoration: none;
1.693     droeschl 7163: }
1.795     www      7164: 
1.721     harmsja  7165: ul.LC_TabContent {
1.952     onken    7166:   min-height:20px;
1.721     harmsja  7167: }
1.795     www      7168: 
                   7169: ul.LC_TabContent li {
1.911     bisitz   7170:   vertical-align:middle;
1.959     onken    7171:   padding: 0 16px 0 10px;
1.911     bisitz   7172:   background-color:$tabbg;
                   7173:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7174:   border-left: solid 1px $font;
1.721     harmsja  7175: }
1.795     www      7176: 
1.847     tempelho 7177: ul.LC_TabContent .right {
1.911     bisitz   7178:   float:right;
1.847     tempelho 7179: }
                   7180: 
1.911     bisitz   7181: ul.LC_TabContent li a,
                   7182: ul.LC_TabContent li {
                   7183:   color:rgb(47,47,47);
                   7184:   text-decoration:none;
                   7185:   font-size:95%;
                   7186:   font-weight:bold;
1.952     onken    7187:   min-height:20px;
                   7188: }
                   7189: 
1.959     onken    7190: ul.LC_TabContent li a:hover,
                   7191: ul.LC_TabContent li a:focus {
1.952     onken    7192:   color: $button_hover;
1.959     onken    7193:   background:none;
                   7194:   outline:none;
1.952     onken    7195: }
                   7196: 
                   7197: ul.LC_TabContent li:hover {
                   7198:   color: $button_hover;
                   7199:   cursor:pointer;
1.721     harmsja  7200: }
1.795     www      7201: 
1.911     bisitz   7202: ul.LC_TabContent li.active {
1.952     onken    7203:   color: $font;
1.911     bisitz   7204:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7205:   border-bottom:solid 1px #FFFFFF;
                   7206:   cursor: default;
1.744     ehlerst  7207: }
1.795     www      7208: 
1.959     onken    7209: ul.LC_TabContent li.active a {
                   7210:   color:$font;
                   7211:   background:#FFFFFF;
                   7212:   outline: none;
                   7213: }
1.1047    raeburn  7214: 
                   7215: ul.LC_TabContent li.goback {
                   7216:   float: left;
                   7217:   border-left: none;
                   7218: }
                   7219: 
1.870     tempelho 7220: #maincoursedoc {
1.911     bisitz   7221:   clear:both;
1.870     tempelho 7222: }
                   7223: 
                   7224: ul.LC_TabContentBigger {
1.911     bisitz   7225:   display:block;
                   7226:   list-style:none;
                   7227:   padding: 0;
1.870     tempelho 7228: }
                   7229: 
1.795     www      7230: ul.LC_TabContentBigger li {
1.911     bisitz   7231:   vertical-align:bottom;
                   7232:   height: 30px;
                   7233:   font-size:110%;
                   7234:   font-weight:bold;
                   7235:   color: #737373;
1.841     tempelho 7236: }
                   7237: 
1.957     onken    7238: ul.LC_TabContentBigger li.active {
                   7239:   position: relative;
                   7240:   top: 1px;
                   7241: }
                   7242: 
1.870     tempelho 7243: ul.LC_TabContentBigger li a {
1.911     bisitz   7244:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7245:   height: 30px;
                   7246:   line-height: 30px;
                   7247:   text-align: center;
                   7248:   display: block;
                   7249:   text-decoration: none;
1.958     onken    7250:   outline: none;  
1.741     harmsja  7251: }
1.795     www      7252: 
1.870     tempelho 7253: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7254:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7255:   color:$font;
1.744     ehlerst  7256: }
1.795     www      7257: 
1.870     tempelho 7258: ul.LC_TabContentBigger li b {
1.911     bisitz   7259:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7260:   display: block;
                   7261:   float: left;
                   7262:   padding: 0 30px;
1.957     onken    7263:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7264: }
                   7265: 
1.956     onken    7266: ul.LC_TabContentBigger li:hover b {
                   7267:   color:$button_hover;
                   7268: }
                   7269: 
1.870     tempelho 7270: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7271:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7272:   color:$font;
1.957     onken    7273:   border: 0;
1.741     harmsja  7274: }
1.693     droeschl 7275: 
1.870     tempelho 7276: 
1.862     bisitz   7277: ul.LC_CourseBreadcrumbs {
                   7278:   background: $sidebg;
1.1020    raeburn  7279:   height: 2em;
1.862     bisitz   7280:   padding-left: 10px;
1.1020    raeburn  7281:   margin: 0;
1.862     bisitz   7282:   list-style-position: inside;
                   7283: }
                   7284: 
1.911     bisitz   7285: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7286: ol#LC_PathBreadcrumbs {
1.911     bisitz   7287:   padding-left: 10px;
                   7288:   margin: 0;
1.933     droeschl 7289:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7290: }
                   7291: 
1.911     bisitz   7292: ol#LC_MenuBreadcrumbs li,
                   7293: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7294: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7295:   display: inline;
1.933     droeschl 7296:   white-space: normal;  
1.693     droeschl 7297: }
                   7298: 
1.823     bisitz   7299: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7300: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7301:   text-decoration: none;
                   7302:   font-size:90%;
1.693     droeschl 7303: }
1.795     www      7304: 
1.969     droeschl 7305: ol#LC_MenuBreadcrumbs h1 {
                   7306:   display: inline;
                   7307:   font-size: 90%;
                   7308:   line-height: 2.5em;
                   7309:   margin: 0;
                   7310:   padding: 0;
                   7311: }
                   7312: 
1.795     www      7313: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7314:   text-decoration:none;
                   7315:   font-size:100%;
                   7316:   font-weight:bold;
1.693     droeschl 7317: }
1.795     www      7318: 
1.840     bisitz   7319: .LC_Box {
1.911     bisitz   7320:   border: solid 1px $lg_border_color;
                   7321:   padding: 0 10px 10px 10px;
1.746     neumanie 7322: }
1.795     www      7323: 
1.1020    raeburn  7324: .LC_DocsBox {
                   7325:   border: solid 1px $lg_border_color;
                   7326:   padding: 0 0 10px 10px;
                   7327: }
                   7328: 
1.795     www      7329: .LC_AboutMe_Image {
1.911     bisitz   7330:   float:left;
                   7331:   margin-right:10px;
1.747     neumanie 7332: }
1.795     www      7333: 
                   7334: .LC_Clear_AboutMe_Image {
1.911     bisitz   7335:   clear:left;
1.747     neumanie 7336: }
1.795     www      7337: 
1.721     harmsja  7338: dl.LC_ListStyleClean dt {
1.911     bisitz   7339:   padding-right: 5px;
                   7340:   display: table-header-group;
1.693     droeschl 7341: }
                   7342: 
1.721     harmsja  7343: dl.LC_ListStyleClean dd {
1.911     bisitz   7344:   display: table-row;
1.693     droeschl 7345: }
                   7346: 
1.721     harmsja  7347: .LC_ListStyleClean,
                   7348: .LC_ListStyleSimple,
                   7349: .LC_ListStyleNormal,
1.795     www      7350: .LC_ListStyleSpecial {
1.911     bisitz   7351:   /* display:block; */
                   7352:   list-style-position: inside;
                   7353:   list-style-type: none;
                   7354:   overflow: hidden;
                   7355:   padding: 0;
1.693     droeschl 7356: }
                   7357: 
1.721     harmsja  7358: .LC_ListStyleSimple li,
                   7359: .LC_ListStyleSimple dd,
                   7360: .LC_ListStyleNormal li,
                   7361: .LC_ListStyleNormal dd,
                   7362: .LC_ListStyleSpecial li,
1.795     www      7363: .LC_ListStyleSpecial dd {
1.911     bisitz   7364:   margin: 0;
                   7365:   padding: 5px 5px 5px 10px;
                   7366:   clear: both;
1.693     droeschl 7367: }
                   7368: 
1.721     harmsja  7369: .LC_ListStyleClean li,
                   7370: .LC_ListStyleClean dd {
1.911     bisitz   7371:   padding-top: 0;
                   7372:   padding-bottom: 0;
1.693     droeschl 7373: }
                   7374: 
1.721     harmsja  7375: .LC_ListStyleSimple dd,
1.795     www      7376: .LC_ListStyleSimple li {
1.911     bisitz   7377:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7378: }
                   7379: 
1.721     harmsja  7380: .LC_ListStyleSpecial li,
                   7381: .LC_ListStyleSpecial dd {
1.911     bisitz   7382:   list-style-type: none;
                   7383:   background-color: RGB(220, 220, 220);
                   7384:   margin-bottom: 4px;
1.693     droeschl 7385: }
                   7386: 
1.721     harmsja  7387: table.LC_SimpleTable {
1.911     bisitz   7388:   margin:5px;
                   7389:   border:solid 1px $lg_border_color;
1.795     www      7390: }
1.693     droeschl 7391: 
1.721     harmsja  7392: table.LC_SimpleTable tr {
1.911     bisitz   7393:   padding: 0;
                   7394:   border:solid 1px $lg_border_color;
1.693     droeschl 7395: }
1.795     www      7396: 
                   7397: table.LC_SimpleTable thead {
1.911     bisitz   7398:   background:rgb(220,220,220);
1.693     droeschl 7399: }
                   7400: 
1.721     harmsja  7401: div.LC_columnSection {
1.911     bisitz   7402:   display: block;
                   7403:   clear: both;
                   7404:   overflow: hidden;
                   7405:   margin: 0;
1.693     droeschl 7406: }
                   7407: 
1.721     harmsja  7408: div.LC_columnSection>* {
1.911     bisitz   7409:   float: left;
                   7410:   margin: 10px 20px 10px 0;
                   7411:   overflow:hidden;
1.693     droeschl 7412: }
1.721     harmsja  7413: 
1.795     www      7414: table em {
1.911     bisitz   7415:   font-weight: bold;
                   7416:   font-style: normal;
1.748     schulted 7417: }
1.795     www      7418: 
1.779     bisitz   7419: table.LC_tableBrowseRes,
1.795     www      7420: table.LC_tableOfContent {
1.911     bisitz   7421:   border:none;
                   7422:   border-spacing: 1px;
                   7423:   padding: 3px;
                   7424:   background-color: #FFFFFF;
                   7425:   font-size: 90%;
1.753     droeschl 7426: }
1.789     droeschl 7427: 
1.911     bisitz   7428: table.LC_tableOfContent {
                   7429:   border-collapse: collapse;
1.789     droeschl 7430: }
                   7431: 
1.771     droeschl 7432: table.LC_tableBrowseRes a,
1.768     schulted 7433: table.LC_tableOfContent a {
1.911     bisitz   7434:   background-color: transparent;
                   7435:   text-decoration: none;
1.753     droeschl 7436: }
                   7437: 
1.795     www      7438: table.LC_tableOfContent img {
1.911     bisitz   7439:   border: none;
                   7440:   height: 1.3em;
                   7441:   vertical-align: text-bottom;
                   7442:   margin-right: 0.3em;
1.753     droeschl 7443: }
1.757     schulted 7444: 
1.795     www      7445: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7446:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7447: }
                   7448: 
1.795     www      7449: a#LC_content_toolbar_everything {
1.911     bisitz   7450:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7451: }
                   7452: 
1.795     www      7453: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7454:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7455: }
                   7456: 
1.795     www      7457: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7458:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7459: }
                   7460: 
1.795     www      7461: a#LC_content_toolbar_changefolder {
1.911     bisitz   7462:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7463: }
                   7464: 
1.795     www      7465: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7466:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7467: }
                   7468: 
1.1043    raeburn  7469: a#LC_content_toolbar_edittoplevel {
                   7470:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7471: }
                   7472: 
1.795     www      7473: ul#LC_toolbar li a:hover {
1.911     bisitz   7474:   background-position: bottom center;
1.757     schulted 7475: }
                   7476: 
1.795     www      7477: ul#LC_toolbar {
1.911     bisitz   7478:   padding: 0;
                   7479:   margin: 2px;
                   7480:   list-style:none;
                   7481:   position:relative;
                   7482:   background-color:white;
1.1082    raeburn  7483:   overflow: auto;
1.757     schulted 7484: }
                   7485: 
1.795     www      7486: ul#LC_toolbar li {
1.911     bisitz   7487:   border:1px solid white;
                   7488:   padding: 0;
                   7489:   margin: 0;
                   7490:   float: left;
                   7491:   display:inline;
                   7492:   vertical-align:middle;
1.1082    raeburn  7493:   white-space: nowrap;
1.911     bisitz   7494: }
1.757     schulted 7495: 
1.783     amueller 7496: 
1.795     www      7497: a.LC_toolbarItem {
1.911     bisitz   7498:   display:block;
                   7499:   padding: 0;
                   7500:   margin: 0;
                   7501:   height: 32px;
                   7502:   width: 32px;
                   7503:   color:white;
                   7504:   border: none;
                   7505:   background-repeat:no-repeat;
                   7506:   background-color:transparent;
1.757     schulted 7507: }
                   7508: 
1.915     droeschl 7509: ul.LC_funclist {
                   7510:     margin: 0;
                   7511:     padding: 0.5em 1em 0.5em 0;
                   7512: }
                   7513: 
1.933     droeschl 7514: ul.LC_funclist > li:first-child {
                   7515:     font-weight:bold; 
                   7516:     margin-left:0.8em;
                   7517: }
                   7518: 
1.915     droeschl 7519: ul.LC_funclist + ul.LC_funclist {
                   7520:     /* 
                   7521:        left border as a seperator if we have more than
                   7522:        one list 
                   7523:     */
                   7524:     border-left: 1px solid $sidebg;
                   7525:     /* 
                   7526:        this hides the left border behind the border of the 
                   7527:        outer box if element is wrapped to the next 'line' 
                   7528:     */
                   7529:     margin-left: -1px;
                   7530: }
                   7531: 
1.843     bisitz   7532: ul.LC_funclist li {
1.915     droeschl 7533:   display: inline;
1.782     bisitz   7534:   white-space: nowrap;
1.915     droeschl 7535:   margin: 0 0 0 25px;
                   7536:   line-height: 150%;
1.782     bisitz   7537: }
                   7538: 
1.974     wenzelju 7539: .LC_hidden {
                   7540:   display: none;
                   7541: }
                   7542: 
1.1030    www      7543: .LCmodal-overlay {
                   7544: 		position:fixed;
                   7545: 		top:0;
                   7546: 		right:0;
                   7547: 		bottom:0;
                   7548: 		left:0;
                   7549: 		height:100%;
                   7550: 		width:100%;
                   7551: 		margin:0;
                   7552: 		padding:0;
                   7553: 		background:#999;
                   7554: 		opacity:.75;
                   7555: 		filter: alpha(opacity=75);
                   7556: 		-moz-opacity: 0.75;
                   7557: 		z-index:101;
                   7558: }
                   7559: 
                   7560: * html .LCmodal-overlay {   
                   7561: 		position: absolute;
                   7562: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7563: }
                   7564: 
                   7565: .LCmodal-window {
                   7566: 		position:fixed;
                   7567: 		top:50%;
                   7568: 		left:50%;
                   7569: 		margin:0;
                   7570: 		padding:0;
                   7571: 		z-index:102;
                   7572: 	}
                   7573: 
                   7574: * html .LCmodal-window {
                   7575: 		position:absolute;
                   7576: }
                   7577: 
                   7578: .LCclose-window {
                   7579: 		position:absolute;
                   7580: 		width:32px;
                   7581: 		height:32px;
                   7582: 		right:8px;
                   7583: 		top:8px;
                   7584: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7585: 		text-indent:-99999px;
                   7586: 		overflow:hidden;
                   7587: 		cursor:pointer;
                   7588: }
                   7589: 
1.1100    raeburn  7590: /*
                   7591:   styles used by TTH when "Default set of options to pass to tth/m
                   7592:   when converting TeX" in course settings has been set
                   7593: 
                   7594:   option passed: -t
                   7595: 
                   7596: */
                   7597: 
                   7598: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7599: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7600: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7601: td div.norm {line-height:normal;}
                   7602: 
                   7603: /*
                   7604:   option passed -y3
                   7605: */
                   7606: 
                   7607: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7608: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7609: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7610: 
1.343     albertel 7611: END
                   7612: }
                   7613: 
1.306     albertel 7614: =pod
                   7615: 
                   7616: =item * &headtag()
                   7617: 
                   7618: Returns a uniform footer for LON-CAPA web pages.
                   7619: 
1.307     albertel 7620: Inputs: $title - optional title for the head
                   7621:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7622:         $args - optional arguments
1.319     albertel 7623:             force_register - if is true call registerurl so the remote is 
                   7624:                              informed
1.415     albertel 7625:             redirect       -> array ref of
                   7626:                                    1- seconds before redirect occurs
                   7627:                                    2- url to redirect to
                   7628:                                    3- whether the side effect should occur
1.315     albertel 7629:                            (side effect of setting 
                   7630:                                $env{'internal.head.redirect'} to the url 
                   7631:                                redirected too)
1.352     albertel 7632:             domain         -> force to color decorate a page for a specific
                   7633:                                domain
                   7634:             function       -> force usage of a specific rolish color scheme
                   7635:             bgcolor        -> override the default page bgcolor
1.460     albertel 7636:             no_auto_mt_title
                   7637:                            -> prevent &mt()ing the title arg
1.464     albertel 7638: 
1.306     albertel 7639: =cut
                   7640: 
                   7641: sub headtag {
1.313     albertel 7642:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7643:     
1.363     albertel 7644:     my $function = $args->{'function'} || &get_users_function();
                   7645:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7646:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1154    raeburn  7647:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7648:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7649: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7650: 		   #time(),
1.418     albertel 7651: 		   $env{'environment.color.timestamp'},
1.363     albertel 7652: 		   $function,$domain,$bgcolor);
                   7653: 
1.369     www      7654:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7655: 
1.308     albertel 7656:     my $result =
                   7657: 	'<head>'.
1.1160    raeburn  7658: 	&font_settings($args);
1.319     albertel 7659: 
1.1188    raeburn  7660:     my $inhibitprint;
                   7661:     if ($args->{'print_suppress'}) {
                   7662:         $inhibitprint = &print_suppression();
                   7663:     }
1.1064    raeburn  7664: 
1.461     albertel 7665:     if (!$args->{'frameset'}) {
                   7666: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7667:     }
1.962     droeschl 7668:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   7669:         $result .= Apache::lonxml::display_title();
1.319     albertel 7670:     }
1.436     albertel 7671:     if (!$args->{'no_nav_bar'} 
                   7672: 	&& !$args->{'only_body'}
                   7673: 	&& !$args->{'frameset'}) {
1.1154    raeburn  7674: 	$result .= &help_menu_js($httphost);
1.1032    www      7675:         $result.=&modal_window();
1.1038    www      7676:         $result.=&togglebox_script();
1.1034    www      7677:         $result.=&wishlist_window();
1.1041    www      7678:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7679:     } else {
                   7680:         if ($args->{'add_modal'}) {
                   7681:            $result.=&modal_window();
                   7682:         }
                   7683:         if ($args->{'add_wishlist'}) {
                   7684:            $result.=&wishlist_window();
                   7685:         }
1.1038    www      7686:         if ($args->{'add_togglebox'}) {
                   7687:            $result.=&togglebox_script();
                   7688:         }
1.1041    www      7689:         if ($args->{'add_progressbar'}) {
                   7690:            $result.=&LCprogressbarUpdate_script();
                   7691:         }
1.436     albertel 7692:     }
1.314     albertel 7693:     if (ref($args->{'redirect'})) {
1.414     albertel 7694: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7695: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7696: 	if (!$inhibit_continue) {
                   7697: 	    $env{'internal.head.redirect'} = $url;
                   7698: 	}
1.313     albertel 7699: 	$result.=<<ADDMETA
                   7700: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7701: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7702: ADDMETA
1.1210  ! raeburn  7703:     } else {
        !          7704:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
        !          7705:             my $requrl = $env{'request.uri'};
        !          7706:             if ($requrl eq '') {
        !          7707:                 $requrl = $ENV{'REQUEST_URI'};
        !          7708:                 $requrl =~ s/\?.+$//;
        !          7709:             }
        !          7710:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
        !          7711:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
        !          7712:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
        !          7713:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
        !          7714:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
        !          7715:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
        !          7716:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
        !          7717:                         my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
        !          7718:                         if ($domdefs{'offloadnow'}{$lonhost}) {
        !          7719:                             my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
        !          7720:                             if (($newserver) && ($newserver ne $lonhost)) {
        !          7721:                                 my $numsec = 5;
        !          7722:                                 my $timeout = $numsec * 1000;
        !          7723:                                 my ($newurl,$locknum,%locks,$msg);
        !          7724:                                 if ($env{'request.role.adv'}) {
        !          7725:                                     ($locknum,%locks) = &Apache::lonnet::get_locks();
        !          7726:                                 }
        !          7727:                                 my $disable_submit = 0;
        !          7728:                                 if ($requrl =~ /$LONCAPA::assess_re/) {
        !          7729:                                     $disable_submit = 1;
        !          7730:                                 }
        !          7731:                                 if ($locknum) {
        !          7732:                                     my @lockinfo = sort(values(%locks));
        !          7733:                                     $msg = &mt('Once the following tasks are complete: ')."\\n".
        !          7734:                                            join(", ",sort(values(%locks)))."\\n".
        !          7735:                                            &mt('your session will be transferred to a different server, after you click "Roles".');
        !          7736:                                 } else {
        !          7737:                                     if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
        !          7738:                                         $msg = &mt('Your LON-CAPA submission has been recorded')."\\n";
        !          7739:                                     }
        !          7740:                                     $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
        !          7741:                                     $newurl = '/adm/switchserver?otherserver='.$newserver;
        !          7742:                                     if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
        !          7743:                                         $newurl .= '&role='.$env{'request.role'};
        !          7744:                                     }
        !          7745:                                     if ($env{'request.symb'}) {
        !          7746:                                         $newurl .= '&symb='.$env{'request.symb'};
        !          7747:                                     } else {
        !          7748:                                         $newurl .= '&origurl='.$requrl;
        !          7749:                                     }
        !          7750:                                 }
        !          7751:                                 $result.=<<OFFLOAD
        !          7752: <meta http-equiv="pragma" content="no-cache" />
        !          7753: <script type="text/javascript">
        !          7754: function LC_Offload_Now() {
        !          7755:     var dest = "$newurl";
        !          7756:     if (dest != '') {
        !          7757:         window.location.href="$newurl";
        !          7758:     }
        !          7759: }
        !          7760: window.alert('$msg');
        !          7761: if ($disable_submit) {
        !          7762:     \$(document).ready(function () {
        !          7763:         \$(".LC_hwk_submit").prop("disabled", true);
        !          7764:         \$( ".LC_textline" ).prop( "readonly", "readonly");
        !          7765:     });
        !          7766: }
        !          7767: setTimeout('LC_Offload_Now()', $timeout);
        !          7768: </script>
        !          7769: OFFLOAD
        !          7770:                             }
        !          7771:                         }
        !          7772:                     }
        !          7773:                 }
        !          7774:             }
        !          7775:         }
1.313     albertel 7776:     }
1.306     albertel 7777:     if (!defined($title)) {
                   7778: 	$title = 'The LearningOnline Network with CAPA';
                   7779:     }
1.460     albertel 7780:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7781:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168    raeburn  7782: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   7783:     if (!$args->{'frameset'}) {
                   7784:         $result .= ' /';
                   7785:     }
                   7786:     $result .= '>' 
1.1064    raeburn  7787:         .$inhibitprint
1.414     albertel 7788: 	.$head_extra;
1.1137    raeburn  7789:     if ($env{'browser.mobile'}) {
                   7790:         $result .= '
                   7791: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   7792: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   7793:     }
1.962     droeschl 7794:     return $result.'</head>';
1.306     albertel 7795: }
                   7796: 
                   7797: =pod
                   7798: 
1.340     albertel 7799: =item * &font_settings()
                   7800: 
                   7801: Returns neccessary <meta> to set the proper encoding
                   7802: 
1.1160    raeburn  7803: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 7804: 
                   7805: =cut
                   7806: 
                   7807: sub font_settings {
1.1160    raeburn  7808:     my ($args) = @_;
1.340     albertel 7809:     my $headerstring='';
1.1160    raeburn  7810:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   7811:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168    raeburn  7812:         $headerstring.=
                   7813:             '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   7814:         if (!$args->{'frameset'}) {
                   7815: 	    $headerstring.= ' /';
                   7816:         }
                   7817: 	$headerstring .= '>'."\n";
1.340     albertel 7818:     }
                   7819:     return $headerstring;
                   7820: }
                   7821: 
1.341     albertel 7822: =pod
                   7823: 
1.1064    raeburn  7824: =item * &print_suppression()
                   7825: 
                   7826: In course context returns css which causes the body to be blank when media="print",
                   7827: if printout generation is unavailable for the current resource.
                   7828: 
                   7829: This could be because:
                   7830: 
                   7831: (a) printstartdate is in the future
                   7832: 
                   7833: (b) printenddate is in the past
                   7834: 
                   7835: (c) there is an active exam block with "printout"
                   7836: functionality blocked
                   7837: 
                   7838: Users with pav, pfo or evb privileges are exempt.
                   7839: 
                   7840: Inputs: none
                   7841: 
                   7842: =cut
                   7843: 
                   7844: 
                   7845: sub print_suppression {
                   7846:     my $noprint;
                   7847:     if ($env{'request.course.id'}) {
                   7848:         my $scope = $env{'request.course.id'};
                   7849:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7850:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   7851:             return;
                   7852:         }
                   7853:         if ($env{'request.course.sec'} ne '') {
                   7854:             $scope .= "/$env{'request.course.sec'}";
                   7855:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7856:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  7857:                 return;
1.1064    raeburn  7858:             }
                   7859:         }
                   7860:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7861:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189    raeburn  7862:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  7863:         if ($blocked) {
                   7864:             my $checkrole = "cm./$cdom/$cnum";
                   7865:             if ($env{'request.course.sec'} ne '') {
                   7866:                 $checkrole .= "/$env{'request.course.sec'}";
                   7867:             }
                   7868:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   7869:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   7870:                 $noprint = 1;
                   7871:             }
                   7872:         }
                   7873:         unless ($noprint) {
                   7874:             my $symb = &Apache::lonnet::symbread();
                   7875:             if ($symb ne '') {
                   7876:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   7877:                 if (ref($navmap)) {
                   7878:                     my $res = $navmap->getBySymb($symb);
                   7879:                     if (ref($res)) {
                   7880:                         if (!$res->resprintable()) {
                   7881:                             $noprint = 1;
                   7882:                         }
                   7883:                     }
                   7884:                 }
                   7885:             }
                   7886:         }
                   7887:         if ($noprint) {
                   7888:             return <<"ENDSTYLE";
                   7889: <style type="text/css" media="print">
                   7890:     body { display:none }
                   7891: </style>
                   7892: ENDSTYLE
                   7893:         }
                   7894:     }
                   7895:     return;
                   7896: }
                   7897: 
                   7898: =pod
                   7899: 
1.341     albertel 7900: =item * &xml_begin()
                   7901: 
                   7902: Returns the needed doctype and <html>
                   7903: 
                   7904: Inputs: none
                   7905: 
                   7906: =cut
                   7907: 
                   7908: sub xml_begin {
1.1168    raeburn  7909:     my ($is_frameset) = @_;
1.341     albertel 7910:     my $output='';
                   7911: 
                   7912:     if ($env{'browser.mathml'}) {
                   7913: 	$output='<?xml version="1.0"?>'
                   7914:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7915: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7916:             
                   7917: #	    .'<!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">] >'
                   7918: 	    .'<!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">'
                   7919:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7920: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168    raeburn  7921:     } elsif ($is_frameset) {
                   7922:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   7923:                 '<html>'."\n";
1.341     albertel 7924:     } else {
1.1168    raeburn  7925: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   7926:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 7927:     }
                   7928:     return $output;
                   7929: }
1.340     albertel 7930: 
                   7931: =pod
                   7932: 
1.306     albertel 7933: =item * &start_page()
                   7934: 
                   7935: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7936: 
1.648     raeburn  7937: Inputs:
                   7938: 
                   7939: =over 4
                   7940: 
                   7941: $title - optional title for the page
                   7942: 
                   7943: $head_extra - optional extra HTML to incude inside the <head>
                   7944: 
                   7945: $args - additional optional args supported are:
                   7946: 
                   7947: =over 8
                   7948: 
                   7949:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7950:                                     arg on
1.814     bisitz   7951:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7952:              add_entries    -> additional attributes to add to the  <body>
                   7953:              domain         -> force to color decorate a page for a 
1.317     albertel 7954:                                     specific domain
1.648     raeburn  7955:              function       -> force usage of a specific rolish color
1.317     albertel 7956:                                     scheme
1.648     raeburn  7957:              redirect       -> see &headtag()
                   7958:              bgcolor        -> override the default page bg color
                   7959:              js_ready       -> return a string ready for being used in 
1.317     albertel 7960:                                     a javascript writeln
1.648     raeburn  7961:              html_encode    -> return a string ready for being used in 
1.320     albertel 7962:                                     a html attribute
1.648     raeburn  7963:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7964:                                     $forcereg arg
1.648     raeburn  7965:              frameset       -> if true will start with a <frameset>
1.330     albertel 7966:                                     rather than <body>
1.648     raeburn  7967:              skip_phases    -> hash ref of 
1.338     albertel 7968:                                     head -> skip the <html><head> generation
                   7969:                                     body -> skip all <body> generation
1.648     raeburn  7970:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7971:              inherit_jsmath -> when creating popup window in a page,
                   7972:                                     should it have jsmath forced on by the
                   7973:                                     current page
1.867     kalberla 7974:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7975:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1096    raeburn  7976:              group          -> includes the current group, if page is for a 
                   7977:                                specific group  
1.361     albertel 7978: 
1.648     raeburn  7979: =back
1.460     albertel 7980: 
1.648     raeburn  7981: =back
1.562     albertel 7982: 
1.306     albertel 7983: =cut
                   7984: 
                   7985: sub start_page {
1.309     albertel 7986:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7987:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7988: 
1.315     albertel 7989:     $env{'internal.start_page'}++;
1.1096    raeburn  7990:     my ($result,@advtools);
1.964     droeschl 7991: 
1.338     albertel 7992:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168    raeburn  7993:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 7994:     }
                   7995:     
                   7996:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7997: 	if ($args->{'frameset'}) {
                   7998: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7999: 						$args->{'add_entries'});
                   8000: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8001:         } else {
                   8002:             $result .=
                   8003:                 &bodytag($title, 
                   8004:                          $args->{'function'},       $args->{'add_entries'},
                   8005:                          $args->{'only_body'},      $args->{'domain'},
                   8006:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  8007:                          $args->{'bgcolor'},        $args,
                   8008:                          \@advtools);
1.831     bisitz   8009:         }
1.330     albertel 8010:     }
1.338     albertel 8011: 
1.315     albertel 8012:     if ($args->{'js_ready'}) {
1.713     kaisler  8013: 		$result = &js_ready($result);
1.315     albertel 8014:     }
1.320     albertel 8015:     if ($args->{'html_encode'}) {
1.713     kaisler  8016: 		$result = &html_encode($result);
                   8017:     }
                   8018: 
1.813     bisitz   8019:     # Preparation for new and consistent functionlist at top of screen
                   8020:     # if ($args->{'functionlist'}) {
                   8021:     #            $result .= &build_functionlist();
                   8022:     #}
                   8023: 
1.964     droeschl 8024:     # Don't add anything more if only_body wanted or in const space
                   8025:     return $result if    $args->{'only_body'} 
                   8026:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8027: 
                   8028:     #Breadcrumbs
1.758     kaisler  8029:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8030: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8031: 		#if any br links exists, add them to the breadcrumbs
                   8032: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8033: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8034: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8035: 			}
                   8036: 		}
1.1096    raeburn  8037:                 # if @advtools array contains items add then to the breadcrumbs
                   8038:                 if (@advtools > 0) {
                   8039:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8040:                 }
1.758     kaisler  8041: 
                   8042: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8043: 		if(exists($args->{'bread_crumbs_component'})){
                   8044: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   8045: 		}else{
                   8046: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   8047: 		}
1.320     albertel 8048:     }
1.315     albertel 8049:     return $result;
1.306     albertel 8050: }
                   8051: 
                   8052: sub end_page {
1.315     albertel 8053:     my ($args) = @_;
                   8054:     $env{'internal.end_page'}++;
1.330     albertel 8055:     my $result;
1.335     albertel 8056:     if ($args->{'discussion'}) {
                   8057: 	my ($target,$parser);
                   8058: 	if (ref($args->{'discussion'})) {
                   8059: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8060: 				$args->{'discussion'}{'parser'});
                   8061: 	}
                   8062: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8063:     }
1.330     albertel 8064:     if ($args->{'frameset'}) {
                   8065: 	$result .= '</frameset>';
                   8066:     } else {
1.635     raeburn  8067: 	$result .= &endbodytag($args);
1.330     albertel 8068:     }
1.1080    raeburn  8069:     unless ($args->{'notbody'}) {
                   8070:         $result .= "\n</html>";
                   8071:     }
1.330     albertel 8072: 
1.315     albertel 8073:     if ($args->{'js_ready'}) {
1.317     albertel 8074: 	$result = &js_ready($result);
1.315     albertel 8075:     }
1.335     albertel 8076: 
1.320     albertel 8077:     if ($args->{'html_encode'}) {
                   8078: 	$result = &html_encode($result);
                   8079:     }
1.335     albertel 8080: 
1.315     albertel 8081:     return $result;
                   8082: }
                   8083: 
1.1034    www      8084: sub wishlist_window {
                   8085:     return(<<'ENDWISHLIST');
1.1046    raeburn  8086: <script type="text/javascript">
1.1034    www      8087: // <![CDATA[
                   8088: // <!-- BEGIN LON-CAPA Internal
                   8089: function set_wishlistlink(title, path) {
                   8090:     if (!title) {
                   8091:         title = document.title;
                   8092:         title = title.replace(/^LON-CAPA /,'');
                   8093:     }
1.1175    raeburn  8094:     title = encodeURIComponent(title);
1.1203    raeburn  8095:     title = title.replace("'","\\\'");
1.1034    www      8096:     if (!path) {
                   8097:         path = location.pathname;
                   8098:     }
1.1175    raeburn  8099:     path = encodeURIComponent(path);
1.1203    raeburn  8100:     path = path.replace("'","\\\'");
1.1034    www      8101:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8102:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8103: }
                   8104: // END LON-CAPA Internal -->
                   8105: // ]]>
                   8106: </script>
                   8107: ENDWISHLIST
                   8108: }
                   8109: 
1.1030    www      8110: sub modal_window {
                   8111:     return(<<'ENDMODAL');
1.1046    raeburn  8112: <script type="text/javascript">
1.1030    www      8113: // <![CDATA[
                   8114: // <!-- BEGIN LON-CAPA Internal
                   8115: var modalWindow = {
                   8116: 	parent:"body",
                   8117: 	windowId:null,
                   8118: 	content:null,
                   8119: 	width:null,
                   8120: 	height:null,
                   8121: 	close:function()
                   8122: 	{
                   8123: 	        $(".LCmodal-window").remove();
                   8124: 	        $(".LCmodal-overlay").remove();
                   8125: 	},
                   8126: 	open:function()
                   8127: 	{
                   8128: 		var modal = "";
                   8129: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8130: 		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;\">";
                   8131: 		modal += this.content;
                   8132: 		modal += "</div>";	
                   8133: 
                   8134: 		$(this.parent).append(modal);
                   8135: 
                   8136: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8137: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8138: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8139: 	}
                   8140: };
1.1140    raeburn  8141: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8142: 	{
1.1203    raeburn  8143:                 source = source.replace("'","&#39;");
1.1030    www      8144: 		modalWindow.windowId = "myModal";
                   8145: 		modalWindow.width = width;
                   8146: 		modalWindow.height = height;
1.1196    raeburn  8147: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8148: 		modalWindow.open();
1.1208    raeburn  8149: 	};
1.1030    www      8150: // END LON-CAPA Internal -->
                   8151: // ]]>
                   8152: </script>
                   8153: ENDMODAL
                   8154: }
                   8155: 
                   8156: sub modal_link {
1.1140    raeburn  8157:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8158:     unless ($width) { $width=480; }
                   8159:     unless ($height) { $height=400; }
1.1031    www      8160:     unless ($scrolling) { $scrolling='yes'; }
1.1140    raeburn  8161:     unless ($transparency) { $transparency='true'; }
                   8162: 
1.1074    raeburn  8163:     my $target_attr;
                   8164:     if (defined($target)) {
                   8165:         $target_attr = 'target="'.$target.'"';
                   8166:     }
                   8167:     return <<"ENDLINK";
1.1140    raeburn  8168: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074    raeburn  8169:            $linktext</a>
                   8170: ENDLINK
1.1030    www      8171: }
                   8172: 
1.1032    www      8173: sub modal_adhoc_script {
                   8174:     my ($funcname,$width,$height,$content)=@_;
                   8175:     return (<<ENDADHOC);
1.1046    raeburn  8176: <script type="text/javascript">
1.1032    www      8177: // <![CDATA[
                   8178:         var $funcname = function()
                   8179:         {
                   8180:                 modalWindow.windowId = "myModal";
                   8181:                 modalWindow.width = $width;
                   8182:                 modalWindow.height = $height;
                   8183:                 modalWindow.content = '$content';
                   8184:                 modalWindow.open();
                   8185:         };  
                   8186: // ]]>
                   8187: </script>
                   8188: ENDADHOC
                   8189: }
                   8190: 
1.1041    www      8191: sub modal_adhoc_inner {
                   8192:     my ($funcname,$width,$height,$content)=@_;
                   8193:     my $innerwidth=$width-20;
                   8194:     $content=&js_ready(
1.1140    raeburn  8195:                  &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
                   8196:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8197:                  $content.
1.1041    www      8198:                  &end_scrollbox().
1.1140    raeburn  8199:                  &end_page()
1.1041    www      8200:              );
                   8201:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8202: }
                   8203: 
                   8204: sub modal_adhoc_window {
                   8205:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8206:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8207:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8208: }
                   8209: 
                   8210: sub modal_adhoc_launch {
                   8211:     my ($funcname,$width,$height,$content)=@_;
                   8212:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8213: <script type="text/javascript">
                   8214: // <![CDATA[
                   8215: $funcname();
                   8216: // ]]>
                   8217: </script>
                   8218: ENDLAUNCH
                   8219: }
                   8220: 
                   8221: sub modal_adhoc_close {
                   8222:     return (<<ENDCLOSE);
                   8223: <script type="text/javascript">
                   8224: // <![CDATA[
                   8225: modalWindow.close();
                   8226: // ]]>
                   8227: </script>
                   8228: ENDCLOSE
                   8229: }
                   8230: 
1.1038    www      8231: sub togglebox_script {
                   8232:    return(<<ENDTOGGLE);
                   8233: <script type="text/javascript"> 
                   8234: // <![CDATA[
                   8235: function LCtoggleDisplay(id,hidetext,showtext) {
                   8236:    link = document.getElementById(id + "link").childNodes[0];
                   8237:    with (document.getElementById(id).style) {
                   8238:       if (display == "none" ) {
                   8239:           display = "inline";
                   8240:           link.nodeValue = hidetext;
                   8241:         } else {
                   8242:           display = "none";
                   8243:           link.nodeValue = showtext;
                   8244:        }
                   8245:    }
                   8246: }
                   8247: // ]]>
                   8248: </script>
                   8249: ENDTOGGLE
                   8250: }
                   8251: 
1.1039    www      8252: sub start_togglebox {
                   8253:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8254:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8255:     unless ($showtext) { $showtext=&mt('show'); }
                   8256:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8257:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8258:     return &start_data_table().
                   8259:            &start_data_table_header_row().
                   8260:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8261:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8262:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8263:            &end_data_table_header_row().
                   8264:            '<tr id="'.$id.'" style="display:none""><td>';
                   8265: }
                   8266: 
                   8267: sub end_togglebox {
                   8268:     return '</td></tr>'.&end_data_table();
                   8269: }
                   8270: 
1.1041    www      8271: sub LCprogressbar_script {
1.1045    www      8272:    my ($id)=@_;
1.1041    www      8273:    return(<<ENDPROGRESS);
                   8274: <script type="text/javascript">
                   8275: // <![CDATA[
1.1045    www      8276: \$('#progressbar$id').progressbar({
1.1041    www      8277:   value: 0,
                   8278:   change: function(event, ui) {
                   8279:     var newVal = \$(this).progressbar('option', 'value');
                   8280:     \$('.pblabel', this).text(LCprogressTxt);
                   8281:   }
                   8282: });
                   8283: // ]]>
                   8284: </script>
                   8285: ENDPROGRESS
                   8286: }
                   8287: 
                   8288: sub LCprogressbarUpdate_script {
                   8289:    return(<<ENDPROGRESSUPDATE);
                   8290: <style type="text/css">
                   8291: .ui-progressbar { position:relative; }
                   8292: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8293: </style>
                   8294: <script type="text/javascript">
                   8295: // <![CDATA[
1.1045    www      8296: var LCprogressTxt='---';
                   8297: 
                   8298: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      8299:    LCprogressTxt=progresstext;
1.1045    www      8300:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      8301: }
                   8302: // ]]>
                   8303: </script>
                   8304: ENDPROGRESSUPDATE
                   8305: }
                   8306: 
1.1042    www      8307: my $LClastpercent;
1.1045    www      8308: my $LCidcnt;
                   8309: my $LCcurrentid;
1.1042    www      8310: 
1.1041    www      8311: sub LCprogressbar {
1.1042    www      8312:     my ($r)=(@_);
                   8313:     $LClastpercent=0;
1.1045    www      8314:     $LCidcnt++;
                   8315:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      8316:     my $starting=&mt('Starting');
                   8317:     my $content=(<<ENDPROGBAR);
1.1045    www      8318:   <div id="progressbar$LCcurrentid">
1.1041    www      8319:     <span class="pblabel">$starting</span>
                   8320:   </div>
                   8321: ENDPROGBAR
1.1045    www      8322:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      8323: }
                   8324: 
                   8325: sub LCprogressbarUpdate {
1.1042    www      8326:     my ($r,$val,$text)=@_;
                   8327:     unless ($val) { 
                   8328:        if ($LClastpercent) {
                   8329:            $val=$LClastpercent;
                   8330:        } else {
                   8331:            $val=0;
                   8332:        }
                   8333:     }
1.1041    www      8334:     if ($val<0) { $val=0; }
                   8335:     if ($val>100) { $val=0; }
1.1042    www      8336:     $LClastpercent=$val;
1.1041    www      8337:     unless ($text) { $text=$val.'%'; }
                   8338:     $text=&js_ready($text);
1.1044    www      8339:     &r_print($r,<<ENDUPDATE);
1.1041    www      8340: <script type="text/javascript">
                   8341: // <![CDATA[
1.1045    www      8342: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      8343: // ]]>
                   8344: </script>
                   8345: ENDUPDATE
1.1035    www      8346: }
                   8347: 
1.1042    www      8348: sub LCprogressbarClose {
                   8349:     my ($r)=@_;
                   8350:     $LClastpercent=0;
1.1044    www      8351:     &r_print($r,<<ENDCLOSE);
1.1042    www      8352: <script type="text/javascript">
                   8353: // <![CDATA[
1.1045    www      8354: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8355: // ]]>
                   8356: </script>
                   8357: ENDCLOSE
1.1044    www      8358: }
                   8359: 
                   8360: sub r_print {
                   8361:     my ($r,$to_print)=@_;
                   8362:     if ($r) {
                   8363:       $r->print($to_print);
                   8364:       $r->rflush();
                   8365:     } else {
                   8366:       print($to_print);
                   8367:     }
1.1042    www      8368: }
                   8369: 
1.320     albertel 8370: sub html_encode {
                   8371:     my ($result) = @_;
                   8372: 
1.322     albertel 8373:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8374:     
                   8375:     return $result;
                   8376: }
1.1044    www      8377: 
1.317     albertel 8378: sub js_ready {
                   8379:     my ($result) = @_;
                   8380: 
1.323     albertel 8381:     $result =~ s/[\n\r]/ /xmsg;
                   8382:     $result =~ s/\\/\\\\/xmsg;
                   8383:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8384:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8385:     
                   8386:     return $result;
                   8387: }
                   8388: 
1.315     albertel 8389: sub validate_page {
                   8390:     if (  exists($env{'internal.start_page'})
1.316     albertel 8391: 	  &&     $env{'internal.start_page'} > 1) {
                   8392: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8393: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8394: 				 $ENV{'request.filename'});
1.315     albertel 8395:     }
                   8396:     if (  exists($env{'internal.end_page'})
1.316     albertel 8397: 	  &&     $env{'internal.end_page'} > 1) {
                   8398: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8399: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8400: 				 $env{'request.filename'});
1.315     albertel 8401:     }
                   8402:     if (     exists($env{'internal.start_page'})
                   8403: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8404: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8405: 				 $env{'request.filename'});
1.315     albertel 8406:     }
                   8407:     if (   ! exists($env{'internal.start_page'})
                   8408: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8409: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8410: 				 $env{'request.filename'});
1.315     albertel 8411:     }
1.306     albertel 8412: }
1.315     albertel 8413: 
1.996     www      8414: 
                   8415: sub start_scrollbox {
1.1140    raeburn  8416:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8417:     unless ($outerwidth) { $outerwidth='520px'; }
                   8418:     unless ($width) { $width='500px'; }
                   8419:     unless ($height) { $height='200px'; }
1.1075    raeburn  8420:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8421:     if ($id ne '') {
1.1140    raeburn  8422:         $table_id = ' id="table_'.$id.'"';
1.1137    raeburn  8423:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8424:     }
1.1075    raeburn  8425:     if ($bgcolor ne '') {
                   8426:         $tdcol = "background-color: $bgcolor;";
                   8427:     }
1.1137    raeburn  8428:     my $nicescroll_js;
                   8429:     if ($env{'browser.mobile'}) {
1.1140    raeburn  8430:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8431:     }
                   8432:     return <<"END";
                   8433: $nicescroll_js
                   8434: 
                   8435: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
                   8436: <div style="overflow:auto; width:$width; height:$height;"$div_id>
                   8437: END
                   8438: }
                   8439: 
                   8440: sub end_scrollbox {
                   8441:     return '</div></td></tr></table>';
                   8442: }
                   8443: 
                   8444: sub nicescroll_javascript {
                   8445:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8446:     my %options;
                   8447:     if (ref($cursor) eq 'HASH') {
                   8448:         %options = %{$cursor};
                   8449:     }
                   8450:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8451:         $options{'railalign'} = 'left';
                   8452:     }
                   8453:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8454:         my $function  = &get_users_function();
                   8455:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138    raeburn  8456:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140    raeburn  8457:             $options{'cursorcolor'} = '#00F';
1.1138    raeburn  8458:         }
1.1140    raeburn  8459:     }
                   8460:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8461:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138    raeburn  8462:             $options{'cursoropacity'}='1.0';
                   8463:         }
1.1140    raeburn  8464:     } else {
                   8465:         $options{'cursoropacity'}='1.0';
                   8466:     }
                   8467:     if ($options{'cursorfixedheight'} eq 'none') {
                   8468:         delete($options{'cursorfixedheight'});
                   8469:     } else {
                   8470:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8471:     }
                   8472:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8473:         delete($options{'railoffset'});
                   8474:     }
                   8475:     my @niceoptions;
                   8476:     while (my($key,$value) = each(%options)) {
                   8477:         if ($value =~ /^\{.+\}$/) {
                   8478:             push(@niceoptions,$key.':'.$value);
1.1138    raeburn  8479:         } else {
1.1140    raeburn  8480:             push(@niceoptions,$key.':"'.$value.'"');
1.1138    raeburn  8481:         }
1.1140    raeburn  8482:     }
                   8483:     my $nicescroll_js = '
1.1137    raeburn  8484: $(document).ready(
1.1140    raeburn  8485:       function() {
                   8486:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8487:       }
1.1137    raeburn  8488: );
                   8489: ';
1.1140    raeburn  8490:     if ($framecheck) {
                   8491:         $nicescroll_js .= '
                   8492: function expand_div(caller) {
                   8493:     if (top === self) {
                   8494:         document.getElementById("'.$id.'").style.width = "auto";
                   8495:         document.getElementById("'.$id.'").style.height = "auto";
                   8496:     } else {
                   8497:         try {
                   8498:             if (parent.frames) {
                   8499:                 if (parent.frames.length > 1) {
                   8500:                     var framesrc = parent.frames[1].location.href;
                   8501:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8502:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8503:                         document.getElementById("'.$id.'").style.width = "auto";
                   8504:                         document.getElementById("'.$id.'").style.height = "auto";
                   8505:                     }
                   8506:                 }
                   8507:             }
                   8508:         } catch (e) {
                   8509:             return;
                   8510:         }
1.1137    raeburn  8511:     }
1.1140    raeburn  8512:     return;
1.996     www      8513: }
1.1140    raeburn  8514: ';
                   8515:     }
                   8516:     if ($needjsready) {
                   8517:         $nicescroll_js = '
                   8518: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8519:     } else {
                   8520:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8521:     }
                   8522:     return $nicescroll_js;
1.996     www      8523: }
                   8524: 
1.318     albertel 8525: sub simple_error_page {
1.1150    bisitz   8526:     my ($r,$title,$msg,$args) = @_;
1.1151    raeburn  8527:     if (ref($args) eq 'HASH') {
                   8528:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8529:     } else {
                   8530:         $msg = &mt($msg);
                   8531:     }
1.1150    bisitz   8532: 
1.318     albertel 8533:     my $page =
                   8534: 	&Apache::loncommon::start_page($title).
1.1150    bisitz   8535: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8536: 	&Apache::loncommon::end_page();
                   8537:     if (ref($r)) {
                   8538: 	$r->print($page);
1.327     albertel 8539: 	return;
1.318     albertel 8540:     }
                   8541:     return $page;
                   8542: }
1.347     albertel 8543: 
                   8544: {
1.610     albertel 8545:     my @row_count;
1.961     onken    8546: 
                   8547:     sub start_data_table_count {
                   8548:         unshift(@row_count, 0);
                   8549:         return;
                   8550:     }
                   8551: 
                   8552:     sub end_data_table_count {
                   8553:         shift(@row_count);
                   8554:         return;
                   8555:     }
                   8556: 
1.347     albertel 8557:     sub start_data_table {
1.1018    raeburn  8558: 	my ($add_class,$id) = @_;
1.422     albertel 8559: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8560:         my $table_id;
                   8561:         if (defined($id)) {
                   8562:             $table_id = ' id="'.$id.'"';
                   8563:         }
1.961     onken    8564: 	&start_data_table_count();
1.1018    raeburn  8565: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8566:     }
                   8567: 
                   8568:     sub end_data_table {
1.961     onken    8569: 	&end_data_table_count();
1.389     albertel 8570: 	return '</table>'."\n";;
1.347     albertel 8571:     }
                   8572: 
                   8573:     sub start_data_table_row {
1.974     wenzelju 8574: 	my ($add_class, $id) = @_;
1.610     albertel 8575: 	$row_count[0]++;
                   8576: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8577: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8578:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8579:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8580:     }
1.471     banghart 8581:     
                   8582:     sub continue_data_table_row {
1.974     wenzelju 8583: 	my ($add_class, $id) = @_;
1.610     albertel 8584: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8585: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8586:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8587:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8588:     }
1.347     albertel 8589: 
                   8590:     sub end_data_table_row {
1.389     albertel 8591: 	return '</tr>'."\n";;
1.347     albertel 8592:     }
1.367     www      8593: 
1.421     albertel 8594:     sub start_data_table_empty_row {
1.707     bisitz   8595: #	$row_count[0]++;
1.421     albertel 8596: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8597:     }
                   8598: 
                   8599:     sub end_data_table_empty_row {
                   8600: 	return '</tr>'."\n";;
                   8601:     }
                   8602: 
1.367     www      8603:     sub start_data_table_header_row {
1.389     albertel 8604: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      8605:     }
                   8606: 
                   8607:     sub end_data_table_header_row {
1.389     albertel 8608: 	return '</tr>'."\n";;
1.367     www      8609:     }
1.890     droeschl 8610: 
                   8611:     sub data_table_caption {
                   8612:         my $caption = shift;
                   8613:         return "<caption class=\"LC_caption\">$caption</caption>";
                   8614:     }
1.347     albertel 8615: }
                   8616: 
1.548     albertel 8617: =pod
                   8618: 
                   8619: =item * &inhibit_menu_check($arg)
                   8620: 
                   8621: Checks for a inhibitmenu state and generates output to preserve it
                   8622: 
                   8623: Inputs:         $arg - can be any of
                   8624:                      - undef - in which case the return value is a string 
                   8625:                                to add  into arguments list of a uri
                   8626:                      - 'input' - in which case the return value is a HTML
                   8627:                                  <form> <input> field of type hidden to
                   8628:                                  preserve the value
                   8629:                      - a url - in which case the return value is the url with
                   8630:                                the neccesary cgi args added to preserve the
                   8631:                                inhibitmenu state
                   8632:                      - a ref to a url - no return value, but the string is
                   8633:                                         updated to include the neccessary cgi
                   8634:                                         args to preserve the inhibitmenu state
                   8635: 
                   8636: =cut
                   8637: 
                   8638: sub inhibit_menu_check {
                   8639:     my ($arg) = @_;
                   8640:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   8641:     if ($arg eq 'input') {
                   8642: 	if ($env{'form.inhibitmenu'}) {
                   8643: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   8644: 	} else {
                   8645: 	    return
                   8646: 	}
                   8647:     }
                   8648:     if ($env{'form.inhibitmenu'}) {
                   8649: 	if (ref($arg)) {
                   8650: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8651: 	} elsif ($arg eq '') {
                   8652: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   8653: 	} else {
                   8654: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8655: 	}
                   8656:     }
                   8657:     if (!ref($arg)) {
                   8658: 	return $arg;
                   8659:     }
                   8660: }
                   8661: 
1.251     albertel 8662: ###############################################
1.182     matthew  8663: 
                   8664: =pod
                   8665: 
1.549     albertel 8666: =back
                   8667: 
                   8668: =head1 User Information Routines
                   8669: 
                   8670: =over 4
                   8671: 
1.405     albertel 8672: =item * &get_users_function()
1.182     matthew  8673: 
                   8674: Used by &bodytag to determine the current users primary role.
                   8675: Returns either 'student','coordinator','admin', or 'author'.
                   8676: 
                   8677: =cut
                   8678: 
                   8679: ###############################################
                   8680: sub get_users_function {
1.815     tempelho 8681:     my $function = 'norole';
1.818     tempelho 8682:     if ($env{'request.role'}=~/^(st)/) {
                   8683:         $function='student';
                   8684:     }
1.907     raeburn  8685:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  8686:         $function='coordinator';
                   8687:     }
1.258     albertel 8688:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  8689:         $function='admin';
                   8690:     }
1.826     bisitz   8691:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  8692:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  8693:         $function='author';
                   8694:     }
                   8695:     return $function;
1.54      www      8696: }
1.99      www      8697: 
                   8698: ###############################################
                   8699: 
1.233     raeburn  8700: =pod
                   8701: 
1.821     raeburn  8702: =item * &show_course()
                   8703: 
                   8704: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   8705: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   8706: 
                   8707: Inputs:
                   8708: None
                   8709: 
                   8710: Outputs:
                   8711: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   8712: 
                   8713: =cut
                   8714: 
                   8715: ###############################################
                   8716: sub show_course {
                   8717:     my $course = !$env{'user.adv'};
                   8718:     if (!$env{'user.adv'}) {
                   8719:         foreach my $env (keys(%env)) {
                   8720:             next if ($env !~ m/^user\.priv\./);
                   8721:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   8722:                 $course = 0;
                   8723:                 last;
                   8724:             }
                   8725:         }
                   8726:     }
                   8727:     return $course;
                   8728: }
                   8729: 
                   8730: ###############################################
                   8731: 
                   8732: =pod
                   8733: 
1.542     raeburn  8734: =item * &check_user_status()
1.274     raeburn  8735: 
                   8736: Determines current status of supplied role for a
                   8737: specific user. Roles can be active, previous or future.
                   8738: 
                   8739: Inputs: 
                   8740: user's domain, user's username, course's domain,
1.375     raeburn  8741: course's number, optional section ID.
1.274     raeburn  8742: 
                   8743: Outputs:
                   8744: role status: active, previous or future. 
                   8745: 
                   8746: =cut
                   8747: 
                   8748: sub check_user_status {
1.412     raeburn  8749:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  8750:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202    raeburn  8751:     my @uroles = keys(%userinfo);
1.274     raeburn  8752:     my $srchstr;
                   8753:     my $active_chk = 'none';
1.412     raeburn  8754:     my $now = time;
1.274     raeburn  8755:     if (@uroles > 0) {
1.908     raeburn  8756:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  8757:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   8758:         } else {
1.412     raeburn  8759:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   8760:         }
                   8761:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  8762:             my $role_end = 0;
                   8763:             my $role_start = 0;
                   8764:             $active_chk = 'active';
1.412     raeburn  8765:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   8766:                 $role_end = $1;
                   8767:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   8768:                     $role_start = $1;
1.274     raeburn  8769:                 }
                   8770:             }
                   8771:             if ($role_start > 0) {
1.412     raeburn  8772:                 if ($now < $role_start) {
1.274     raeburn  8773:                     $active_chk = 'future';
                   8774:                 }
                   8775:             }
                   8776:             if ($role_end > 0) {
1.412     raeburn  8777:                 if ($now > $role_end) {
1.274     raeburn  8778:                     $active_chk = 'previous';
                   8779:                 }
                   8780:             }
                   8781:         }
                   8782:     }
                   8783:     return $active_chk;
                   8784: }
                   8785: 
                   8786: ###############################################
                   8787: 
                   8788: =pod
                   8789: 
1.405     albertel 8790: =item * &get_sections()
1.233     raeburn  8791: 
                   8792: Determines all the sections for a course including
                   8793: sections with students and sections containing other roles.
1.419     raeburn  8794: Incoming parameters: 
                   8795: 
                   8796: 1. domain
                   8797: 2. course number 
                   8798: 3. reference to array containing roles for which sections should 
                   8799: be gathered (optional).
                   8800: 4. reference to array containing status types for which sections 
                   8801: should be gathered (optional).
                   8802: 
                   8803: If the third argument is undefined, sections are gathered for any role. 
                   8804: If the fourth argument is undefined, sections are gathered for any status.
                   8805: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  8806:  
1.374     raeburn  8807: Returns section hash (keys are section IDs, values are
                   8808: number of users in each section), subject to the
1.419     raeburn  8809: optional roles filter, optional status filter 
1.233     raeburn  8810: 
                   8811: =cut
                   8812: 
                   8813: ###############################################
                   8814: sub get_sections {
1.419     raeburn  8815:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 8816:     if (!defined($cdom) || !defined($cnum)) {
                   8817:         my $cid =  $env{'request.course.id'};
                   8818: 
                   8819: 	return if (!defined($cid));
                   8820: 
                   8821:         $cdom = $env{'course.'.$cid.'.domain'};
                   8822:         $cnum = $env{'course.'.$cid.'.num'};
                   8823:     }
                   8824: 
                   8825:     my %sectioncount;
1.419     raeburn  8826:     my $now = time;
1.240     albertel 8827: 
1.1118    raeburn  8828:     my $check_students = 1;
                   8829:     my $only_students = 0;
                   8830:     if (ref($possible_roles) eq 'ARRAY') {
                   8831:         if (grep(/^st$/,@{$possible_roles})) {
                   8832:             if (@{$possible_roles} == 1) {
                   8833:                 $only_students = 1;
                   8834:             }
                   8835:         } else {
                   8836:             $check_students = 0;
                   8837:         }
                   8838:     }
                   8839: 
                   8840:     if ($check_students) { 
1.276     albertel 8841: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 8842: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   8843: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  8844:         my $start_index = &Apache::loncoursedata::CL_START();
                   8845:         my $end_index = &Apache::loncoursedata::CL_END();
                   8846:         my $status;
1.366     albertel 8847: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  8848: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   8849: 				                     $data->[$status_index],
                   8850:                                                      $data->[$start_index],
                   8851:                                                      $data->[$end_index]);
                   8852:             if ($stu_status eq 'Active') {
                   8853:                 $status = 'active';
                   8854:             } elsif ($end < $now) {
                   8855:                 $status = 'previous';
                   8856:             } elsif ($start > $now) {
                   8857:                 $status = 'future';
                   8858:             } 
                   8859: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   8860:                 if ((!defined($possible_status)) || (($status ne '') && 
                   8861:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   8862: 		    $sectioncount{$section}++;
                   8863:                 }
1.240     albertel 8864: 	    }
                   8865: 	}
                   8866:     }
1.1118    raeburn  8867:     if ($only_students) {
                   8868:         return %sectioncount;
                   8869:     }
1.240     albertel 8870:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8871:     foreach my $user (sort(keys(%courseroles))) {
                   8872: 	if ($user !~ /^(\w{2})/) { next; }
                   8873: 	my ($role) = ($user =~ /^(\w{2})/);
                   8874: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  8875: 	my ($section,$status);
1.240     albertel 8876: 	if ($role eq 'cr' &&
                   8877: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   8878: 	    $section=$1;
                   8879: 	}
                   8880: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   8881: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  8882:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   8883:         if ($end == -1 && $start == -1) {
                   8884:             next; #deleted role
                   8885:         }
                   8886:         if (!defined($possible_status)) { 
                   8887:             $sectioncount{$section}++;
                   8888:         } else {
                   8889:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   8890:                 $status = 'active';
                   8891:             } elsif ($end < $now) {
                   8892:                 $status = 'future';
                   8893:             } elsif ($start > $now) {
                   8894:                 $status = 'previous';
                   8895:             }
                   8896:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   8897:                 $sectioncount{$section}++;
                   8898:             }
                   8899:         }
1.233     raeburn  8900:     }
1.366     albertel 8901:     return %sectioncount;
1.233     raeburn  8902: }
                   8903: 
1.274     raeburn  8904: ###############################################
1.294     raeburn  8905: 
                   8906: =pod
1.405     albertel 8907: 
                   8908: =item * &get_course_users()
                   8909: 
1.275     raeburn  8910: Retrieves usernames:domains for users in the specified course
                   8911: with specific role(s), and access status. 
                   8912: 
                   8913: Incoming parameters:
1.277     albertel 8914: 1. course domain
                   8915: 2. course number
                   8916: 3. access status: users must have - either active, 
1.275     raeburn  8917: previous, future, or all.
1.277     albertel 8918: 4. reference to array of permissible roles
1.288     raeburn  8919: 5. reference to array of section restrictions (optional)
                   8920: 6. reference to results object (hash of hashes).
                   8921: 7. reference to optional userdata hash
1.609     raeburn  8922: 8. reference to optional statushash
1.630     raeburn  8923: 9. flag if privileged users (except those set to unhide in
                   8924:    course settings) should be excluded    
1.609     raeburn  8925: Keys of top level results hash are roles.
1.275     raeburn  8926: Keys of inner hashes are username:domain, with 
                   8927: values set to access type.
1.288     raeburn  8928: Optional userdata hash returns an array with arguments in the 
                   8929: same order as loncoursedata::get_classlist() for student data.
                   8930: 
1.609     raeburn  8931: Optional statushash returns
                   8932: 
1.288     raeburn  8933: Entries for end, start, section and status are blank because
                   8934: of the possibility of multiple values for non-student roles.
                   8935: 
1.275     raeburn  8936: =cut
1.405     albertel 8937: 
1.275     raeburn  8938: ###############################################
1.405     albertel 8939: 
1.275     raeburn  8940: sub get_course_users {
1.630     raeburn  8941:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  8942:     my %idx = ();
1.419     raeburn  8943:     my %seclists;
1.288     raeburn  8944: 
                   8945:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   8946:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   8947:     $idx{end} = &Apache::loncoursedata::CL_END();
                   8948:     $idx{start} = &Apache::loncoursedata::CL_START();
                   8949:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   8950:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   8951:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   8952:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   8953: 
1.290     albertel 8954:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 8955:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  8956:         my $now = time;
1.277     albertel 8957:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  8958:             my $match = 0;
1.412     raeburn  8959:             my $secmatch = 0;
1.419     raeburn  8960:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  8961:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  8962:             if ($section eq '') {
                   8963:                 $section = 'none';
                   8964:             }
1.291     albertel 8965:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8966:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8967:                     $secmatch = 1;
                   8968:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 8969:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8970:                         $secmatch = 1;
                   8971:                     }
                   8972:                 } else {  
1.419     raeburn  8973: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  8974: 		        $secmatch = 1;
                   8975:                     }
1.290     albertel 8976: 		}
1.412     raeburn  8977:                 if (!$secmatch) {
                   8978:                     next;
                   8979:                 }
1.419     raeburn  8980:             }
1.275     raeburn  8981:             if (defined($$types{'active'})) {
1.288     raeburn  8982:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  8983:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  8984:                     $match = 1;
1.275     raeburn  8985:                 }
                   8986:             }
                   8987:             if (defined($$types{'previous'})) {
1.609     raeburn  8988:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  8989:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  8990:                     $match = 1;
1.275     raeburn  8991:                 }
                   8992:             }
                   8993:             if (defined($$types{'future'})) {
1.609     raeburn  8994:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  8995:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  8996:                     $match = 1;
1.275     raeburn  8997:                 }
                   8998:             }
1.609     raeburn  8999:             if ($match) {
                   9000:                 push(@{$seclists{$student}},$section);
                   9001:                 if (ref($userdata) eq 'HASH') {
                   9002:                     $$userdata{$student} = $$classlist{$student};
                   9003:                 }
                   9004:                 if (ref($statushash) eq 'HASH') {
                   9005:                     $statushash->{$student}{'st'}{$section} = $status;
                   9006:                 }
1.288     raeburn  9007:             }
1.275     raeburn  9008:         }
                   9009:     }
1.412     raeburn  9010:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9011:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9012:         my $now = time;
1.609     raeburn  9013:         my %displaystatus = ( previous => 'Expired',
                   9014:                               active   => 'Active',
                   9015:                               future   => 'Future',
                   9016:                             );
1.1121    raeburn  9017:         my (%nothide,@possdoms);
1.630     raeburn  9018:         if ($hidepriv) {
                   9019:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9020:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9021:                 if ($user !~ /:/) {
                   9022:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9023:                 } else {
                   9024:                     $nothide{$user} = 1;
                   9025:                 }
                   9026:             }
1.1121    raeburn  9027:             my @possdoms = ($cdom);
                   9028:             if ($coursehash{'checkforpriv'}) {
                   9029:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9030:             }
1.630     raeburn  9031:         }
1.439     raeburn  9032:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9033:             my $match = 0;
1.412     raeburn  9034:             my $secmatch = 0;
1.439     raeburn  9035:             my $status;
1.412     raeburn  9036:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9037:             $user =~ s/:$//;
1.439     raeburn  9038:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9039:             if ($end == -1 || $start == -1) {
                   9040:                 next;
                   9041:             }
                   9042:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9043:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9044:                 my ($uname,$udom) = split(/:/,$user);
                   9045:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9046:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9047:                         $secmatch = 1;
                   9048:                     } elsif ($usec eq '') {
1.420     albertel 9049:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9050:                             $secmatch = 1;
                   9051:                         }
                   9052:                     } else {
                   9053:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9054:                             $secmatch = 1;
                   9055:                         }
                   9056:                     }
                   9057:                     if (!$secmatch) {
                   9058:                         next;
                   9059:                     }
1.288     raeburn  9060:                 }
1.419     raeburn  9061:                 if ($usec eq '') {
                   9062:                     $usec = 'none';
                   9063:                 }
1.275     raeburn  9064:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9065:                     if ($hidepriv) {
1.1121    raeburn  9066:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9067:                             (!$nothide{$uname.':'.$udom})) {
                   9068:                             next;
                   9069:                         }
                   9070:                     }
1.503     raeburn  9071:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9072:                         $status = 'previous';
                   9073:                     } elsif ($start > $now) {
                   9074:                         $status = 'future';
                   9075:                     } else {
                   9076:                         $status = 'active';
                   9077:                     }
1.277     albertel 9078:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9079:                         if ($status eq $type) {
1.420     albertel 9080:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9081:                                 push(@{$$users{$role}{$user}},$type);
                   9082:                             }
1.288     raeburn  9083:                             $match = 1;
                   9084:                         }
                   9085:                     }
1.419     raeburn  9086:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9087:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9088: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9089:                         }
1.420     albertel 9090:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9091:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9092:                         }
1.609     raeburn  9093:                         if (ref($statushash) eq 'HASH') {
                   9094:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9095:                         }
1.275     raeburn  9096:                     }
                   9097:                 }
                   9098:             }
                   9099:         }
1.290     albertel 9100:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9101:             if ((defined($cdom)) && (defined($cnum))) {
                   9102:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9103:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9104:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9105:                     next if ($owner eq '');
                   9106:                     my ($ownername,$ownerdom);
                   9107:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9108:                         $ownername = $1;
                   9109:                         $ownerdom = $2;
                   9110:                     } else {
                   9111:                         $ownername = $owner;
                   9112:                         $ownerdom = $cdom;
                   9113:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9114:                     }
                   9115:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9116:                     if (defined($userdata) && 
1.609     raeburn  9117: 			!exists($$userdata{$owner})) {
                   9118: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9119:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9120:                             push(@{$seclists{$owner}},'none');
                   9121:                         }
                   9122:                         if (ref($statushash) eq 'HASH') {
                   9123:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9124:                         }
1.290     albertel 9125: 		    }
1.279     raeburn  9126:                 }
                   9127:             }
                   9128:         }
1.419     raeburn  9129:         foreach my $user (keys(%seclists)) {
                   9130:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9131:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9132:         }
1.275     raeburn  9133:     }
                   9134:     return;
                   9135: }
                   9136: 
1.288     raeburn  9137: sub get_user_info {
                   9138:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9139:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9140: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9141:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9142:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9143:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9144:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9145:     return;
                   9146: }
1.275     raeburn  9147: 
1.472     raeburn  9148: ###############################################
                   9149: 
                   9150: =pod
                   9151: 
                   9152: =item * &get_user_quota()
                   9153: 
1.1134    raeburn  9154: Retrieves quota assigned for storage of user files.
                   9155: Default is to report quota for portfolio files.
1.472     raeburn  9156: 
                   9157: Incoming parameters:
                   9158: 1. user's username
                   9159: 2. user's domain
1.1134    raeburn  9160: 3. quota name - portfolio, author, or course
1.1136    raeburn  9161:    (if no quota name provided, defaults to portfolio).
1.1165    raeburn  9162: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1136    raeburn  9163:    course
1.472     raeburn  9164: 
                   9165: Returns:
1.1163    raeburn  9166: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9167: 2. (Optional) Type of setting: custom or default
                   9168:    (individually assigned or default for user's 
                   9169:    institutional status).
                   9170: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9171:    or student - types as defined in localenroll::inst_usertypes 
                   9172:    for user's domain, which determines default quota for user.
                   9173: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9174: 
                   9175: If a value has been stored in the user's environment, 
1.536     raeburn  9176: it will return that, otherwise it returns the maximal default
1.1134    raeburn  9177: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9178: 
                   9179: =cut
                   9180: 
                   9181: ###############################################
                   9182: 
                   9183: 
                   9184: sub get_user_quota {
1.1136    raeburn  9185:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9186:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9187:     if (!defined($udom)) {
                   9188:         $udom = $env{'user.domain'};
                   9189:     }
                   9190:     if (!defined($uname)) {
                   9191:         $uname = $env{'user.name'};
                   9192:     }
                   9193:     if (($udom eq '' || $uname eq '') ||
                   9194:         ($udom eq 'public') && ($uname eq 'public')) {
                   9195:         $quota = 0;
1.536     raeburn  9196:         $quotatype = 'default';
                   9197:         $defquota = 0; 
1.472     raeburn  9198:     } else {
1.536     raeburn  9199:         my $inststatus;
1.1134    raeburn  9200:         if ($quotaname eq 'course') {
                   9201:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9202:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9203:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9204:             } else {
                   9205:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9206:                 $quota = $cenv{'internal.uploadquota'};
                   9207:             }
1.536     raeburn  9208:         } else {
1.1134    raeburn  9209:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9210:                 if ($quotaname eq 'author') {
                   9211:                     $quota = $env{'environment.authorquota'};
                   9212:                 } else {
                   9213:                     $quota = $env{'environment.portfolioquota'};
                   9214:                 }
                   9215:                 $inststatus = $env{'environment.inststatus'};
                   9216:             } else {
                   9217:                 my %userenv = 
                   9218:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9219:                                          'authorquota','inststatus'],$udom,$uname);
                   9220:                 my ($tmp) = keys(%userenv);
                   9221:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9222:                     if ($quotaname eq 'author') {
                   9223:                         $quota = $userenv{'authorquota'};
                   9224:                     } else {
                   9225:                         $quota = $userenv{'portfolioquota'};
                   9226:                     }
                   9227:                     $inststatus = $userenv{'inststatus'};
                   9228:                 } else {
                   9229:                     undef(%userenv);
                   9230:                 }
                   9231:             }
                   9232:         }
                   9233:         if ($quota eq '' || wantarray) {
                   9234:             if ($quotaname eq 'course') {
                   9235:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165    raeburn  9236:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') || 
                   9237:                     ($crstype eq 'community') || ($crstype eq 'textbook')) { 
1.1136    raeburn  9238:                     $defquota = $domdefs{$crstype.'quota'};
                   9239:                 }
                   9240:                 if ($defquota eq '') {
                   9241:                     $defquota = 500;
                   9242:                 }
1.1134    raeburn  9243:             } else {
                   9244:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9245:             }
                   9246:             if ($quota eq '') {
                   9247:                 $quota = $defquota;
                   9248:                 $quotatype = 'default';
                   9249:             } else {
                   9250:                 $quotatype = 'custom';
                   9251:             }
1.472     raeburn  9252:         }
                   9253:     }
1.536     raeburn  9254:     if (wantarray) {
                   9255:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9256:     } else {
                   9257:         return $quota;
                   9258:     }
1.472     raeburn  9259: }
                   9260: 
                   9261: ###############################################
                   9262: 
                   9263: =pod
                   9264: 
                   9265: =item * &default_quota()
                   9266: 
1.536     raeburn  9267: Retrieves default quota assigned for storage of user portfolio files,
                   9268: given an (optional) user's institutional status.
1.472     raeburn  9269: 
                   9270: Incoming parameters:
1.1142    raeburn  9271: 
1.472     raeburn  9272: 1. domain
1.536     raeburn  9273: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9274:    status types (e.g., faculty, staff, student etc.)
                   9275:    which apply to the user for whom the default is being retrieved.
                   9276:    If the institutional status string in undefined, the domain
1.1134    raeburn  9277:    default quota will be returned.
                   9278: 3.  quota name - portfolio, author, or course
                   9279:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9280: 
                   9281: Returns:
1.1142    raeburn  9282: 
1.1163    raeburn  9283: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9284: 2. (Optional) institutional type which determined the value of the
                   9285:    default quota.
1.472     raeburn  9286: 
                   9287: If a value has been stored in the domain's configuration db,
                   9288: it will return that, otherwise it returns 20 (for backwards 
                   9289: compatibility with domains which have not set up a configuration
1.1163    raeburn  9290: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9291: 
1.536     raeburn  9292: If the user's status includes multiple types (e.g., staff and student),
                   9293: the largest default quota which applies to the user determines the
                   9294: default quota returned.
                   9295: 
1.472     raeburn  9296: =cut
                   9297: 
                   9298: ###############################################
                   9299: 
                   9300: 
                   9301: sub default_quota {
1.1134    raeburn  9302:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9303:     my ($defquota,$settingstatus);
                   9304:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9305:                                             ['quotas'],$udom);
1.1134    raeburn  9306:     my $key = 'defaultquota';
                   9307:     if ($quotaname eq 'author') {
                   9308:         $key = 'authorquota';
                   9309:     }
1.622     raeburn  9310:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9311:         if ($inststatus ne '') {
1.765     raeburn  9312:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9313:             foreach my $item (@statuses) {
1.1134    raeburn  9314:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9315:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9316:                         if ($defquota eq '') {
1.1134    raeburn  9317:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9318:                             $settingstatus = $item;
1.1134    raeburn  9319:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9320:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9321:                             $settingstatus = $item;
                   9322:                         }
                   9323:                     }
1.1134    raeburn  9324:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9325:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9326:                         if ($defquota eq '') {
                   9327:                             $defquota = $quotahash{'quotas'}{$item};
                   9328:                             $settingstatus = $item;
                   9329:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9330:                             $defquota = $quotahash{'quotas'}{$item};
                   9331:                             $settingstatus = $item;
                   9332:                         }
1.536     raeburn  9333:                     }
                   9334:                 }
                   9335:             }
                   9336:         }
                   9337:         if ($defquota eq '') {
1.1134    raeburn  9338:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9339:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9340:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9341:                 $defquota = $quotahash{'quotas'}{'default'};
                   9342:             }
1.536     raeburn  9343:             $settingstatus = 'default';
1.1139    raeburn  9344:             if ($defquota eq '') {
                   9345:                 if ($quotaname eq 'author') {
                   9346:                     $defquota = 500;
                   9347:                 }
                   9348:             }
1.536     raeburn  9349:         }
                   9350:     } else {
                   9351:         $settingstatus = 'default';
1.1134    raeburn  9352:         if ($quotaname eq 'author') {
                   9353:             $defquota = 500;
                   9354:         } else {
                   9355:             $defquota = 20;
                   9356:         }
1.536     raeburn  9357:     }
                   9358:     if (wantarray) {
                   9359:         return ($defquota,$settingstatus);
1.472     raeburn  9360:     } else {
1.536     raeburn  9361:         return $defquota;
1.472     raeburn  9362:     }
                   9363: }
                   9364: 
1.1135    raeburn  9365: ###############################################
                   9366: 
                   9367: =pod
                   9368: 
1.1136    raeburn  9369: =item * &excess_filesize_warning()
1.1135    raeburn  9370: 
                   9371: Returns warning message if upload of file to authoring space, or copying
1.1136    raeburn  9372: of existing file within authoring space will cause quota for the authoring
1.1146    raeburn  9373: space to be exceeded.
1.1136    raeburn  9374: 
                   9375: Same, if upload of a file directly to a course/community via Course Editor
1.1137    raeburn  9376: will cause quota for uploaded content for the course to be exceeded.
1.1135    raeburn  9377: 
1.1165    raeburn  9378: Inputs: 7 
1.1136    raeburn  9379: 1. username or coursenum
1.1135    raeburn  9380: 2. domain
1.1136    raeburn  9381: 3. context ('author' or 'course')
1.1135    raeburn  9382: 4. filename of file for which action is being requested
                   9383: 5. filesize (kB) of file
                   9384: 6. action being taken: copy or upload.
1.1165    raeburn  9385: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1135    raeburn  9386: 
                   9387: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142    raeburn  9388:          otherwise return null.
                   9389: 
                   9390: =back
1.1135    raeburn  9391: 
                   9392: =cut
                   9393: 
1.1136    raeburn  9394: sub excess_filesize_warning {
1.1165    raeburn  9395:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136    raeburn  9396:     my $current_disk_usage = 0;
1.1165    raeburn  9397:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136    raeburn  9398:     if ($context eq 'author') {
                   9399:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9400:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9401:     } else {
                   9402:         foreach my $subdir ('docs','supplemental') {
                   9403:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9404:         }
                   9405:     }
1.1135    raeburn  9406:     $disk_quota = int($disk_quota * 1000);
                   9407:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179    bisitz   9408:         return '<p class="LC_warning">'.
1.1135    raeburn  9409:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179    bisitz   9410:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9411:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135    raeburn  9412:                             $disk_quota,$current_disk_usage).
                   9413:                '</p>';
                   9414:     }
                   9415:     return;
                   9416: }
                   9417: 
                   9418: ###############################################
                   9419: 
                   9420: 
1.1136    raeburn  9421: 
                   9422: 
1.384     raeburn  9423: sub get_secgrprole_info {
                   9424:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9425:     my %sections_count = &get_sections($cdom,$cnum);
                   9426:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9427:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9428:     my @groups = sort(keys(%curr_groups));
                   9429:     my $allroles = [];
                   9430:     my $rolehash;
                   9431:     my $accesshash = {
                   9432:                      active => 'Currently has access',
                   9433:                      future => 'Will have future access',
                   9434:                      previous => 'Previously had access',
                   9435:                   };
                   9436:     if ($needroles) {
                   9437:         $rolehash = {'all' => 'all'};
1.385     albertel 9438:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9439: 	if (&Apache::lonnet::error(%user_roles)) {
                   9440: 	    undef(%user_roles);
                   9441: 	}
                   9442:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9443:             my ($role)=split(/\:/,$item,2);
                   9444:             if ($role eq 'cr') { next; }
                   9445:             if ($role =~ /^cr/) {
                   9446:                 $$rolehash{$role} = (split('/',$role))[3];
                   9447:             } else {
                   9448:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9449:             }
                   9450:         }
                   9451:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9452:             push(@{$allroles},$key);
                   9453:         }
                   9454:         push (@{$allroles},'st');
                   9455:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9456:     }
                   9457:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9458: }
                   9459: 
1.555     raeburn  9460: sub user_picker {
1.994     raeburn  9461:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  9462:     my $currdom = $dom;
                   9463:     my %curr_selected = (
                   9464:                         srchin => 'dom',
1.580     raeburn  9465:                         srchby => 'lastname',
1.555     raeburn  9466:                       );
                   9467:     my $srchterm;
1.625     raeburn  9468:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9469:         if ($srch->{'srchby'} ne '') {
                   9470:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9471:         }
                   9472:         if ($srch->{'srchin'} ne '') {
                   9473:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9474:         }
                   9475:         if ($srch->{'srchtype'} ne '') {
                   9476:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9477:         }
                   9478:         if ($srch->{'srchdomain'} ne '') {
                   9479:             $currdom = $srch->{'srchdomain'};
                   9480:         }
                   9481:         $srchterm = $srch->{'srchterm'};
                   9482:     }
                   9483:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  9484:                     'usr'       => 'Search criteria',
1.563     raeburn  9485:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9486:                     'uname'     => 'username',
                   9487:                     'lastname'  => 'last name',
1.555     raeburn  9488:                     'lastfirst' => 'last name, first name',
1.558     albertel 9489:                     'crs'       => 'in this course',
1.576     raeburn  9490:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9491:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9492:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9493:                     'exact'     => 'is',
                   9494:                     'contains'  => 'contains',
1.569     raeburn  9495:                     'begins'    => 'begins with',
1.571     raeburn  9496:                     'youm'      => "You must include some text to search for.",
                   9497:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9498:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9499:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9500:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9501:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9502:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9503:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9504:                                        );
1.563     raeburn  9505:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   9506:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9507: 
                   9508:     my @srchins = ('crs','dom','alc','instd');
                   9509: 
                   9510:     foreach my $option (@srchins) {
                   9511:         # FIXME 'alc' option unavailable until 
                   9512:         #       loncreateuser::print_user_query_page()
                   9513:         #       has been completed.
                   9514:         next if ($option eq 'alc');
1.880     raeburn  9515:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9516:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  9517:         if ($curr_selected{'srchin'} eq $option) {
                   9518:             $srchinsel .= ' 
                   9519:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   9520:         } else {
                   9521:             $srchinsel .= '
                   9522:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   9523:         }
1.555     raeburn  9524:     }
1.563     raeburn  9525:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9526: 
                   9527:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9528:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9529:         if ($curr_selected{'srchby'} eq $option) {
                   9530:             $srchbysel .= '
                   9531:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   9532:         } else {
                   9533:             $srchbysel .= '
                   9534:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   9535:          }
                   9536:     }
                   9537:     $srchbysel .= "\n  </select>\n";
                   9538: 
                   9539:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9540:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9541:         if ($curr_selected{'srchtype'} eq $option) {
                   9542:             $srchtypesel .= '
                   9543:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   9544:         } else {
                   9545:             $srchtypesel .= '
                   9546:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   9547:         }
                   9548:     }
                   9549:     $srchtypesel .= "\n  </select>\n";
                   9550: 
1.558     albertel 9551:     my ($newuserscript,$new_user_create);
1.994     raeburn  9552:     my $context_dom = $env{'request.role.domain'};
                   9553:     if ($context eq 'requestcrs') {
                   9554:         if ($env{'form.coursedom'} ne '') { 
                   9555:             $context_dom = $env{'form.coursedom'};
                   9556:         }
                   9557:     }
1.556     raeburn  9558:     if ($forcenewuser) {
1.576     raeburn  9559:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9560:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9561:                 if ($cancreate) {
                   9562:                     $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>';
                   9563:                 } else {
1.799     bisitz   9564:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9565:                     my %usertypetext = (
                   9566:                         official   => 'institutional',
                   9567:                         unofficial => 'non-institutional',
                   9568:                     );
1.799     bisitz   9569:                     $new_user_create = '<p class="LC_warning">'
                   9570:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   9571:                                       .' '
                   9572:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   9573:                                           ,'<a href="'.$helplink.'">','</a>')
                   9574:                                       .'</p><br />';
1.627     raeburn  9575:                 }
1.576     raeburn  9576:             }
                   9577:         }
                   9578: 
1.556     raeburn  9579:         $newuserscript = <<"ENDSCRIPT";
                   9580: 
1.570     raeburn  9581: function setSearch(createnew,callingForm) {
1.556     raeburn  9582:     if (createnew == 1) {
1.570     raeburn  9583:         for (var i=0; i<callingForm.srchby.length; i++) {
                   9584:             if (callingForm.srchby.options[i].value == 'uname') {
                   9585:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  9586:             }
                   9587:         }
1.570     raeburn  9588:         for (var i=0; i<callingForm.srchin.length; i++) {
                   9589:             if ( callingForm.srchin.options[i].value == 'dom') {
                   9590: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  9591:             }
                   9592:         }
1.570     raeburn  9593:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   9594:             if (callingForm.srchtype.options[i].value == 'exact') {
                   9595:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  9596:             }
                   9597:         }
1.570     raeburn  9598:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  9599:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  9600:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  9601:             }
                   9602:         }
                   9603:     }
                   9604: }
                   9605: ENDSCRIPT
1.558     albertel 9606: 
1.556     raeburn  9607:     }
                   9608: 
1.555     raeburn  9609:     my $output = <<"END_BLOCK";
1.556     raeburn  9610: <script type="text/javascript">
1.824     bisitz   9611: // <![CDATA[
1.570     raeburn  9612: function validateEntry(callingForm) {
1.558     albertel 9613: 
1.556     raeburn  9614:     var checkok = 1;
1.558     albertel 9615:     var srchin;
1.570     raeburn  9616:     for (var i=0; i<callingForm.srchin.length; i++) {
                   9617: 	if ( callingForm.srchin[i].checked ) {
                   9618: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 9619: 	}
                   9620:     }
                   9621: 
1.570     raeburn  9622:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   9623:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   9624:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   9625:     var srchterm =  callingForm.srchterm.value;
                   9626:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  9627:     var msg = "";
                   9628: 
                   9629:     if (srchterm == "") {
                   9630:         checkok = 0;
1.571     raeburn  9631:         msg += "$lt{'youm'}\\n";
1.556     raeburn  9632:     }
                   9633: 
1.569     raeburn  9634:     if (srchtype== 'begins') {
                   9635:         if (srchterm.length < 2) {
                   9636:             checkok = 0;
1.571     raeburn  9637:             msg += "$lt{'thte'}\\n";
1.569     raeburn  9638:         }
                   9639:     }
                   9640: 
1.556     raeburn  9641:     if (srchtype== 'contains') {
                   9642:         if (srchterm.length < 3) {
                   9643:             checkok = 0;
1.571     raeburn  9644:             msg += "$lt{'thet'}\\n";
1.556     raeburn  9645:         }
                   9646:     }
                   9647:     if (srchin == 'instd') {
                   9648:         if (srchdomain == '') {
                   9649:             checkok = 0;
1.571     raeburn  9650:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  9651:         }
                   9652:     }
                   9653:     if (srchin == 'dom') {
                   9654:         if (srchdomain == '') {
                   9655:             checkok = 0;
1.571     raeburn  9656:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  9657:         }
                   9658:     }
                   9659:     if (srchby == 'lastfirst') {
                   9660:         if (srchterm.indexOf(",") == -1) {
                   9661:             checkok = 0;
1.571     raeburn  9662:             msg += "$lt{'whus'}\\n";
1.556     raeburn  9663:         }
                   9664:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   9665:             checkok = 0;
1.571     raeburn  9666:             msg += "$lt{'whse'}\\n";
1.556     raeburn  9667:         }
                   9668:     }
                   9669:     if (checkok == 0) {
1.571     raeburn  9670:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  9671:         return;
                   9672:     }
                   9673:     if (checkok == 1) {
1.570     raeburn  9674:         callingForm.submit();
1.556     raeburn  9675:     }
                   9676: }
                   9677: 
                   9678: $newuserscript
                   9679: 
1.824     bisitz   9680: // ]]>
1.556     raeburn  9681: </script>
1.558     albertel 9682: 
                   9683: $new_user_create
                   9684: 
1.555     raeburn  9685: END_BLOCK
1.558     albertel 9686: 
1.876     raeburn  9687:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   9688:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   9689:                $domform.
                   9690:                &Apache::lonhtmlcommon::row_closure().
                   9691:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   9692:                $srchbysel.
                   9693:                $srchtypesel. 
                   9694:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   9695:                $srchinsel.
                   9696:                &Apache::lonhtmlcommon::row_closure(1). 
                   9697:                &Apache::lonhtmlcommon::end_pick_box().
                   9698:                '<br />';
1.555     raeburn  9699:     return $output;
                   9700: }
                   9701: 
1.612     raeburn  9702: sub user_rule_check {
1.615     raeburn  9703:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  9704:     my $response;
                   9705:     if (ref($usershash) eq 'HASH') {
                   9706:         foreach my $user (keys(%{$usershash})) {
                   9707:             my ($uname,$udom) = split(/:/,$user);
                   9708:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  9709:             my ($id,$newuser);
1.612     raeburn  9710:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  9711:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  9712:                 $id = $usershash->{$user}->{'id'};
                   9713:             }
                   9714:             my $inst_response;
                   9715:             if (ref($checks) eq 'HASH') {
                   9716:                 if (defined($checks->{'username'})) {
1.615     raeburn  9717:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  9718:                         &Apache::lonnet::get_instuser($udom,$uname);
                   9719:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  9720:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  9721:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   9722:                 }
1.615     raeburn  9723:             } else {
                   9724:                 ($inst_response,%{$inst_results->{$user}}) =
                   9725:                     &Apache::lonnet::get_instuser($udom,$uname);
                   9726:                 return;
1.612     raeburn  9727:             }
1.615     raeburn  9728:             if (!$got_rules->{$udom}) {
1.612     raeburn  9729:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   9730:                                                   ['usercreation'],$udom);
                   9731:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  9732:                     foreach my $item ('username','id') {
1.612     raeburn  9733:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   9734:                             $$curr_rules{$udom}{$item} = 
                   9735:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  9736:                         }
                   9737:                     }
                   9738:                 }
1.615     raeburn  9739:                 $got_rules->{$udom} = 1;  
1.585     raeburn  9740:             }
1.612     raeburn  9741:             foreach my $item (keys(%{$checks})) {
                   9742:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   9743:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   9744:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   9745:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   9746:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   9747:                                 if ($rule_check{$rule}) {
                   9748:                                     $$rulematch{$user}{$item} = $rule;
                   9749:                                     if ($inst_response eq 'ok') {
1.615     raeburn  9750:                                         if (ref($inst_results) eq 'HASH') {
                   9751:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   9752:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   9753:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   9754:                                                 }
1.612     raeburn  9755:                                             }
                   9756:                                         }
1.615     raeburn  9757:                                     }
                   9758:                                     last;
1.585     raeburn  9759:                                 }
                   9760:                             }
                   9761:                         }
                   9762:                     }
                   9763:                 }
                   9764:             }
                   9765:         }
                   9766:     }
1.612     raeburn  9767:     return;
                   9768: }
                   9769: 
                   9770: sub user_rule_formats {
                   9771:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   9772:     my %text = ( 
                   9773:                  'username' => 'Usernames',
                   9774:                  'id'       => 'IDs',
                   9775:                );
                   9776:     my $output;
                   9777:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   9778:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   9779:         if (@{$ruleorder} > 0) {
1.1102    raeburn  9780:             $output = '<br />'.
                   9781:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   9782:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   9783:                       ' <ul>';
1.612     raeburn  9784:             foreach my $rule (@{$ruleorder}) {
                   9785:                 if (ref($curr_rules) eq 'ARRAY') {
                   9786:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   9787:                         if (ref($rules->{$rule}) eq 'HASH') {
                   9788:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   9789:                                         $rules->{$rule}{'desc'}.'</li>';
                   9790:                         }
                   9791:                     }
                   9792:                 }
                   9793:             }
                   9794:             $output .= '</ul>';
                   9795:         }
                   9796:     }
                   9797:     return $output;
                   9798: }
                   9799: 
                   9800: sub instrule_disallow_msg {
1.615     raeburn  9801:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  9802:     my $response;
                   9803:     my %text = (
                   9804:                   item   => 'username',
                   9805:                   items  => 'usernames',
                   9806:                   match  => 'matches',
                   9807:                   do     => 'does',
                   9808:                   action => 'a username',
                   9809:                   one    => 'one',
                   9810:                );
                   9811:     if ($count > 1) {
                   9812:         $text{'item'} = 'usernames';
                   9813:         $text{'match'} ='match';
                   9814:         $text{'do'} = 'do';
                   9815:         $text{'action'} = 'usernames',
                   9816:         $text{'one'} = 'ones';
                   9817:     }
                   9818:     if ($checkitem eq 'id') {
                   9819:         $text{'items'} = 'IDs';
                   9820:         $text{'item'} = 'ID';
                   9821:         $text{'action'} = 'an ID';
1.615     raeburn  9822:         if ($count > 1) {
                   9823:             $text{'item'} = 'IDs';
                   9824:             $text{'action'} = 'IDs';
                   9825:         }
1.612     raeburn  9826:     }
1.674     bisitz   9827:     $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  9828:     if ($mode eq 'upload') {
                   9829:         if ($checkitem eq 'username') {
                   9830:             $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'}.");
                   9831:         } elsif ($checkitem eq 'id') {
1.674     bisitz   9832:             $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  9833:         }
1.669     raeburn  9834:     } elsif ($mode eq 'selfcreate') {
                   9835:         if ($checkitem eq 'id') {
                   9836:             $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.");
                   9837:         }
1.615     raeburn  9838:     } else {
                   9839:         if ($checkitem eq 'username') {
                   9840:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   9841:         } elsif ($checkitem eq 'id') {
                   9842:             $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.");
                   9843:         }
1.612     raeburn  9844:     }
                   9845:     return $response;
1.585     raeburn  9846: }
                   9847: 
1.624     raeburn  9848: sub personal_data_fieldtitles {
                   9849:     my %fieldtitles = &Apache::lonlocal::texthash (
                   9850:                         id => 'Student/Employee ID',
                   9851:                         permanentemail => 'E-mail address',
                   9852:                         lastname => 'Last Name',
                   9853:                         firstname => 'First Name',
                   9854:                         middlename => 'Middle Name',
                   9855:                         generation => 'Generation',
                   9856:                         gen => 'Generation',
1.765     raeburn  9857:                         inststatus => 'Affiliation',
1.624     raeburn  9858:                    );
                   9859:     return %fieldtitles;
                   9860: }
                   9861: 
1.642     raeburn  9862: sub sorted_inst_types {
                   9863:     my ($dom) = @_;
1.1185    raeburn  9864:     my ($usertypes,$order);
                   9865:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   9866:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   9867:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   9868:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   9869:     } else {
                   9870:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   9871:     }
1.642     raeburn  9872:     my $othertitle = &mt('All users');
                   9873:     if ($env{'request.course.id'}) {
1.668     raeburn  9874:         $othertitle  = &mt('Any users');
1.642     raeburn  9875:     }
                   9876:     my @types;
                   9877:     if (ref($order) eq 'ARRAY') {
                   9878:         @types = @{$order};
                   9879:     }
                   9880:     if (@types == 0) {
                   9881:         if (ref($usertypes) eq 'HASH') {
                   9882:             @types = sort(keys(%{$usertypes}));
                   9883:         }
                   9884:     }
                   9885:     if (keys(%{$usertypes}) > 0) {
                   9886:         $othertitle = &mt('Other users');
                   9887:     }
                   9888:     return ($othertitle,$usertypes,\@types);
                   9889: }
                   9890: 
1.645     raeburn  9891: sub get_institutional_codes {
                   9892:     my ($settings,$allcourses,$LC_code) = @_;
                   9893: # Get complete list of course sections to update
                   9894:     my @currsections = ();
                   9895:     my @currxlists = ();
                   9896:     my $coursecode = $$settings{'internal.coursecode'};
                   9897: 
                   9898:     if ($$settings{'internal.sectionnums'} ne '') {
                   9899:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   9900:     }
                   9901: 
                   9902:     if ($$settings{'internal.crosslistings'} ne '') {
                   9903:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   9904:     }
                   9905: 
                   9906:     if (@currxlists > 0) {
                   9907:         foreach (@currxlists) {
                   9908:             if (m/^([^:]+):(\w*)$/) {
                   9909:                 unless (grep/^$1$/,@{$allcourses}) {
                   9910:                     push @{$allcourses},$1;
                   9911:                     $$LC_code{$1} = $2;
                   9912:                 }
                   9913:             }
                   9914:         }
                   9915:     }
                   9916:  
                   9917:     if (@currsections > 0) {
                   9918:         foreach (@currsections) {
                   9919:             if (m/^(\w+):(\w*)$/) {
                   9920:                 my $sec = $coursecode.$1;
                   9921:                 my $lc_sec = $2;
                   9922:                 unless (grep/^$sec$/,@{$allcourses}) {
                   9923:                     push @{$allcourses},$sec;
                   9924:                     $$LC_code{$sec} = $lc_sec;
                   9925:                 }
                   9926:             }
                   9927:         }
                   9928:     }
                   9929:     return;
                   9930: }
                   9931: 
1.971     raeburn  9932: sub get_standard_codeitems {
                   9933:     return ('Year','Semester','Department','Number','Section');
                   9934: }
                   9935: 
1.112     bowersj2 9936: =pod
                   9937: 
1.780     raeburn  9938: =head1 Slot Helpers
                   9939: 
                   9940: =over 4
                   9941: 
                   9942: =item * sorted_slots()
                   9943: 
1.1040    raeburn  9944: Sorts an array of slot names in order of an optional sort key,
                   9945: default sort is by slot start time (earliest first). 
1.780     raeburn  9946: 
                   9947: Inputs:
                   9948: 
                   9949: =over 4
                   9950: 
                   9951: slotsarr  - Reference to array of unsorted slot names.
                   9952: 
                   9953: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   9954: 
1.1040    raeburn  9955: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   9956: 
1.549     albertel 9957: =back
                   9958: 
1.780     raeburn  9959: Returns:
                   9960: 
                   9961: =over 4
                   9962: 
1.1040    raeburn  9963: sorted   - An array of slot names sorted by a specified sort key 
                   9964:            (default sort key is start time of the slot).
1.780     raeburn  9965: 
                   9966: =back
                   9967: 
                   9968: =cut
                   9969: 
                   9970: 
                   9971: sub sorted_slots {
1.1040    raeburn  9972:     my ($slotsarr,$slots,$sortkey) = @_;
                   9973:     if ($sortkey eq '') {
                   9974:         $sortkey = 'starttime';
                   9975:     }
1.780     raeburn  9976:     my @sorted;
                   9977:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   9978:         @sorted =
                   9979:             sort {
                   9980:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  9981:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  9982:                      }
                   9983:                      if (ref($slots->{$a})) { return -1;}
                   9984:                      if (ref($slots->{$b})) { return 1;}
                   9985:                      return 0;
                   9986:                  } @{$slotsarr};
                   9987:     }
                   9988:     return @sorted;
                   9989: }
                   9990: 
1.1040    raeburn  9991: =pod
                   9992: 
                   9993: =item * get_future_slots()
                   9994: 
                   9995: Inputs:
                   9996: 
                   9997: =over 4
                   9998: 
                   9999: cnum - course number
                   10000: 
                   10001: cdom - course domain
                   10002: 
                   10003: now - current UNIX time
                   10004: 
                   10005: symb - optional symb
                   10006: 
                   10007: =back
                   10008: 
                   10009: Returns:
                   10010: 
                   10011: =over 4
                   10012: 
                   10013: sorted_reservable - ref to array of student_schedulable slots currently 
                   10014:                     reservable, ordered by end date of reservation period.
                   10015: 
                   10016: reservable_now - ref to hash of student_schedulable slots currently
                   10017:                  reservable.
                   10018: 
                   10019:     Keys in inner hash are:
                   10020:     (a) symb: either blank or symb to which slot use is restricted.
                   10021:     (b) endreserve: end date of reservation period. 
                   10022: 
                   10023: sorted_future - ref to array of student_schedulable slots reservable in
                   10024:                 the future, ordered by start date of reservation period.
                   10025: 
                   10026: future_reservable - ref to hash of student_schedulable slots reservable
                   10027:                     in the future.
                   10028: 
                   10029:     Keys in inner hash are:
                   10030:     (a) symb: either blank or symb to which slot use is restricted.
                   10031:     (b) startreserve:  start date of reservation period.
                   10032: 
                   10033: =back
                   10034: 
                   10035: =cut
                   10036: 
                   10037: sub get_future_slots {
                   10038:     my ($cnum,$cdom,$now,$symb) = @_;
                   10039:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10040:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10041:     foreach my $slot (keys(%slots)) {
                   10042:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10043:         if ($symb) {
                   10044:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10045:                      ($slots{$slot}->{'symb'} ne $symb));
                   10046:         }
                   10047:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10048:             ($slots{$slot}->{'endtime'} > $now)) {
                   10049:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10050:                 my $userallowed = 0;
                   10051:                 if ($slots{$slot}->{'allowedsections'}) {
                   10052:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10053:                     if (!defined($env{'request.role.sec'})
                   10054:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10055:                         $userallowed=1;
                   10056:                     } else {
                   10057:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10058:                             $userallowed=1;
                   10059:                         }
                   10060:                     }
                   10061:                     unless ($userallowed) {
                   10062:                         if (defined($env{'request.course.groups'})) {
                   10063:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10064:                             foreach my $group (@groups) {
                   10065:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10066:                                     $userallowed=1;
                   10067:                                     last;
                   10068:                                 }
                   10069:                             }
                   10070:                         }
                   10071:                     }
                   10072:                 }
                   10073:                 if ($slots{$slot}->{'allowedusers'}) {
                   10074:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10075:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10076:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10077:                         $userallowed = 1;
                   10078:                     }
                   10079:                 }
                   10080:                 next unless($userallowed);
                   10081:             }
                   10082:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10083:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10084:             my $symb = $slots{$slot}->{'symb'};
                   10085:             if (($startreserve < $now) &&
                   10086:                 (!$endreserve || $endreserve > $now)) {
                   10087:                 my $lastres = $endreserve;
                   10088:                 if (!$lastres) {
                   10089:                     $lastres = $slots{$slot}->{'starttime'};
                   10090:                 }
                   10091:                 $reservable_now{$slot} = {
                   10092:                                            symb       => $symb,
                   10093:                                            endreserve => $lastres
                   10094:                                          };
                   10095:             } elsif (($startreserve > $now) &&
                   10096:                      (!$endreserve || $endreserve > $startreserve)) {
                   10097:                 $future_reservable{$slot} = {
                   10098:                                               symb         => $symb,
                   10099:                                               startreserve => $startreserve
                   10100:                                             };
                   10101:             }
                   10102:         }
                   10103:     }
                   10104:     my @unsorted_reservable = keys(%reservable_now);
                   10105:     if (@unsorted_reservable > 0) {
                   10106:         @sorted_reservable = 
                   10107:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10108:     }
                   10109:     my @unsorted_future = keys(%future_reservable);
                   10110:     if (@unsorted_future > 0) {
                   10111:         @sorted_future =
                   10112:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10113:     }
                   10114:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10115: }
1.780     raeburn  10116: 
                   10117: =pod
                   10118: 
1.1057    foxr     10119: =back
                   10120: 
1.549     albertel 10121: =head1 HTTP Helpers
                   10122: 
                   10123: =over 4
                   10124: 
1.648     raeburn  10125: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10126: 
1.258     albertel 10127: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10128: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10129: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10130: 
                   10131: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10132: $possible_names is an ref to an array of form element names.  As an example:
                   10133: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10134: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10135: 
                   10136: =cut
1.1       albertel 10137: 
1.6       albertel 10138: sub get_unprocessed_cgi {
1.25      albertel 10139:   my ($query,$possible_names)= @_;
1.26      matthew  10140:   # $Apache::lonxml::debug=1;
1.356     albertel 10141:   foreach my $pair (split(/&/,$query)) {
                   10142:     my ($name, $value) = split(/=/,$pair);
1.369     www      10143:     $name = &unescape($name);
1.25      albertel 10144:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10145:       $value =~ tr/+/ /;
                   10146:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10147:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10148:     }
1.16      harris41 10149:   }
1.6       albertel 10150: }
                   10151: 
1.112     bowersj2 10152: =pod
                   10153: 
1.648     raeburn  10154: =item * &cacheheader() 
1.112     bowersj2 10155: 
                   10156: returns cache-controlling header code
                   10157: 
                   10158: =cut
                   10159: 
1.7       albertel 10160: sub cacheheader {
1.258     albertel 10161:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10162:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10163:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10164:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10165:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10166:     return $output;
1.7       albertel 10167: }
                   10168: 
1.112     bowersj2 10169: =pod
                   10170: 
1.648     raeburn  10171: =item * &no_cache($r) 
1.112     bowersj2 10172: 
                   10173: specifies header code to not have cache
                   10174: 
                   10175: =cut
                   10176: 
1.9       albertel 10177: sub no_cache {
1.216     albertel 10178:     my ($r) = @_;
                   10179:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10180: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10181:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10182:     $r->no_cache(1);
                   10183:     $r->header_out("Expires" => $date);
                   10184:     $r->header_out("Pragma" => "no-cache");
1.123     www      10185: }
                   10186: 
                   10187: sub content_type {
1.181     albertel 10188:     my ($r,$type,$charset) = @_;
1.299     foxr     10189:     if ($r) {
                   10190: 	#  Note that printout.pl calls this with undef for $r.
                   10191: 	&no_cache($r);
                   10192:     }
1.258     albertel 10193:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10194:     unless ($charset) {
                   10195: 	$charset=&Apache::lonlocal::current_encoding;
                   10196:     }
                   10197:     if ($charset) { $type.='; charset='.$charset; }
                   10198:     if ($r) {
                   10199: 	$r->content_type($type);
                   10200:     } else {
                   10201: 	print("Content-type: $type\n\n");
                   10202:     }
1.9       albertel 10203: }
1.25      albertel 10204: 
1.112     bowersj2 10205: =pod
                   10206: 
1.648     raeburn  10207: =item * &add_to_env($name,$value) 
1.112     bowersj2 10208: 
1.258     albertel 10209: adds $name to the %env hash with value
1.112     bowersj2 10210: $value, if $name already exists, the entry is converted to an array
                   10211: reference and $value is added to the array.
                   10212: 
                   10213: =cut
                   10214: 
1.25      albertel 10215: sub add_to_env {
                   10216:   my ($name,$value)=@_;
1.258     albertel 10217:   if (defined($env{$name})) {
                   10218:     if (ref($env{$name})) {
1.25      albertel 10219:       #already have multiple values
1.258     albertel 10220:       push(@{ $env{$name} },$value);
1.25      albertel 10221:     } else {
                   10222:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10223:       my $first=$env{$name};
                   10224:       undef($env{$name});
                   10225:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10226:     }
                   10227:   } else {
1.258     albertel 10228:     $env{$name}=$value;
1.25      albertel 10229:   }
1.31      albertel 10230: }
1.149     albertel 10231: 
                   10232: =pod
                   10233: 
1.648     raeburn  10234: =item * &get_env_multiple($name) 
1.149     albertel 10235: 
1.258     albertel 10236: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10237: values may be defined and end up as an array ref.
                   10238: 
                   10239: returns an array of values
                   10240: 
                   10241: =cut
                   10242: 
                   10243: sub get_env_multiple {
                   10244:     my ($name) = @_;
                   10245:     my @values;
1.258     albertel 10246:     if (defined($env{$name})) {
1.149     albertel 10247:         # exists is it an array
1.258     albertel 10248:         if (ref($env{$name})) {
                   10249:             @values=@{ $env{$name} };
1.149     albertel 10250:         } else {
1.258     albertel 10251:             $values[0]=$env{$name};
1.149     albertel 10252:         }
                   10253:     }
                   10254:     return(@values);
                   10255: }
                   10256: 
1.660     raeburn  10257: sub ask_for_embedded_content {
                   10258:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10259:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  10260:         %currsubfile,%unused,$rem);
1.1071    raeburn  10261:     my $counter = 0;
                   10262:     my $numnew = 0;
1.987     raeburn  10263:     my $numremref = 0;
                   10264:     my $numinvalid = 0;
                   10265:     my $numpathchg = 0;
                   10266:     my $numexisting = 0;
1.1071    raeburn  10267:     my $numunused = 0;
                   10268:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156    raeburn  10269:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10270:     my $heading = &mt('Upload embedded files');
                   10271:     my $buttontext = &mt('Upload');
                   10272: 
1.1085    raeburn  10273:     if ($env{'request.course.id'}) {
1.1123    raeburn  10274:         if ($actionurl eq '/adm/dependencies') {
                   10275:             $navmap = Apache::lonnavmaps::navmap->new();
                   10276:         }
                   10277:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10278:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  10279:     }
1.1123    raeburn  10280:     if (($actionurl eq '/adm/portfolio') || 
                   10281:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10282:         my $current_path='/';
                   10283:         if ($env{'form.currentpath'}) {
                   10284:             $current_path = $env{'form.currentpath'};
                   10285:         }
                   10286:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  10287:             $udom = $cdom;
                   10288:             $uname = $cnum;
1.984     raeburn  10289:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10290:         } else {
                   10291:             $udom = $env{'user.domain'};
                   10292:             $uname = $env{'user.name'};
                   10293:             $url = '/userfiles/portfolio';
                   10294:         }
1.987     raeburn  10295:         $toplevel = $url.'/';
1.984     raeburn  10296:         $url .= $current_path;
                   10297:         $getpropath = 1;
1.987     raeburn  10298:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10299:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10300:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10301:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10302:         $toplevel = $url;
1.984     raeburn  10303:         if ($rest ne '') {
1.987     raeburn  10304:             $url .= $rest;
                   10305:         }
                   10306:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10307:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10308:             $url = $args->{'docs_url'};
                   10309:             $toplevel = $url;
1.1084    raeburn  10310:             if ($args->{'context'} eq 'paste') {
                   10311:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10312:                 ($path) = 
                   10313:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10314:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10315:                 $fileloc =~ s{^/}{};
                   10316:             }
1.1071    raeburn  10317:         }
1.1084    raeburn  10318:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  10319:         if ($env{'request.course.id'} ne '') {
                   10320:             if (ref($args) eq 'HASH') {
                   10321:                 $url = $args->{'docs_url'};
                   10322:                 $title = $args->{'docs_title'};
1.1126    raeburn  10323:                 $toplevel = $url; 
                   10324:                 unless ($toplevel =~ m{^/}) {
                   10325:                     $toplevel = "/$url";
                   10326:                 }
1.1085    raeburn  10327:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126    raeburn  10328:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10329:                     $path = $1;
                   10330:                 } else {
                   10331:                     ($path) =
                   10332:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10333:                 }
1.1195    raeburn  10334:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10335:                     $fileloc = $toplevel;
                   10336:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10337:                     my ($udom,$uname,$fname) =
                   10338:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10339:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10340:                 } else {
                   10341:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10342:                 }
1.1071    raeburn  10343:                 $fileloc =~ s{^/}{};
                   10344:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10345:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10346:             }
1.987     raeburn  10347:         }
1.1123    raeburn  10348:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10349:         $udom = $cdom;
                   10350:         $uname = $cnum;
                   10351:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10352:         $toplevel = $url;
                   10353:         $path = $url;
                   10354:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10355:         $fileloc =~ s{^/}{};
1.987     raeburn  10356:     }
1.1126    raeburn  10357:     foreach my $file (keys(%{$allfiles})) {
                   10358:         my $embed_file;
                   10359:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10360:             $embed_file = $1;
                   10361:         } else {
                   10362:             $embed_file = $file;
                   10363:         }
1.1158    raeburn  10364:         my ($absolutepath,$cleaned_file);
                   10365:         if ($embed_file =~ m{^\w+://}) {
                   10366:             $cleaned_file = $embed_file;
1.1147    raeburn  10367:             $newfiles{$cleaned_file} = 1;
                   10368:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10369:         } else {
1.1158    raeburn  10370:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10371:             if ($embed_file =~ m{^/}) {
                   10372:                 $absolutepath = $embed_file;
                   10373:             }
1.1147    raeburn  10374:             if ($cleaned_file =~ m{/}) {
                   10375:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10376:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10377:                 my $item = $fname;
                   10378:                 if ($path ne '') {
                   10379:                     $item = $path.'/'.$fname;
                   10380:                     $subdependencies{$path}{$fname} = 1;
                   10381:                 } else {
                   10382:                     $dependencies{$item} = 1;
                   10383:                 }
                   10384:                 if ($absolutepath) {
                   10385:                     $mapping{$item} = $absolutepath;
                   10386:                 } else {
                   10387:                     $mapping{$item} = $embed_file;
                   10388:                 }
                   10389:             } else {
                   10390:                 $dependencies{$embed_file} = 1;
                   10391:                 if ($absolutepath) {
1.1147    raeburn  10392:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10393:                 } else {
1.1147    raeburn  10394:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10395:                 }
                   10396:             }
1.984     raeburn  10397:         }
                   10398:     }
1.1071    raeburn  10399:     my $dirptr = 16384;
1.984     raeburn  10400:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10401:         $currsubfile{$path} = {};
1.1123    raeburn  10402:         if (($actionurl eq '/adm/portfolio') || 
                   10403:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  10404:             my ($sublistref,$listerror) =
                   10405:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10406:             if (ref($sublistref) eq 'ARRAY') {
                   10407:                 foreach my $line (@{$sublistref}) {
                   10408:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10409:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10410:                 }
1.984     raeburn  10411:             }
1.987     raeburn  10412:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10413:             if (opendir(my $dir,$url.'/'.$path)) {
                   10414:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10415:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10416:             }
1.1084    raeburn  10417:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10418:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  10419:                   ($args->{'context'} eq 'paste')) ||
                   10420:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10421:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  10422:                 my $dir;
                   10423:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10424:                     $dir = $fileloc;
                   10425:                 } else {
                   10426:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10427:                 }
1.1071    raeburn  10428:                 if ($dir ne '') {
                   10429:                     my ($sublistref,$listerror) =
                   10430:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10431:                     if (ref($sublistref) eq 'ARRAY') {
                   10432:                         foreach my $line (@{$sublistref}) {
                   10433:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10434:                                 undef,$mtime)=split(/\&/,$line,12);
                   10435:                             unless (($testdir&$dirptr) ||
                   10436:                                     ($file_name =~ /^\.\.?$/)) {
                   10437:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10438:                             }
                   10439:                         }
                   10440:                     }
                   10441:                 }
1.984     raeburn  10442:             }
                   10443:         }
                   10444:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10445:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10446:                 my $item = $path.'/'.$file;
                   10447:                 unless ($mapping{$item} eq $item) {
                   10448:                     $pathchanges{$item} = 1;
                   10449:                 }
                   10450:                 $existing{$item} = 1;
                   10451:                 $numexisting ++;
                   10452:             } else {
                   10453:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  10454:             }
                   10455:         }
1.1071    raeburn  10456:         if ($actionurl eq '/adm/dependencies') {
                   10457:             foreach my $path (keys(%currsubfile)) {
                   10458:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   10459:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   10460:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  10461:                              next if (($rem ne '') &&
                   10462:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   10463:                                        (ref($navmap) &&
                   10464:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   10465:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10466:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  10467:                              $unused{$path.'/'.$file} = 1; 
                   10468:                          }
                   10469:                     }
                   10470:                 }
                   10471:             }
                   10472:         }
1.984     raeburn  10473:     }
1.987     raeburn  10474:     my %currfile;
1.1123    raeburn  10475:     if (($actionurl eq '/adm/portfolio') ||
                   10476:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  10477:         my ($dirlistref,$listerror) =
                   10478:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   10479:         if (ref($dirlistref) eq 'ARRAY') {
                   10480:             foreach my $line (@{$dirlistref}) {
                   10481:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   10482:                 $currfile{$file_name} = 1;
                   10483:             }
1.984     raeburn  10484:         }
1.987     raeburn  10485:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10486:         if (opendir(my $dir,$url)) {
1.987     raeburn  10487:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  10488:             map {$currfile{$_} = 1;} @dir_list;
                   10489:         }
1.1084    raeburn  10490:     } elsif (($actionurl eq '/adm/dependencies') ||
                   10491:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  10492:               ($args->{'context'} eq 'paste')) ||
                   10493:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10494:         if ($env{'request.course.id'} ne '') {
                   10495:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10496:             if ($dir ne '') {
                   10497:                 my ($dirlistref,$listerror) =
                   10498:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   10499:                 if (ref($dirlistref) eq 'ARRAY') {
                   10500:                     foreach my $line (@{$dirlistref}) {
                   10501:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   10502:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   10503:                         unless (($testdir&$dirptr) ||
                   10504:                                 ($file_name =~ /^\.\.?$/)) {
                   10505:                             $currfile{$file_name} = [$size,$mtime];
                   10506:                         }
                   10507:                     }
                   10508:                 }
                   10509:             }
                   10510:         }
1.984     raeburn  10511:     }
                   10512:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  10513:         if (exists($currfile{$file})) {
1.987     raeburn  10514:             unless ($mapping{$file} eq $file) {
                   10515:                 $pathchanges{$file} = 1;
                   10516:             }
                   10517:             $existing{$file} = 1;
                   10518:             $numexisting ++;
                   10519:         } else {
1.984     raeburn  10520:             $newfiles{$file} = 1;
                   10521:         }
                   10522:     }
1.1071    raeburn  10523:     foreach my $file (keys(%currfile)) {
                   10524:         unless (($file eq $filename) ||
                   10525:                 ($file eq $filename.'.bak') ||
                   10526:                 ($dependencies{$file})) {
1.1085    raeburn  10527:             if ($actionurl eq '/adm/dependencies') {
1.1126    raeburn  10528:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   10529:                     next if (($rem ne '') &&
                   10530:                              (($env{"httpref.$rem".$file} ne '') ||
                   10531:                               (ref($navmap) &&
                   10532:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   10533:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10534:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   10535:                 }
1.1085    raeburn  10536:             }
1.1071    raeburn  10537:             $unused{$file} = 1;
                   10538:         }
                   10539:     }
1.1084    raeburn  10540:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   10541:         ($args->{'context'} eq 'paste')) {
                   10542:         $counter = scalar(keys(%existing));
                   10543:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  10544:         return ($output,$counter,$numpathchg,\%existing);
                   10545:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   10546:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   10547:         $counter = scalar(keys(%existing));
                   10548:         $numpathchg = scalar(keys(%pathchanges));
                   10549:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  10550:     }
1.984     raeburn  10551:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  10552:         if ($actionurl eq '/adm/dependencies') {
                   10553:             next if ($embed_file =~ m{^\w+://});
                   10554:         }
1.660     raeburn  10555:         $upload_output .= &start_data_table_row().
1.1123    raeburn  10556:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  10557:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  10558:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  10559:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   10560:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  10561:         }
1.1123    raeburn  10562:         $upload_output .= '</td>';
1.1071    raeburn  10563:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  10564:             $upload_output.='<td align="right">'.
                   10565:                             '<span class="LC_info LC_fontsize_medium">'.
                   10566:                             &mt("URL points to web address").'</span>';
1.987     raeburn  10567:             $numremref++;
1.660     raeburn  10568:         } elsif ($args->{'error_on_invalid_names'}
                   10569:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  10570:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   10571:                             &mt('Invalid characters').'</span>';
1.987     raeburn  10572:             $numinvalid++;
1.660     raeburn  10573:         } else {
1.1123    raeburn  10574:             $upload_output .= '<td>'.
                   10575:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  10576:                                                      $embed_file,\%mapping,
1.1071    raeburn  10577:                                                      $allfiles,$codebase,'upload');
                   10578:             $counter ++;
                   10579:             $numnew ++;
1.987     raeburn  10580:         }
                   10581:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   10582:     }
                   10583:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  10584:         if ($actionurl eq '/adm/dependencies') {
                   10585:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   10586:             $modify_output .= &start_data_table_row().
                   10587:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   10588:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   10589:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   10590:                               '<td>'.$size.'</td>'.
                   10591:                               '<td>'.$mtime.'</td>'.
                   10592:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   10593:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   10594:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   10595:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   10596:                               &embedded_file_element('upload_embedded',$counter,
                   10597:                                                      $embed_file,\%mapping,
                   10598:                                                      $allfiles,$codebase,'modify').
                   10599:                               '</div></td>'.
                   10600:                               &end_data_table_row()."\n";
                   10601:             $counter ++;
                   10602:         } else {
                   10603:             $upload_output .= &start_data_table_row().
1.1123    raeburn  10604:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   10605:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   10606:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  10607:                               &Apache::loncommon::end_data_table_row()."\n";
                   10608:         }
                   10609:     }
                   10610:     my $delidx = $counter;
                   10611:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   10612:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   10613:         $delete_output .= &start_data_table_row().
                   10614:                           '<td><img src="'.&icon($oldfile).'" />'.
                   10615:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   10616:                           '<td>'.$size.'</td>'.
                   10617:                           '<td>'.$mtime.'</td>'.
                   10618:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   10619:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   10620:                           &embedded_file_element('upload_embedded',$delidx,
                   10621:                                                  $oldfile,\%mapping,$allfiles,
                   10622:                                                  $codebase,'delete').'</td>'.
                   10623:                           &end_data_table_row()."\n"; 
                   10624:         $numunused ++;
                   10625:         $delidx ++;
1.987     raeburn  10626:     }
                   10627:     if ($upload_output) {
                   10628:         $upload_output = &start_data_table().
                   10629:                          $upload_output.
                   10630:                          &end_data_table()."\n";
                   10631:     }
1.1071    raeburn  10632:     if ($modify_output) {
                   10633:         $modify_output = &start_data_table().
                   10634:                          &start_data_table_header_row().
                   10635:                          '<th>'.&mt('File').'</th>'.
                   10636:                          '<th>'.&mt('Size (KB)').'</th>'.
                   10637:                          '<th>'.&mt('Modified').'</th>'.
                   10638:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   10639:                          &end_data_table_header_row().
                   10640:                          $modify_output.
                   10641:                          &end_data_table()."\n";
                   10642:     }
                   10643:     if ($delete_output) {
                   10644:         $delete_output = &start_data_table().
                   10645:                          &start_data_table_header_row().
                   10646:                          '<th>'.&mt('File').'</th>'.
                   10647:                          '<th>'.&mt('Size (KB)').'</th>'.
                   10648:                          '<th>'.&mt('Modified').'</th>'.
                   10649:                          '<th>'.&mt('Delete?').'</th>'.
                   10650:                          &end_data_table_header_row().
                   10651:                          $delete_output.
                   10652:                          &end_data_table()."\n";
                   10653:     }
1.987     raeburn  10654:     my $applies = 0;
                   10655:     if ($numremref) {
                   10656:         $applies ++;
                   10657:     }
                   10658:     if ($numinvalid) {
                   10659:         $applies ++;
                   10660:     }
                   10661:     if ($numexisting) {
                   10662:         $applies ++;
                   10663:     }
1.1071    raeburn  10664:     if ($counter || $numunused) {
1.987     raeburn  10665:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   10666:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  10667:                   $state.'<h3>'.$heading.'</h3>'; 
                   10668:         if ($actionurl eq '/adm/dependencies') {
                   10669:             if ($numnew) {
                   10670:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   10671:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   10672:                            $upload_output.'<br />'."\n";
                   10673:             }
                   10674:             if ($numexisting) {
                   10675:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   10676:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   10677:                            $modify_output.'<br />'."\n";
                   10678:                            $buttontext = &mt('Save changes');
                   10679:             }
                   10680:             if ($numunused) {
                   10681:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   10682:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   10683:                            $delete_output.'<br />'."\n";
                   10684:                            $buttontext = &mt('Save changes');
                   10685:             }
                   10686:         } else {
                   10687:             $output .= $upload_output.'<br />'."\n";
                   10688:         }
                   10689:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   10690:                    $counter.'" />'."\n";
                   10691:         if ($actionurl eq '/adm/dependencies') { 
                   10692:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   10693:                        $numnew.'" />'."\n";
                   10694:         } elsif ($actionurl eq '') {
1.987     raeburn  10695:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   10696:         }
                   10697:     } elsif ($applies) {
                   10698:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   10699:         if ($applies > 1) {
                   10700:             $output .=  
1.1123    raeburn  10701:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  10702:             if ($numremref) {
                   10703:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   10704:             }
                   10705:             if ($numinvalid) {
                   10706:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   10707:             }
                   10708:             if ($numexisting) {
                   10709:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   10710:             }
                   10711:             $output .= '</ul><br />';
                   10712:         } elsif ($numremref) {
                   10713:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   10714:         } elsif ($numinvalid) {
                   10715:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   10716:         } elsif ($numexisting) {
                   10717:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   10718:         }
                   10719:         $output .= $upload_output.'<br />';
                   10720:     }
                   10721:     my ($pathchange_output,$chgcount);
1.1071    raeburn  10722:     $chgcount = $counter;
1.987     raeburn  10723:     if (keys(%pathchanges) > 0) {
                   10724:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  10725:             if ($counter) {
1.987     raeburn  10726:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   10727:                                                   $embed_file,\%mapping,
1.1071    raeburn  10728:                                                   $allfiles,$codebase,'change');
1.987     raeburn  10729:             } else {
                   10730:                 $pathchange_output .= 
                   10731:                     &start_data_table_row().
                   10732:                     '<td><input type ="checkbox" name="namechange" value="'.
                   10733:                     $chgcount.'" checked="checked" /></td>'.
                   10734:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   10735:                     '<td>'.$embed_file.
                   10736:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  10737:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  10738:                     '</td>'.&end_data_table_row();
1.660     raeburn  10739:             }
1.987     raeburn  10740:             $numpathchg ++;
                   10741:             $chgcount ++;
1.660     raeburn  10742:         }
                   10743:     }
1.1127    raeburn  10744:     if (($counter) || ($numunused)) {
1.987     raeburn  10745:         if ($numpathchg) {
                   10746:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   10747:                        $numpathchg.'" />'."\n";
                   10748:         }
                   10749:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   10750:             ($actionurl eq '/adm/imsimport')) {
                   10751:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   10752:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   10753:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  10754:         } elsif ($actionurl eq '/adm/dependencies') {
                   10755:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  10756:         }
1.1123    raeburn  10757:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  10758:     } elsif ($numpathchg) {
                   10759:         my %pathchange = ();
                   10760:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   10761:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   10762:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  10763:         }
1.987     raeburn  10764:     }
1.1071    raeburn  10765:     return ($output,$counter,$numpathchg);
1.987     raeburn  10766: }
                   10767: 
1.1147    raeburn  10768: =pod
                   10769: 
                   10770: =item * clean_path($name)
                   10771: 
                   10772: Performs clean-up of directories, subdirectories and filename in an
                   10773: embedded object, referenced in an HTML file which is being uploaded
                   10774: to a course or portfolio, where 
                   10775: "Upload embedded images/multimedia files if HTML file" checkbox was
                   10776: checked.
                   10777: 
                   10778: Clean-up is similar to replacements in lonnet::clean_filename()
                   10779: except each / between sub-directory and next level is preserved.
                   10780: 
                   10781: =cut
                   10782: 
                   10783: sub clean_path {
                   10784:     my ($embed_file) = @_;
                   10785:     $embed_file =~s{^/+}{};
                   10786:     my @contents;
                   10787:     if ($embed_file =~ m{/}) {
                   10788:         @contents = split(/\//,$embed_file);
                   10789:     } else {
                   10790:         @contents = ($embed_file);
                   10791:     }
                   10792:     my $lastidx = scalar(@contents)-1;
                   10793:     for (my $i=0; $i<=$lastidx; $i++) { 
                   10794:         $contents[$i]=~s{\\}{/}g;
                   10795:         $contents[$i]=~s/\s+/\_/g;
                   10796:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   10797:         if ($i == $lastidx) {
                   10798:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   10799:         }
                   10800:     }
                   10801:     if ($lastidx > 0) {
                   10802:         return join('/',@contents);
                   10803:     } else {
                   10804:         return $contents[0];
                   10805:     }
                   10806: }
                   10807: 
1.987     raeburn  10808: sub embedded_file_element {
1.1071    raeburn  10809:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  10810:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   10811:                    (ref($codebase) eq 'HASH'));
                   10812:     my $output;
1.1071    raeburn  10813:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  10814:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   10815:     }
                   10816:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   10817:                &escape($embed_file).'" />';
                   10818:     unless (($context eq 'upload_embedded') && 
                   10819:             ($mapping->{$embed_file} eq $embed_file)) {
                   10820:         $output .='
                   10821:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   10822:     }
                   10823:     my $attrib;
                   10824:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   10825:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   10826:     }
                   10827:     $output .=
                   10828:         "\n\t\t".
                   10829:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   10830:         $attrib.'" />';
                   10831:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   10832:         $output .=
                   10833:             "\n\t\t".
                   10834:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   10835:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  10836:     }
1.987     raeburn  10837:     return $output;
1.660     raeburn  10838: }
                   10839: 
1.1071    raeburn  10840: sub get_dependency_details {
                   10841:     my ($currfile,$currsubfile,$embed_file) = @_;
                   10842:     my ($size,$mtime,$showsize,$showmtime);
                   10843:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   10844:         if ($embed_file =~ m{/}) {
                   10845:             my ($path,$fname) = split(/\//,$embed_file);
                   10846:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   10847:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   10848:             }
                   10849:         } else {
                   10850:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   10851:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   10852:             }
                   10853:         }
                   10854:         $showsize = $size/1024.0;
                   10855:         $showsize = sprintf("%.1f",$showsize);
                   10856:         if ($mtime > 0) {
                   10857:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   10858:         }
                   10859:     }
                   10860:     return ($showsize,$showmtime);
                   10861: }
                   10862: 
                   10863: sub ask_embedded_js {
                   10864:     return <<"END";
                   10865: <script type="text/javascript"">
                   10866: // <![CDATA[
                   10867: function toggleBrowse(counter) {
                   10868:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   10869:     var fileid = document.getElementById('embedded_item_'+counter);
                   10870:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   10871:     if (chkboxid.checked == true) {
                   10872:         uploaddivid.style.display='block';
                   10873:     } else {
                   10874:         uploaddivid.style.display='none';
                   10875:         fileid.value = '';
                   10876:     }
                   10877: }
                   10878: // ]]>
                   10879: </script>
                   10880: 
                   10881: END
                   10882: }
                   10883: 
1.661     raeburn  10884: sub upload_embedded {
                   10885:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  10886:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   10887:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  10888:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   10889:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   10890:         my $orig_uploaded_filename =
                   10891:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  10892:         foreach my $type ('orig','ref','attrib','codebase') {
                   10893:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   10894:                 $env{'form.embedded_'.$type.'_'.$i} =
                   10895:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   10896:             }
                   10897:         }
1.661     raeburn  10898:         my ($path,$fname) =
                   10899:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   10900:         # no path, whole string is fname
                   10901:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   10902:         $fname = &Apache::lonnet::clean_filename($fname);
                   10903:         # See if there is anything left
                   10904:         next if ($fname eq '');
                   10905: 
                   10906:         # Check if file already exists as a file or directory.
                   10907:         my ($state,$msg);
                   10908:         if ($context eq 'portfolio') {
                   10909:             my $port_path = $dirpath;
                   10910:             if ($group ne '') {
                   10911:                 $port_path = "groups/$group/$port_path";
                   10912:             }
1.987     raeburn  10913:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   10914:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  10915:                                               $dir_root,$port_path,$disk_quota,
                   10916:                                               $current_disk_usage,$uname,$udom);
                   10917:             if ($state eq 'will_exceed_quota'
1.984     raeburn  10918:                 || $state eq 'file_locked') {
1.661     raeburn  10919:                 $output .= $msg;
                   10920:                 next;
                   10921:             }
                   10922:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   10923:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   10924:             if ($state eq 'exists') {
                   10925:                 $output .= $msg;
                   10926:                 next;
                   10927:             }
                   10928:         }
                   10929:         # Check if extension is valid
                   10930:         if (($fname =~ /\.(\w+)$/) &&
                   10931:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155    bisitz   10932:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   10933:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  10934:             next;
                   10935:         } elsif (($fname =~ /\.(\w+)$/) &&
                   10936:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  10937:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  10938:             next;
                   10939:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   10940:             $output .= &mt('Filename not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661     raeburn  10941:             next;
                   10942:         }
                   10943:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  10944:         my $subdir = $path;
                   10945:         $subdir =~ s{/+$}{};
1.661     raeburn  10946:         if ($context eq 'portfolio') {
1.984     raeburn  10947:             my $result;
                   10948:             if ($state eq 'existingfile') {
                   10949:                 $result=
                   10950:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  10951:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  10952:             } else {
1.984     raeburn  10953:                 $result=
                   10954:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  10955:                                                     $dirpath.
1.1123    raeburn  10956:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  10957:                 if ($result !~ m|^/uploaded/|) {
                   10958:                     $output .= '<span class="LC_error">'
                   10959:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   10960:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   10961:                                .'</span><br />';
                   10962:                     next;
                   10963:                 } else {
1.987     raeburn  10964:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   10965:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  10966:                 }
1.661     raeburn  10967:             }
1.1123    raeburn  10968:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126    raeburn  10969:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   10970:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  10971:             my $result =
1.1126    raeburn  10972:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  10973:             if ($result !~ m|^/uploaded/|) {
                   10974:                 $output .= '<span class="LC_error">'
                   10975:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   10976:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   10977:                            .'</span><br />';
                   10978:                     next;
                   10979:             } else {
                   10980:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   10981:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  10982:                 if ($context eq 'syllabus') {
                   10983:                     &Apache::lonnet::make_public_indefinitely($result);
                   10984:                 }
1.987     raeburn  10985:             }
1.661     raeburn  10986:         } else {
                   10987: # Save the file
                   10988:             my $target = $env{'form.embedded_item_'.$i};
                   10989:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   10990:             my $dest = $fullpath.$fname;
                   10991:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  10992:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  10993:             my $count;
                   10994:             my $filepath = $dir_root;
1.1027    raeburn  10995:             foreach my $subdir (@parts) {
                   10996:                 $filepath .= "/$subdir";
                   10997:                 if (!-e $filepath) {
1.661     raeburn  10998:                     mkdir($filepath,0770);
                   10999:                 }
                   11000:             }
                   11001:             my $fh;
                   11002:             if (!open($fh,'>'.$dest)) {
                   11003:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11004:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11005:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11006:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11007:                            '</span><br />';
                   11008:             } else {
                   11009:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11010:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11011:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11012:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11013:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11014:                               '</span><br />';
                   11015:                 } else {
1.987     raeburn  11016:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11017:                                $url.'</span>').'<br />';
                   11018:                     unless ($context eq 'testbank') {
                   11019:                         $footer .= &mt('View embedded file: [_1]',
                   11020:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11021:                     }
                   11022:                 }
                   11023:                 close($fh);
                   11024:             }
                   11025:         }
                   11026:         if ($env{'form.embedded_ref_'.$i}) {
                   11027:             $pathchange{$i} = 1;
                   11028:         }
                   11029:     }
                   11030:     if ($output) {
                   11031:         $output = '<p>'.$output.'</p>';
                   11032:     }
                   11033:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11034:     $returnflag = 'ok';
1.1071    raeburn  11035:     my $numpathchgs = scalar(keys(%pathchange));
                   11036:     if ($numpathchgs > 0) {
1.987     raeburn  11037:         if ($context eq 'portfolio') {
                   11038:             $output .= '<p>'.&mt('or').'</p>';
                   11039:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11040:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11041:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11042:             $returnflag = 'modify_orightml';
                   11043:         }
                   11044:     }
1.1071    raeburn  11045:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11046: }
                   11047: 
                   11048: sub modify_html_form {
                   11049:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11050:     my $end = 0;
                   11051:     my $modifyform;
                   11052:     if ($context eq 'upload_embedded') {
                   11053:         return unless (ref($pathchange) eq 'HASH');
                   11054:         if ($env{'form.number_embedded_items'}) {
                   11055:             $end += $env{'form.number_embedded_items'};
                   11056:         }
                   11057:         if ($env{'form.number_pathchange_items'}) {
                   11058:             $end += $env{'form.number_pathchange_items'};
                   11059:         }
                   11060:         if ($end) {
                   11061:             for (my $i=0; $i<$end; $i++) {
                   11062:                 if ($i < $env{'form.number_embedded_items'}) {
                   11063:                     next unless($pathchange->{$i});
                   11064:                 }
                   11065:                 $modifyform .=
                   11066:                     &start_data_table_row().
                   11067:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11068:                     'checked="checked" /></td>'.
                   11069:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11070:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11071:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11072:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11073:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11074:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11075:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11076:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11077:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11078:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11079:                     &end_data_table_row();
1.1071    raeburn  11080:             }
1.987     raeburn  11081:         }
                   11082:     } else {
                   11083:         $modifyform = $pathchgtable;
                   11084:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11085:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11086:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11087:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11088:         }
                   11089:     }
                   11090:     if ($modifyform) {
1.1071    raeburn  11091:         if ($actionurl eq '/adm/dependencies') {
                   11092:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11093:         }
1.987     raeburn  11094:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11095:                '<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".
                   11096:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11097:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11098:                '</ol></p>'."\n".'<p>'.
                   11099:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11100:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11101:                &start_data_table()."\n".
                   11102:                &start_data_table_header_row().
                   11103:                '<th>'.&mt('Change?').'</th>'.
                   11104:                '<th>'.&mt('Current reference').'</th>'.
                   11105:                '<th>'.&mt('Required reference').'</th>'.
                   11106:                &end_data_table_header_row()."\n".
                   11107:                $modifyform.
                   11108:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11109:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11110:                '</form>'."\n";
                   11111:     }
                   11112:     return;
                   11113: }
                   11114: 
                   11115: sub modify_html_refs {
1.1123    raeburn  11116:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11117:     my $container;
                   11118:     if ($context eq 'portfolio') {
                   11119:         $container = $env{'form.container'};
                   11120:     } elsif ($context eq 'coursedoc') {
                   11121:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11122:     } elsif ($context eq 'manage_dependencies') {
                   11123:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11124:         $container = "/$container";
1.1123    raeburn  11125:     } elsif ($context eq 'syllabus') {
                   11126:         $container = $url;
1.987     raeburn  11127:     } else {
1.1027    raeburn  11128:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11129:     }
                   11130:     my (%allfiles,%codebase,$output,$content);
                   11131:     my @changes = &get_env_multiple('form.namechange');
1.1126    raeburn  11132:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  11133:         if (wantarray) {
                   11134:             return ('',0,0); 
                   11135:         } else {
                   11136:             return;
                   11137:         }
                   11138:     }
                   11139:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  11140:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11141:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11142:             if (wantarray) {
                   11143:                 return ('',0,0);
                   11144:             } else {
                   11145:                 return;
                   11146:             }
                   11147:         } 
1.987     raeburn  11148:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11149:         if ($content eq '-1') {
                   11150:             if (wantarray) {
                   11151:                 return ('',0,0);
                   11152:             } else {
                   11153:                 return;
                   11154:             }
                   11155:         }
1.987     raeburn  11156:     } else {
1.1071    raeburn  11157:         unless ($container =~ /^\Q$dir_root\E/) {
                   11158:             if (wantarray) {
                   11159:                 return ('',0,0);
                   11160:             } else {
                   11161:                 return;
                   11162:             }
                   11163:         } 
1.987     raeburn  11164:         if (open(my $fh,"<$container")) {
                   11165:             $content = join('', <$fh>);
                   11166:             close($fh);
                   11167:         } else {
1.1071    raeburn  11168:             if (wantarray) {
                   11169:                 return ('',0,0);
                   11170:             } else {
                   11171:                 return;
                   11172:             }
1.987     raeburn  11173:         }
                   11174:     }
                   11175:     my ($count,$codebasecount) = (0,0);
                   11176:     my $mm = new File::MMagic;
                   11177:     my $mime_type = $mm->checktype_contents($content);
                   11178:     if ($mime_type eq 'text/html') {
                   11179:         my $parse_result = 
                   11180:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11181:                                                     \%codebase,\$content);
                   11182:         if ($parse_result eq 'ok') {
                   11183:             foreach my $i (@changes) {
                   11184:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11185:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11186:                 if ($allfiles{$ref}) {
                   11187:                     my $newname =  $orig;
                   11188:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11189:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11190:                     if ($attrib_regexp =~ /:/) {
                   11191:                         $attrib_regexp =~ s/\:/|/g;
                   11192:                     }
                   11193:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11194:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11195:                         $count += $numchg;
1.1123    raeburn  11196:                         $allfiles{$newname} = $allfiles{$ref};
1.1148    raeburn  11197:                         delete($allfiles{$ref});
1.987     raeburn  11198:                     }
                   11199:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11200:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11201:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11202:                         $codebasecount ++;
                   11203:                     }
                   11204:                 }
                   11205:             }
1.1123    raeburn  11206:             my $skiprewrites;
1.987     raeburn  11207:             if ($count || $codebasecount) {
                   11208:                 my $saveresult;
1.1071    raeburn  11209:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  11210:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11211:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11212:                     if ($url eq $container) {
                   11213:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11214:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11215:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11216:                                             $fname.'</span>').'</p>';
1.987     raeburn  11217:                     } else {
                   11218:                          $output = '<p class="LC_error">'.
                   11219:                                    &mt('Error: update failed for: [_1].',
                   11220:                                    '<span class="LC_filename">'.
                   11221:                                    $container.'</span>').'</p>';
                   11222:                     }
1.1123    raeburn  11223:                     if ($context eq 'syllabus') {
                   11224:                         unless ($saveresult eq 'ok') {
                   11225:                             $skiprewrites = 1;
                   11226:                         }
                   11227:                     }
1.987     raeburn  11228:                 } else {
                   11229:                     if (open(my $fh,">$container")) {
                   11230:                         print $fh $content;
                   11231:                         close($fh);
                   11232:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11233:                                   $count,'<span class="LC_filename">'.
                   11234:                                   $container.'</span>').'</p>';
1.661     raeburn  11235:                     } else {
1.987     raeburn  11236:                          $output = '<p class="LC_error">'.
                   11237:                                    &mt('Error: could not update [_1].',
                   11238:                                    '<span class="LC_filename">'.
                   11239:                                    $container.'</span>').'</p>';
1.661     raeburn  11240:                     }
                   11241:                 }
                   11242:             }
1.1123    raeburn  11243:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11244:                 my ($actionurl,$state);
                   11245:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11246:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11247:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11248:                                               \%codebase,
                   11249:                                               {'context' => 'rewrites',
                   11250:                                                'ignore_remote_references' => 1,});
                   11251:                 if (ref($mapping) eq 'HASH') {
                   11252:                     my $rewrites = 0;
                   11253:                     foreach my $key (keys(%{$mapping})) {
                   11254:                         next if ($key =~ m{^https?://});
                   11255:                         my $ref = $mapping->{$key};
                   11256:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11257:                         my $attrib;
                   11258:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11259:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11260:                         }
                   11261:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11262:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11263:                             $rewrites += $numchg;
                   11264:                         }
                   11265:                     }
                   11266:                     if ($rewrites) {
                   11267:                         my $saveresult; 
                   11268:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11269:                         if ($url eq $container) {
                   11270:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11271:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11272:                                             $count,'<span class="LC_filename">'.
                   11273:                                             $fname.'</span>').'</p>';
                   11274:                         } else {
                   11275:                             $output .= '<p class="LC_error">'.
                   11276:                                        &mt('Error: could not update links in [_1].',
                   11277:                                        '<span class="LC_filename">'.
                   11278:                                        $container.'</span>').'</p>';
                   11279: 
                   11280:                         }
                   11281:                     }
                   11282:                 }
                   11283:             }
1.987     raeburn  11284:         } else {
                   11285:             &logthis('Failed to parse '.$container.
                   11286:                      ' to modify references: '.$parse_result);
1.661     raeburn  11287:         }
                   11288:     }
1.1071    raeburn  11289:     if (wantarray) {
                   11290:         return ($output,$count,$codebasecount);
                   11291:     } else {
                   11292:         return $output;
                   11293:     }
1.661     raeburn  11294: }
                   11295: 
                   11296: sub check_for_existing {
                   11297:     my ($path,$fname,$element) = @_;
                   11298:     my ($state,$msg);
                   11299:     if (-d $path.'/'.$fname) {
                   11300:         $state = 'exists';
                   11301:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11302:     } elsif (-e $path.'/'.$fname) {
                   11303:         $state = 'exists';
                   11304:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11305:     }
                   11306:     if ($state eq 'exists') {
                   11307:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11308:     }
                   11309:     return ($state,$msg);
                   11310: }
                   11311: 
                   11312: sub check_for_upload {
                   11313:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11314:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11315:     my $filesize = length($env{'form.'.$element});
                   11316:     if (!$filesize) {
                   11317:         my $msg = '<span class="LC_error">'.
                   11318:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11319:                       '<span class="LC_filename">'.$fname.'</span>',
                   11320:                       $filesize).'<br />'.
1.1007    raeburn  11321:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11322:                   '</span>';
                   11323:         return ('zero_bytes',$msg);
                   11324:     }
                   11325:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11326:     my $getpropath = 1;
1.1021    raeburn  11327:     my ($dirlistref,$listerror) =
                   11328:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11329:     my $found_file = 0;
                   11330:     my $locked_file = 0;
1.991     raeburn  11331:     my @lockers;
                   11332:     my $navmap;
                   11333:     if ($env{'request.course.id'}) {
                   11334:         $navmap = Apache::lonnavmaps::navmap->new();
                   11335:     }
1.1021    raeburn  11336:     if (ref($dirlistref) eq 'ARRAY') {
                   11337:         foreach my $line (@{$dirlistref}) {
                   11338:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11339:             if ($file_name eq $fname){
                   11340:                 $file_name = $path.$file_name;
                   11341:                 if ($group ne '') {
                   11342:                     $file_name = $group.$file_name;
                   11343:                 }
                   11344:                 $found_file = 1;
                   11345:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11346:                     foreach my $lock (@lockers) {
                   11347:                         if (ref($lock) eq 'ARRAY') {
                   11348:                             my ($symb,$crsid) = @{$lock};
                   11349:                             if ($crsid eq $env{'request.course.id'}) {
                   11350:                                 if (ref($navmap)) {
                   11351:                                     my $res = $navmap->getBySymb($symb);
                   11352:                                     foreach my $part (@{$res->parts()}) { 
                   11353:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11354:                                         unless (($slot_status == $res->RESERVED) ||
                   11355:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11356:                                             $locked_file = 1;
                   11357:                                         }
1.991     raeburn  11358:                                     }
1.1021    raeburn  11359:                                 } else {
                   11360:                                     $locked_file = 1;
1.991     raeburn  11361:                                 }
                   11362:                             } else {
                   11363:                                 $locked_file = 1;
                   11364:                             }
                   11365:                         }
1.1021    raeburn  11366:                    }
                   11367:                 } else {
                   11368:                     my @info = split(/\&/,$rest);
                   11369:                     my $currsize = $info[6]/1000;
                   11370:                     if ($currsize < $filesize) {
                   11371:                         my $extra = $filesize - $currsize;
                   11372:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1179    bisitz   11373:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11374:                                       &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.',
1.1179    bisitz   11375:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11376:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11377:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11378:                             return ('will_exceed_quota',$msg);
                   11379:                         }
1.984     raeburn  11380:                     }
                   11381:                 }
1.661     raeburn  11382:             }
                   11383:         }
                   11384:     }
                   11385:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1179    bisitz   11386:         my $msg = '<p class="LC_warning">'.
                   11387:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184    raeburn  11388:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11389:         return ('will_exceed_quota',$msg);
                   11390:     } elsif ($found_file) {
                   11391:         if ($locked_file) {
1.1179    bisitz   11392:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11393:             $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>');
1.1179    bisitz   11394:             $msg .= '</p>';
1.661     raeburn  11395:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11396:             return ('file_locked',$msg);
                   11397:         } else {
1.1179    bisitz   11398:             my $msg = '<p class="LC_error">';
1.984     raeburn  11399:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179    bisitz   11400:             $msg .= '</p>';
1.984     raeburn  11401:             return ('existingfile',$msg);
1.661     raeburn  11402:         }
                   11403:     }
                   11404: }
                   11405: 
1.987     raeburn  11406: sub check_for_traversal {
                   11407:     my ($path,$url,$toplevel) = @_;
                   11408:     my @parts=split(/\//,$path);
                   11409:     my $cleanpath;
                   11410:     my $fullpath = $url;
                   11411:     for (my $i=0;$i<@parts;$i++) {
                   11412:         next if ($parts[$i] eq '.');
                   11413:         if ($parts[$i] eq '..') {
                   11414:             $fullpath =~ s{([^/]+/)$}{};
                   11415:         } else {
                   11416:             $fullpath .= $parts[$i].'/';
                   11417:         }
                   11418:     }
                   11419:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11420:         $cleanpath = $1;
                   11421:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11422:         my $curr_toprel = $1;
                   11423:         my @parts = split(/\//,$curr_toprel);
                   11424:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11425:         my @urlparts = split(/\//,$url_toprel);
                   11426:         my $doubledots;
                   11427:         my $startdiff = -1;
                   11428:         for (my $i=0; $i<@urlparts; $i++) {
                   11429:             if ($startdiff == -1) {
                   11430:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11431:                     $startdiff = $i;
                   11432:                     $doubledots .= '../';
                   11433:                 }
                   11434:             } else {
                   11435:                 $doubledots .= '../';
                   11436:             }
                   11437:         }
                   11438:         if ($startdiff > -1) {
                   11439:             $cleanpath = $doubledots;
                   11440:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11441:                 $cleanpath .= $parts[$i].'/';
                   11442:             }
                   11443:         }
                   11444:     }
                   11445:     $cleanpath =~ s{(/)$}{};
                   11446:     return $cleanpath;
                   11447: }
1.31      albertel 11448: 
1.1053    raeburn  11449: sub is_archive_file {
                   11450:     my ($mimetype) = @_;
                   11451:     if (($mimetype eq 'application/octet-stream') ||
                   11452:         ($mimetype eq 'application/x-stuffit') ||
                   11453:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   11454:         return 1;
                   11455:     }
                   11456:     return;
                   11457: }
                   11458: 
                   11459: sub decompress_form {
1.1065    raeburn  11460:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  11461:     my %lt = &Apache::lonlocal::texthash (
                   11462:         this => 'This file is an archive file.',
1.1067    raeburn  11463:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  11464:         itsc => 'Its contents are as follows:',
1.1053    raeburn  11465:         youm => 'You may wish to extract its contents.',
                   11466:         extr => 'Extract contents',
1.1067    raeburn  11467:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   11468:         proa => 'Process automatically?',
1.1053    raeburn  11469:         yes  => 'Yes',
                   11470:         no   => 'No',
1.1067    raeburn  11471:         fold => 'Title for folder containing movie',
                   11472:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  11473:     );
1.1065    raeburn  11474:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  11475:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  11476:     my $info = &list_archive_contents($fileloc,\@paths);
                   11477:     if (@paths) {
                   11478:         foreach my $path (@paths) {
                   11479:             $path =~ s{^/}{};
1.1067    raeburn  11480:             if ($path =~ m{^([^/]+)/$}) {
                   11481:                 $topdir = $1;
                   11482:             }
1.1065    raeburn  11483:             if ($path =~ m{^([^/]+)/}) {
                   11484:                 $toplevel{$1} = $path;
                   11485:             } else {
                   11486:                 $toplevel{$path} = $path;
                   11487:             }
                   11488:         }
                   11489:     }
1.1067    raeburn  11490:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164    raeburn  11491:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  11492:                         "$topdir/media/",
                   11493:                         "$topdir/media/$topdir.mp4",
                   11494:                         "$topdir/media/FirstFrame.png",
                   11495:                         "$topdir/media/player.swf",
                   11496:                         "$topdir/media/swfobject.js",
                   11497:                         "$topdir/media/expressInstall.swf");
1.1197    raeburn  11498:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164    raeburn  11499:                          "$topdir/$topdir.mp4",
                   11500:                          "$topdir/$topdir\_config.xml",
                   11501:                          "$topdir/$topdir\_controller.swf",
                   11502:                          "$topdir/$topdir\_embed.css",
                   11503:                          "$topdir/$topdir\_First_Frame.png",
                   11504:                          "$topdir/$topdir\_player.html",
                   11505:                          "$topdir/$topdir\_Thumbnails.png",
                   11506:                          "$topdir/playerProductInstall.swf",
                   11507:                          "$topdir/scripts/",
                   11508:                          "$topdir/scripts/config_xml.js",
                   11509:                          "$topdir/scripts/handlebars.js",
                   11510:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   11511:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   11512:                          "$topdir/scripts/modernizr.js",
                   11513:                          "$topdir/scripts/player-min.js",
                   11514:                          "$topdir/scripts/swfobject.js",
                   11515:                          "$topdir/skins/",
                   11516:                          "$topdir/skins/configuration_express.xml",
                   11517:                          "$topdir/skins/express_show/",
                   11518:                          "$topdir/skins/express_show/player-min.css",
                   11519:                          "$topdir/skins/express_show/spritesheet.png");
1.1197    raeburn  11520:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   11521:                          "$topdir/$topdir.mp4",
                   11522:                          "$topdir/$topdir\_config.xml",
                   11523:                          "$topdir/$topdir\_controller.swf",
                   11524:                          "$topdir/$topdir\_embed.css",
                   11525:                          "$topdir/$topdir\_First_Frame.png",
                   11526:                          "$topdir/$topdir\_player.html",
                   11527:                          "$topdir/$topdir\_Thumbnails.png",
                   11528:                          "$topdir/playerProductInstall.swf",
                   11529:                          "$topdir/scripts/",
                   11530:                          "$topdir/scripts/config_xml.js",
                   11531:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   11532:                          "$topdir/skins/",
                   11533:                          "$topdir/skins/configuration_express.xml",
                   11534:                          "$topdir/skins/express_show/",
                   11535:                          "$topdir/skins/express_show/spritesheet.min.css",
                   11536:                          "$topdir/skins/express_show/spritesheet.png",
                   11537:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164    raeburn  11538:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  11539:         if (@diffs == 0) {
1.1164    raeburn  11540:             $is_camtasia = 6;
                   11541:         } else {
1.1197    raeburn  11542:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164    raeburn  11543:             if (@diffs == 0) {
                   11544:                 $is_camtasia = 8;
1.1197    raeburn  11545:             } else {
                   11546:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   11547:                 if (@diffs == 0) {
                   11548:                     $is_camtasia = 8;
                   11549:                 }
1.1164    raeburn  11550:             }
1.1067    raeburn  11551:         }
                   11552:     }
                   11553:     my $output;
                   11554:     if ($is_camtasia) {
                   11555:         $output = <<"ENDCAM";
                   11556: <script type="text/javascript" language="Javascript">
                   11557: // <![CDATA[
                   11558: 
                   11559: function camtasiaToggle() {
                   11560:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   11561:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164    raeburn  11562:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  11563:                 document.getElementById('camtasia_titles').style.display='block';
                   11564:             } else {
                   11565:                 document.getElementById('camtasia_titles').style.display='none';
                   11566:             }
                   11567:         }
                   11568:     }
                   11569:     return;
                   11570: }
                   11571: 
                   11572: // ]]>
                   11573: </script>
                   11574: <p>$lt{'camt'}</p>
                   11575: ENDCAM
1.1065    raeburn  11576:     } else {
1.1067    raeburn  11577:         $output = '<p>'.$lt{'this'};
                   11578:         if ($info eq '') {
                   11579:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   11580:         } else {
                   11581:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   11582:                        '<div><pre>'.$info.'</pre></div>';
                   11583:         }
1.1065    raeburn  11584:     }
1.1067    raeburn  11585:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  11586:     my $duplicates;
                   11587:     my $num = 0;
                   11588:     if (ref($dirlist) eq 'ARRAY') {
                   11589:         foreach my $item (@{$dirlist}) {
                   11590:             if (ref($item) eq 'ARRAY') {
                   11591:                 if (exists($toplevel{$item->[0]})) {
                   11592:                     $duplicates .= 
                   11593:                         &start_data_table_row().
                   11594:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   11595:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   11596:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   11597:                         'value="1" />'.&mt('Yes').'</label>'.
                   11598:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   11599:                         '<td>'.$item->[0].'</td>';
                   11600:                     if ($item->[2]) {
                   11601:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   11602:                     } else {
                   11603:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   11604:                     }
                   11605:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   11606:                                    '<td>'.
                   11607:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   11608:                                    '</td>'.
                   11609:                                    &end_data_table_row();
                   11610:                     $num ++;
                   11611:                 }
                   11612:             }
                   11613:         }
                   11614:     }
                   11615:     my $itemcount;
                   11616:     if (@paths > 0) {
                   11617:         $itemcount = scalar(@paths);
                   11618:     } else {
                   11619:         $itemcount = 1;
                   11620:     }
1.1067    raeburn  11621:     if ($is_camtasia) {
                   11622:         $output .= $lt{'auto'}.'<br />'.
                   11623:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164    raeburn  11624:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  11625:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   11626:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   11627:                    $lt{'no'}.'</label></span><br />'.
                   11628:                    '<div id="camtasia_titles" style="display:block">'.
                   11629:                    &Apache::lonhtmlcommon::start_pick_box().
                   11630:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   11631:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   11632:                    &Apache::lonhtmlcommon::row_closure().
                   11633:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   11634:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   11635:                    &Apache::lonhtmlcommon::row_closure(1).
                   11636:                    &Apache::lonhtmlcommon::end_pick_box().
                   11637:                    '</div>';
                   11638:     }
1.1065    raeburn  11639:     $output .= 
                   11640:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  11641:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   11642:         "\n";
1.1065    raeburn  11643:     if ($duplicates ne '') {
                   11644:         $output .= '<p><span class="LC_warning">'.
                   11645:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   11646:                    &start_data_table().
                   11647:                    &start_data_table_header_row().
                   11648:                    '<th>'.&mt('Overwrite?').'</th>'.
                   11649:                    '<th>'.&mt('Name').'</th>'.
                   11650:                    '<th>'.&mt('Type').'</th>'.
                   11651:                    '<th>'.&mt('Size').'</th>'.
                   11652:                    '<th>'.&mt('Last modified').'</th>'.
                   11653:                    &end_data_table_header_row().
                   11654:                    $duplicates.
                   11655:                    &end_data_table().
                   11656:                    '</p>';
                   11657:     }
1.1067    raeburn  11658:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  11659:     if (ref($hiddenelements) eq 'HASH') {
                   11660:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   11661:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   11662:         }
                   11663:     }
                   11664:     $output .= <<"END";
1.1067    raeburn  11665: <br />
1.1053    raeburn  11666: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   11667: </form>
                   11668: $noextract
                   11669: END
                   11670:     return $output;
                   11671: }
                   11672: 
1.1065    raeburn  11673: sub decompression_utility {
                   11674:     my ($program) = @_;
                   11675:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   11676:     my $location;
                   11677:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   11678:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   11679:                          '/usr/sbin/') {
                   11680:             if (-x $dir.$program) {
                   11681:                 $location = $dir.$program;
                   11682:                 last;
                   11683:             }
                   11684:         }
                   11685:     }
                   11686:     return $location;
                   11687: }
                   11688: 
                   11689: sub list_archive_contents {
                   11690:     my ($file,$pathsref) = @_;
                   11691:     my (@cmd,$output);
                   11692:     my $needsregexp;
                   11693:     if ($file =~ /\.zip$/) {
                   11694:         @cmd = (&decompression_utility('unzip'),"-l");
                   11695:         $needsregexp = 1;
                   11696:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   11697:              ($file =~ /\.tgz$/)) {
                   11698:         @cmd = (&decompression_utility('tar'),"-ztf");
                   11699:     } elsif ($file =~ /\.tar\.bz2$/) {
                   11700:         @cmd = (&decompression_utility('tar'),"-jtf");
                   11701:     } elsif ($file =~ m|\.tar$|) {
                   11702:         @cmd = (&decompression_utility('tar'),"-tf");
                   11703:     }
                   11704:     if (@cmd) {
                   11705:         undef($!);
                   11706:         undef($@);
                   11707:         if (open(my $fh,"-|", @cmd, $file)) {
                   11708:             while (my $line = <$fh>) {
                   11709:                 $output .= $line;
                   11710:                 chomp($line);
                   11711:                 my $item;
                   11712:                 if ($needsregexp) {
                   11713:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   11714:                 } else {
                   11715:                     $item = $line;
                   11716:                 }
                   11717:                 if ($item ne '') {
                   11718:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   11719:                         push(@{$pathsref},$item);
                   11720:                     } 
                   11721:                 }
                   11722:             }
                   11723:             close($fh);
                   11724:         }
                   11725:     }
                   11726:     return $output;
                   11727: }
                   11728: 
1.1053    raeburn  11729: sub decompress_uploaded_file {
                   11730:     my ($file,$dir) = @_;
                   11731:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   11732:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   11733:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   11734:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   11735:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   11736:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   11737:     my $decompressed = $env{'cgi.decompressed'};
                   11738:     &Apache::lonnet::delenv('cgi.file');
                   11739:     &Apache::lonnet::delenv('cgi.dir');
                   11740:     &Apache::lonnet::delenv('cgi.decompressed');
                   11741:     return ($decompressed,$result);
                   11742: }
                   11743: 
1.1055    raeburn  11744: sub process_decompression {
                   11745:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   11746:     my ($dir,$error,$warning,$output);
1.1180    raeburn  11747:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120    bisitz   11748:         $error = &mt('Filename not a supported archive file type.').
                   11749:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  11750:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   11751:     } else {
                   11752:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   11753:         if ($docuhome eq 'no_host') {
                   11754:             $error = &mt('Could not determine home server for course.');
                   11755:         } else {
                   11756:             my @ids=&Apache::lonnet::current_machine_ids();
                   11757:             my $currdir = "$dir_root/$destination";
                   11758:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   11759:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   11760:                        "$dir_root/$destination";
                   11761:             } else {
                   11762:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   11763:                        "$dir_root/$docudom/$docuname/$destination";
                   11764:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   11765:                     $error = &mt('Archive file not found.');
                   11766:                 }
                   11767:             }
1.1065    raeburn  11768:             my (@to_overwrite,@to_skip);
                   11769:             if ($env{'form.archive_overwrite_total'} > 0) {
                   11770:                 my $total = $env{'form.archive_overwrite_total'};
                   11771:                 for (my $i=0; $i<$total; $i++) {
                   11772:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   11773:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   11774:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   11775:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   11776:                     }
                   11777:                 }
                   11778:             }
                   11779:             my $numskip = scalar(@to_skip);
                   11780:             if (($numskip > 0) && 
                   11781:                 ($numskip == $env{'form.archive_itemcount'})) {
                   11782:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   11783:             } elsif ($dir eq '') {
1.1055    raeburn  11784:                 $error = &mt('Directory containing archive file unavailable.');
                   11785:             } elsif (!$error) {
1.1065    raeburn  11786:                 my ($decompressed,$display);
                   11787:                 if ($numskip > 0) {
                   11788:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   11789:                     mkdir("$dir/$tempdir",0755);
                   11790:                     system("mv $dir/$file $dir/$tempdir/$file");
                   11791:                     ($decompressed,$display) = 
                   11792:                         &decompress_uploaded_file($file,"$dir/$tempdir");
                   11793:                     foreach my $item (@to_skip) {
                   11794:                         if (($item ne '') && ($item !~ /\.\./)) {
                   11795:                             if (-f "$dir/$tempdir/$item") { 
                   11796:                                 unlink("$dir/$tempdir/$item");
                   11797:                             } elsif (-d "$dir/$tempdir/$item") {
                   11798:                                 system("rm -rf $dir/$tempdir/$item");
                   11799:                             }
                   11800:                         }
                   11801:                     }
                   11802:                     system("mv $dir/$tempdir/* $dir");
                   11803:                     rmdir("$dir/$tempdir");   
                   11804:                 } else {
                   11805:                     ($decompressed,$display) = 
                   11806:                         &decompress_uploaded_file($file,$dir);
                   11807:                 }
1.1055    raeburn  11808:                 if ($decompressed eq 'ok') {
1.1065    raeburn  11809:                     $output = '<p class="LC_info">'.
                   11810:                               &mt('Files extracted successfully from archive.').
                   11811:                               '</p>'."\n";
1.1055    raeburn  11812:                     my ($warning,$result,@contents);
                   11813:                     my ($newdirlistref,$newlisterror) =
                   11814:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   11815:                                                  $docuname,1);
                   11816:                     my (%is_dir,%changes,@newitems);
                   11817:                     my $dirptr = 16384;
1.1065    raeburn  11818:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  11819:                         foreach my $dir_line (@{$newdirlistref}) {
                   11820:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065    raeburn  11821:                             unless (($item =~ /^\.+$/) || ($item eq $file) || 
                   11822:                                     ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055    raeburn  11823:                                 push(@newitems,$item);
                   11824:                                 if ($dirptr&$testdir) {
                   11825:                                     $is_dir{$item} = 1;
                   11826:                                 }
                   11827:                                 $changes{$item} = 1;
                   11828:                             }
                   11829:                         }
                   11830:                     }
                   11831:                     if (keys(%changes) > 0) {
                   11832:                         foreach my $item (sort(@newitems)) {
                   11833:                             if ($changes{$item}) {
                   11834:                                 push(@contents,$item);
                   11835:                             }
                   11836:                         }
                   11837:                     }
                   11838:                     if (@contents > 0) {
1.1067    raeburn  11839:                         my $wantform;
                   11840:                         unless ($env{'form.autoextract_camtasia'}) {
                   11841:                             $wantform = 1;
                   11842:                         }
1.1056    raeburn  11843:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  11844:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   11845:                                                                 $currdir,\%is_dir,
                   11846:                                                                 \%children,\%parent,
1.1056    raeburn  11847:                                                                 \@contents,\%dirorder,
                   11848:                                                                 \%titles,$wantform);
1.1055    raeburn  11849:                         if ($datatable ne '') {
                   11850:                             $output .= &archive_options_form('decompressed',$datatable,
                   11851:                                                              $count,$hiddenelem);
1.1065    raeburn  11852:                             my $startcount = 6;
1.1055    raeburn  11853:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  11854:                                                            \%titles,\%children);
1.1055    raeburn  11855:                         }
1.1067    raeburn  11856:                         if ($env{'form.autoextract_camtasia'}) {
1.1164    raeburn  11857:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  11858:                             my %displayed;
                   11859:                             my $total = 1;
                   11860:                             $env{'form.archive_directory'} = [];
                   11861:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   11862:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   11863:                                 $path =~ s{/$}{};
                   11864:                                 my $item;
                   11865:                                 if ($path ne '') {
                   11866:                                     $item = "$path/$titles{$i}";
                   11867:                                 } else {
                   11868:                                     $item = $titles{$i};
                   11869:                                 }
                   11870:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   11871:                                 if ($item eq $contents[0]) {
                   11872:                                     push(@{$env{'form.archive_directory'}},$i);
                   11873:                                     $env{'form.archive_'.$i} = 'display';
                   11874:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   11875:                                     $displayed{'folder'} = $i;
1.1164    raeburn  11876:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   11877:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) { 
1.1067    raeburn  11878:                                     $env{'form.archive_'.$i} = 'display';
                   11879:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   11880:                                     $displayed{'web'} = $i;
                   11881:                                 } else {
1.1164    raeburn  11882:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   11883:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   11884:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  11885:                                         push(@{$env{'form.archive_directory'}},$i);
                   11886:                                     }
                   11887:                                     $env{'form.archive_'.$i} = 'dependency';
                   11888:                                 }
                   11889:                                 $total ++;
                   11890:                             }
                   11891:                             for (my $i=1; $i<$total; $i++) {
                   11892:                                 next if ($i == $displayed{'web'});
                   11893:                                 next if ($i == $displayed{'folder'});
                   11894:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   11895:                             }
                   11896:                             $env{'form.phase'} = 'decompress_cleanup';
                   11897:                             $env{'form.archivedelete'} = 1;
                   11898:                             $env{'form.archive_count'} = $total-1;
                   11899:                             $output .=
                   11900:                                 &process_extracted_files('coursedocs',$docudom,
                   11901:                                                          $docuname,$destination,
                   11902:                                                          $dir_root,$hiddenelem);
                   11903:                         }
1.1055    raeburn  11904:                     } else {
                   11905:                         $warning = &mt('No new items extracted from archive file.');
                   11906:                     }
                   11907:                 } else {
                   11908:                     $output = $display;
                   11909:                     $error = &mt('An error occurred during extraction from the archive file.');
                   11910:                 }
                   11911:             }
                   11912:         }
                   11913:     }
                   11914:     if ($error) {
                   11915:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   11916:                    $error.'</p>'."\n";
                   11917:     }
                   11918:     if ($warning) {
                   11919:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   11920:     }
                   11921:     return $output;
                   11922: }
                   11923: 
                   11924: sub get_extracted {
1.1056    raeburn  11925:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   11926:         $titles,$wantform) = @_;
1.1055    raeburn  11927:     my $count = 0;
                   11928:     my $depth = 0;
                   11929:     my $datatable;
1.1056    raeburn  11930:     my @hierarchy;
1.1055    raeburn  11931:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  11932:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   11933:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  11934:     foreach my $item (@{$contents}) {
                   11935:         $count ++;
1.1056    raeburn  11936:         @{$dirorder->{$count}} = @hierarchy;
                   11937:         $titles->{$count} = $item;
1.1055    raeburn  11938:         &archive_hierarchy($depth,$count,$parent,$children);
                   11939:         if ($wantform) {
                   11940:             $datatable .= &archive_row($is_dir->{$item},$item,
                   11941:                                        $currdir,$depth,$count);
                   11942:         }
                   11943:         if ($is_dir->{$item}) {
                   11944:             $depth ++;
1.1056    raeburn  11945:             push(@hierarchy,$count);
                   11946:             $parent->{$depth} = $count;
1.1055    raeburn  11947:             $datatable .=
                   11948:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  11949:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   11950:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  11951:             $depth --;
1.1056    raeburn  11952:             pop(@hierarchy);
1.1055    raeburn  11953:         }
                   11954:     }
                   11955:     return ($count,$datatable);
                   11956: }
                   11957: 
                   11958: sub recurse_extracted_archive {
1.1056    raeburn  11959:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   11960:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  11961:     my $result='';
1.1056    raeburn  11962:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   11963:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   11964:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  11965:         return $result;
                   11966:     }
                   11967:     my $dirptr = 16384;
                   11968:     my ($newdirlistref,$newlisterror) =
                   11969:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   11970:     if (ref($newdirlistref) eq 'ARRAY') {
                   11971:         foreach my $dir_line (@{$newdirlistref}) {
                   11972:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   11973:             unless ($item =~ /^\.+$/) {
                   11974:                 $$count ++;
1.1056    raeburn  11975:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   11976:                 $titles->{$$count} = $item;
1.1055    raeburn  11977:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  11978: 
1.1055    raeburn  11979:                 my $is_dir;
                   11980:                 if ($dirptr&$testdir) {
                   11981:                     $is_dir = 1;
                   11982:                 }
                   11983:                 if ($wantform) {
                   11984:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   11985:                 }
                   11986:                 if ($is_dir) {
                   11987:                     $$depth ++;
1.1056    raeburn  11988:                     push(@{$hierarchy},$$count);
                   11989:                     $parent->{$$depth} = $$count;
1.1055    raeburn  11990:                     $result .=
                   11991:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   11992:                                                    $docuname,$depth,$count,
1.1056    raeburn  11993:                                                    $hierarchy,$dirorder,$children,
                   11994:                                                    $parent,$titles,$wantform);
1.1055    raeburn  11995:                     $$depth --;
1.1056    raeburn  11996:                     pop(@{$hierarchy});
1.1055    raeburn  11997:                 }
                   11998:             }
                   11999:         }
                   12000:     }
                   12001:     return $result;
                   12002: }
                   12003: 
                   12004: sub archive_hierarchy {
                   12005:     my ($depth,$count,$parent,$children) =@_;
                   12006:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12007:         if (exists($parent->{$depth})) {
                   12008:              $children->{$parent->{$depth}} .= $count.':';
                   12009:         }
                   12010:     }
                   12011:     return;
                   12012: }
                   12013: 
                   12014: sub archive_row {
                   12015:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12016:     my ($name) = ($item =~ m{([^/]+)$});
                   12017:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12018:                                        'display'    => 'Add as file',
1.1055    raeburn  12019:                                        'dependency' => 'Include as dependency',
                   12020:                                        'discard'    => 'Discard',
                   12021:                                       );
                   12022:     if ($is_dir) {
1.1059    raeburn  12023:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12024:     }
1.1056    raeburn  12025:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12026:     my $offset = 0;
1.1055    raeburn  12027:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12028:         $offset ++;
1.1065    raeburn  12029:         if ($action ne 'display') {
                   12030:             $offset ++;
                   12031:         }  
1.1055    raeburn  12032:         $output .= '<td><span class="LC_nobreak">'.
                   12033:                    '<label><input type="radio" name="archive_'.$count.
                   12034:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12035:         my $text = $choices{$action};
                   12036:         if ($is_dir) {
                   12037:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12038:             if ($action eq 'display') {
1.1059    raeburn  12039:                 $text = &mt('Add as folder');
1.1055    raeburn  12040:             }
1.1056    raeburn  12041:         } else {
                   12042:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12043: 
                   12044:         }
                   12045:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12046:         if ($action eq 'dependency') {
                   12047:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12048:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12049:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12050:                        '<option value=""></option>'."\n".
                   12051:                        '</select>'."\n".
                   12052:                        '</div>';
1.1059    raeburn  12053:         } elsif ($action eq 'display') {
                   12054:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12055:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12056:                        '</div>';
1.1055    raeburn  12057:         }
1.1056    raeburn  12058:         $output .= '</td>';
1.1055    raeburn  12059:     }
                   12060:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12061:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12062:     for (my $i=0; $i<$depth; $i++) {
                   12063:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12064:     }
                   12065:     if ($is_dir) {
                   12066:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12067:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12068:     } else {
                   12069:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12070:     }
                   12071:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12072:                &end_data_table_row();
                   12073:     return $output;
                   12074: }
                   12075: 
                   12076: sub archive_options_form {
1.1065    raeburn  12077:     my ($form,$display,$count,$hiddenelem) = @_;
                   12078:     my %lt = &Apache::lonlocal::texthash(
                   12079:                perm => 'Permanently remove archive file?',
                   12080:                hows => 'How should each extracted item be incorporated in the course?',
                   12081:                cont => 'Content actions for all',
                   12082:                addf => 'Add as folder/file',
                   12083:                incd => 'Include as dependency for a displayed file',
                   12084:                disc => 'Discard',
                   12085:                no   => 'No',
                   12086:                yes  => 'Yes',
                   12087:                save => 'Save',
                   12088:     );
                   12089:     my $output = <<"END";
                   12090: <form name="$form" method="post" action="">
                   12091: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12092: <label>
                   12093:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12094: </label>
                   12095: &nbsp;
                   12096: <label>
                   12097:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12098: </span>
                   12099: </p>
                   12100: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12101: <br />$lt{'hows'}
                   12102: <div class="LC_columnSection">
                   12103:   <fieldset>
                   12104:     <legend>$lt{'cont'}</legend>
                   12105:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12106:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12107:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12108:   </fieldset>
                   12109: </div>
                   12110: END
                   12111:     return $output.
1.1055    raeburn  12112:            &start_data_table()."\n".
1.1065    raeburn  12113:            $display."\n".
1.1055    raeburn  12114:            &end_data_table()."\n".
                   12115:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12116:            $hiddenelem.
1.1065    raeburn  12117:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12118:            '</form>';
                   12119: }
                   12120: 
                   12121: sub archive_javascript {
1.1056    raeburn  12122:     my ($startcount,$numitems,$titles,$children) = @_;
                   12123:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12124:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12125:     my $scripttag = <<START;
                   12126: <script type="text/javascript">
                   12127: // <![CDATA[
                   12128: 
                   12129: function checkAll(form,prefix) {
                   12130:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12131:     for (var i=0; i < form.elements.length; i++) {
                   12132:         var id = form.elements[i].id;
                   12133:         if ((id != '') && (id != undefined)) {
                   12134:             if (idstr.test(id)) {
                   12135:                 if (form.elements[i].type == 'radio') {
                   12136:                     form.elements[i].checked = true;
1.1056    raeburn  12137:                     var nostart = i-$startcount;
1.1059    raeburn  12138:                     var offset = nostart%7;
                   12139:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12140:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12141:                 }
                   12142:             }
                   12143:         }
                   12144:     }
                   12145: }
                   12146: 
                   12147: function propagateCheck(form,count) {
                   12148:     if (count > 0) {
1.1059    raeburn  12149:         var startelement = $startcount + ((count-1) * 7);
                   12150:         for (var j=1; j<6; j++) {
                   12151:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12152:                 var item = startelement + j; 
                   12153:                 if (form.elements[item].type == 'radio') {
                   12154:                     if (form.elements[item].checked) {
                   12155:                         containerCheck(form,count,j);
                   12156:                         break;
                   12157:                     }
1.1055    raeburn  12158:                 }
                   12159:             }
                   12160:         }
                   12161:     }
                   12162: }
                   12163: 
                   12164: numitems = $numitems
1.1056    raeburn  12165: var titles = new Array(numitems);
                   12166: var parents = new Array(numitems);
1.1055    raeburn  12167: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12168:     parents[i] = new Array;
1.1055    raeburn  12169: }
1.1059    raeburn  12170: var maintitle = '$maintitle';
1.1055    raeburn  12171: 
                   12172: START
                   12173: 
1.1056    raeburn  12174:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12175:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12176:         for (my $i=0; $i<@contents; $i ++) {
                   12177:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12178:         }
                   12179:     }
                   12180: 
1.1056    raeburn  12181:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12182:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12183:     }
                   12184: 
1.1055    raeburn  12185:     $scripttag .= <<END;
                   12186: 
                   12187: function containerCheck(form,count,offset) {
                   12188:     if (count > 0) {
1.1056    raeburn  12189:         dependencyCheck(form,count,offset);
1.1059    raeburn  12190:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12191:         form.elements[item].checked = true;
                   12192:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12193:             if (parents[count].length > 0) {
                   12194:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12195:                     containerCheck(form,parents[count][j],offset);
                   12196:                 }
                   12197:             }
                   12198:         }
                   12199:     }
                   12200: }
                   12201: 
                   12202: function dependencyCheck(form,count,offset) {
                   12203:     if (count > 0) {
1.1059    raeburn  12204:         var chosen = (offset+$startcount)+7*(count-1);
                   12205:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12206:         var currtype = form.elements[depitem].type;
                   12207:         if (form.elements[chosen].value == 'dependency') {
                   12208:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12209:             form.elements[depitem].options.length = 0;
                   12210:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  12211:             for (var i=1; i<=numitems; i++) {
                   12212:                 if (i == count) {
                   12213:                     continue;
                   12214:                 }
1.1059    raeburn  12215:                 var startelement = $startcount + (i-1) * 7;
                   12216:                 for (var j=1; j<6; j++) {
                   12217:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12218:                         var item = startelement + j;
                   12219:                         if (form.elements[item].type == 'radio') {
                   12220:                             if (form.elements[item].checked) {
                   12221:                                 if (form.elements[item].value == 'display') {
                   12222:                                     var n = form.elements[depitem].options.length;
                   12223:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12224:                                 }
                   12225:                             }
                   12226:                         }
                   12227:                     }
                   12228:                 }
                   12229:             }
                   12230:         } else {
                   12231:             document.getElementById('arc_depon_'+count).style.display='none';
                   12232:             form.elements[depitem].options.length = 0;
                   12233:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12234:         }
1.1059    raeburn  12235:         titleCheck(form,count,offset);
1.1056    raeburn  12236:     }
                   12237: }
                   12238: 
                   12239: function propagateSelect(form,count,offset) {
                   12240:     if (count > 0) {
1.1065    raeburn  12241:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12242:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12243:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12244:             if (parents[count].length > 0) {
                   12245:                 for (var j=0; j<parents[count].length; j++) {
                   12246:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12247:                 }
                   12248:             }
                   12249:         }
                   12250:     }
                   12251: }
1.1056    raeburn  12252: 
                   12253: function containerSelect(form,count,offset,picked) {
                   12254:     if (count > 0) {
1.1065    raeburn  12255:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12256:         if (form.elements[item].type == 'radio') {
                   12257:             if (form.elements[item].value == 'dependency') {
                   12258:                 if (form.elements[item+1].type == 'select-one') {
                   12259:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12260:                         if (form.elements[item+1].options[i].value == picked) {
                   12261:                             form.elements[item+1].selectedIndex = i;
                   12262:                             break;
                   12263:                         }
                   12264:                     }
                   12265:                 }
                   12266:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12267:                     if (parents[count].length > 0) {
                   12268:                         for (var j=0; j<parents[count].length; j++) {
                   12269:                             containerSelect(form,parents[count][j],offset,picked);
                   12270:                         }
                   12271:                     }
                   12272:                 }
                   12273:             }
                   12274:         }
                   12275:     }
                   12276: }
                   12277: 
1.1059    raeburn  12278: function titleCheck(form,count,offset) {
                   12279:     if (count > 0) {
                   12280:         var chosen = (offset+$startcount)+7*(count-1);
                   12281:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12282:         var currtype = form.elements[depitem].type;
                   12283:         if (form.elements[chosen].value == 'display') {
                   12284:             document.getElementById('arc_title_'+count).style.display='block';
                   12285:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12286:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12287:             }
                   12288:         } else {
                   12289:             document.getElementById('arc_title_'+count).style.display='none';
                   12290:             if (currtype == 'text') { 
                   12291:                 document.getElementById('archive_title_'+count).value='';
                   12292:             }
                   12293:         }
                   12294:     }
                   12295:     return;
                   12296: }
                   12297: 
1.1055    raeburn  12298: // ]]>
                   12299: </script>
                   12300: END
                   12301:     return $scripttag;
                   12302: }
                   12303: 
                   12304: sub process_extracted_files {
1.1067    raeburn  12305:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12306:     my $numitems = $env{'form.archive_count'};
                   12307:     return unless ($numitems);
                   12308:     my @ids=&Apache::lonnet::current_machine_ids();
                   12309:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12310:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12311:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12312:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12313:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12314:         $pathtocheck = "$dir_root/$destination";
                   12315:         $dir = $dir_root;
                   12316:         $ishome = 1;
                   12317:     } else {
                   12318:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12319:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   12320:         $dir = "$dir_root/$docudom/$docuname";    
                   12321:     }
                   12322:     my $currdir = "$dir_root/$destination";
                   12323:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12324:     if ($env{'form.folderpath'}) {
                   12325:         my @items = split('&',$env{'form.folderpath'});
                   12326:         $folders{'0'} = $items[-2];
1.1099    raeburn  12327:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12328:             $containers{'0'}='page';
                   12329:         } else {  
                   12330:             $containers{'0'}='sequence';
                   12331:         }
1.1055    raeburn  12332:     }
                   12333:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12334:     if ($numitems) {
                   12335:         for (my $i=1; $i<=$numitems; $i++) {
                   12336:             my $path = $env{'form.archive_content_'.$i};
                   12337:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12338:                 my $item = $1;
                   12339:                 $toplevelitems{$item} = $i;
                   12340:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12341:                     $is_dir{$item} = 1;
                   12342:                 }
                   12343:             }
                   12344:         }
                   12345:     }
1.1067    raeburn  12346:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12347:     if (keys(%toplevelitems) > 0) {
                   12348:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12349:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12350:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12351:     }
1.1066    raeburn  12352:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12353:     if ($numitems) {
                   12354:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  12355:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12356:             my $path = $env{'form.archive_content_'.$i};
                   12357:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12358:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12359:                     if ($prefix ne '' && $path ne '') {
                   12360:                         if (-e $prefix.$path) {
1.1066    raeburn  12361:                             if ((@archdirs > 0) && 
                   12362:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12363:                                 $todeletedir{$prefix.$path} = 1;
                   12364:                             } else {
                   12365:                                 $todelete{$prefix.$path} = 1;
                   12366:                             }
1.1055    raeburn  12367:                         }
                   12368:                     }
                   12369:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12370:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12371:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12372:                     $docstitle = $env{'form.archive_title_'.$i};
                   12373:                     if ($docstitle eq '') {
                   12374:                         $docstitle = $title;
                   12375:                     }
1.1055    raeburn  12376:                     $outer = 0;
1.1056    raeburn  12377:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12378:                         if (@{$dirorder{$i}} > 0) {
                   12379:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12380:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12381:                                     $outer = $item;
                   12382:                                     last;
                   12383:                                 }
                   12384:                             }
                   12385:                         }
                   12386:                     }
                   12387:                     my ($errtext,$fatal) = 
                   12388:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12389:                                                '/'.$folders{$outer}.'.'.
                   12390:                                                $containers{$outer});
                   12391:                     next if ($fatal);
                   12392:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12393:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12394:                             $mapinner{$i} = time;
1.1055    raeburn  12395:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12396:                             $containers{$i} = 'sequence';
                   12397:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12398:                                       $folders{$i}.'.'.$containers{$i};
                   12399:                             my $newidx = &LONCAPA::map::getresidx();
                   12400:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12401:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12402:                             push(@LONCAPA::map::order,$newidx);
                   12403:                             my ($outtext,$errtext) =
                   12404:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12405:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  12406:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12407:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12408:                             unless ($errtext) {
                   12409:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
                   12410:                             }
1.1055    raeburn  12411:                         }
                   12412:                     } else {
                   12413:                         if ($context eq 'coursedocs') {
                   12414:                             my $newidx=&LONCAPA::map::getresidx();
                   12415:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12416:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12417:                                       $title;
                   12418:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12419:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   12420:                             }
                   12421:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12422:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12423:                             }
                   12424:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12425:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  12426:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067    raeburn  12427:                                 unless ($ishome) {
                   12428:                                     my $fetch = "$newdest{$i}/$title";
                   12429:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   12430:                                     $prompttofetch{$fetch} = 1;
                   12431:                                 }
1.1055    raeburn  12432:                             }
                   12433:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12434:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12435:                             push(@LONCAPA::map::order, $newidx);
                   12436:                             my ($outtext,$errtext)=
                   12437:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12438:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  12439:                                                         '.'.$containers{$outer},1,1);
1.1067    raeburn  12440:                             unless ($errtext) {
                   12441:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   12442:                                     $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
                   12443:                                 }
                   12444:                             }
1.1055    raeburn  12445:                         }
                   12446:                     }
1.1086    raeburn  12447:                 }
                   12448:             } else {
                   12449:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   12450:             }
                   12451:         }
                   12452:         for (my $i=1; $i<=$numitems; $i++) {
                   12453:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   12454:             my $path = $env{'form.archive_content_'.$i};
                   12455:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12456:                 my ($title) = ($path =~ m{/([^/]+)$});
                   12457:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   12458:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   12459:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12460:                         my ($itemidx,$fullpath,$relpath);
                   12461:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   12462:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  12463:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  12464:                                 if ($dirorder{$i}->[$j] eq $container) {
                   12465:                                     $itemidx = $j;
1.1056    raeburn  12466:                                 }
                   12467:                             }
1.1086    raeburn  12468:                         }
                   12469:                         if ($itemidx eq '') {
                   12470:                             $itemidx =  0;
                   12471:                         } 
                   12472:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   12473:                             if ($mapinner{$referrer{$i}}) {
                   12474:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   12475:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12476:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12477:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12478:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12479:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12480:                                             if (!-e $fullpath) {
                   12481:                                                 mkdir($fullpath,0755);
1.1056    raeburn  12482:                                             }
                   12483:                                         }
1.1086    raeburn  12484:                                     } else {
                   12485:                                         last;
1.1056    raeburn  12486:                                     }
1.1086    raeburn  12487:                                 }
                   12488:                             }
                   12489:                         } elsif ($newdest{$referrer{$i}}) {
                   12490:                             $fullpath = $newdest{$referrer{$i}};
                   12491:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12492:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   12493:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   12494:                                     last;
                   12495:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12496:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12497:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12498:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12499:                                         if (!-e $fullpath) {
                   12500:                                             mkdir($fullpath,0755);
1.1056    raeburn  12501:                                         }
                   12502:                                     }
1.1086    raeburn  12503:                                 } else {
                   12504:                                     last;
1.1056    raeburn  12505:                                 }
1.1055    raeburn  12506:                             }
                   12507:                         }
1.1086    raeburn  12508:                         if ($fullpath ne '') {
                   12509:                             if (-e "$prefix$path") {
                   12510:                                 system("mv $prefix$path $fullpath/$title");
                   12511:                             }
                   12512:                             if (-e "$fullpath/$title") {
                   12513:                                 my $showpath;
                   12514:                                 if ($relpath ne '') {
                   12515:                                     $showpath = "$relpath/$title";
                   12516:                                 } else {
                   12517:                                     $showpath = "/$title";
                   12518:                                 } 
                   12519:                                 $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
                   12520:                             } 
                   12521:                             unless ($ishome) {
                   12522:                                 my $fetch = "$fullpath/$title";
                   12523:                                 $fetch =~ s/^\Q$prefix$dir\E//; 
                   12524:                                 $prompttofetch{$fetch} = 1;
                   12525:                             }
                   12526:                         }
1.1055    raeburn  12527:                     }
1.1086    raeburn  12528:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   12529:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   12530:                                     $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  12531:                 }
                   12532:             } else {
                   12533:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   12534:             }
                   12535:         }
                   12536:         if (keys(%todelete)) {
                   12537:             foreach my $key (keys(%todelete)) {
                   12538:                 unlink($key);
1.1066    raeburn  12539:             }
                   12540:         }
                   12541:         if (keys(%todeletedir)) {
                   12542:             foreach my $key (keys(%todeletedir)) {
                   12543:                 rmdir($key);
                   12544:             }
                   12545:         }
                   12546:         foreach my $dir (sort(keys(%is_dir))) {
                   12547:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   12548:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  12549:             }
                   12550:         }
1.1067    raeburn  12551:         if ($result ne '') {
                   12552:             $output .= '<ul>'."\n".
                   12553:                        $result."\n".
                   12554:                        '</ul>';
                   12555:         }
                   12556:         unless ($ishome) {
                   12557:             my $replicationfail;
                   12558:             foreach my $item (keys(%prompttofetch)) {
                   12559:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   12560:                 unless ($fetchresult eq 'ok') {
                   12561:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   12562:                 }
                   12563:             }
                   12564:             if ($replicationfail) {
                   12565:                 $output .= '<p class="LC_error">'.
                   12566:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   12567:                            $replicationfail.
                   12568:                            '</ul></p>';
                   12569:             }
                   12570:         }
1.1055    raeburn  12571:     } else {
                   12572:         $warning = &mt('No items found in archive.');
                   12573:     }
                   12574:     if ($error) {
                   12575:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12576:                    $error.'</p>'."\n";
                   12577:     }
                   12578:     if ($warning) {
                   12579:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12580:     }
                   12581:     return $output;
                   12582: }
                   12583: 
1.1066    raeburn  12584: sub cleanup_empty_dirs {
                   12585:     my ($path) = @_;
                   12586:     if (($path ne '') && (-d $path)) {
                   12587:         if (opendir(my $dirh,$path)) {
                   12588:             my @dircontents = grep(!/^\./,readdir($dirh));
                   12589:             my $numitems = 0;
                   12590:             foreach my $item (@dircontents) {
                   12591:                 if (-d "$path/$item") {
1.1111    raeburn  12592:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  12593:                     if (-e "$path/$item") {
                   12594:                         $numitems ++;
                   12595:                     }
                   12596:                 } else {
                   12597:                     $numitems ++;
                   12598:                 }
                   12599:             }
                   12600:             if ($numitems == 0) {
                   12601:                 rmdir($path);
                   12602:             }
                   12603:             closedir($dirh);
                   12604:         }
                   12605:     }
                   12606:     return;
                   12607: }
                   12608: 
1.41      ng       12609: =pod
1.45      matthew  12610: 
1.1162    raeburn  12611: =item * &get_folder_hierarchy()
1.1068    raeburn  12612: 
                   12613: Provides hierarchy of names of folders/sub-folders containing the current
                   12614: item,
                   12615: 
                   12616: Inputs: 3
                   12617:      - $navmap - navmaps object
                   12618: 
                   12619:      - $map - url for map (either the trigger itself, or map containing
                   12620:                            the resource, which is the trigger).
                   12621: 
                   12622:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   12623: 
                   12624: Outputs: 1 @pathitems - array of folder/subfolder names.
                   12625: 
                   12626: =cut
                   12627: 
                   12628: sub get_folder_hierarchy {
                   12629:     my ($navmap,$map,$showitem) = @_;
                   12630:     my @pathitems;
                   12631:     if (ref($navmap)) {
                   12632:         my $mapres = $navmap->getResourceByUrl($map);
                   12633:         if (ref($mapres)) {
                   12634:             my $pcslist = $mapres->map_hierarchy();
                   12635:             if ($pcslist ne '') {
                   12636:                 my @pcs = split(/,/,$pcslist);
                   12637:                 foreach my $pc (@pcs) {
                   12638:                     if ($pc == 1) {
1.1129    raeburn  12639:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  12640:                     } else {
                   12641:                         my $res = $navmap->getByMapPc($pc);
                   12642:                         if (ref($res)) {
                   12643:                             my $title = $res->compTitle();
                   12644:                             $title =~ s/\W+/_/g;
                   12645:                             if ($title ne '') {
                   12646:                                 push(@pathitems,$title);
                   12647:                             }
                   12648:                         }
                   12649:                     }
                   12650:                 }
                   12651:             }
1.1071    raeburn  12652:             if ($showitem) {
                   12653:                 if ($mapres->{ID} eq '0.0') {
1.1129    raeburn  12654:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  12655:                 } else {
                   12656:                     my $maptitle = $mapres->compTitle();
                   12657:                     $maptitle =~ s/\W+/_/g;
                   12658:                     if ($maptitle ne '') {
                   12659:                         push(@pathitems,$maptitle);
                   12660:                     }
1.1068    raeburn  12661:                 }
                   12662:             }
                   12663:         }
                   12664:     }
                   12665:     return @pathitems;
                   12666: }
                   12667: 
                   12668: =pod
                   12669: 
1.1015    raeburn  12670: =item * &get_turnedin_filepath()
                   12671: 
                   12672: Determines path in a user's portfolio file for storage of files uploaded
                   12673: to a specific essayresponse or dropbox item.
                   12674: 
                   12675: Inputs: 3 required + 1 optional.
                   12676: $symb is symb for resource, $uname and $udom are for current user (required).
                   12677: $caller is optional (can be "submission", if routine is called when storing
                   12678: an upoaded file when "Submit Answer" button was pressed).
                   12679: 
                   12680: Returns array containing $path and $multiresp. 
                   12681: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   12682: than one file upload item.  Callers of routine should append partid as a 
                   12683: subdirectory to $path in cases where $multiresp is 1.
                   12684: 
                   12685: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   12686: 
                   12687: =cut
                   12688: 
                   12689: sub get_turnedin_filepath {
                   12690:     my ($symb,$uname,$udom,$caller) = @_;
                   12691:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   12692:     my $turnindir;
                   12693:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   12694:     $turnindir = $userhash{'turnindir'};
                   12695:     my ($path,$multiresp);
                   12696:     if ($turnindir eq '') {
                   12697:         if ($caller eq 'submission') {
                   12698:             $turnindir = &mt('turned in');
                   12699:             $turnindir =~ s/\W+/_/g;
                   12700:             my %newhash = (
                   12701:                             'turnindir' => $turnindir,
                   12702:                           );
                   12703:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   12704:         }
                   12705:     }
                   12706:     if ($turnindir ne '') {
                   12707:         $path = '/'.$turnindir.'/';
                   12708:         my ($multipart,$turnin,@pathitems);
                   12709:         my $navmap = Apache::lonnavmaps::navmap->new();
                   12710:         if (defined($navmap)) {
                   12711:             my $mapres = $navmap->getResourceByUrl($map);
                   12712:             if (ref($mapres)) {
                   12713:                 my $pcslist = $mapres->map_hierarchy();
                   12714:                 if ($pcslist ne '') {
                   12715:                     foreach my $pc (split(/,/,$pcslist)) {
                   12716:                         my $res = $navmap->getByMapPc($pc);
                   12717:                         if (ref($res)) {
                   12718:                             my $title = $res->compTitle();
                   12719:                             $title =~ s/\W+/_/g;
                   12720:                             if ($title ne '') {
1.1149    raeburn  12721:                                 if (($pc > 1) && (length($title) > 12)) {
                   12722:                                     $title = substr($title,0,12);
                   12723:                                 }
1.1015    raeburn  12724:                                 push(@pathitems,$title);
                   12725:                             }
                   12726:                         }
                   12727:                     }
                   12728:                 }
                   12729:                 my $maptitle = $mapres->compTitle();
                   12730:                 $maptitle =~ s/\W+/_/g;
                   12731:                 if ($maptitle ne '') {
1.1149    raeburn  12732:                     if (length($maptitle) > 12) {
                   12733:                         $maptitle = substr($maptitle,0,12);
                   12734:                     }
1.1015    raeburn  12735:                     push(@pathitems,$maptitle);
                   12736:                 }
                   12737:                 unless ($env{'request.state'} eq 'construct') {
                   12738:                     my $res = $navmap->getBySymb($symb);
                   12739:                     if (ref($res)) {
                   12740:                         my $partlist = $res->parts();
                   12741:                         my $totaluploads = 0;
                   12742:                         if (ref($partlist) eq 'ARRAY') {
                   12743:                             foreach my $part (@{$partlist}) {
                   12744:                                 my @types = $res->responseType($part);
                   12745:                                 my @ids = $res->responseIds($part);
                   12746:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   12747:                                     if ($types[$i] eq 'essay') {
                   12748:                                         my $partid = $part.'_'.$ids[$i];
                   12749:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   12750:                                             $totaluploads ++;
                   12751:                                         }
                   12752:                                     }
                   12753:                                 }
                   12754:                             }
                   12755:                             if ($totaluploads > 1) {
                   12756:                                 $multiresp = 1;
                   12757:                             }
                   12758:                         }
                   12759:                     }
                   12760:                 }
                   12761:             } else {
                   12762:                 return;
                   12763:             }
                   12764:         } else {
                   12765:             return;
                   12766:         }
                   12767:         my $restitle=&Apache::lonnet::gettitle($symb);
                   12768:         $restitle =~ s/\W+/_/g;
                   12769:         if ($restitle eq '') {
                   12770:             $restitle = ($resurl =~ m{/[^/]+$});
                   12771:             if ($restitle eq '') {
                   12772:                 $restitle = time;
                   12773:             }
                   12774:         }
1.1149    raeburn  12775:         if (length($restitle) > 12) {
                   12776:             $restitle = substr($restitle,0,12);
                   12777:         }
1.1015    raeburn  12778:         push(@pathitems,$restitle);
                   12779:         $path .= join('/',@pathitems);
                   12780:     }
                   12781:     return ($path,$multiresp);
                   12782: }
                   12783: 
                   12784: =pod
                   12785: 
1.464     albertel 12786: =back
1.41      ng       12787: 
1.112     bowersj2 12788: =head1 CSV Upload/Handling functions
1.38      albertel 12789: 
1.41      ng       12790: =over 4
                   12791: 
1.648     raeburn  12792: =item * &upfile_store($r)
1.41      ng       12793: 
                   12794: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 12795: needs $env{'form.upfile'}
1.41      ng       12796: returns $datatoken to be put into hidden field
                   12797: 
                   12798: =cut
1.31      albertel 12799: 
                   12800: sub upfile_store {
                   12801:     my $r=shift;
1.258     albertel 12802:     $env{'form.upfile'}=~s/\r/\n/gs;
                   12803:     $env{'form.upfile'}=~s/\f/\n/gs;
                   12804:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   12805:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 12806: 
1.258     albertel 12807:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   12808: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 12809:     {
1.158     raeburn  12810:         my $datafile = $r->dir_config('lonDaemons').
                   12811:                            '/tmp/'.$datatoken.'.tmp';
                   12812:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 12813:             print $fh $env{'form.upfile'};
1.158     raeburn  12814:             close($fh);
                   12815:         }
1.31      albertel 12816:     }
                   12817:     return $datatoken;
                   12818: }
                   12819: 
1.56      matthew  12820: =pod
                   12821: 
1.648     raeburn  12822: =item * &load_tmp_file($r)
1.41      ng       12823: 
                   12824: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 12825: needs $env{'form.datatoken'},
                   12826: sets $env{'form.upfile'} to the contents of the file
1.41      ng       12827: 
                   12828: =cut
1.31      albertel 12829: 
                   12830: sub load_tmp_file {
                   12831:     my $r=shift;
                   12832:     my @studentdata=();
                   12833:     {
1.158     raeburn  12834:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 12835:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  12836:         if ( open(my $fh,"<$studentfile") ) {
                   12837:             @studentdata=<$fh>;
                   12838:             close($fh);
                   12839:         }
1.31      albertel 12840:     }
1.258     albertel 12841:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 12842: }
                   12843: 
1.56      matthew  12844: =pod
                   12845: 
1.648     raeburn  12846: =item * &upfile_record_sep()
1.41      ng       12847: 
                   12848: Separate uploaded file into records
                   12849: returns array of records,
1.258     albertel 12850: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       12851: 
                   12852: =cut
1.31      albertel 12853: 
                   12854: sub upfile_record_sep {
1.258     albertel 12855:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 12856:     } else {
1.248     albertel 12857: 	my @records;
1.258     albertel 12858: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 12859: 	    if ($line=~/^\s*$/) { next; }
                   12860: 	    push(@records,$line);
                   12861: 	}
                   12862: 	return @records;
1.31      albertel 12863:     }
                   12864: }
                   12865: 
1.56      matthew  12866: =pod
                   12867: 
1.648     raeburn  12868: =item * &record_sep($record)
1.41      ng       12869: 
1.258     albertel 12870: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       12871: 
                   12872: =cut
                   12873: 
1.263     www      12874: sub takeleft {
                   12875:     my $index=shift;
                   12876:     return substr('0000'.$index,-4,4);
                   12877: }
                   12878: 
1.31      albertel 12879: sub record_sep {
                   12880:     my $record=shift;
                   12881:     my %components=();
1.258     albertel 12882:     if ($env{'form.upfiletype'} eq 'xml') {
                   12883:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 12884:         my $i=0;
1.356     albertel 12885:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 12886:             $field=~s/^(\"|\')//;
                   12887:             $field=~s/(\"|\')$//;
1.263     www      12888:             $components{&takeleft($i)}=$field;
1.31      albertel 12889:             $i++;
                   12890:         }
1.258     albertel 12891:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 12892:         my $i=0;
1.356     albertel 12893:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 12894:             $field=~s/^(\"|\')//;
                   12895:             $field=~s/(\"|\')$//;
1.263     www      12896:             $components{&takeleft($i)}=$field;
1.31      albertel 12897:             $i++;
                   12898:         }
                   12899:     } else {
1.561     www      12900:         my $separator=',';
1.480     banghart 12901:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      12902:             $separator=';';
1.480     banghart 12903:         }
1.31      albertel 12904:         my $i=0;
1.561     www      12905: # the character we are looking for to indicate the end of a quote or a record 
                   12906:         my $looking_for=$separator;
                   12907: # do not add the characters to the fields
                   12908:         my $ignore=0;
                   12909: # we just encountered a separator (or the beginning of the record)
                   12910:         my $just_found_separator=1;
                   12911: # store the field we are working on here
                   12912:         my $field='';
                   12913: # work our way through all characters in record
                   12914:         foreach my $character ($record=~/(.)/g) {
                   12915:             if ($character eq $looking_for) {
                   12916:                if ($character ne $separator) {
                   12917: # Found the end of a quote, again looking for separator
                   12918:                   $looking_for=$separator;
                   12919:                   $ignore=1;
                   12920:                } else {
                   12921: # Found a separator, store away what we got
                   12922:                   $components{&takeleft($i)}=$field;
                   12923: 	          $i++;
                   12924:                   $just_found_separator=1;
                   12925:                   $ignore=0;
                   12926:                   $field='';
                   12927:                }
                   12928:                next;
                   12929:             }
                   12930: # single or double quotation marks after a separator indicate beginning of a quote
                   12931: # we are now looking for the end of the quote and need to ignore separators
                   12932:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   12933:                $looking_for=$character;
                   12934:                next;
                   12935:             }
                   12936: # ignore would be true after we reached the end of a quote
                   12937:             if ($ignore) { next; }
                   12938:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   12939:             $field.=$character;
                   12940:             $just_found_separator=0; 
1.31      albertel 12941:         }
1.561     www      12942: # catch the very last entry, since we never encountered the separator
                   12943:         $components{&takeleft($i)}=$field;
1.31      albertel 12944:     }
                   12945:     return %components;
                   12946: }
                   12947: 
1.144     matthew  12948: ######################################################
                   12949: ######################################################
                   12950: 
1.56      matthew  12951: =pod
                   12952: 
1.648     raeburn  12953: =item * &upfile_select_html()
1.41      ng       12954: 
1.144     matthew  12955: Return HTML code to select a file from the users machine and specify 
                   12956: the file type.
1.41      ng       12957: 
                   12958: =cut
                   12959: 
1.144     matthew  12960: ######################################################
                   12961: ######################################################
1.31      albertel 12962: sub upfile_select_html {
1.144     matthew  12963:     my %Types = (
                   12964:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 12965:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  12966:                  space => &mt('Space separated'),
                   12967:                  tab   => &mt('Tabulator separated'),
                   12968: #                 xml   => &mt('HTML/XML'),
                   12969:                  );
                   12970:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  12971:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  12972:     foreach my $type (sort(keys(%Types))) {
                   12973:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   12974:     }
                   12975:     $Str .= "</select>\n";
                   12976:     return $Str;
1.31      albertel 12977: }
                   12978: 
1.301     albertel 12979: sub get_samples {
                   12980:     my ($records,$toget) = @_;
                   12981:     my @samples=({});
                   12982:     my $got=0;
                   12983:     foreach my $rec (@$records) {
                   12984: 	my %temp = &record_sep($rec);
                   12985: 	if (! grep(/\S/, values(%temp))) { next; }
                   12986: 	if (%temp) {
                   12987: 	    $samples[$got]=\%temp;
                   12988: 	    $got++;
                   12989: 	    if ($got == $toget) { last; }
                   12990: 	}
                   12991:     }
                   12992:     return \@samples;
                   12993: }
                   12994: 
1.144     matthew  12995: ######################################################
                   12996: ######################################################
                   12997: 
1.56      matthew  12998: =pod
                   12999: 
1.648     raeburn  13000: =item * &csv_print_samples($r,$records)
1.41      ng       13001: 
                   13002: Prints a table of sample values from each column uploaded $r is an
                   13003: Apache Request ref, $records is an arrayref from
                   13004: &Apache::loncommon::upfile_record_sep
                   13005: 
                   13006: =cut
                   13007: 
1.144     matthew  13008: ######################################################
                   13009: ######################################################
1.31      albertel 13010: sub csv_print_samples {
                   13011:     my ($r,$records) = @_;
1.662     bisitz   13012:     my $samples = &get_samples($records,5);
1.301     albertel 13013: 
1.594     raeburn  13014:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13015:               &start_data_table_header_row());
1.356     albertel 13016:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13017:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13018:     $r->print(&end_data_table_header_row());
1.301     albertel 13019:     foreach my $hash (@$samples) {
1.594     raeburn  13020: 	$r->print(&start_data_table_row());
1.356     albertel 13021: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13022: 	    $r->print('<td>');
1.356     albertel 13023: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13024: 	    $r->print('</td>');
                   13025: 	}
1.594     raeburn  13026: 	$r->print(&end_data_table_row());
1.31      albertel 13027:     }
1.594     raeburn  13028:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13029: }
                   13030: 
1.144     matthew  13031: ######################################################
                   13032: ######################################################
                   13033: 
1.56      matthew  13034: =pod
                   13035: 
1.648     raeburn  13036: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13037: 
                   13038: Prints a table to create associations between values and table columns.
1.144     matthew  13039: 
1.41      ng       13040: $r is an Apache Request ref,
                   13041: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13042: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13043: 
                   13044: =cut
                   13045: 
1.144     matthew  13046: ######################################################
                   13047: ######################################################
1.31      albertel 13048: sub csv_print_select_table {
                   13049:     my ($r,$records,$d) = @_;
1.301     albertel 13050:     my $i=0;
                   13051:     my $samples = &get_samples($records,1);
1.144     matthew  13052:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13053: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13054:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13055:               '<th>'.&mt('Column').'</th>'.
                   13056:               &end_data_table_header_row()."\n");
1.356     albertel 13057:     foreach my $array_ref (@$d) {
                   13058: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13059: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13060: 
1.875     bisitz   13061: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13062: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13063: 	$r->print('<option value="none"></option>');
1.356     albertel 13064: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13065: 	    $r->print('<option value="'.$sample.'"'.
                   13066:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13067:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13068: 	}
1.594     raeburn  13069: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13070: 	$i++;
                   13071:     }
1.594     raeburn  13072:     $r->print(&end_data_table());
1.31      albertel 13073:     $i--;
                   13074:     return $i;
                   13075: }
1.56      matthew  13076: 
1.144     matthew  13077: ######################################################
                   13078: ######################################################
                   13079: 
1.56      matthew  13080: =pod
1.31      albertel 13081: 
1.648     raeburn  13082: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13083: 
                   13084: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13085: 
                   13086: $r is an Apache Request ref,
                   13087: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13088: $d is an array of 2 element arrays (internal name, displayed name)
                   13089: 
                   13090: =cut
                   13091: 
1.144     matthew  13092: ######################################################
                   13093: ######################################################
1.31      albertel 13094: sub csv_samples_select_table {
                   13095:     my ($r,$records,$d) = @_;
                   13096:     my $i=0;
1.144     matthew  13097:     #
1.662     bisitz   13098:     my $max_samples = 5;
                   13099:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13100:     $r->print(&start_data_table().
                   13101:               &start_data_table_header_row().'<th>'.
                   13102:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13103:               &end_data_table_header_row());
1.301     albertel 13104: 
                   13105:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13106: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13107: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13108: 	foreach my $option (@$d) {
                   13109: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13110: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13111:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13112:                       $display.'</option>');
1.31      albertel 13113: 	}
                   13114: 	$r->print('</select></td><td>');
1.662     bisitz   13115: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13116: 	    if (defined($samples->[$line]{$key})) { 
                   13117: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13118: 	    }
                   13119: 	}
1.594     raeburn  13120: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13121: 	$i++;
                   13122:     }
1.594     raeburn  13123:     $r->print(&end_data_table());
1.31      albertel 13124:     $i--;
                   13125:     return($i);
1.115     matthew  13126: }
                   13127: 
1.144     matthew  13128: ######################################################
                   13129: ######################################################
                   13130: 
1.115     matthew  13131: =pod
                   13132: 
1.648     raeburn  13133: =item * &clean_excel_name($name)
1.115     matthew  13134: 
                   13135: Returns a replacement for $name which does not contain any illegal characters.
                   13136: 
                   13137: =cut
                   13138: 
1.144     matthew  13139: ######################################################
                   13140: ######################################################
1.115     matthew  13141: sub clean_excel_name {
                   13142:     my ($name) = @_;
                   13143:     $name =~ s/[:\*\?\/\\]//g;
                   13144:     if (length($name) > 31) {
                   13145:         $name = substr($name,0,31);
                   13146:     }
                   13147:     return $name;
1.25      albertel 13148: }
1.84      albertel 13149: 
1.85      albertel 13150: =pod
                   13151: 
1.648     raeburn  13152: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13153: 
                   13154: Returns either 1 or undef
                   13155: 
                   13156: 1 if the part is to be hidden, undef if it is to be shown
                   13157: 
                   13158: Arguments are:
                   13159: 
                   13160: $id the id of the part to be checked
                   13161: $symb, optional the symb of the resource to check
                   13162: $udom, optional the domain of the user to check for
                   13163: $uname, optional the username of the user to check for
                   13164: 
                   13165: =cut
1.84      albertel 13166: 
                   13167: sub check_if_partid_hidden {
                   13168:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13169:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13170: 					 $symb,$udom,$uname);
1.141     albertel 13171:     my $truth=1;
                   13172:     #if the string starts with !, then the list is the list to show not hide
                   13173:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13174:     my @hiddenlist=split(/,/,$hiddenparts);
                   13175:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13176: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13177:     }
1.141     albertel 13178:     return !$truth;
1.84      albertel 13179: }
1.127     matthew  13180: 
1.138     matthew  13181: 
                   13182: ############################################################
                   13183: ############################################################
                   13184: 
                   13185: =pod
                   13186: 
1.157     matthew  13187: =back 
                   13188: 
1.138     matthew  13189: =head1 cgi-bin script and graphing routines
                   13190: 
1.157     matthew  13191: =over 4
                   13192: 
1.648     raeburn  13193: =item * &get_cgi_id()
1.138     matthew  13194: 
                   13195: Inputs: none
                   13196: 
                   13197: Returns an id which can be used to pass environment variables
                   13198: to various cgi-bin scripts.  These environment variables will
                   13199: be removed from the users environment after a given time by
                   13200: the routine &Apache::lonnet::transfer_profile_to_env.
                   13201: 
                   13202: =cut
                   13203: 
                   13204: ############################################################
                   13205: ############################################################
1.152     albertel 13206: my $uniq=0;
1.136     matthew  13207: sub get_cgi_id {
1.154     albertel 13208:     $uniq=($uniq+1)%100000;
1.280     albertel 13209:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13210: }
                   13211: 
1.127     matthew  13212: ############################################################
                   13213: ############################################################
                   13214: 
                   13215: =pod
                   13216: 
1.648     raeburn  13217: =item * &DrawBarGraph()
1.127     matthew  13218: 
1.138     matthew  13219: Facilitates the plotting of data in a (stacked) bar graph.
                   13220: Puts plot definition data into the users environment in order for 
                   13221: graph.png to plot it.  Returns an <img> tag for the plot.
                   13222: The bars on the plot are labeled '1','2',...,'n'.
                   13223: 
                   13224: Inputs:
                   13225: 
                   13226: =over 4
                   13227: 
                   13228: =item $Title: string, the title of the plot
                   13229: 
                   13230: =item $xlabel: string, text describing the X-axis of the plot
                   13231: 
                   13232: =item $ylabel: string, text describing the Y-axis of the plot
                   13233: 
                   13234: =item $Max: scalar, the maximum Y value to use in the plot
                   13235: If $Max is < any data point, the graph will not be rendered.
                   13236: 
1.140     matthew  13237: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13238: they are plotted.  If undefined, default values will be used.
                   13239: 
1.178     matthew  13240: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13241: 
1.138     matthew  13242: =item @Values: An array of array references.  Each array reference holds data
                   13243: to be plotted in a stacked bar chart.
                   13244: 
1.239     matthew  13245: =item If the final element of @Values is a hash reference the key/value
                   13246: pairs will be added to the graph definition.
                   13247: 
1.138     matthew  13248: =back
                   13249: 
                   13250: Returns:
                   13251: 
                   13252: An <img> tag which references graph.png and the appropriate identifying
                   13253: information for the plot.
                   13254: 
1.127     matthew  13255: =cut
                   13256: 
                   13257: ############################################################
                   13258: ############################################################
1.134     matthew  13259: sub DrawBarGraph {
1.178     matthew  13260:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13261:     #
                   13262:     if (! defined($colors)) {
                   13263:         $colors = ['#33ff00', 
                   13264:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13265:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13266:                   ]; 
                   13267:     }
1.228     matthew  13268:     my $extra_settings = {};
                   13269:     if (ref($Values[-1]) eq 'HASH') {
                   13270:         $extra_settings = pop(@Values);
                   13271:     }
1.127     matthew  13272:     #
1.136     matthew  13273:     my $identifier = &get_cgi_id();
                   13274:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13275:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13276:         return '';
                   13277:     }
1.225     matthew  13278:     #
                   13279:     my @Labels;
                   13280:     if (defined($labels)) {
                   13281:         @Labels = @$labels;
                   13282:     } else {
                   13283:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   13284:             push (@Labels,$i+1);
                   13285:         }
                   13286:     }
                   13287:     #
1.129     matthew  13288:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13289:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13290:     my %ValuesHash;
                   13291:     my $NumSets=1;
                   13292:     foreach my $array (@Values) {
                   13293:         next if (! ref($array));
1.136     matthew  13294:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13295:             join(',',@$array);
1.129     matthew  13296:     }
1.127     matthew  13297:     #
1.136     matthew  13298:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13299:     if ($NumBars < 3) {
                   13300:         $width = 120+$NumBars*32;
1.220     matthew  13301:         $xskip = 1;
1.225     matthew  13302:         $bar_width = 30;
                   13303:     } elsif ($NumBars < 5) {
                   13304:         $width = 120+$NumBars*20;
                   13305:         $xskip = 1;
                   13306:         $bar_width = 20;
1.220     matthew  13307:     } elsif ($NumBars < 10) {
1.136     matthew  13308:         $width = 120+$NumBars*15;
                   13309:         $xskip = 1;
                   13310:         $bar_width = 15;
                   13311:     } elsif ($NumBars <= 25) {
                   13312:         $width = 120+$NumBars*11;
                   13313:         $xskip = 5;
                   13314:         $bar_width = 8;
                   13315:     } elsif ($NumBars <= 50) {
                   13316:         $width = 120+$NumBars*8;
                   13317:         $xskip = 5;
                   13318:         $bar_width = 4;
                   13319:     } else {
                   13320:         $width = 120+$NumBars*8;
                   13321:         $xskip = 5;
                   13322:         $bar_width = 4;
                   13323:     }
                   13324:     #
1.137     matthew  13325:     $Max = 1 if ($Max < 1);
                   13326:     if ( int($Max) < $Max ) {
                   13327:         $Max++;
                   13328:         $Max = int($Max);
                   13329:     }
1.127     matthew  13330:     $Title  = '' if (! defined($Title));
                   13331:     $xlabel = '' if (! defined($xlabel));
                   13332:     $ylabel = '' if (! defined($ylabel));
1.369     www      13333:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13334:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13335:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13336:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13337:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13338:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13339:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13340:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13341:     $ValuesHash{$id.'.height'}   = $height;
                   13342:     $ValuesHash{$id.'.width'}    = $width;
                   13343:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13344:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13345:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13346:     #
1.228     matthew  13347:     # Deal with other parameters
                   13348:     while (my ($key,$value) = each(%$extra_settings)) {
                   13349:         $ValuesHash{$id.'.'.$key} = $value;
                   13350:     }
                   13351:     #
1.646     raeburn  13352:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13353:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13354: }
                   13355: 
                   13356: ############################################################
                   13357: ############################################################
                   13358: 
                   13359: =pod
                   13360: 
1.648     raeburn  13361: =item * &DrawXYGraph()
1.137     matthew  13362: 
1.138     matthew  13363: Facilitates the plotting of data in an XY graph.
                   13364: Puts plot definition data into the users environment in order for 
                   13365: graph.png to plot it.  Returns an <img> tag for the plot.
                   13366: 
                   13367: Inputs:
                   13368: 
                   13369: =over 4
                   13370: 
                   13371: =item $Title: string, the title of the plot
                   13372: 
                   13373: =item $xlabel: string, text describing the X-axis of the plot
                   13374: 
                   13375: =item $ylabel: string, text describing the Y-axis of the plot
                   13376: 
                   13377: =item $Max: scalar, the maximum Y value to use in the plot
                   13378: If $Max is < any data point, the graph will not be rendered.
                   13379: 
                   13380: =item $colors: Array ref containing the hex color codes for the data to be 
                   13381: plotted in.  If undefined, default values will be used.
                   13382: 
                   13383: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13384: 
                   13385: =item $Ydata: Array ref containing Array refs.  
1.185     www      13386: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13387: 
                   13388: =item %Values: hash indicating or overriding any default values which are 
                   13389: passed to graph.png.  
                   13390: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13391: 
                   13392: =back
                   13393: 
                   13394: Returns:
                   13395: 
                   13396: An <img> tag which references graph.png and the appropriate identifying
                   13397: information for the plot.
                   13398: 
1.137     matthew  13399: =cut
                   13400: 
                   13401: ############################################################
                   13402: ############################################################
                   13403: sub DrawXYGraph {
                   13404:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   13405:     #
                   13406:     # Create the identifier for the graph
                   13407:     my $identifier = &get_cgi_id();
                   13408:     my $id = 'cgi.'.$identifier;
                   13409:     #
                   13410:     $Title  = '' if (! defined($Title));
                   13411:     $xlabel = '' if (! defined($xlabel));
                   13412:     $ylabel = '' if (! defined($ylabel));
                   13413:     my %ValuesHash = 
                   13414:         (
1.369     www      13415:          $id.'.title'  => &escape($Title),
                   13416:          $id.'.xlabel' => &escape($xlabel),
                   13417:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  13418:          $id.'.y_max_value'=> $Max,
                   13419:          $id.'.labels'     => join(',',@$Xlabels),
                   13420:          $id.'.PlotType'   => 'XY',
                   13421:          );
                   13422:     #
                   13423:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13424:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13425:     }
                   13426:     #
                   13427:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   13428:         return '';
                   13429:     }
                   13430:     my $NumSets=1;
1.138     matthew  13431:     foreach my $array (@{$Ydata}){
1.137     matthew  13432:         next if (! ref($array));
                   13433:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   13434:     }
1.138     matthew  13435:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  13436:     #
                   13437:     # Deal with other parameters
                   13438:     while (my ($key,$value) = each(%Values)) {
                   13439:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  13440:     }
                   13441:     #
1.646     raeburn  13442:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  13443:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13444: }
                   13445: 
                   13446: ############################################################
                   13447: ############################################################
                   13448: 
                   13449: =pod
                   13450: 
1.648     raeburn  13451: =item * &DrawXYYGraph()
1.138     matthew  13452: 
                   13453: Facilitates the plotting of data in an XY graph with two Y axes.
                   13454: Puts plot definition data into the users environment in order for 
                   13455: graph.png to plot it.  Returns an <img> tag for the plot.
                   13456: 
                   13457: Inputs:
                   13458: 
                   13459: =over 4
                   13460: 
                   13461: =item $Title: string, the title of the plot
                   13462: 
                   13463: =item $xlabel: string, text describing the X-axis of the plot
                   13464: 
                   13465: =item $ylabel: string, text describing the Y-axis of the plot
                   13466: 
                   13467: =item $colors: Array ref containing the hex color codes for the data to be 
                   13468: plotted in.  If undefined, default values will be used.
                   13469: 
                   13470: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13471: 
                   13472: =item $Ydata1: The first data set
                   13473: 
                   13474: =item $Min1: The minimum value of the left Y-axis
                   13475: 
                   13476: =item $Max1: The maximum value of the left Y-axis
                   13477: 
                   13478: =item $Ydata2: The second data set
                   13479: 
                   13480: =item $Min2: The minimum value of the right Y-axis
                   13481: 
                   13482: =item $Max2: The maximum value of the left Y-axis
                   13483: 
                   13484: =item %Values: hash indicating or overriding any default values which are 
                   13485: passed to graph.png.  
                   13486: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13487: 
                   13488: =back
                   13489: 
                   13490: Returns:
                   13491: 
                   13492: An <img> tag which references graph.png and the appropriate identifying
                   13493: information for the plot.
1.136     matthew  13494: 
                   13495: =cut
                   13496: 
                   13497: ############################################################
                   13498: ############################################################
1.137     matthew  13499: sub DrawXYYGraph {
                   13500:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   13501:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  13502:     #
                   13503:     # Create the identifier for the graph
                   13504:     my $identifier = &get_cgi_id();
                   13505:     my $id = 'cgi.'.$identifier;
                   13506:     #
                   13507:     $Title  = '' if (! defined($Title));
                   13508:     $xlabel = '' if (! defined($xlabel));
                   13509:     $ylabel = '' if (! defined($ylabel));
                   13510:     my %ValuesHash = 
                   13511:         (
1.369     www      13512:          $id.'.title'  => &escape($Title),
                   13513:          $id.'.xlabel' => &escape($xlabel),
                   13514:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  13515:          $id.'.labels' => join(',',@$Xlabels),
                   13516:          $id.'.PlotType' => 'XY',
                   13517:          $id.'.NumSets' => 2,
1.137     matthew  13518:          $id.'.two_axes' => 1,
                   13519:          $id.'.y1_max_value' => $Max1,
                   13520:          $id.'.y1_min_value' => $Min1,
                   13521:          $id.'.y2_max_value' => $Max2,
                   13522:          $id.'.y2_min_value' => $Min2,
1.136     matthew  13523:          );
                   13524:     #
1.137     matthew  13525:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13526:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13527:     }
                   13528:     #
                   13529:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   13530:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  13531:         return '';
                   13532:     }
                   13533:     my $NumSets=1;
1.137     matthew  13534:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  13535:         next if (! ref($array));
                   13536:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  13537:     }
                   13538:     #
                   13539:     # Deal with other parameters
                   13540:     while (my ($key,$value) = each(%Values)) {
                   13541:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  13542:     }
                   13543:     #
1.646     raeburn  13544:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 13545:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  13546: }
                   13547: 
                   13548: ############################################################
                   13549: ############################################################
                   13550: 
                   13551: =pod
                   13552: 
1.157     matthew  13553: =back 
                   13554: 
1.139     matthew  13555: =head1 Statistics helper routines?  
                   13556: 
                   13557: Bad place for them but what the hell.
                   13558: 
1.157     matthew  13559: =over 4
                   13560: 
1.648     raeburn  13561: =item * &chartlink()
1.139     matthew  13562: 
                   13563: Returns a link to the chart for a specific student.  
                   13564: 
                   13565: Inputs:
                   13566: 
                   13567: =over 4
                   13568: 
                   13569: =item $linktext: The text of the link
                   13570: 
                   13571: =item $sname: The students username
                   13572: 
                   13573: =item $sdomain: The students domain
                   13574: 
                   13575: =back
                   13576: 
1.157     matthew  13577: =back
                   13578: 
1.139     matthew  13579: =cut
                   13580: 
                   13581: ############################################################
                   13582: ############################################################
                   13583: sub chartlink {
                   13584:     my ($linktext, $sname, $sdomain) = @_;
                   13585:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      13586:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 13587:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  13588:        '">'.$linktext.'</a>';
1.153     matthew  13589: }
                   13590: 
                   13591: #######################################################
                   13592: #######################################################
                   13593: 
                   13594: =pod
                   13595: 
                   13596: =head1 Course Environment Routines
1.157     matthew  13597: 
                   13598: =over 4
1.153     matthew  13599: 
1.648     raeburn  13600: =item * &restore_course_settings()
1.153     matthew  13601: 
1.648     raeburn  13602: =item * &store_course_settings()
1.153     matthew  13603: 
                   13604: Restores/Store indicated form parameters from the course environment.
                   13605: Will not overwrite existing values of the form parameters.
                   13606: 
                   13607: Inputs: 
                   13608: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   13609: 
                   13610: a hash ref describing the data to be stored.  For example:
                   13611:    
                   13612: %Save_Parameters = ('Status' => 'scalar',
                   13613:     'chartoutputmode' => 'scalar',
                   13614:     'chartoutputdata' => 'scalar',
                   13615:     'Section' => 'array',
1.373     raeburn  13616:     'Group' => 'array',
1.153     matthew  13617:     'StudentData' => 'array',
                   13618:     'Maps' => 'array');
                   13619: 
                   13620: Returns: both routines return nothing
                   13621: 
1.631     raeburn  13622: =back
                   13623: 
1.153     matthew  13624: =cut
                   13625: 
                   13626: #######################################################
                   13627: #######################################################
                   13628: sub store_course_settings {
1.496     albertel 13629:     return &store_settings($env{'request.course.id'},@_);
                   13630: }
                   13631: 
                   13632: sub store_settings {
1.153     matthew  13633:     # save to the environment
                   13634:     # appenv the same items, just to be safe
1.300     albertel 13635:     my $udom  = $env{'user.domain'};
                   13636:     my $uname = $env{'user.name'};
1.496     albertel 13637:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  13638:     my %SaveHash;
                   13639:     my %AppHash;
                   13640:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 13641:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 13642:         my $envname = 'environment.'.$basename;
1.258     albertel 13643:         if (exists($env{'form.'.$setting})) {
1.153     matthew  13644:             # Save this value away
                   13645:             if ($type eq 'scalar' &&
1.258     albertel 13646:                 (! exists($env{$envname}) || 
                   13647:                  $env{$envname} ne $env{'form.'.$setting})) {
                   13648:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   13649:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  13650:             } elsif ($type eq 'array') {
                   13651:                 my $stored_form;
1.258     albertel 13652:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  13653:                     $stored_form = join(',',
                   13654:                                         map {
1.369     www      13655:                                             &escape($_);
1.258     albertel 13656:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  13657:                 } else {
                   13658:                     $stored_form = 
1.369     www      13659:                         &escape($env{'form.'.$setting});
1.153     matthew  13660:                 }
                   13661:                 # Determine if the array contents are the same.
1.258     albertel 13662:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  13663:                     $SaveHash{$basename} = $stored_form;
                   13664:                     $AppHash{$envname}   = $stored_form;
                   13665:                 }
                   13666:             }
                   13667:         }
                   13668:     }
                   13669:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 13670:                                           $udom,$uname);
1.153     matthew  13671:     if ($put_result !~ /^(ok|delayed)/) {
                   13672:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   13673:                                  'got error:'.$put_result);
                   13674:     }
                   13675:     # Make sure these settings stick around in this session, too
1.646     raeburn  13676:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  13677:     return;
                   13678: }
                   13679: 
                   13680: sub restore_course_settings {
1.499     albertel 13681:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 13682: }
                   13683: 
                   13684: sub restore_settings {
                   13685:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  13686:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 13687:         next if (exists($env{'form.'.$setting}));
1.496     albertel 13688:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  13689:             '.'.$setting;
1.258     albertel 13690:         if (exists($env{$envname})) {
1.153     matthew  13691:             if ($type eq 'scalar') {
1.258     albertel 13692:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  13693:             } elsif ($type eq 'array') {
1.258     albertel 13694:                 $env{'form.'.$setting} = [ 
1.153     matthew  13695:                                            map { 
1.369     www      13696:                                                &unescape($_); 
1.258     albertel 13697:                                            } split(',',$env{$envname})
1.153     matthew  13698:                                            ];
                   13699:             }
                   13700:         }
                   13701:     }
1.127     matthew  13702: }
                   13703: 
1.618     raeburn  13704: #######################################################
                   13705: #######################################################
                   13706: 
                   13707: =pod
                   13708: 
                   13709: =head1 Domain E-mail Routines  
                   13710: 
                   13711: =over 4
                   13712: 
1.648     raeburn  13713: =item * &build_recipient_list()
1.618     raeburn  13714: 
1.1144    raeburn  13715: Build recipient lists for following types of e-mail:
1.766     raeburn  13716: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144    raeburn  13717: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   13718: module change checking, student/employee ID conflict checks, as
                   13719: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   13720: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  13721: 
                   13722: Inputs:
1.619     raeburn  13723: defmail (scalar - email address of default recipient), 
1.1144    raeburn  13724: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   13725: requestsmail, updatesmail, or idconflictsmail).
                   13726: 
1.619     raeburn  13727: defdom (domain for which to retrieve configuration settings),
1.1144    raeburn  13728: 
1.619     raeburn  13729: origmail (scalar - email address of recipient from loncapa.conf, 
                   13730: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  13731: 
1.655     raeburn  13732: Returns: comma separated list of addresses to which to send e-mail.
                   13733: 
                   13734: =back
1.618     raeburn  13735: 
                   13736: =cut
                   13737: 
                   13738: ############################################################
                   13739: ############################################################
                   13740: sub build_recipient_list {
1.619     raeburn  13741:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  13742:     my @recipients;
                   13743:     my $otheremails;
                   13744:     my %domconfig =
                   13745:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   13746:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  13747:         if (exists($domconfig{'contacts'}{$mailing})) {
                   13748:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   13749:                 my @contacts = ('adminemail','supportemail');
                   13750:                 foreach my $item (@contacts) {
                   13751:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   13752:                         my $addr = $domconfig{'contacts'}{$item}; 
                   13753:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   13754:                             push(@recipients,$addr);
                   13755:                         }
1.619     raeburn  13756:                     }
1.766     raeburn  13757:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  13758:                 }
                   13759:             }
1.766     raeburn  13760:         } elsif ($origmail ne '') {
                   13761:             push(@recipients,$origmail);
1.618     raeburn  13762:         }
1.619     raeburn  13763:     } elsif ($origmail ne '') {
                   13764:         push(@recipients,$origmail);
1.618     raeburn  13765:     }
1.688     raeburn  13766:     if (defined($defmail)) {
                   13767:         if ($defmail ne '') {
                   13768:             push(@recipients,$defmail);
                   13769:         }
1.618     raeburn  13770:     }
                   13771:     if ($otheremails) {
1.619     raeburn  13772:         my @others;
                   13773:         if ($otheremails =~ /,/) {
                   13774:             @others = split(/,/,$otheremails);
1.618     raeburn  13775:         } else {
1.619     raeburn  13776:             push(@others,$otheremails);
                   13777:         }
                   13778:         foreach my $addr (@others) {
                   13779:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   13780:                 push(@recipients,$addr);
                   13781:             }
1.618     raeburn  13782:         }
                   13783:     }
1.619     raeburn  13784:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  13785:     return $recipientlist;
                   13786: }
                   13787: 
1.127     matthew  13788: ############################################################
                   13789: ############################################################
1.154     albertel 13790: 
1.655     raeburn  13791: =pod
                   13792: 
                   13793: =head1 Course Catalog Routines
                   13794: 
                   13795: =over 4
                   13796: 
                   13797: =item * &gather_categories()
                   13798: 
                   13799: Converts category definitions - keys of categories hash stored in  
                   13800: coursecategories in configuration.db on the primary library server in a 
                   13801: domain - to an array.  Also generates javascript and idx hash used to 
                   13802: generate Domain Coordinator interface for editing Course Categories.
                   13803: 
                   13804: Inputs:
1.663     raeburn  13805: 
1.655     raeburn  13806: categories (reference to hash of category definitions).
1.663     raeburn  13807: 
1.655     raeburn  13808: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   13809:       categories and subcategories).
1.663     raeburn  13810: 
1.655     raeburn  13811: idx (reference to hash of counters used in Domain Coordinator interface for 
                   13812:       editing Course Categories).
1.663     raeburn  13813: 
1.655     raeburn  13814: jsarray (reference to array of categories used to create Javascript arrays for
                   13815:          Domain Coordinator interface for editing Course Categories).
                   13816: 
                   13817: Returns: nothing
                   13818: 
                   13819: Side effects: populates cats, idx and jsarray. 
                   13820: 
                   13821: =cut
                   13822: 
                   13823: sub gather_categories {
                   13824:     my ($categories,$cats,$idx,$jsarray) = @_;
                   13825:     my %counters;
                   13826:     my $num = 0;
                   13827:     foreach my $item (keys(%{$categories})) {
                   13828:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   13829:         if ($container eq '' && $depth == 0) {
                   13830:             $cats->[$depth][$categories->{$item}] = $cat;
                   13831:         } else {
                   13832:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   13833:         }
                   13834:         my ($escitem,$tail) = split(/:/,$item,2);
                   13835:         if ($counters{$tail} eq '') {
                   13836:             $counters{$tail} = $num;
                   13837:             $num ++;
                   13838:         }
                   13839:         if (ref($idx) eq 'HASH') {
                   13840:             $idx->{$item} = $counters{$tail};
                   13841:         }
                   13842:         if (ref($jsarray) eq 'ARRAY') {
                   13843:             push(@{$jsarray->[$counters{$tail}]},$item);
                   13844:         }
                   13845:     }
                   13846:     return;
                   13847: }
                   13848: 
                   13849: =pod
                   13850: 
                   13851: =item * &extract_categories()
                   13852: 
                   13853: Used to generate breadcrumb trails for course categories.
                   13854: 
                   13855: Inputs:
1.663     raeburn  13856: 
1.655     raeburn  13857: categories (reference to hash of category definitions).
1.663     raeburn  13858: 
1.655     raeburn  13859: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   13860:       categories and subcategories).
1.663     raeburn  13861: 
1.655     raeburn  13862: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  13863: 
1.655     raeburn  13864: allitems (reference to hash - key is category key 
                   13865:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  13866: 
1.655     raeburn  13867: idx (reference to hash of counters used in Domain Coordinator interface for
                   13868:       editing Course Categories).
1.663     raeburn  13869: 
1.655     raeburn  13870: jsarray (reference to array of categories used to create Javascript arrays for
                   13871:          Domain Coordinator interface for editing Course Categories).
                   13872: 
1.665     raeburn  13873: subcats (reference to hash of arrays containing all subcategories within each 
                   13874:          category, -recursive)
                   13875: 
1.655     raeburn  13876: Returns: nothing
                   13877: 
                   13878: Side effects: populates trails and allitems hash references.
                   13879: 
                   13880: =cut
                   13881: 
                   13882: sub extract_categories {
1.665     raeburn  13883:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  13884:     if (ref($categories) eq 'HASH') {
                   13885:         &gather_categories($categories,$cats,$idx,$jsarray);
                   13886:         if (ref($cats->[0]) eq 'ARRAY') {
                   13887:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   13888:                 my $name = $cats->[0][$i];
                   13889:                 my $item = &escape($name).'::0';
                   13890:                 my $trailstr;
                   13891:                 if ($name eq 'instcode') {
                   13892:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  13893:                 } elsif ($name eq 'communities') {
                   13894:                     $trailstr = &mt('Communities');
1.655     raeburn  13895:                 } else {
                   13896:                     $trailstr = $name;
                   13897:                 }
                   13898:                 if ($allitems->{$item} eq '') {
                   13899:                     push(@{$trails},$trailstr);
                   13900:                     $allitems->{$item} = scalar(@{$trails})-1;
                   13901:                 }
                   13902:                 my @parents = ($name);
                   13903:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   13904:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   13905:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  13906:                         if (ref($subcats) eq 'HASH') {
                   13907:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   13908:                         }
                   13909:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   13910:                     }
                   13911:                 } else {
                   13912:                     if (ref($subcats) eq 'HASH') {
                   13913:                         $subcats->{$item} = [];
1.655     raeburn  13914:                     }
                   13915:                 }
                   13916:             }
                   13917:         }
                   13918:     }
                   13919:     return;
                   13920: }
                   13921: 
                   13922: =pod
                   13923: 
1.1162    raeburn  13924: =item * &recurse_categories()
1.655     raeburn  13925: 
                   13926: Recursively used to generate breadcrumb trails for course categories.
                   13927: 
                   13928: Inputs:
1.663     raeburn  13929: 
1.655     raeburn  13930: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   13931:       categories and subcategories).
1.663     raeburn  13932: 
1.655     raeburn  13933: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  13934: 
                   13935: category (current course category, for which breadcrumb trail is being generated).
                   13936: 
                   13937: trails (reference to array of breadcrumb trails for each category).
                   13938: 
1.655     raeburn  13939: allitems (reference to hash - key is category key
                   13940:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  13941: 
1.655     raeburn  13942: parents (array containing containers directories for current category, 
                   13943:          back to top level). 
                   13944: 
                   13945: Returns: nothing
                   13946: 
                   13947: Side effects: populates trails and allitems hash references
                   13948: 
                   13949: =cut
                   13950: 
                   13951: sub recurse_categories {
1.665     raeburn  13952:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  13953:     my $shallower = $depth - 1;
                   13954:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   13955:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   13956:             my $name = $cats->[$depth]{$category}[$k];
                   13957:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   13958:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   13959:             if ($allitems->{$item} eq '') {
                   13960:                 push(@{$trails},$trailstr);
                   13961:                 $allitems->{$item} = scalar(@{$trails})-1;
                   13962:             }
                   13963:             my $deeper = $depth+1;
                   13964:             push(@{$parents},$category);
1.665     raeburn  13965:             if (ref($subcats) eq 'HASH') {
                   13966:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   13967:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   13968:                     my $higher;
                   13969:                     if ($j > 0) {
                   13970:                         $higher = &escape($parents->[$j]).':'.
                   13971:                                   &escape($parents->[$j-1]).':'.$j;
                   13972:                     } else {
                   13973:                         $higher = &escape($parents->[$j]).'::'.$j;
                   13974:                     }
                   13975:                     push(@{$subcats->{$higher}},$subcat);
                   13976:                 }
                   13977:             }
                   13978:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   13979:                                 $subcats);
1.655     raeburn  13980:             pop(@{$parents});
                   13981:         }
                   13982:     } else {
                   13983:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   13984:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   13985:         if ($allitems->{$item} eq '') {
                   13986:             push(@{$trails},$trailstr);
                   13987:             $allitems->{$item} = scalar(@{$trails})-1;
                   13988:         }
                   13989:     }
                   13990:     return;
                   13991: }
                   13992: 
1.663     raeburn  13993: =pod
                   13994: 
1.1162    raeburn  13995: =item * &assign_categories_table()
1.663     raeburn  13996: 
                   13997: Create a datatable for display of hierarchical categories in a domain,
                   13998: with checkboxes to allow a course to be categorized. 
                   13999: 
                   14000: Inputs:
                   14001: 
                   14002: cathash - reference to hash of categories defined for the domain (from
                   14003:           configuration.db)
                   14004: 
                   14005: currcat - scalar with an & separated list of categories assigned to a course. 
                   14006: 
1.919     raeburn  14007: type    - scalar contains course type (Course or Community).
                   14008: 
1.663     raeburn  14009: Returns: $output (markup to be displayed) 
                   14010: 
                   14011: =cut
                   14012: 
                   14013: sub assign_categories_table {
1.919     raeburn  14014:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  14015:     my $output;
                   14016:     if (ref($cathash) eq 'HASH') {
                   14017:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   14018:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   14019:         $maxdepth = scalar(@cats);
                   14020:         if (@cats > 0) {
                   14021:             my $itemcount = 0;
                   14022:             if (ref($cats[0]) eq 'ARRAY') {
                   14023:                 my @currcategories;
                   14024:                 if ($currcat ne '') {
                   14025:                     @currcategories = split('&',$currcat);
                   14026:                 }
1.919     raeburn  14027:                 my $table;
1.663     raeburn  14028:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14029:                     my $parent = $cats[0][$i];
1.919     raeburn  14030:                     next if ($parent eq 'instcode');
                   14031:                     if ($type eq 'Community') {
                   14032:                         next unless ($parent eq 'communities');
                   14033:                     } else {
                   14034:                         next if ($parent eq 'communities');
                   14035:                     }
1.663     raeburn  14036:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14037:                     my $item = &escape($parent).'::0';
                   14038:                     my $checked = '';
                   14039:                     if (@currcategories > 0) {
                   14040:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14041:                             $checked = ' checked="checked"';
1.663     raeburn  14042:                         }
                   14043:                     }
1.919     raeburn  14044:                     my $parent_title = $parent;
                   14045:                     if ($parent eq 'communities') {
                   14046:                         $parent_title = &mt('Communities');
                   14047:                     }
                   14048:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14049:                               '<input type="checkbox" name="usecategory" value="'.
                   14050:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   14051:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14052:                     my $depth = 1;
                   14053:                     push(@path,$parent);
1.919     raeburn  14054:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  14055:                     pop(@path);
1.919     raeburn  14056:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14057:                     $itemcount ++;
                   14058:                 }
1.919     raeburn  14059:                 if ($itemcount) {
                   14060:                     $output = &Apache::loncommon::start_data_table().
                   14061:                               $table.
                   14062:                               &Apache::loncommon::end_data_table();
                   14063:                 }
1.663     raeburn  14064:             }
                   14065:         }
                   14066:     }
                   14067:     return $output;
                   14068: }
                   14069: 
                   14070: =pod
                   14071: 
1.1162    raeburn  14072: =item * &assign_category_rows()
1.663     raeburn  14073: 
                   14074: Create a datatable row for display of nested categories in a domain,
                   14075: with checkboxes to allow a course to be categorized,called recursively.
                   14076: 
                   14077: Inputs:
                   14078: 
                   14079: itemcount - track row number for alternating colors
                   14080: 
                   14081: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14082:       categories and subcategories.
                   14083: 
                   14084: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14085: 
                   14086: parent - parent of current category item
                   14087: 
                   14088: path - Array containing all categories back up through the hierarchy from the
                   14089:        current category to the top level.
                   14090: 
                   14091: currcategories - reference to array of current categories assigned to the course
                   14092: 
                   14093: Returns: $output (markup to be displayed).
                   14094: 
                   14095: =cut
                   14096: 
                   14097: sub assign_category_rows {
                   14098:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   14099:     my ($text,$name,$item,$chgstr);
                   14100:     if (ref($cats) eq 'ARRAY') {
                   14101:         my $maxdepth = scalar(@{$cats});
                   14102:         if (ref($cats->[$depth]) eq 'HASH') {
                   14103:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14104:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14105:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145    raeburn  14106:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14107:                 for (my $j=0; $j<$numchildren; $j++) {
                   14108:                     $name = $cats->[$depth]{$parent}[$j];
                   14109:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14110:                     my $deeper = $depth+1;
                   14111:                     my $checked = '';
                   14112:                     if (ref($currcategories) eq 'ARRAY') {
                   14113:                         if (@{$currcategories} > 0) {
                   14114:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14115:                                 $checked = ' checked="checked"';
1.663     raeburn  14116:                             }
                   14117:                         }
                   14118:                     }
1.664     raeburn  14119:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14120:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  14121:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   14122:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14123:                              '</td><td>';
1.663     raeburn  14124:                     if (ref($path) eq 'ARRAY') {
                   14125:                         push(@{$path},$name);
                   14126:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   14127:                         pop(@{$path});
                   14128:                     }
                   14129:                     $text .= '</td></tr>';
                   14130:                 }
                   14131:                 $text .= '</table></td>';
                   14132:             }
                   14133:         }
                   14134:     }
                   14135:     return $text;
                   14136: }
                   14137: 
1.1181    raeburn  14138: =pod
                   14139: 
                   14140: =back
                   14141: 
                   14142: =cut
                   14143: 
1.655     raeburn  14144: ############################################################
                   14145: ############################################################
                   14146: 
                   14147: 
1.443     albertel 14148: sub commit_customrole {
1.664     raeburn  14149:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14150:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14151:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14152:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14153:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14154:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14155:                  '</b><br />';
                   14156:     return $output;
                   14157: }
                   14158: 
                   14159: sub commit_standardrole {
1.1116    raeburn  14160:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14161:     my ($output,$logmsg,$linefeed);
                   14162:     if ($context eq 'auto') {
                   14163:         $linefeed = "\n";
                   14164:     } else {
                   14165:         $linefeed = "<br />\n";
                   14166:     }  
1.443     albertel 14167:     if ($three eq 'st') {
1.541     raeburn  14168:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116    raeburn  14169:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14170:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14171:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14172:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14173:         } else {
1.541     raeburn  14174:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14175:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14176:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14177:             if ($context eq 'auto') {
                   14178:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14179:             } else {
                   14180:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14181:                &mt('Add to classlist').': <b>ok</b>';
                   14182:             }
                   14183:             $output .= $linefeed;
1.443     albertel 14184:         }
                   14185:     } else {
                   14186:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14187:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14188:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14189:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14190:         if ($context eq 'auto') {
                   14191:             $output .= $result.$linefeed;
                   14192:         } else {
                   14193:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   14194:         }
1.443     albertel 14195:     }
                   14196:     return $output;
                   14197: }
                   14198: 
                   14199: sub commit_studentrole {
1.1116    raeburn  14200:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   14201:         $credits) = @_;
1.626     raeburn  14202:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  14203:     if ($context eq 'auto') {
                   14204:         $linefeed = "\n";
                   14205:     } else {
                   14206:         $linefeed = '<br />'."\n";
                   14207:     }
1.443     albertel 14208:     if (defined($one) && defined($two)) {
                   14209:         my $cid=$one.'_'.$two;
                   14210:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   14211:         my $secchange = 0;
                   14212:         my $expire_role_result;
                   14213:         my $modify_section_result;
1.628     raeburn  14214:         if ($oldsec ne '-1') { 
                   14215:             if ($oldsec ne $sec) {
1.443     albertel 14216:                 $secchange = 1;
1.628     raeburn  14217:                 my $now = time;
1.443     albertel 14218:                 my $uurl='/'.$cid;
                   14219:                 $uurl=~s/\_/\//g;
                   14220:                 if ($oldsec) {
                   14221:                     $uurl.='/'.$oldsec;
                   14222:                 }
1.626     raeburn  14223:                 $oldsecurl = $uurl;
1.628     raeburn  14224:                 $expire_role_result = 
1.652     raeburn  14225:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  14226:                 if ($env{'request.course.sec'} ne '') { 
                   14227:                     if ($expire_role_result eq 'refused') {
                   14228:                         my @roles = ('st');
                   14229:                         my @statuses = ('previous');
                   14230:                         my @roledoms = ($one);
                   14231:                         my $withsec = 1;
                   14232:                         my %roleshash = 
                   14233:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   14234:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   14235:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   14236:                             my ($oldstart,$oldend) = 
                   14237:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   14238:                             if ($oldend > 0 && $oldend <= $now) {
                   14239:                                 $expire_role_result = 'ok';
                   14240:                             }
                   14241:                         }
                   14242:                     }
                   14243:                 }
1.443     albertel 14244:                 $result = $expire_role_result;
                   14245:             }
                   14246:         }
                   14247:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  14248:             $modify_section_result = 
                   14249:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   14250:                                                            undef,undef,undef,$sec,
                   14251:                                                            $end,$start,'','',$cid,
                   14252:                                                            '',$context,$credits);
1.443     albertel 14253:             if ($modify_section_result =~ /^ok/) {
                   14254:                 if ($secchange == 1) {
1.628     raeburn  14255:                     if ($sec eq '') {
                   14256:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   14257:                     } else {
                   14258:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   14259:                     }
1.443     albertel 14260:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  14261:                     if ($sec eq '') {
                   14262:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   14263:                     } else {
                   14264:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14265:                     }
1.443     albertel 14266:                 } else {
1.628     raeburn  14267:                     if ($sec eq '') {
                   14268:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   14269:                     } else {
                   14270:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14271:                     }
1.443     albertel 14272:                 }
                   14273:             } else {
1.1115    raeburn  14274:                 if ($secchange) { 
1.628     raeburn  14275:                     $$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;
                   14276:                 } else {
                   14277:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   14278:                 }
1.443     albertel 14279:             }
                   14280:             $result = $modify_section_result;
                   14281:         } elsif ($secchange == 1) {
1.628     raeburn  14282:             if ($oldsec eq '') {
1.1103    raeburn  14283:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
1.628     raeburn  14284:             } else {
                   14285:                 $$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;
                   14286:             }
1.626     raeburn  14287:             if ($expire_role_result eq 'refused') {
                   14288:                 my $newsecurl = '/'.$cid;
                   14289:                 $newsecurl =~ s/\_/\//g;
                   14290:                 if ($sec ne '') {
                   14291:                     $newsecurl.='/'.$sec;
                   14292:                 }
                   14293:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   14294:                     if ($sec eq '') {
                   14295:                         $$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;
                   14296:                     } else {
                   14297:                         $$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;
                   14298:                     }
                   14299:                 }
                   14300:             }
1.443     albertel 14301:         }
                   14302:     } else {
1.626     raeburn  14303:         $$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 14304:         $result = "error: incomplete course id\n";
                   14305:     }
                   14306:     return $result;
                   14307: }
                   14308: 
1.1108    raeburn  14309: sub show_role_extent {
                   14310:     my ($scope,$context,$role) = @_;
                   14311:     $scope =~ s{^/}{};
                   14312:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   14313:     push(@courseroles,'co');
                   14314:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   14315:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   14316:         $scope =~ s{/}{_};
                   14317:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   14318:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   14319:         my ($audom,$auname) = split(/\//,$scope);
                   14320:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   14321:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   14322:     } else {
                   14323:         $scope =~ s{/$}{};
                   14324:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   14325:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   14326:     }
                   14327: }
                   14328: 
1.443     albertel 14329: ############################################################
                   14330: ############################################################
                   14331: 
1.566     albertel 14332: sub check_clone {
1.578     raeburn  14333:     my ($args,$linefeed) = @_;
1.566     albertel 14334:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   14335:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   14336:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   14337:     my $clonemsg;
                   14338:     my $can_clone = 0;
1.944     raeburn  14339:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  14340:     if ($lctype ne 'community') {
                   14341:         $lctype = 'course';
                   14342:     }
1.566     albertel 14343:     if ($clonehome eq 'no_host') {
1.944     raeburn  14344:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14345:             $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'});
                   14346:         } else {
                   14347:             $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'});
                   14348:         }     
1.566     albertel 14349:     } else {
                   14350: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  14351:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14352:             if ($clonedesc{'type'} ne 'Community') {
                   14353:                  $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'});
                   14354:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14355:             }
                   14356:         }
1.882     raeburn  14357: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   14358:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 14359: 	    $can_clone = 1;
                   14360: 	} else {
                   14361: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   14362: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   14363: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  14364:             if (grep(/^\*$/,@cloners)) {
                   14365:                 $can_clone = 1;
                   14366:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   14367:                 $can_clone = 1;
                   14368:             } else {
1.908     raeburn  14369:                 my $ccrole = 'cc';
1.944     raeburn  14370:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14371:                     $ccrole = 'co';
                   14372:                 }
1.578     raeburn  14373: 	        my %roleshash =
                   14374: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   14375: 					 $args->{'ccdomain'},
1.908     raeburn  14376:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  14377: 					 [$args->{'clonedomain'}]);
1.908     raeburn  14378: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  14379:                     $can_clone = 1;
                   14380:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   14381:                     $can_clone = 1;
                   14382:                 } else {
1.944     raeburn  14383:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14384:                         $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'});
                   14385:                     } else {
                   14386:                         $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'});
                   14387:                     }
1.578     raeburn  14388: 	        }
1.566     albertel 14389: 	    }
1.578     raeburn  14390:         }
1.566     albertel 14391:     }
                   14392:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14393: }
                   14394: 
1.444     albertel 14395: sub construct_course {
1.1166    raeburn  14396:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category,$coderef) = @_;
1.444     albertel 14397:     my $outcome;
1.541     raeburn  14398:     my $linefeed =  '<br />'."\n";
                   14399:     if ($context eq 'auto') {
                   14400:         $linefeed = "\n";
                   14401:     }
1.566     albertel 14402: 
                   14403: #
                   14404: # Are we cloning?
                   14405: #
                   14406:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14407:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  14408: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 14409: 	if ($context ne 'auto') {
1.578     raeburn  14410:             if ($clonemsg ne '') {
                   14411: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   14412:             }
1.566     albertel 14413: 	}
                   14414: 	$outcome .= $clonemsg.$linefeed;
                   14415: 
                   14416:         if (!$can_clone) {
                   14417: 	    return (0,$outcome);
                   14418: 	}
                   14419:     }
                   14420: 
1.444     albertel 14421: #
                   14422: # Open course
                   14423: #
                   14424:     my $crstype = lc($args->{'crstype'});
                   14425:     my %cenv=();
                   14426:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   14427:                                              $args->{'cdescr'},
                   14428:                                              $args->{'curl'},
                   14429:                                              $args->{'course_home'},
                   14430:                                              $args->{'nonstandard'},
                   14431:                                              $args->{'crscode'},
                   14432:                                              $args->{'ccuname'}.':'.
                   14433:                                              $args->{'ccdomain'},
1.882     raeburn  14434:                                              $args->{'crstype'},
1.885     raeburn  14435:                                              $cnum,$context,$category);
1.444     albertel 14436: 
                   14437:     # Note: The testing routines depend on this being output; see 
                   14438:     # Utils::Course. This needs to at least be output as a comment
                   14439:     # if anyone ever decides to not show this, and Utils::Course::new
                   14440:     # will need to be suitably modified.
1.541     raeburn  14441:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  14442:     if ($$courseid =~ /^error:/) {
                   14443:         return (0,$outcome);
                   14444:     }
                   14445: 
1.444     albertel 14446: #
                   14447: # Check if created correctly
                   14448: #
1.479     albertel 14449:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 14450:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  14451:     if ($crsuhome eq 'no_host') {
                   14452:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   14453:         return (0,$outcome);
                   14454:     }
1.541     raeburn  14455:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 14456: 
1.444     albertel 14457: #
1.566     albertel 14458: # Do the cloning
                   14459: #   
                   14460:     if ($can_clone && $cloneid) {
                   14461: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   14462: 	if ($context ne 'auto') {
                   14463: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   14464: 	}
                   14465: 	$outcome .= $clonemsg.$linefeed;
                   14466: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 14467: # Copy all files
1.637     www      14468: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 14469: # Restore URL
1.566     albertel 14470: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 14471: # Restore title
1.566     albertel 14472: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  14473: # Restore creation date, creator and creation context.
                   14474:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   14475:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   14476:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 14477: # Mark as cloned
1.566     albertel 14478: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      14479: # Need to clone grading mode
                   14480:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   14481:         $cenv{'grading'}=$newenv{'grading'};
                   14482: # Do not clone these environment entries
                   14483:         &Apache::lonnet::del('environment',
                   14484:                   ['default_enrollment_start_date',
                   14485:                    'default_enrollment_end_date',
                   14486:                    'question.email',
                   14487:                    'policy.email',
                   14488:                    'comment.email',
                   14489:                    'pch.users.denied',
1.725     raeburn  14490:                    'plc.users.denied',
                   14491:                    'hidefromcat',
1.1121    raeburn  14492:                    'checkforpriv',
1.1166    raeburn  14493:                    'categories',
                   14494:                    'internal.uniquecode'],
1.638     www      14495:                    $$crsudom,$$crsunum);
1.1170    raeburn  14496:         if ($args->{'textbook'}) {
                   14497:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   14498:         }
1.444     albertel 14499:     }
1.566     albertel 14500: 
1.444     albertel 14501: #
                   14502: # Set environment (will override cloned, if existing)
                   14503: #
                   14504:     my @sections = ();
                   14505:     my @xlists = ();
                   14506:     if ($args->{'crstype'}) {
                   14507:         $cenv{'type'}=$args->{'crstype'};
                   14508:     }
                   14509:     if ($args->{'crsid'}) {
                   14510:         $cenv{'courseid'}=$args->{'crsid'};
                   14511:     }
                   14512:     if ($args->{'crscode'}) {
                   14513:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   14514:     }
                   14515:     if ($args->{'crsquota'} ne '') {
                   14516:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   14517:     } else {
                   14518:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   14519:     }
                   14520:     if ($args->{'ccuname'}) {
                   14521:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   14522:                                         ':'.$args->{'ccdomain'};
                   14523:     } else {
                   14524:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   14525:     }
1.1116    raeburn  14526:     if ($args->{'defaultcredits'}) {
                   14527:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   14528:     }
1.444     albertel 14529:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   14530:     if ($args->{'crssections'}) {
                   14531:         $cenv{'internal.sectionnums'} = '';
                   14532:         if ($args->{'crssections'} =~ m/,/) {
                   14533:             @sections = split/,/,$args->{'crssections'};
                   14534:         } else {
                   14535:             $sections[0] = $args->{'crssections'};
                   14536:         }
                   14537:         if (@sections > 0) {
                   14538:             foreach my $item (@sections) {
                   14539:                 my ($sec,$gp) = split/:/,$item;
                   14540:                 my $class = $args->{'crscode'}.$sec;
                   14541:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   14542:                 $cenv{'internal.sectionnums'} .= $item.',';
                   14543:                 unless ($addcheck eq 'ok') {
                   14544:                     push @badclasses, $class;
                   14545:                 }
                   14546:             }
                   14547:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   14548:         }
                   14549:     }
                   14550: # do not hide course coordinator from staff listing, 
                   14551: # even if privileged
                   14552:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  14553: # add course coordinator's domain to domains to check for privileged users
                   14554: # if different to course domain
                   14555:     if ($$crsudom ne $args->{'ccdomain'}) {
                   14556:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   14557:     }
1.444     albertel 14558: # add crosslistings
                   14559:     if ($args->{'crsxlist'}) {
                   14560:         $cenv{'internal.crosslistings'}='';
                   14561:         if ($args->{'crsxlist'} =~ m/,/) {
                   14562:             @xlists = split/,/,$args->{'crsxlist'};
                   14563:         } else {
                   14564:             $xlists[0] = $args->{'crsxlist'};
                   14565:         }
                   14566:         if (@xlists > 0) {
                   14567:             foreach my $item (@xlists) {
                   14568:                 my ($xl,$gp) = split/:/,$item;
                   14569:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   14570:                 $cenv{'internal.crosslistings'} .= $item.',';
                   14571:                 unless ($addcheck eq 'ok') {
                   14572:                     push @badclasses, $xl;
                   14573:                 }
                   14574:             }
                   14575:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   14576:         }
                   14577:     }
                   14578:     if ($args->{'autoadds'}) {
                   14579:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   14580:     }
                   14581:     if ($args->{'autodrops'}) {
                   14582:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   14583:     }
                   14584: # check for notification of enrollment changes
                   14585:     my @notified = ();
                   14586:     if ($args->{'notify_owner'}) {
                   14587:         if ($args->{'ccuname'} ne '') {
                   14588:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   14589:         }
                   14590:     }
                   14591:     if ($args->{'notify_dc'}) {
                   14592:         if ($uname ne '') { 
1.630     raeburn  14593:             push(@notified,$uname.':'.$udom);
1.444     albertel 14594:         }
                   14595:     }
                   14596:     if (@notified > 0) {
                   14597:         my $notifylist;
                   14598:         if (@notified > 1) {
                   14599:             $notifylist = join(',',@notified);
                   14600:         } else {
                   14601:             $notifylist = $notified[0];
                   14602:         }
                   14603:         $cenv{'internal.notifylist'} = $notifylist;
                   14604:     }
                   14605:     if (@badclasses > 0) {
                   14606:         my %lt=&Apache::lonlocal::texthash(
                   14607:                 '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',
                   14608:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   14609:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   14610:         );
1.541     raeburn  14611:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   14612:                            ' ('.$lt{'adby'}.')';
                   14613:         if ($context eq 'auto') {
                   14614:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 14615:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  14616:             foreach my $item (@badclasses) {
                   14617:                 if ($context eq 'auto') {
                   14618:                     $outcome .= " - $item\n";
                   14619:                 } else {
                   14620:                     $outcome .= "<li>$item</li>\n";
                   14621:                 }
                   14622:             }
                   14623:             if ($context eq 'auto') {
                   14624:                 $outcome .= $linefeed;
                   14625:             } else {
1.566     albertel 14626:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  14627:             }
                   14628:         } 
1.444     albertel 14629:     }
                   14630:     if ($args->{'no_end_date'}) {
                   14631:         $args->{'endaccess'} = 0;
                   14632:     }
                   14633:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   14634:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   14635:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   14636:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   14637:     if ($args->{'showphotos'}) {
                   14638:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   14639:     }
                   14640:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   14641:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   14642:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   14643:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  14644:             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'); 
                   14645:             if ($context eq 'auto') {
                   14646:                 $outcome .= $krb_msg;
                   14647:             } else {
1.566     albertel 14648:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  14649:             }
                   14650:             $outcome .= $linefeed;
1.444     albertel 14651:         }
                   14652:     }
                   14653:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   14654:        if ($args->{'setpolicy'}) {
                   14655:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   14656:        }
                   14657:        if ($args->{'setcontent'}) {
                   14658:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   14659:        }
                   14660:     }
                   14661:     if ($args->{'reshome'}) {
                   14662: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   14663: 	$cenv{'reshome'}=~s/\/+$/\//;
                   14664:     }
                   14665: #
                   14666: # course has keyed access
                   14667: #
                   14668:     if ($args->{'setkeys'}) {
                   14669:        $cenv{'keyaccess'}='yes';
                   14670:     }
                   14671: # if specified, key authority is not course, but user
                   14672: # only active if keyaccess is yes
                   14673:     if ($args->{'keyauth'}) {
1.487     albertel 14674: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   14675: 	$user = &LONCAPA::clean_username($user);
                   14676: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     14677: 	if ($user ne '' && $domain ne '') {
1.487     albertel 14678: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 14679: 	}
                   14680:     }
                   14681: 
1.1166    raeburn  14682: #
1.1167    raeburn  14683: #  generate and store uniquecode (available to course requester), if course should have one.
1.1166    raeburn  14684: #
                   14685:     if ($args->{'uniquecode'}) {
                   14686:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   14687:         if ($code) {
                   14688:             $cenv{'internal.uniquecode'} = $code;
1.1167    raeburn  14689:             my %crsinfo =
                   14690:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   14691:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   14692:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   14693:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   14694:             } 
1.1166    raeburn  14695:             if (ref($coderef)) {
                   14696:                 $$coderef = $code;
                   14697:             }
                   14698:         }
                   14699:     }
                   14700: 
1.444     albertel 14701:     if ($args->{'disresdis'}) {
                   14702:         $cenv{'pch.roles.denied'}='st';
                   14703:     }
                   14704:     if ($args->{'disablechat'}) {
                   14705:         $cenv{'plc.roles.denied'}='st';
                   14706:     }
                   14707: 
                   14708:     # Record we've not yet viewed the Course Initialization Helper for this 
                   14709:     # course
                   14710:     $cenv{'course.helper.not.run'} = 1;
                   14711:     #
                   14712:     # Use new Randomseed
                   14713:     #
                   14714:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   14715:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   14716:     #
                   14717:     # The encryption code and receipt prefix for this course
                   14718:     #
                   14719:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   14720:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   14721:     #
                   14722:     # By default, use standard grading
                   14723:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   14724: 
1.541     raeburn  14725:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   14726:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 14727: #
                   14728: # Open all assignments
                   14729: #
                   14730:     if ($args->{'openall'}) {
                   14731:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   14732:        my %storecontent = ($storeunder         => time,
                   14733:                            $storeunder.'.type' => 'date_start');
                   14734:        
                   14735:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  14736:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 14737:    }
                   14738: #
                   14739: # Set first page
                   14740: #
                   14741:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   14742: 	    || ($cloneid)) {
1.445     albertel 14743: 	use LONCAPA::map;
1.444     albertel 14744: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 14745: 
                   14746: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   14747:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   14748: 
1.444     albertel 14749:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   14750:         my $title; my $url;
                   14751:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   14752: 	    $title=&mt('Syllabus');
1.444     albertel 14753:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   14754:         } else {
1.963     raeburn  14755:             $title=&mt('Table of Contents');
1.444     albertel 14756:             $url='/adm/navmaps';
                   14757:         }
1.445     albertel 14758: 
                   14759:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   14760: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   14761: 
                   14762: 	if ($errtext) { $fatal=2; }
1.541     raeburn  14763:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 14764:     }
1.566     albertel 14765: 
                   14766:     return (1,$outcome);
1.444     albertel 14767: }
                   14768: 
1.1166    raeburn  14769: sub make_unique_code {
                   14770:     my ($cdom,$cnum) = @_;
                   14771:     # get lock on uniquecodes db
                   14772:     my $lockhash = {
                   14773:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   14774:                                                   ':'.$env{'user.domain'},
                   14775:                    };
                   14776:     my $tries = 0;
                   14777:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   14778:     my ($code,$error);
                   14779:   
                   14780:     while (($gotlock ne 'ok') && ($tries<3)) {
                   14781:         $tries ++;
                   14782:         sleep 1;
                   14783:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   14784:     }
                   14785:     if ($gotlock eq 'ok') {
                   14786:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   14787:         my $gotcode;
                   14788:         my $attempts = 0;
                   14789:         while ((!$gotcode) && ($attempts < 100)) {
                   14790:             $code = &generate_code();
                   14791:             if (!exists($currcodes{$code})) {
                   14792:                 $gotcode = 1;
                   14793:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   14794:                     $error = 'nostore';
                   14795:                 }
                   14796:             }
                   14797:             $attempts ++;
                   14798:         }
                   14799:         my @del_lock = ($cnum."\0".'uniquecodes');
                   14800:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   14801:     } else {
                   14802:         $error = 'nolock';
                   14803:     }
                   14804:     return ($code,$error);
                   14805: }
                   14806: 
                   14807: sub generate_code {
                   14808:     my $code;
                   14809:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   14810:     for (my $i=0; $i<6; $i++) {
                   14811:         my $lettnum = int (rand 2);
                   14812:         my $item = '';
                   14813:         if ($lettnum) {
                   14814:             $item = $letts[int( rand(18) )];
                   14815:         } else {
                   14816:             $item = 1+int( rand(8) );
                   14817:         }
                   14818:         $code .= $item;
                   14819:     }
                   14820:     return $code;
                   14821: }
                   14822: 
1.444     albertel 14823: ############################################################
                   14824: ############################################################
                   14825: 
1.953     droeschl 14826: #SD
                   14827: # only Community and Course, or anything else?
1.378     raeburn  14828: sub course_type {
                   14829:     my ($cid) = @_;
                   14830:     if (!defined($cid)) {
                   14831:         $cid = $env{'request.course.id'};
                   14832:     }
1.404     albertel 14833:     if (defined($env{'course.'.$cid.'.type'})) {
                   14834:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  14835:     } else {
                   14836:         return 'Course';
1.377     raeburn  14837:     }
                   14838: }
1.156     albertel 14839: 
1.406     raeburn  14840: sub group_term {
                   14841:     my $crstype = &course_type();
                   14842:     my %names = (
                   14843:                   'Course' => 'group',
1.865     raeburn  14844:                   'Community' => 'group',
1.406     raeburn  14845:                 );
                   14846:     return $names{$crstype};
                   14847: }
                   14848: 
1.902     raeburn  14849: sub course_types {
1.1165    raeburn  14850:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  14851:     my %typename = (
                   14852:                          official   => 'Official course',
                   14853:                          unofficial => 'Unofficial course',
                   14854:                          community  => 'Community',
1.1165    raeburn  14855:                          textbook   => 'Textbook course',
1.902     raeburn  14856:                    );
                   14857:     return (\@types,\%typename);
                   14858: }
                   14859: 
1.156     albertel 14860: sub icon {
                   14861:     my ($file)=@_;
1.505     albertel 14862:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 14863:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 14864:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 14865:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   14866: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   14867: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   14868: 	            $curfext.".gif") {
                   14869: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   14870: 		$curfext.".gif";
                   14871: 	}
                   14872:     }
1.249     albertel 14873:     return &lonhttpdurl($iconname);
1.154     albertel 14874: } 
1.84      albertel 14875: 
1.575     albertel 14876: sub lonhttpdurl {
1.692     www      14877: #
                   14878: # Had been used for "small fry" static images on separate port 8080.
                   14879: # Modify here if lightweight http functionality desired again.
                   14880: # Currently eliminated due to increasing firewall issues.
                   14881: #
1.575     albertel 14882:     my ($url)=@_;
1.692     www      14883:     return $url;
1.215     albertel 14884: }
                   14885: 
1.213     albertel 14886: sub connection_aborted {
                   14887:     my ($r)=@_;
                   14888:     $r->print(" ");$r->rflush();
                   14889:     my $c = $r->connection;
                   14890:     return $c->aborted();
                   14891: }
                   14892: 
1.221     foxr     14893: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     14894: #    strings as 'strings'.
                   14895: sub escape_single {
1.221     foxr     14896:     my ($input) = @_;
1.223     albertel 14897:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     14898:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   14899:     return $input;
                   14900: }
1.223     albertel 14901: 
1.222     foxr     14902: #  Same as escape_single, but escape's "'s  This 
                   14903: #  can be used for  "strings"
                   14904: sub escape_double {
                   14905:     my ($input) = @_;
                   14906:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   14907:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   14908:     return $input;
                   14909: }
1.223     albertel 14910:  
1.222     foxr     14911: #   Escapes the last element of a full URL.
                   14912: sub escape_url {
                   14913:     my ($url)   = @_;
1.238     raeburn  14914:     my @urlslices = split(/\//, $url,-1);
1.369     www      14915:     my $lastitem = &escape(pop(@urlslices));
1.1203    raeburn  14916:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     14917: }
1.462     albertel 14918: 
1.820     raeburn  14919: sub compare_arrays {
                   14920:     my ($arrayref1,$arrayref2) = @_;
                   14921:     my (@difference,%count);
                   14922:     @difference = ();
                   14923:     %count = ();
                   14924:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   14925:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   14926:         foreach my $element (keys(%count)) {
                   14927:             if ($count{$element} == 1) {
                   14928:                 push(@difference,$element);
                   14929:             }
                   14930:         }
                   14931:     }
                   14932:     return @difference;
                   14933: }
                   14934: 
1.817     bisitz   14935: # -------------------------------------------------------- Initialize user login
1.462     albertel 14936: sub init_user_environment {
1.463     albertel 14937:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 14938:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   14939: 
                   14940:     my $public=($username eq 'public' && $domain eq 'public');
                   14941: 
                   14942: # See if old ID present, if so, remove
                   14943: 
1.1062    raeburn  14944:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 14945:     my $now=time;
                   14946: 
                   14947:     if ($public) {
                   14948: 	my $max_public=100;
                   14949: 	my $oldest;
                   14950: 	my $oldest_time=0;
                   14951: 	for(my $next=1;$next<=$max_public;$next++) {
                   14952: 	    if (-e $lonids."/publicuser_$next.id") {
                   14953: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   14954: 		if ($mtime<$oldest_time || !$oldest_time) {
                   14955: 		    $oldest_time=$mtime;
                   14956: 		    $oldest=$next;
                   14957: 		}
                   14958: 	    } else {
                   14959: 		$cookie="publicuser_$next";
                   14960: 		last;
                   14961: 	    }
                   14962: 	}
                   14963: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   14964:     } else {
1.463     albertel 14965: 	# if this isn't a robot, kill any existing non-robot sessions
                   14966: 	if (!$args->{'robot'}) {
                   14967: 	    opendir(DIR,$lonids);
                   14968: 	    while ($filename=readdir(DIR)) {
                   14969: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   14970: 		    unlink($lonids.'/'.$filename);
                   14971: 		}
1.462     albertel 14972: 	    }
1.463     albertel 14973: 	    closedir(DIR);
1.1204    raeburn  14974: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   14975:             my $namespace = 'nohist_courseeditor';
                   14976:             my $lockingkey = 'paste'."\0".'locked_num';
                   14977:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   14978:                                                 $domain,$username);
                   14979:             if (exists($lockhash{$lockingkey})) {
                   14980:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   14981:                 unless ($delresult eq 'ok') {
                   14982:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   14983:                 }
                   14984:             }
1.462     albertel 14985: 	}
                   14986: # Give them a new cookie
1.463     albertel 14987: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      14988: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 14989: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 14990:     
                   14991: # Initialize roles
                   14992: 
1.1062    raeburn  14993: 	($userroles,$firstaccenv,$timerintenv) = 
                   14994:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 14995:     }
                   14996: # ------------------------------------ Check browser type and MathML capability
                   14997: 
1.1194    raeburn  14998:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   14999:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15000: 
                   15001: # ------------------------------------------------------------- Get environment
                   15002: 
                   15003:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15004:     my ($tmp) = keys(%userenv);
                   15005:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15006:     } else {
                   15007: 	undef(%userenv);
                   15008:     }
                   15009:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15010: 	$form->{'interface'}=$userenv{'interface'};
                   15011:     }
                   15012:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15013: 
                   15014: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15015:     foreach my $option ('interface','localpath','localres') {
                   15016:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15017:     }
                   15018: # --------------------------------------------------------- Write first profile
                   15019: 
                   15020:     {
                   15021: 	my %initial_env = 
                   15022: 	    ("user.name"          => $username,
                   15023: 	     "user.domain"        => $domain,
                   15024: 	     "user.home"          => $authhost,
                   15025: 	     "browser.type"       => $clientbrowser,
                   15026: 	     "browser.version"    => $clientversion,
                   15027: 	     "browser.mathml"     => $clientmathml,
                   15028: 	     "browser.unicode"    => $clientunicode,
                   15029: 	     "browser.os"         => $clientos,
1.1137    raeburn  15030:              "browser.mobile"     => $clientmobile,
1.1141    raeburn  15031:              "browser.info"       => $clientinfo,
1.1194    raeburn  15032:              "browser.osversion"  => $clientosversion,
1.462     albertel 15033: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15034: 	     "request.course.fn"  => '',
                   15035: 	     "request.course.uri" => '',
                   15036: 	     "request.course.sec" => '',
                   15037: 	     "request.role"       => 'cm',
                   15038: 	     "request.role.adv"   => $env{'user.adv'},
                   15039: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   15040: 
                   15041:         if ($form->{'localpath'}) {
                   15042: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15043: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15044:         }
                   15045: 	
                   15046: 	if ($form->{'interface'}) {
                   15047: 	    $form->{'interface'}=~s/\W//gs;
                   15048: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15049: 	    $env{'browser.interface'}=$form->{'interface'};
                   15050: 	}
                   15051: 
1.1157    raeburn  15052:         if ($form->{'iptoken'}) {
                   15053:             my $lonhost = $r->dir_config('lonHostID');
                   15054:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15055:             $env{'user.noloadbalance'} = $lonhost;
                   15056:         }
                   15057: 
1.981     raeburn  15058:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  15059:         my %domdef;
                   15060:         unless ($domain eq 'public') {
                   15061:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   15062:         }
1.980     raeburn  15063: 
1.1081    raeburn  15064:         foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724     raeburn  15065:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  15066:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15067:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  15068:         }
                   15069: 
1.1165    raeburn  15070:         foreach my $crstype ('official','unofficial','community','textbook') {
1.765     raeburn  15071:             $userenv{'canrequest.'.$crstype} =
                   15072:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  15073:                                                   'reload','requestcourses',
                   15074:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  15075:         }
                   15076: 
1.1092    raeburn  15077:         $userenv{'canrequest.author'} =
                   15078:             &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15079:                                         'reload','requestauthor',
                   15080:                                         \%userenv,\%domdef,\%is_adv);
                   15081:         my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15082:                                              $domain,$username);
                   15083:         my $reqstatus = $reqauthor{'author_status'};
                   15084:         if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   15085:             if (ref($reqauthor{'author'}) eq 'HASH') {
                   15086:                 $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   15087:                                                   $reqauthor{'author'}{'timestamp'};
                   15088:             }
                   15089:         }
                   15090: 
1.462     albertel 15091: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  15092: 
1.462     albertel 15093: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   15094: 		 &GDBM_WRCREAT(),0640)) {
                   15095: 	    &_add_to_env(\%disk_env,\%initial_env);
                   15096: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   15097: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  15098:             if (ref($firstaccenv) eq 'HASH') {
                   15099:                 &_add_to_env(\%disk_env,$firstaccenv);
                   15100:             }
                   15101:             if (ref($timerintenv) eq 'HASH') {
                   15102:                 &_add_to_env(\%disk_env,$timerintenv);
                   15103:             }
1.463     albertel 15104: 	    if (ref($args->{'extra_env'})) {
                   15105: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   15106: 	    }
1.462     albertel 15107: 	    untie(%disk_env);
                   15108: 	} else {
1.705     tempelho 15109: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   15110: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 15111: 	    return 'error: '.$!;
                   15112: 	}
                   15113:     }
                   15114:     $env{'request.role'}='cm';
                   15115:     $env{'request.role.adv'}=$env{'user.adv'};
                   15116:     $env{'browser.type'}=$clientbrowser;
                   15117: 
                   15118:     return $cookie;
                   15119: 
                   15120: }
                   15121: 
                   15122: sub _add_to_env {
                   15123:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  15124:     if (ref($env_data) eq 'HASH') {
                   15125:         while (my ($key,$value) = each(%$env_data)) {
                   15126: 	    $idf->{$prefix.$key} = $value;
                   15127: 	    $env{$prefix.$key}   = $value;
                   15128:         }
1.462     albertel 15129:     }
                   15130: }
                   15131: 
1.685     tempelho 15132: # --- Get the symbolic name of a problem and the url
                   15133: sub get_symb {
                   15134:     my ($request,$silent) = @_;
1.726     raeburn  15135:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 15136:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   15137:     if ($symb eq '') {
                   15138:         if (!$silent) {
1.1071    raeburn  15139:             if (ref($request)) { 
                   15140:                 $request->print("Unable to handle ambiguous references:$url:.");
                   15141:             }
1.685     tempelho 15142:             return ();
                   15143:         }
                   15144:     }
                   15145:     &Apache::lonenc::check_decrypt(\$symb);
                   15146:     return ($symb);
                   15147: }
                   15148: 
                   15149: # --------------------------------------------------------------Get annotation
                   15150: 
                   15151: sub get_annotation {
                   15152:     my ($symb,$enc) = @_;
                   15153: 
                   15154:     my $key = $symb;
                   15155:     if (!$enc) {
                   15156:         $key =
                   15157:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   15158:     }
                   15159:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   15160:     return $annotation{$key};
                   15161: }
                   15162: 
                   15163: sub clean_symb {
1.731     raeburn  15164:     my ($symb,$delete_enc) = @_;
1.685     tempelho 15165: 
                   15166:     &Apache::lonenc::check_decrypt(\$symb);
                   15167:     my $enc = $env{'request.enc'};
1.731     raeburn  15168:     if ($delete_enc) {
1.730     raeburn  15169:         delete($env{'request.enc'});
                   15170:     }
1.685     tempelho 15171: 
                   15172:     return ($symb,$enc);
                   15173: }
1.462     albertel 15174: 
1.1181    raeburn  15175: ############################################################
                   15176: ############################################################
                   15177: 
                   15178: =pod
                   15179: 
                   15180: =head1 Routines for building display used to search for courses
                   15181: 
                   15182: 
                   15183: =over 4
                   15184: 
                   15185: =item * &build_filters()
                   15186: 
                   15187: Create markup for a table used to set filters to use when selecting
1.1182    raeburn  15188: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   15189: and quotacheck.pl
                   15190: 
1.1181    raeburn  15191: 
                   15192: Inputs:
                   15193: 
                   15194: filterlist - anonymous array of fields to include as potential filters 
                   15195: 
                   15196: crstype - course type
                   15197: 
                   15198: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   15199:               to pop-open a course selector (will contain "extra element"). 
                   15200: 
                   15201: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   15202: 
                   15203: filter - anonymous hash of criteria and their values
                   15204: 
                   15205: action - form action
                   15206: 
                   15207: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   15208: 
1.1182    raeburn  15209: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181    raeburn  15210: 
                   15211: cloneruname - username of owner of new course who wants to clone
                   15212: 
                   15213: clonerudom - domain of owner of new course who wants to clone
                   15214: 
                   15215: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community) 
                   15216: 
                   15217: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   15218: 
                   15219: codedom - domain
                   15220: 
                   15221: formname - value of form element named "form". 
                   15222: 
                   15223: fixeddom - domain, if fixed.
                   15224: 
                   15225: prevphase - value to assign to form element named "phase" when going back to the previous screen  
                   15226: 
                   15227: cnameelement - name of form element in form on opener page which will receive title of selected course 
                   15228: 
                   15229: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   15230: 
                   15231: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   15232: 
                   15233: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   15234: 
                   15235: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   15236: 
                   15237: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   15238: 
1.1182    raeburn  15239: 
1.1181    raeburn  15240: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   15241: 
1.1182    raeburn  15242: 
1.1181    raeburn  15243: Side Effects: None
                   15244: 
                   15245: =cut
                   15246: 
                   15247: # ---------------------------------------------- search for courses based on last activity etc.
                   15248: 
                   15249: sub build_filters {
                   15250:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   15251:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   15252:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   15253:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   15254:         $clonetext,$clonewarning) = @_;
1.1182    raeburn  15255:     my ($list,$jscript);
1.1181    raeburn  15256:     my $onchange = 'javascript:updateFilters(this)';
                   15257:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   15258:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   15259:         $typeselectform,$instcodetitle);
                   15260:     if ($formname eq '') {
                   15261:         $formname = $caller;
                   15262:     }
                   15263:     foreach my $item (@{$filterlist}) {
                   15264:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   15265:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   15266:             if ($item eq 'domainfilter') {
                   15267:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   15268:             } elsif ($item eq 'coursefilter') {
                   15269:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   15270:             } elsif ($item eq 'ownerfilter') {
                   15271:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   15272:             } elsif ($item eq 'ownerdomfilter') {
                   15273:                 $filter->{'ownerdomfilter'} =
                   15274:                     &LONCAPA::clean_domain($filter->{$item});
                   15275:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   15276:                                                        'ownerdomfilter',1);
                   15277:             } elsif ($item eq 'personfilter') {
                   15278:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   15279:             } elsif ($item eq 'persondomfilter') {
                   15280:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   15281:                                                         'persondomfilter',1);
                   15282:             } else {
                   15283:                 $filter->{$item} =~ s/\W//g;
                   15284:             }
                   15285:             if (!$filter->{$item}) {
                   15286:                 $filter->{$item} = '';
                   15287:             }
                   15288:         }
                   15289:         if ($item eq 'domainfilter') {
                   15290:             my $allow_blank = 1;
                   15291:             if ($formname eq 'portform') {
                   15292:                 $allow_blank=0;
                   15293:             } elsif ($formname eq 'studentform') {
                   15294:                 $allow_blank=0;
                   15295:             }
                   15296:             if ($fixeddom) {
                   15297:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   15298:                                     ' value="'.$codedom.'" />'.
                   15299:                                     &Apache::lonnet::domain($codedom,'description');
                   15300:             } else {
                   15301:                 $domainselectform = &select_dom_form($filter->{$item},
                   15302:                                                      'domainfilter',
                   15303:                                                       $allow_blank,'',$onchange);
                   15304:             }
                   15305:         } else {
                   15306:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   15307:         }
                   15308:     }
                   15309: 
                   15310:     # last course activity filter and selection
                   15311:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   15312: 
                   15313:     # course created filter and selection
                   15314:     if (exists($filter->{'createdfilter'})) {
                   15315:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   15316:     }
                   15317: 
                   15318:     my %lt = &Apache::lonlocal::texthash(
                   15319:                 'cac' => "$crstype Activity",
                   15320:                 'ccr' => "$crstype Created",
                   15321:                 'cde' => "$crstype Title",
                   15322:                 'cdo' => "$crstype Domain",
                   15323:                 'ins' => 'Institutional Code',
                   15324:                 'inc' => 'Institutional Categorization',
                   15325:                 'cow' => "$crstype Owner/Co-owner",
                   15326:                 'cop' => "$crstype Personnel Includes",
                   15327:                 'cog' => 'Type',
                   15328:              );
                   15329: 
                   15330:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   15331:         my $typeval = 'Course';
                   15332:         if ($crstype eq 'Community') {
                   15333:             $typeval = 'Community';
                   15334:         }
                   15335:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   15336:     } else {
                   15337:         $typeselectform =  '<select name="type" size="1"';
                   15338:         if ($onchange) {
                   15339:             $typeselectform .= ' onchange="'.$onchange.'"';
                   15340:         }
                   15341:         $typeselectform .= '>'."\n";
                   15342:         foreach my $posstype ('Course','Community') {
                   15343:             $typeselectform.='<option value="'.$posstype.'"'.
                   15344:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   15345:         }
                   15346:         $typeselectform.="</select>";
                   15347:     }
                   15348: 
                   15349:     my ($cloneableonlyform,$cloneabletitle);
                   15350:     if (exists($filter->{'cloneableonly'})) {
                   15351:         my $cloneableon = '';
                   15352:         my $cloneableoff = ' checked="checked"';
                   15353:         if ($filter->{'cloneableonly'}) {
                   15354:             $cloneableon = $cloneableoff;
                   15355:             $cloneableoff = '';
                   15356:         }
                   15357:         $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/>&nbsp;'.&mt('Required').'</label>'.('&nbsp;'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' />&nbsp;'.&mt('No restriction').'</label></span>';
                   15358:         if ($formname eq 'ccrs') {
1.1187    bisitz   15359:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181    raeburn  15360:         } else {
                   15361:             $cloneabletitle = &mt('Cloneable by you');
                   15362:         }
                   15363:     }
                   15364:     my $officialjs;
                   15365:     if ($crstype eq 'Course') {
                   15366:         if (exists($filter->{'instcodefilter'})) {
1.1182    raeburn  15367: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   15368: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   15369:             if ($codedom) { 
1.1181    raeburn  15370:                 $officialjs = 1;
                   15371:                 ($instcodeform,$jscript,$$numtitlesref) =
                   15372:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   15373:                                                                   $officialjs,$codetitlesref);
                   15374:                 if ($jscript) {
1.1182    raeburn  15375:                     $jscript = '<script type="text/javascript">'."\n".
                   15376:                                '// <![CDATA['."\n".
                   15377:                                $jscript."\n".
                   15378:                                '// ]]>'."\n".
                   15379:                                '</script>'."\n";
1.1181    raeburn  15380:                 }
                   15381:             }
                   15382:             if ($instcodeform eq '') {
                   15383:                 $instcodeform =
                   15384:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   15385:                     $list->{'instcodefilter'}.'" />';
                   15386:                 $instcodetitle = $lt{'ins'};
                   15387:             } else {
                   15388:                 $instcodetitle = $lt{'inc'};
                   15389:             }
                   15390:             if ($fixeddom) {
                   15391:                 $instcodetitle .= '<br />('.$codedom.')';
                   15392:             }
                   15393:         }
                   15394:     }
                   15395:     my $output = qq|
                   15396: <form method="post" name="filterpicker" action="$action">
                   15397: <input type="hidden" name="form" value="$formname" />
                   15398: |;
                   15399:     if ($formname eq 'modifycourse') {
                   15400:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   15401:                    '<input type="hidden" name="prevphase" value="'.
                   15402:                    $prevphase.'" />'."\n";
1.1198    musolffc 15403:     } elsif ($formname eq 'quotacheck') {
                   15404:         $output .= qq|
                   15405: <input type="hidden" name="sortby" value="" />
                   15406: <input type="hidden" name="sortorder" value="" />
                   15407: |;
                   15408:     } else {
1.1181    raeburn  15409:         my $name_input;
                   15410:         if ($cnameelement ne '') {
                   15411:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   15412:                           $cnameelement.'" />';
                   15413:         }
                   15414:         $output .= qq|
1.1182    raeburn  15415: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   15416: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181    raeburn  15417: $name_input
                   15418: $roleelement
                   15419: $multelement
                   15420: $typeelement
                   15421: |;
                   15422:         if ($formname eq 'portform') {
                   15423:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   15424:         }
                   15425:     }
                   15426:     if ($fixeddom) {
                   15427:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   15428:     }
                   15429:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   15430:     if ($sincefilterform) {
                   15431:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   15432:                   .$sincefilterform
                   15433:                   .&Apache::lonhtmlcommon::row_closure();
                   15434:     }
                   15435:     if ($createdfilterform) {
                   15436:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   15437:                   .$createdfilterform
                   15438:                   .&Apache::lonhtmlcommon::row_closure();
                   15439:     }
                   15440:     if ($domainselectform) {
                   15441:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   15442:                   .$domainselectform
                   15443:                   .&Apache::lonhtmlcommon::row_closure();
                   15444:     }
                   15445:     if ($typeselectform) {
                   15446:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   15447:             $output .= $typeselectform;
                   15448:         } else {
                   15449:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   15450:                       .$typeselectform
                   15451:                       .&Apache::lonhtmlcommon::row_closure();
                   15452:         }
                   15453:     }
                   15454:     if ($instcodeform) {
                   15455:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   15456:                   .$instcodeform
                   15457:                   .&Apache::lonhtmlcommon::row_closure();
                   15458:     }
                   15459:     if (exists($filter->{'ownerfilter'})) {
                   15460:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   15461:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   15462:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   15463:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   15464:                    $ownerdomselectform.'</td></tr></table>'.
                   15465:                    &Apache::lonhtmlcommon::row_closure();
                   15466:     }
                   15467:     if (exists($filter->{'personfilter'})) {
                   15468:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   15469:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   15470:                    '<input type="text" name="personfilter" size="20" value="'.
                   15471:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   15472:                    $persondomselectform.'</td></tr></table>'.
                   15473:                    &Apache::lonhtmlcommon::row_closure();
                   15474:     }
                   15475:     if (exists($filter->{'coursefilter'})) {
                   15476:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   15477:                   .'<input type="text" name="coursefilter" size="25" value="'
                   15478:                   .$list->{'coursefilter'}.'" />'
                   15479:                   .&Apache::lonhtmlcommon::row_closure();
                   15480:     }
                   15481:     if ($cloneableonlyform) {
                   15482:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   15483:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   15484:     }
                   15485:     if (exists($filter->{'descriptfilter'})) {
                   15486:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   15487:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   15488:                   .$list->{'descriptfilter'}.'" />'
                   15489:                   .&Apache::lonhtmlcommon::row_closure(1);
                   15490:     }
                   15491:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   15492:                '<input type="hidden" name="updater" value="" />'."\n".
                   15493:                '<input type="submit" name="gosearch" value="'.
                   15494:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   15495:     return $jscript.$clonewarning.$output;
                   15496: }
                   15497: 
                   15498: =pod 
                   15499: 
                   15500: =item * &timebased_select_form()
                   15501: 
1.1182    raeburn  15502: Create markup for a dropdown list used to select a time-based
1.1181    raeburn  15503: filter e.g., Course Activity, Course Created, when searching for courses
                   15504: or communities
                   15505: 
                   15506: Inputs:
                   15507: 
                   15508: item - name of form element (sincefilter or createdfilter)
                   15509: 
                   15510: filter - anonymous hash of criteria and their values
                   15511: 
                   15512: Returns: HTML for a select box contained a blank, then six time selections,
                   15513:          with value set in incoming form variables currently selected. 
                   15514: 
                   15515: Side Effects: None
                   15516: 
                   15517: =cut
                   15518: 
                   15519: sub timebased_select_form {
                   15520:     my ($item,$filter) = @_;
                   15521:     if (ref($filter) eq 'HASH') {
                   15522:         $filter->{$item} =~ s/[^\d-]//g;
                   15523:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   15524:         return &select_form(
                   15525:                             $filter->{$item},
                   15526:                             $item,
                   15527:                             {      '-1' => '',
                   15528:                                 '86400' => &mt('today'),
                   15529:                                '604800' => &mt('last week'),
                   15530:                               '2592000' => &mt('last month'),
                   15531:                               '7776000' => &mt('last three months'),
                   15532:                              '15552000' => &mt('last six months'),
                   15533:                              '31104000' => &mt('last year'),
                   15534:                     'select_form_order' =>
                   15535:                            ['-1','86400','604800','2592000','7776000',
                   15536:                             '15552000','31104000']});
                   15537:     }
                   15538: }
                   15539: 
                   15540: =pod
                   15541: 
                   15542: =item * &js_changer()
                   15543: 
                   15544: Create script tag containing Javascript used to submit course search form
1.1183    raeburn  15545: when course type or domain is changed, and also to hide 'Searching ...' on
                   15546: page load completion for page showing search result.
1.1181    raeburn  15547: 
                   15548: Inputs: None
                   15549: 
1.1183    raeburn  15550: Returns: markup containing updateFilters() and hideSearching() javascript functions. 
1.1181    raeburn  15551: 
                   15552: Side Effects: None
                   15553: 
                   15554: =cut
                   15555: 
                   15556: sub js_changer {
                   15557:     return <<ENDJS;
                   15558: <script type="text/javascript">
                   15559: // <![CDATA[
                   15560: function updateFilters(caller) {
                   15561:     if (typeof(caller) != "undefined") {
                   15562:         document.filterpicker.updater.value = caller.name;
                   15563:     }
                   15564:     document.filterpicker.submit();
                   15565: }
1.1183    raeburn  15566: 
                   15567: function hideSearching() {
                   15568:     if (document.getElementById('searching')) {
                   15569:         document.getElementById('searching').style.display = 'none';
                   15570:     }
                   15571:     return;
                   15572: }
                   15573: 
1.1181    raeburn  15574: // ]]>
                   15575: </script>
                   15576: 
                   15577: ENDJS
                   15578: }
                   15579: 
                   15580: =pod
                   15581: 
1.1182    raeburn  15582: =item * &search_courses()
                   15583: 
                   15584: Process selected filters form course search form and pass to lonnet::courseiddump
                   15585: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   15586: 
                   15587: Inputs:
                   15588: 
                   15589: dom - domain being searched 
                   15590: 
                   15591: type - course type ('Course' or 'Community' or '.' if any).
                   15592: 
                   15593: filter - anonymous hash of criteria and their values
                   15594: 
                   15595: numtitles - for institutional codes - number of categories
                   15596: 
                   15597: cloneruname - optional username of new course owner
                   15598: 
                   15599: clonerudom - optional domain of new course owner
                   15600: 
                   15601: domcloner - Optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by, 
                   15602:             (used when DC is using course creation form)
                   15603: 
                   15604: codetitles - reference to array of titles of components in institutional codes (official courses).
                   15605: 
                   15606: 
                   15607: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   15608: 
                   15609: 
                   15610: Side Effects: None
                   15611: 
                   15612: =cut
                   15613: 
                   15614: 
                   15615: sub search_courses {
                   15616:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles) = @_;
                   15617:     my (%courses,%showcourses,$cloner);
                   15618:     if (($filter->{'ownerfilter'} ne '') ||
                   15619:         ($filter->{'ownerdomfilter'} ne '')) {
                   15620:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   15621:                                        $filter->{'ownerdomfilter'};
                   15622:     }
                   15623:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   15624:         if (!$filter->{$item}) {
                   15625:             $filter->{$item}='.';
                   15626:         }
                   15627:     }
                   15628:     my $now = time;
                   15629:     my $timefilter =
                   15630:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   15631:     my ($createdbefore,$createdafter);
                   15632:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   15633:         $createdbefore = $now;
                   15634:         $createdafter = $now-$filter->{'createdfilter'};
                   15635:     }
                   15636:     my ($instcodefilter,$regexpok);
                   15637:     if ($numtitles) {
                   15638:         if ($env{'form.official'} eq 'on') {
                   15639:             $instcodefilter =
                   15640:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   15641:             $regexpok = 1;
                   15642:         } elsif ($env{'form.official'} eq 'off') {
                   15643:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   15644:             unless ($instcodefilter eq '') {
                   15645:                 $regexpok = -1;
                   15646:             }
                   15647:         }
                   15648:     } else {
                   15649:         $instcodefilter = $filter->{'instcodefilter'};
                   15650:     }
                   15651:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   15652:     if ($type eq '') { $type = '.'; }
                   15653: 
                   15654:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   15655:         $cloner = $cloneruname.':'.$clonerudom;
                   15656:     }
                   15657:     %courses = &Apache::lonnet::courseiddump($dom,
                   15658:                                              $filter->{'descriptfilter'},
                   15659:                                              $timefilter,
                   15660:                                              $instcodefilter,
                   15661:                                              $filter->{'combownerfilter'},
                   15662:                                              $filter->{'coursefilter'},
                   15663:                                              undef,undef,$type,$regexpok,undef,undef,
                   15664:                                              undef,undef,$cloner,$env{'form.cc_clone'},
                   15665:                                              $filter->{'cloneableonly'},
                   15666:                                              $createdbefore,$createdafter,undef,
                   15667:                                              $domcloner);
                   15668:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   15669:         my $ccrole;
                   15670:         if ($type eq 'Community') {
                   15671:             $ccrole = 'co';
                   15672:         } else {
                   15673:             $ccrole = 'cc';
                   15674:         }
                   15675:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   15676:                                                      $filter->{'persondomfilter'},
                   15677:                                                      'userroles',undef,
                   15678:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   15679:                                                      $dom);
                   15680:         foreach my $role (keys(%rolehash)) {
                   15681:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   15682:             my $cid = $cdom.'_'.$cnum;
                   15683:             if (exists($courses{$cid})) {
                   15684:                 if (ref($courses{$cid}) eq 'HASH') {
                   15685:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   15686:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
                   15687:                             push (@{$courses{$cid}{roles}},$courserole);
                   15688:                         }
                   15689:                     } else {
                   15690:                         $courses{$cid}{roles} = [$courserole];
                   15691:                     }
                   15692:                     $showcourses{$cid} = $courses{$cid};
                   15693:                 }
                   15694:             }
                   15695:         }
                   15696:         %courses = %showcourses;
                   15697:     }
                   15698:     return %courses;
                   15699: }
                   15700: 
                   15701: =pod
                   15702: 
1.1181    raeburn  15703: =back
                   15704: 
1.1207    raeburn  15705: =head1 Routines for version requirements for current course.
                   15706: 
                   15707: =over 4
                   15708: 
                   15709: =item * &check_release_required()
                   15710: 
                   15711: Compares required LON-CAPA version with version on server, and
                   15712: if required version is newer looks for a server with the required version.
                   15713: 
                   15714: Looks first at servers in user's owen domain; if none suitable, looks at
                   15715: servers in course's domain are permitted to host sessions for user's domain.
                   15716: 
                   15717: Inputs:
                   15718: 
                   15719: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   15720: 
                   15721: $courseid - Course ID of current course
                   15722: 
                   15723: $rolecode - User's current role in course (for switchserver query string).
                   15724: 
                   15725: $required - LON-CAPA version needed by course (format: Major.Minor).
                   15726: 
                   15727: 
                   15728: Returns:
                   15729: 
                   15730: $switchserver - query string tp append to /adm/switchserver call (if 
                   15731:                 current server's LON-CAPA version is too old. 
                   15732: 
                   15733: $warning - Message is displayed if no suitable server could be found.
                   15734: 
                   15735: =cut
                   15736: 
                   15737: sub check_release_required {
                   15738:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   15739:     my ($switchserver,$warning);
                   15740:     if ($required ne '') {
                   15741:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   15742:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   15743:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   15744:             my $otherserver;
                   15745:             if (($major eq '' && $minor eq '') ||
                   15746:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   15747:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   15748:                 my $switchlcrev =
                   15749:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   15750:                                                            $userdomserver);
                   15751:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   15752:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   15753:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   15754:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   15755:                     if ($cdom ne $env{'user.domain'}) {
                   15756:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   15757:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   15758:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   15759:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   15760:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   15761:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   15762:                         my $canhost =
                   15763:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   15764:                                                               $coursedomserver,
                   15765:                                                               $remoterev,
                   15766:                                                               $udomdefaults{'remotesessions'},
                   15767:                                                               $defdomdefaults{'hostedsessions'});
                   15768: 
                   15769:                         if ($canhost) {
                   15770:                             $otherserver = $coursedomserver;
                   15771:                         } else {
                   15772:                             $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
                   15773:                         }
                   15774:                     } else {
                   15775:                         $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
                   15776:                     }
                   15777:                 } else {
                   15778:                     $otherserver = $userdomserver;
                   15779:                 }
                   15780:             }
                   15781:             if ($otherserver ne '') {
                   15782:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   15783:             }
                   15784:         }
                   15785:     }
                   15786:     return ($switchserver,$warning);
                   15787: }
                   15788: 
                   15789: =pod
                   15790: 
                   15791: =item * &check_release_result()
                   15792: 
                   15793: Inputs:
                   15794: 
                   15795: $switchwarning - Warning message if no suitable server found to host session.
                   15796: 
                   15797: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   15798:                 and current role.
                   15799: 
                   15800: Returns: HTML to display with information about requirement to switch server.
                   15801:          Either displaying warning with link to Roles/Courses screen or
                   15802:          display link to switchserver.
                   15803: 
1.1181    raeburn  15804: =cut
                   15805: 
1.1207    raeburn  15806: sub check_release_result {
                   15807:     my ($switchwarning,$switchserver) = @_;
                   15808:     my $output = &start_page('Selected course unavailable on this server').
                   15809:                  '<p class="LC_warning">';
                   15810:     if ($switchwarning) {
                   15811:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   15812:         if (&show_course()) {
                   15813:             $output .= &mt('Display courses');
                   15814:         } else {
                   15815:             $output .= &mt('Display roles');
                   15816:         }
                   15817:         $output .= '</a>';
                   15818:     } elsif ($switchserver) {
                   15819:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   15820:                    '<br />'.
                   15821:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   15822:                    &mt('Switch Server').
                   15823:                    '</a>';
                   15824:     }
                   15825:     $output .= '</p>'.&end_page();
                   15826:     return $output;
                   15827: }
                   15828: 
                   15829: =pod
                   15830: 
                   15831: =item * &needs_coursereinit()
                   15832: 
                   15833: Determine if course contents stored for user's session needs to be
                   15834: refreshed, because content has changed since "Big Hash" last tied.
                   15835: 
                   15836: Check for change is made if time last checked is more than 10 minutes ago
                   15837: (by default).
                   15838: 
                   15839: Inputs:
                   15840: 
                   15841: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   15842: 
                   15843: $interval (optional) - Time which may elapse (in s) between last check for content
                   15844:                        change in current course. (default: 600 s).  
                   15845: 
                   15846: Returns: an array; first element is:
                   15847: 
                   15848: =over 4
                   15849: 
                   15850: 'switch' - if content updates mean user's session
                   15851:            needs to be switched to a server running a newer LON-CAPA version
                   15852:  
                   15853: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   15854:            on current server hosting user's session                
                   15855: 
                   15856: ''       - if no action required.
                   15857: 
                   15858: =back
                   15859: 
                   15860: If first item element is 'switch':
                   15861: 
                   15862: second item is $switchwarning - Warning message if no suitable server found to host session. 
                   15863: 
                   15864: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   15865:                               and current role. 
                   15866: 
                   15867: otherwise: no other elements returned.
                   15868: 
                   15869: =back
                   15870: 
                   15871: =cut
                   15872: 
                   15873: sub needs_coursereinit {
                   15874:     my ($loncaparev,$interval) = @_;
                   15875:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   15876:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   15877:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   15878:     my $now = time;
                   15879:     if ($interval eq '') {
                   15880:         $interval = 600;
                   15881:     }
                   15882:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   15883:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   15884:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   15885:         if ($lastchange > $env{'request.course.tied'}) {
                   15886:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   15887:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   15888:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   15889:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   15890:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   15891:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   15892:                     my ($switchserver,$switchwarning) =
                   15893:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   15894:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   15895:                     if ($switchwarning ne '' || $switchserver ne '') {
                   15896:                         return ('switch',$switchwarning,$switchserver);
                   15897:                     }
                   15898:                 }
                   15899:             }
                   15900:             return ('update');
                   15901:         }
                   15902:     }
                   15903:     return ();
                   15904: }
1.1181    raeburn  15905: 
1.1083    raeburn  15906: sub update_content_constraints {
                   15907:     my ($cdom,$cnum,$chome,$cid) = @_;
                   15908:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   15909:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   15910:     my %checkresponsetypes;
                   15911:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   15912:         my ($item,$name,$value) = split(/:/,$key);
                   15913:         if ($item eq 'resourcetag') {
                   15914:             if ($name eq 'responsetype') {
                   15915:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   15916:             }
                   15917:         }
                   15918:     }
                   15919:     my $navmap = Apache::lonnavmaps::navmap->new();
                   15920:     if (defined($navmap)) {
                   15921:         my %allresponses;
                   15922:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   15923:             my %responses = $res->responseTypes();
                   15924:             foreach my $key (keys(%responses)) {
                   15925:                 next unless(exists($checkresponsetypes{$key}));
                   15926:                 $allresponses{$key} += $responses{$key};
                   15927:             }
                   15928:         }
                   15929:         foreach my $key (keys(%allresponses)) {
                   15930:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   15931:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   15932:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   15933:             }
                   15934:         }
                   15935:         undef($navmap);
                   15936:     }
                   15937:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   15938:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   15939:     }
                   15940:     return;
                   15941: }
                   15942: 
1.1110    raeburn  15943: sub allmaps_incourse {
                   15944:     my ($cdom,$cnum,$chome,$cid) = @_;
                   15945:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   15946:         $cid = $env{'request.course.id'};
                   15947:         $cdom = $env{'course.'.$cid.'.domain'};
                   15948:         $cnum = $env{'course.'.$cid.'.num'};
                   15949:         $chome = $env{'course.'.$cid.'.home'};
                   15950:     }
                   15951:     my %allmaps = ();
                   15952:     my $lastchange =
                   15953:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   15954:     if ($lastchange > $env{'request.course.tied'}) {
                   15955:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   15956:         unless ($ferr) {
                   15957:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   15958:         }
                   15959:     }
                   15960:     my $navmap = Apache::lonnavmaps::navmap->new();
                   15961:     if (defined($navmap)) {
                   15962:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   15963:             $allmaps{$res->src()} = 1;
                   15964:         }
                   15965:     }
                   15966:     return \%allmaps;
                   15967: }
                   15968: 
1.1083    raeburn  15969: sub parse_supplemental_title {
                   15970:     my ($title) = @_;
                   15971: 
                   15972:     my ($foldertitle,$renametitle);
                   15973:     if ($title =~ /&amp;&amp;&amp;/) {
                   15974:         $title = &HTML::Entites::decode($title);
                   15975:     }
                   15976:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   15977:         $renametitle=$4;
                   15978:         my ($time,$uname,$udom) = ($1,$2,$3);
                   15979:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   15980:         my $name =  &plainname($uname,$udom);
                   15981:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   15982:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   15983:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   15984:             $name.': <br />'.$foldertitle;
                   15985:     }
                   15986:     if (wantarray) {
                   15987:         return ($title,$foldertitle,$renametitle);
                   15988:     }
                   15989:     return $title;
                   15990: }
                   15991: 
1.1143    raeburn  15992: sub recurse_supplemental {
                   15993:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   15994:     if ($suppmap) {
                   15995:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   15996:         if ($fatal) {
                   15997:             $errors ++;
                   15998:         } else {
                   15999:             if ($#LONCAPA::map::resources > 0) {
                   16000:                 foreach my $res (@LONCAPA::map::resources) {
                   16001:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16002:                     if (($src ne '') && ($status eq 'res')) {
1.1146    raeburn  16003:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16004:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1143    raeburn  16005:                         } else {
                   16006:                             $numfiles ++;
                   16007:                         }
                   16008:                     }
                   16009:                 }
                   16010:             }
                   16011:         }
                   16012:     }
                   16013:     return ($numfiles,$errors);
                   16014: }
                   16015: 
1.1101    raeburn  16016: sub symb_to_docspath {
                   16017:     my ($symb) = @_;
                   16018:     return unless ($symb);
                   16019:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16020:     if ($resurl=~/\.(sequence|page)$/) {
                   16021:         $mapurl=$resurl;
                   16022:     } elsif ($resurl eq 'adm/navmaps') {
                   16023:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16024:     }
                   16025:     my $mapresobj;
                   16026:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16027:     if (ref($navmap)) {
                   16028:         $mapresobj = $navmap->getResourceByUrl($mapurl);
                   16029:     }
                   16030:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16031:     my $type=$2;
                   16032:     my $path;
                   16033:     if (ref($mapresobj)) {
                   16034:         my $pcslist = $mapresobj->map_hierarchy();
                   16035:         if ($pcslist ne '') {
                   16036:             foreach my $pc (split(/,/,$pcslist)) {
                   16037:                 next if ($pc <= 1);
                   16038:                 my $res = $navmap->getByMapPc($pc);
                   16039:                 if (ref($res)) {
                   16040:                     my $thisurl = $res->src();
                   16041:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16042:                     my $thistitle = $res->title();
                   16043:                     $path .= '&'.
                   16044:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146    raeburn  16045:                              &escape($thistitle).
1.1101    raeburn  16046:                              ':'.$res->randompick().
                   16047:                              ':'.$res->randomout().
                   16048:                              ':'.$res->encrypted().
                   16049:                              ':'.$res->randomorder().
                   16050:                              ':'.$res->is_page();
                   16051:                 }
                   16052:             }
                   16053:         }
                   16054:         $path =~ s/^\&//;
                   16055:         my $maptitle = $mapresobj->title();
                   16056:         if ($mapurl eq 'default') {
1.1129    raeburn  16057:             $maptitle = 'Main Content';
1.1101    raeburn  16058:         }
                   16059:         $path .= (($path ne '')? '&' : '').
                   16060:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  16061:                  &escape($maptitle).
1.1101    raeburn  16062:                  ':'.$mapresobj->randompick().
                   16063:                  ':'.$mapresobj->randomout().
                   16064:                  ':'.$mapresobj->encrypted().
                   16065:                  ':'.$mapresobj->randomorder().
                   16066:                  ':'.$mapresobj->is_page();
                   16067:     } else {
                   16068:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16069:         my $ispage = (($type eq 'page')? 1 : '');
                   16070:         if ($mapurl eq 'default') {
1.1129    raeburn  16071:             $maptitle = 'Main Content';
1.1101    raeburn  16072:         }
                   16073:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  16074:                 &escape($maptitle).':::::'.$ispage;
1.1101    raeburn  16075:     }
                   16076:     unless ($mapurl eq 'default') {
                   16077:         $path = 'default&'.
1.1146    raeburn  16078:                 &escape('Main Content').
1.1101    raeburn  16079:                 ':::::&'.$path;
                   16080:     }
                   16081:     return $path;
                   16082: }
                   16083: 
1.1094    raeburn  16084: sub captcha_display {
                   16085:     my ($context,$lonhost) = @_;
                   16086:     my ($output,$error);
                   16087:     my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095    raeburn  16088:     if ($captcha eq 'original') {
1.1094    raeburn  16089:         $output = &create_captcha();
                   16090:         unless ($output) {
1.1172    raeburn  16091:             $error = 'captcha';
1.1094    raeburn  16092:         }
                   16093:     } elsif ($captcha eq 'recaptcha') {
                   16094:         $output = &create_recaptcha($pubkey);
                   16095:         unless ($output) {
1.1172    raeburn  16096:             $error = 'recaptcha';
1.1094    raeburn  16097:         }
                   16098:     }
1.1176    raeburn  16099:     return ($output,$error,$captcha);
1.1094    raeburn  16100: }
                   16101: 
                   16102: sub captcha_response {
                   16103:     my ($context,$lonhost) = @_;
                   16104:     my ($captcha_chk,$captcha_error);
                   16105:     my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095    raeburn  16106:     if ($captcha eq 'original') {
1.1094    raeburn  16107:         ($captcha_chk,$captcha_error) = &check_captcha();
                   16108:     } elsif ($captcha eq 'recaptcha') {
                   16109:         $captcha_chk = &check_recaptcha($privkey);
                   16110:     } else {
                   16111:         $captcha_chk = 1;
                   16112:     }
                   16113:     return ($captcha_chk,$captcha_error);
                   16114: }
                   16115: 
                   16116: sub get_captcha_config {
                   16117:     my ($context,$lonhost) = @_;
1.1095    raeburn  16118:     my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094    raeburn  16119:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   16120:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   16121:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  16122:     if ($context eq 'usercreation') {
                   16123:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   16124:         if (ref($domconfig{$context}) eq 'HASH') {
                   16125:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   16126:             if (ref($hashtocheck) eq 'HASH') {
                   16127:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   16128:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   16129:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   16130:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   16131:                     }
                   16132:                     if ($privkey && $pubkey) {
                   16133:                         $captcha = 'recaptcha';
                   16134:                     } else {
                   16135:                         $captcha = 'original';
                   16136:                     }
                   16137:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   16138:                     $captcha = 'original';
                   16139:                 }
1.1094    raeburn  16140:             }
1.1095    raeburn  16141:         } else {
                   16142:             $captcha = 'captcha';
                   16143:         }
                   16144:     } elsif ($context eq 'login') {
                   16145:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   16146:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   16147:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   16148:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  16149:             if ($privkey && $pubkey) {
                   16150:                 $captcha = 'recaptcha';
1.1095    raeburn  16151:             } else {
                   16152:                 $captcha = 'original';
1.1094    raeburn  16153:             }
1.1095    raeburn  16154:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   16155:             $captcha = 'original';
1.1094    raeburn  16156:         }
                   16157:     }
                   16158:     return ($captcha,$pubkey,$privkey);
                   16159: }
                   16160: 
                   16161: sub create_captcha {
                   16162:     my %captcha_params = &captcha_settings();
                   16163:     my ($output,$maxtries,$tries) = ('',10,0);
                   16164:     while ($tries < $maxtries) {
                   16165:         $tries ++;
                   16166:         my $captcha = Authen::Captcha->new (
                   16167:                                            output_folder => $captcha_params{'output_dir'},
                   16168:                                            data_folder   => $captcha_params{'db_dir'},
                   16169:                                           );
                   16170:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   16171: 
                   16172:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   16173:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   16174:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1176    raeburn  16175:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   16176:                       '<br />'.
                   16177:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094    raeburn  16178:             last;
                   16179:         }
                   16180:     }
                   16181:     return $output;
                   16182: }
                   16183: 
                   16184: sub captcha_settings {
                   16185:     my %captcha_params = (
                   16186:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   16187:                            www_output_dir => "/captchaspool",
                   16188:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   16189:                            numchars       => '5',
                   16190:                          );
                   16191:     return %captcha_params;
                   16192: }
                   16193: 
                   16194: sub check_captcha {
                   16195:     my ($captcha_chk,$captcha_error);
                   16196:     my $code = $env{'form.code'};
                   16197:     my $md5sum = $env{'form.crypt'};
                   16198:     my %captcha_params = &captcha_settings();
                   16199:     my $captcha = Authen::Captcha->new(
                   16200:                       output_folder => $captcha_params{'output_dir'},
                   16201:                       data_folder   => $captcha_params{'db_dir'},
                   16202:                   );
1.1109    raeburn  16203:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  16204:     my %captcha_hash = (
                   16205:                         0       => 'Code not checked (file error)',
                   16206:                        -1      => 'Failed: code expired',
                   16207:                        -2      => 'Failed: invalid code (not in database)',
                   16208:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   16209:     );
                   16210:     if ($captcha_chk != 1) {
                   16211:         $captcha_error = $captcha_hash{$captcha_chk}
                   16212:     }
                   16213:     return ($captcha_chk,$captcha_error);
                   16214: }
                   16215: 
                   16216: sub create_recaptcha {
                   16217:     my ($pubkey) = @_;
1.1153    raeburn  16218:     my $use_ssl;
                   16219:     if ($ENV{'SERVER_PORT'} == 443) {
                   16220:         $use_ssl = 1;
                   16221:     }
1.1094    raeburn  16222:     my $captcha = Captcha::reCAPTCHA->new;
                   16223:     return $captcha->get_options_setter({theme => 'white'})."\n".
1.1153    raeburn  16224:            $captcha->get_html($pubkey,undef,$use_ssl).
1.1094    raeburn  16225:            &mt('If either word is hard to read, [_1] will replace them.',
1.1133    raeburn  16226:                '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
1.1094    raeburn  16227:            '<br /><br />';
                   16228: }
                   16229: 
                   16230: sub check_recaptcha {
                   16231:     my ($privkey) = @_;
                   16232:     my $captcha_chk;
                   16233:     my $captcha = Captcha::reCAPTCHA->new;
                   16234:     my $captcha_result =
                   16235:         $captcha->check_answer(
                   16236:                                 $privkey,
                   16237:                                 $ENV{'REMOTE_ADDR'},
                   16238:                                 $env{'form.recaptcha_challenge_field'},
                   16239:                                 $env{'form.recaptcha_response_field'},
                   16240:                               );
                   16241:     if ($captcha_result->{is_valid}) {
                   16242:         $captcha_chk = 1;
                   16243:     }
                   16244:     return $captcha_chk;
                   16245: }
                   16246: 
1.1174    raeburn  16247: sub emailusername_info {
1.1177    raeburn  16248:     my @fields = ('firstname','lastname','institution','web','location','officialemail');
1.1174    raeburn  16249:     my %titles = &Apache::lonlocal::texthash (
                   16250:                      lastname      => 'Last Name',
                   16251:                      firstname     => 'First Name',
                   16252:                      institution   => 'School/college/university',
                   16253:                      location      => "School's city, state/province, country",
                   16254:                      web           => "School's web address",
                   16255:                      officialemail => 'E-mail address at institution (if different)',
                   16256:                  );
                   16257:     return (\@fields,\%titles);
                   16258: }
                   16259: 
1.1161    raeburn  16260: sub cleanup_html {
                   16261:     my ($incoming) = @_;
                   16262:     my $outgoing;
                   16263:     if ($incoming ne '') {
                   16264:         $outgoing = $incoming;
                   16265:         $outgoing =~ s/;/&#059;/g;
                   16266:         $outgoing =~ s/\#/&#035;/g;
                   16267:         $outgoing =~ s/\&/&#038;/g;
                   16268:         $outgoing =~ s/</&#060;/g;
                   16269:         $outgoing =~ s/>/&#062;/g;
                   16270:         $outgoing =~ s/\(/&#040/g;
                   16271:         $outgoing =~ s/\)/&#041;/g;
                   16272:         $outgoing =~ s/"/&#034;/g;
                   16273:         $outgoing =~ s/'/&#039;/g;
                   16274:         $outgoing =~ s/\$/&#036;/g;
                   16275:         $outgoing =~ s{/}{&#047;}g;
                   16276:         $outgoing =~ s/=/&#061;/g;
                   16277:         $outgoing =~ s/\\/&#092;/g
                   16278:     }
                   16279:     return $outgoing;
                   16280: }
                   16281: 
1.1190    musolffc 16282: # Checks for critical messages and returns a redirect url if one exists.
                   16283: # $interval indicates how often to check for messages.
                   16284: sub critical_redirect {
                   16285:     my ($interval) = @_;
                   16286:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   16287:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'}, 
                   16288:                                         $env{'user.name'});
                   16289:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191    raeburn  16290:         my $redirecturl;
1.1190    musolffc 16291:         if ($what[0]) {
                   16292: 	    if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   16293: 	        $redirecturl='/adm/email?critical=display';
1.1191    raeburn  16294: 	        my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   16295:                 return (1, $url);
1.1190    musolffc 16296:             }
1.1191    raeburn  16297:         }
                   16298:     } 
                   16299:     return ();
1.1190    musolffc 16300: }
                   16301: 
1.1174    raeburn  16302: # Use:
                   16303: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   16304: #
                   16305: ##################################################
                   16306: #          password associated functions         #
                   16307: ##################################################
                   16308: sub des_keys {
                   16309:     # Make a new key for DES encryption.
                   16310:     # Each key has two parts which are returned separately.
                   16311:     # Please note:  Each key must be passed through the &hex function
                   16312:     # before it is output to the web browser.  The hex versions cannot
                   16313:     # be used to decrypt.
                   16314:     my @hexstr=('0','1','2','3','4','5','6','7',
                   16315:                 '8','9','a','b','c','d','e','f');
                   16316:     my $lkey='';
                   16317:     for (0..7) {
                   16318:         $lkey.=$hexstr[rand(15)];
                   16319:     }
                   16320:     my $ukey='';
                   16321:     for (0..7) {
                   16322:         $ukey.=$hexstr[rand(15)];
                   16323:     }
                   16324:     return ($lkey,$ukey);
                   16325: }
                   16326: 
                   16327: sub des_decrypt {
                   16328:     my ($key,$cyphertext) = @_;
                   16329:     my $keybin=pack("H16",$key);
                   16330:     my $cypher;
                   16331:     if ($Crypt::DES::VERSION>=2.03) {
                   16332:         $cypher=new Crypt::DES $keybin;
                   16333:     } else {
                   16334:         $cypher=new DES $keybin;
                   16335:     }
                   16336:     my $plaintext=
                   16337:         $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,0,16))));
                   16338:     $plaintext.=
                   16339:         $cypher->decrypt(unpack("a8",pack("H16",substr($cyphertext,16,16))));
                   16340:     $plaintext=substr($plaintext,1,ord(substr($plaintext,0,1)) );
                   16341:     return $plaintext;
                   16342: }
                   16343: 
1.112     bowersj2 16344: 1;
                   16345: __END__;
1.41      ng       16346: 

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