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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1126  ! raeburn     4: # $Id: loncommon.pm,v 1.1125 2013/05/03 14:28:35 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.479     albertel   72: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    73: use DateTime::TimeZone;
1.687     raeburn    74: use DateTime::Locale::Catalog;
1.1091    foxr       75: use Text::Aspell;
1.1094    raeburn    76: use Authen::Captcha;
                     77: use Captcha::reCAPTCHA;
1.117     www        78: 
1.517     raeburn    79: # ---------------------------------------------- Designs
                     80: use vars qw(%defaultdesign);
                     81: 
1.22      www        82: my $readit;
                     83: 
1.517     raeburn    84: 
1.157     matthew    85: ##
                     86: ## Global Variables
                     87: ##
1.46      matthew    88: 
1.643     foxr       89: 
                     90: # ----------------------------------------------- SSI with retries:
                     91: #
                     92: 
                     93: =pod
                     94: 
1.648     raeburn    95: =head1 Server Side include with retries:
1.643     foxr       96: 
                     97: =over 4
                     98: 
1.648     raeburn    99: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      100: 
                    101: Performs an ssi with some number of retries.  Retries continue either
                    102: until the result is ok or until the retry count supplied by the
                    103: caller is exhausted.  
                    104: 
                    105: Inputs:
1.648     raeburn   106: 
                    107: =over 4
                    108: 
1.643     foxr      109: resource   - Identifies the resource to insert.
1.648     raeburn   110: 
1.643     foxr      111: retries    - Count of the number of retries allowed.
1.648     raeburn   112: 
1.643     foxr      113: form       - Hash that identifies the rendering options.
                    114: 
1.648     raeburn   115: =back
                    116: 
                    117: Returns:
                    118: 
                    119: =over 4
                    120: 
1.643     foxr      121: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   122: 
1.643     foxr      123: response   - The response from the last attempt (which may or may not have been successful.
                    124: 
1.648     raeburn   125: =back
                    126: 
                    127: =back
                    128: 
1.643     foxr      129: =cut
                    130: 
                    131: sub ssi_with_retries {
                    132:     my ($resource, $retries, %form) = @_;
                    133: 
                    134: 
                    135:     my $ok = 0;			# True if we got a good response.
                    136:     my $content;
                    137:     my $response;
                    138: 
                    139:     # Try to get the ssi done. within the retries count:
                    140: 
                    141:     do {
                    142: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    143: 	$ok      = $response->is_success;
1.650     www       144:         if (!$ok) {
                    145:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    146:         }
1.643     foxr      147: 	$retries--;
                    148:     } while (!$ok && ($retries > 0));
                    149: 
                    150:     if (!$ok) {
                    151: 	$content = '';		# On error return an empty content.
                    152:     }
                    153:     return ($content, $response);
                    154: 
                    155: }
                    156: 
                    157: 
                    158: 
1.20      www       159: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  160: my %language;
1.124     www       161: my %supported_language;
1.1088    foxr      162: my %supported_codes;
1.1048    foxr      163: my %latex_language;		# For choosing hyphenation in <transl..>
                    164: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  165: my %cprtag;
1.192     taceyjo1  166: my %scprtag;
1.351     www       167: my %fe; my %fd; my %fm;
1.41      ng        168: my %category_extensions;
1.12      harris41  169: 
1.46      matthew   170: # ---------------------------------------------- Thesaurus variables
1.144     matthew   171: #
                    172: # %Keywords:
                    173: #      A hash used by &keyword to determine if a word is considered a keyword.
                    174: # $thesaurus_db_file 
                    175: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   176: 
                    177: my %Keywords;
                    178: my $thesaurus_db_file;
                    179: 
1.144     matthew   180: #
                    181: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    182: # thesaurus.tab, and filecategories.tab.
                    183: #
1.18      www       184: BEGIN {
1.46      matthew   185:     # Variable initialization
                    186:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    187:     #
1.22      www       188:     unless ($readit) {
1.12      harris41  189: # ------------------------------------------------------------------- languages
                    190:     {
1.158     raeburn   191:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    192:                                    '/language.tab';
                    193:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  194:             while (my $line = <$fh>) {
                    195:                 next if ($line=~/^\#/);
                    196:                 chomp($line);
1.1088    foxr      197:                 my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   198:                 $language{$key}=$val.' - '.$enc;
                    199:                 if ($sup) {
                    200:                     $supported_language{$key}=$sup;
1.1088    foxr      201: 		    $supported_codes{$key}   = $code;
1.158     raeburn   202:                 }
1.1048    foxr      203: 		if ($latex) {
                    204: 		    $latex_language_bykey{$key} = $latex;
1.1088    foxr      205: 		    $latex_language{$code} = $latex;
1.1048    foxr      206: 		}
1.158     raeburn   207:             }
                    208:             close($fh);
                    209:         }
1.12      harris41  210:     }
                    211: # ------------------------------------------------------------------ copyrights
                    212:     {
1.158     raeburn   213:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    214:                                   '/copyright.tab';
                    215:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  216:             while (my $line = <$fh>) {
                    217:                 next if ($line=~/^\#/);
                    218:                 chomp($line);
                    219:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   220:                 $cprtag{$key}=$val;
                    221:             }
                    222:             close($fh);
                    223:         }
1.12      harris41  224:     }
1.351     www       225: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  226:     {
                    227:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    228:                                   '/source_copyright.tab';
                    229:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  230:             while (my $line = <$fh>) {
                    231:                 next if ($line =~ /^\#/);
                    232:                 chomp($line);
                    233:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  234:                 $scprtag{$key}=$val;
                    235:             }
                    236:             close($fh);
                    237:         }
                    238:     }
1.63      www       239: 
1.517     raeburn   240: # -------------------------------------------------------------- default domain designs
1.63      www       241:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   242:     my $designfile = $designdir.'/default.tab';
                    243:     if ( open (my $fh,"<$designfile") ) {
                    244:         while (my $line = <$fh>) {
                    245:             next if ($line =~ /^\#/);
                    246:             chomp($line);
                    247:             my ($key,$val)=(split(/\=/,$line));
                    248:             if ($val) { $defaultdesign{$key}=$val; }
                    249:         }
                    250:         close($fh);
1.63      www       251:     }
                    252: 
1.15      harris41  253: # ------------------------------------------------------------- file categories
                    254:     {
1.158     raeburn   255:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    256:                                   '/filecategories.tab';
                    257:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  258: 	    while (my $line = <$fh>) {
                    259: 		next if ($line =~ /^\#/);
                    260: 		chomp($line);
                    261:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   262:                 push @{$category_extensions{lc($category)}},$extension;
                    263:             }
                    264:             close($fh);
                    265:         }
                    266: 
1.15      harris41  267:     }
1.12      harris41  268: # ------------------------------------------------------------------ file types
                    269:     {
1.158     raeburn   270:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    271:                '/filetypes.tab';
                    272:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  273:             while (my $line = <$fh>) {
                    274: 		next if ($line =~ /^\#/);
                    275: 		chomp($line);
                    276:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   277:                 if ($descr ne '') {
                    278:                     $fe{$ending}=lc($emb);
                    279:                     $fd{$ending}=$descr;
1.351     www       280:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   281:                 }
                    282:             }
                    283:             close($fh);
                    284:         }
1.12      harris41  285:     }
1.22      www       286:     &Apache::lonnet::logthis(
1.705     tempelho  287:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       288:     $readit=1;
1.46      matthew   289:     }  # end of unless($readit) 
1.32      matthew   290:     
                    291: }
1.112     bowersj2  292: 
1.42      matthew   293: ###############################################################
                    294: ##           HTML and Javascript Helper Functions            ##
                    295: ###############################################################
                    296: 
                    297: =pod 
                    298: 
1.112     bowersj2  299: =head1 HTML and Javascript Functions
1.42      matthew   300: 
1.112     bowersj2  301: =over 4
                    302: 
1.648     raeburn   303: =item * &browser_and_searcher_javascript()
1.112     bowersj2  304: 
                    305: X<browsing, javascript>X<searching, javascript>Returns a string
                    306: containing javascript with two functions, C<openbrowser> and
                    307: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    308: tags.
1.42      matthew   309: 
1.648     raeburn   310: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   311: 
                    312: inputs: formname, elementname, only, omit
                    313: 
                    314: formname and elementname indicate the name of the html form and name of
                    315: the element that the results of the browsing selection are to be placed in. 
                    316: 
                    317: Specifying 'only' will restrict the browser to displaying only files
1.185     www       318: with the given extension.  Can be a comma separated list.
1.42      matthew   319: 
                    320: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       321: with the given extension.  Can be a comma separated list.
1.42      matthew   322: 
1.648     raeburn   323: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   324: 
                    325: Inputs: formname, elementname
                    326: 
                    327: formname and elementname specify the name of the html form and the name
                    328: of the element the selection from the search results will be placed in.
1.542     raeburn   329: 
1.42      matthew   330: =cut
                    331: 
                    332: sub browser_and_searcher_javascript {
1.199     albertel  333:     my ($mode)=@_;
                    334:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  335:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   336:     return <<END;
1.219     albertel  337: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   338:     var editbrowser = null;
1.135     albertel  339:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       340:         var url = '$resurl/?';
1.42      matthew   341:         if (editbrowser == null) {
                    342:             url += 'launch=1&';
                    343:         }
                    344:         url += 'catalogmode=interactive&';
1.199     albertel  345:         url += 'mode=$mode&';
1.611     albertel  346:         url += 'inhibitmenu=yes&';
1.42      matthew   347:         url += 'form=' + formname + '&';
                    348:         if (only != null) {
                    349:             url += 'only=' + only + '&';
1.217     albertel  350:         } else {
                    351:             url += 'only=&';
                    352: 	}
1.42      matthew   353:         if (omit != null) {
                    354:             url += 'omit=' + omit + '&';
1.217     albertel  355:         } else {
                    356:             url += 'omit=&';
                    357: 	}
1.135     albertel  358:         if (titleelement != null) {
                    359:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  360:         } else {
                    361: 	    url += 'titleelement=&';
                    362: 	}
1.42      matthew   363:         url += 'element=' + elementname + '';
                    364:         var title = 'Browser';
1.435     albertel  365:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   366:         options += ',width=700,height=600';
                    367:         editbrowser = open(url,title,options,'1');
                    368:         editbrowser.focus();
                    369:     }
                    370:     var editsearcher;
1.135     albertel  371:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   372:         var url = '/adm/searchcat?';
                    373:         if (editsearcher == null) {
                    374:             url += 'launch=1&';
                    375:         }
                    376:         url += 'catalogmode=interactive&';
1.199     albertel  377:         url += 'mode=$mode&';
1.42      matthew   378:         url += 'form=' + formname + '&';
1.135     albertel  379:         if (titleelement != null) {
                    380:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  381:         } else {
                    382: 	    url += 'titleelement=&';
                    383: 	}
1.42      matthew   384:         url += 'element=' + elementname + '';
                    385:         var title = 'Search';
1.435     albertel  386:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   387:         options += ',width=700,height=600';
                    388:         editsearcher = open(url,title,options,'1');
                    389:         editsearcher.focus();
                    390:     }
1.219     albertel  391: // END LON-CAPA Internal -->
1.42      matthew   392: END
1.170     www       393: }
                    394: 
                    395: sub lastresurl {
1.258     albertel  396:     if ($env{'environment.lastresurl'}) {
                    397: 	return $env{'environment.lastresurl'}
1.170     www       398:     } else {
                    399: 	return '/res';
                    400:     }
                    401: }
                    402: 
                    403: sub storeresurl {
                    404:     my $resurl=&Apache::lonnet::clutter(shift);
                    405:     unless ($resurl=~/^\/res/) { return 0; }
                    406:     $resurl=~s/\/$//;
                    407:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   408:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       409:     return 1;
1.42      matthew   410: }
                    411: 
1.74      www       412: sub studentbrowser_javascript {
1.111     www       413:    unless (
1.258     albertel  414:             (($env{'request.course.id'}) && 
1.302     albertel  415:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    416: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    417: 					  '/'.$env{'request.course.sec'})
                    418: 	      ))
1.258     albertel  419:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       420:           ) { return ''; }  
1.74      www       421:    return (<<'ENDSTDBRW');
1.776     bisitz    422: <script type="text/javascript" language="Javascript">
1.824     bisitz    423: // <![CDATA[
1.74      www       424:     var stdeditbrowser;
1.999     www       425:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74      www       426:         var url = '/adm/pickstudent?';
                    427:         var filter;
1.558     albertel  428: 	if (!ignorefilter) {
                    429: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    430: 	}
1.74      www       431:         if (filter != null) {
                    432:            if (filter != '') {
                    433:                url += 'filter='+filter+'&';
                    434: 	   }
                    435:         }
                    436:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       437:                                     '&udomelement='+udom+
                    438:                                     '&clicker='+clicker;
1.111     www       439: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   440:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       441:         var title = 'Student_Browser';
1.74      www       442:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    443:         options += ',width=700,height=600';
                    444:         stdeditbrowser = open(url,title,options,'1');
                    445:         stdeditbrowser.focus();
                    446:     }
1.824     bisitz    447: // ]]>
1.74      www       448: </script>
                    449: ENDSTDBRW
                    450: }
1.42      matthew   451: 
1.1003    www       452: sub resourcebrowser_javascript {
                    453:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       454:    return (<<'ENDRESBRW');
1.1003    www       455: <script type="text/javascript" language="Javascript">
                    456: // <![CDATA[
                    457:     var reseditbrowser;
1.1004    www       458:     function openresbrowser(formname,reslink) {
1.1005    www       459:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       460:         var title = 'Resource_Browser';
                    461:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       462:         options += ',width=700,height=500';
1.1004    www       463:         reseditbrowser = open(url,title,options,'1');
                    464:         reseditbrowser.focus();
1.1003    www       465:     }
                    466: // ]]>
                    467: </script>
1.1004    www       468: ENDRESBRW
1.1003    www       469: }
                    470: 
1.74      www       471: sub selectstudent_link {
1.999     www       472:    my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
                    473:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    474:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    475:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  476:    if ($env{'request.course.id'}) {  
1.302     albertel  477:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    478: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    479: 					'/'.$env{'request.course.sec'})) {
1.111     www       480: 	   return '';
                    481:        }
1.999     www       482:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793     raeburn   483:        if ($courseadvonly)  {
                    484:            $callargs .= ",'',1,1";
                    485:        }
                    486:        return '<span class="LC_nobreak">'.
                    487:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    488:               &mt('Select User').'</a></span>';
1.74      www       489:    }
1.258     albertel  490:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       491:        $callargs .= ",'',1"; 
1.793     raeburn   492:        return '<span class="LC_nobreak">'.
                    493:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    494:               &mt('Select User').'</a></span>';
1.111     www       495:    }
                    496:    return '';
1.91      www       497: }
                    498: 
1.1004    www       499: sub selectresource_link {
                    500:    my ($form,$reslink,$arg)=@_;
                    501:    
                    502:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    503:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    504:    unless ($env{'request.course.id'}) { return $arg; }
                    505:    return '<span class="LC_nobreak">'.
                    506:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    507:               $arg.'</a></span>';
                    508: }
                    509: 
                    510: 
                    511: 
1.653     raeburn   512: sub authorbrowser_javascript {
                    513:     return <<"ENDAUTHORBRW";
1.776     bisitz    514: <script type="text/javascript" language="JavaScript">
1.824     bisitz    515: // <![CDATA[
1.653     raeburn   516: var stdeditbrowser;
                    517: 
                    518: function openauthorbrowser(formname,udom) {
                    519:     var url = '/adm/pickauthor?';
                    520:     url += 'form='+formname+'&roledom='+udom;
                    521:     var title = 'Author_Browser';
                    522:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    523:     options += ',width=700,height=600';
                    524:     stdeditbrowser = open(url,title,options,'1');
                    525:     stdeditbrowser.focus();
                    526: }
                    527: 
1.824     bisitz    528: // ]]>
1.653     raeburn   529: </script>
                    530: ENDAUTHORBRW
                    531: }
                    532: 
1.91      www       533: sub coursebrowser_javascript {
1.1116    raeburn   534:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
                    535:         $credits_element) = @_;
1.932     raeburn   536:     my $wintitle = 'Course_Browser';
1.931     raeburn   537:     if ($crstype eq 'Community') {
1.932     raeburn   538:         $wintitle = 'Community_Browser';
1.909     raeburn   539:     }
1.876     raeburn   540:     my $id_functions = &javascript_index_functions();
                    541:     my $output = '
1.776     bisitz    542: <script type="text/javascript" language="JavaScript">
1.824     bisitz    543: // <![CDATA[
1.468     raeburn   544:     var stdeditbrowser;'."\n";
1.876     raeburn   545: 
                    546:     $output .= <<"ENDSTDBRW";
1.909     raeburn   547:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       548:         var url = '/adm/pickcourse?';
1.895     raeburn   549:         var formid = getFormIdByName(formname);
1.876     raeburn   550:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  551:         if (domainfilter != null) {
                    552:            if (domainfilter != '') {
                    553:                url += 'domainfilter='+domainfilter+'&';
                    554: 	   }
                    555:         }
1.91      www       556:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  557: 	                            '&cdomelement='+udom+
                    558:                                     '&cnameelement='+desc;
1.468     raeburn   559:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   560:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   561:                 url += '&roleelement='+extra_element;
                    562:                 if (domainfilter == null || domainfilter == '') {
                    563:                     url += '&domainfilter='+extra_element;
                    564:                 }
1.234     raeburn   565:             }
1.468     raeburn   566:             else {
                    567:                 if (formname == 'portform') {
                    568:                     url += '&setroles='+extra_element;
1.800     raeburn   569:                 } else {
                    570:                     if (formname == 'rules') {
                    571:                         url += '&fixeddom='+extra_element; 
                    572:                     }
1.468     raeburn   573:                 }
                    574:             }     
1.230     raeburn   575:         }
1.909     raeburn   576:         if (type != null && type != '') {
                    577:             url += '&type='+type;
                    578:         }
                    579:         if (type_elem != null && type_elem != '') {
                    580:             url += '&typeelement='+type_elem;
                    581:         }
1.872     raeburn   582:         if (formname == 'ccrs') {
                    583:             var ownername = document.forms[formid].ccuname.value;
                    584:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    585:             url += '&cloner='+ownername+':'+ownerdom;
                    586:         }
1.293     raeburn   587:         if (multflag !=null && multflag != '') {
                    588:             url += '&multiple='+multflag;
                    589:         }
1.909     raeburn   590:         var title = '$wintitle';
1.91      www       591:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    592:         options += ',width=700,height=600';
                    593:         stdeditbrowser = open(url,title,options,'1');
                    594:         stdeditbrowser.focus();
                    595:     }
1.876     raeburn   596: $id_functions
                    597: ENDSTDBRW
1.1116    raeburn   598:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    599:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    600:                                       $credits_element);
1.876     raeburn   601:     }
                    602:     $output .= '
                    603: // ]]>
                    604: </script>';
                    605:     return $output;
                    606: }
                    607: 
                    608: sub javascript_index_functions {
                    609:     return <<"ENDJS";
                    610: 
                    611: function getFormIdByName(formname) {
                    612:     for (var i=0;i<document.forms.length;i++) {
                    613:         if (document.forms[i].name == formname) {
                    614:             return i;
                    615:         }
                    616:     }
                    617:     return -1;
                    618: }
                    619: 
                    620: function getIndexByName(formid,item) {
                    621:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    622:         if (document.forms[formid].elements[i].name == item) {
                    623:             return i;
                    624:         }
                    625:     }
                    626:     return -1;
                    627: }
1.468     raeburn   628: 
1.876     raeburn   629: function getDomainFromSelectbox(formname,udom) {
                    630:     var userdom;
                    631:     var formid = getFormIdByName(formname);
                    632:     if (formid > -1) {
                    633:         var domid = getIndexByName(formid,udom);
                    634:         if (domid > -1) {
                    635:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    636:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    637:             }
                    638:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    639:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   640:             }
                    641:         }
                    642:     }
1.876     raeburn   643:     return userdom;
                    644: }
                    645: 
                    646: ENDJS
1.468     raeburn   647: 
1.876     raeburn   648: }
                    649: 
1.1017    raeburn   650: sub javascript_array_indexof {
1.1018    raeburn   651:     return <<ENDJS;
1.1017    raeburn   652: <script type="text/javascript" language="JavaScript">
                    653: // <![CDATA[
                    654: 
                    655: if (!Array.prototype.indexOf) {
                    656:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    657:         "use strict";
                    658:         if (this === void 0 || this === null) {
                    659:             throw new TypeError();
                    660:         }
                    661:         var t = Object(this);
                    662:         var len = t.length >>> 0;
                    663:         if (len === 0) {
                    664:             return -1;
                    665:         }
                    666:         var n = 0;
                    667:         if (arguments.length > 0) {
                    668:             n = Number(arguments[1]);
1.1088    foxr      669:             if (n !== n) { // shortcut for verifying if it is NaN
1.1017    raeburn   670:                 n = 0;
                    671:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    672:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    673:             }
                    674:         }
                    675:         if (n >= len) {
                    676:             return -1;
                    677:         }
                    678:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    679:         for (; k < len; k++) {
                    680:             if (k in t && t[k] === searchElement) {
                    681:                 return k;
                    682:             }
                    683:         }
                    684:         return -1;
                    685:     }
                    686: }
                    687: 
                    688: // ]]>
                    689: </script>
                    690: 
                    691: ENDJS
                    692: 
                    693: }
                    694: 
1.876     raeburn   695: sub userbrowser_javascript {
                    696:     my $id_functions = &javascript_index_functions();
                    697:     return <<"ENDUSERBRW";
                    698: 
1.888     raeburn   699: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   700:     var url = '/adm/pickuser?';
                    701:     var userdom = getDomainFromSelectbox(formname,udom);
                    702:     if (userdom != null) {
                    703:        if (userdom != '') {
                    704:            url += 'srchdom='+userdom+'&';
                    705:        }
                    706:     }
                    707:     url += 'form=' + formname + '&unameelement='+uname+
                    708:                                 '&udomelement='+udom+
                    709:                                 '&ulastelement='+ulast+
                    710:                                 '&ufirstelement='+ufirst+
                    711:                                 '&uemailelement='+uemail+
1.881     raeburn   712:                                 '&hideudomelement='+hideudom+
                    713:                                 '&coursedom='+crsdom;
1.888     raeburn   714:     if ((caller != null) && (caller != undefined)) {
                    715:         url += '&caller='+caller;
                    716:     }
1.876     raeburn   717:     var title = 'User_Browser';
                    718:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    719:     options += ',width=700,height=600';
                    720:     var stdeditbrowser = open(url,title,options,'1');
                    721:     stdeditbrowser.focus();
                    722: }
                    723: 
1.888     raeburn   724: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   725:     var formid = getFormIdByName(formname);
                    726:     if (formid > -1) {
1.888     raeburn   727:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   728:         var domid = getIndexByName(formid,udom);
                    729:         var hidedomid = getIndexByName(formid,origdom);
                    730:         if (hidedomid > -1) {
                    731:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   732:             var unameval = document.forms[formid].elements[unameid].value;
                    733:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    734:                 if (domid > -1) {
                    735:                     var slct = document.forms[formid].elements[domid];
                    736:                     if (slct.type == 'select-one') {
                    737:                         var i;
                    738:                         for (i=0;i<slct.length;i++) {
                    739:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    740:                         }
                    741:                     }
                    742:                     if (slct.type == 'hidden') {
                    743:                         slct.value = fixeddom;
1.876     raeburn   744:                     }
                    745:                 }
1.468     raeburn   746:             }
                    747:         }
                    748:     }
1.876     raeburn   749:     return;
                    750: }
                    751: 
                    752: $id_functions
                    753: ENDUSERBRW
1.468     raeburn   754: }
                    755: 
                    756: sub setsec_javascript {
1.1116    raeburn   757:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   758:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    759:         $communityrolestr);
                    760:     if ($role_element ne '') {
                    761:         my @allroles = ('st','ta','ep','in','ad');
                    762:         foreach my $crstype ('Course','Community') {
                    763:             if ($crstype eq 'Community') {
                    764:                 foreach my $role (@allroles) {
                    765:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    766:                 }
                    767:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    768:             } else {
                    769:                 foreach my $role (@allroles) {
                    770:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    771:                 }
                    772:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    773:             }
                    774:         }
                    775:         $rolestr = '"'.join('","',@allroles).'"';
                    776:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    777:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    778:     }
1.468     raeburn   779:     my $setsections = qq|
                    780: function setSect(sectionlist) {
1.629     raeburn   781:     var sectionsArray = new Array();
                    782:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    783:         sectionsArray = sectionlist.split(",");
                    784:     }
1.468     raeburn   785:     var numSections = sectionsArray.length;
                    786:     document.$formname.$sec_element.length = 0;
                    787:     if (numSections == 0) {
                    788:         document.$formname.$sec_element.multiple=false;
                    789:         document.$formname.$sec_element.size=1;
                    790:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    791:     } else {
                    792:         if (numSections == 1) {
                    793:             document.$formname.$sec_element.multiple=false;
                    794:             document.$formname.$sec_element.size=1;
                    795:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    796:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    797:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    798:         } else {
                    799:             for (var i=0; i<numSections; i++) {
                    800:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    801:             }
                    802:             document.$formname.$sec_element.multiple=true
                    803:             if (numSections < 3) {
                    804:                 document.$formname.$sec_element.size=numSections;
                    805:             } else {
                    806:                 document.$formname.$sec_element.size=3;
                    807:             }
                    808:             document.$formname.$sec_element.options[0].selected = false
                    809:         }
                    810:     }
1.91      www       811: }
1.905     raeburn   812: 
                    813: function setRole(crstype) {
1.468     raeburn   814: |;
1.905     raeburn   815:     if ($role_element eq '') {
                    816:         $setsections .= '    return;
                    817: }
                    818: ';
                    819:     } else {
                    820:         $setsections .= qq|
                    821:     var elementLength = document.$formname.$role_element.length;
                    822:     var allroles = Array($rolestr);
                    823:     var courserolenames = Array($courserolestr);
                    824:     var communityrolenames = Array($communityrolestr);
                    825:     if (elementLength != undefined) {
                    826:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    827:             if (crstype == 'Course') {
                    828:                 return;
                    829:             } else {
                    830:                 allroles[5] = 'co';
                    831:                 for (var i=0; i<6; i++) {
                    832:                     document.$formname.$role_element.options[i].value = allroles[i];
                    833:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    834:                 }
                    835:             }
                    836:         } else {
                    837:             if (crstype == 'Community') {
                    838:                 return;
                    839:             } else {
                    840:                 allroles[5] = 'cc';
                    841:                 for (var i=0; i<6; i++) {
                    842:                     document.$formname.$role_element.options[i].value = allroles[i];
                    843:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    844:                 }
                    845:             }
                    846:         }
                    847:     }
                    848:     return;
                    849: }
                    850: |;
                    851:     }
1.1116    raeburn   852:     if ($credits_element) {
                    853:         $setsections .= qq|
                    854: function setCredits(defaultcredits) {
                    855:     document.$formname.$credits_element.value = defaultcredits;
                    856:     return;
                    857: }
                    858: |;
                    859:     }
1.468     raeburn   860:     return $setsections;
                    861: }
                    862: 
1.91      www       863: sub selectcourse_link {
1.909     raeburn   864:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    865:        $typeelement) = @_;
                    866:    my $type = $selecttype;
1.871     raeburn   867:    my $linktext = &mt('Select Course');
                    868:    if ($selecttype eq 'Community') {
1.909     raeburn   869:        $linktext = &mt('Select Community');
1.906     raeburn   870:    } elsif ($selecttype eq 'Course/Community') {
                    871:        $linktext = &mt('Select Course/Community');
1.909     raeburn   872:        $type = '';
1.1019    raeburn   873:    } elsif ($selecttype eq 'Select') {
                    874:        $linktext = &mt('Select');
                    875:        $type = '';
1.871     raeburn   876:    }
1.787     bisitz    877:    return '<span class="LC_nobreak">'
                    878:          ."<a href='"
                    879:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    880:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   881:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   882:          ."'>".$linktext.'</a>'
1.787     bisitz    883:          .'</span>';
1.74      www       884: }
1.42      matthew   885: 
1.653     raeburn   886: sub selectauthor_link {
                    887:    my ($form,$udom)=@_;
                    888:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    889:           &mt('Select Author').'</a>';
                    890: }
                    891: 
1.876     raeburn   892: sub selectuser_link {
1.881     raeburn   893:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   894:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   895:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   896:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   897:            ');">'.$linktext.'</a>';
1.876     raeburn   898: }
                    899: 
1.273     raeburn   900: sub check_uncheck_jscript {
                    901:     my $jscript = <<"ENDSCRT";
                    902: function checkAll(field) {
                    903:     if (field.length > 0) {
                    904:         for (i = 0; i < field.length; i++) {
1.1093    raeburn   905:             if (!field[i].disabled) { 
                    906:                 field[i].checked = true;
                    907:             }
1.273     raeburn   908:         }
                    909:     } else {
1.1093    raeburn   910:         if (!field.disabled) { 
                    911:             field.checked = true;
                    912:         }
1.273     raeburn   913:     }
                    914: }
                    915:  
                    916: function uncheckAll(field) {
                    917:     if (field.length > 0) {
                    918:         for (i = 0; i < field.length; i++) {
                    919:             field[i].checked = false ;
1.543     albertel  920:         }
                    921:     } else {
1.273     raeburn   922:         field.checked = false ;
                    923:     }
                    924: }
                    925: ENDSCRT
                    926:     return $jscript;
                    927: }
                    928: 
1.656     www       929: sub select_timezone {
1.659     raeburn   930:    my ($name,$selected,$onchange,$includeempty)=@_;
                    931:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    932:    if ($includeempty) {
                    933:        $output .= '<option value=""';
                    934:        if (($selected eq '') || ($selected eq 'local')) {
                    935:            $output .= ' selected="selected" ';
                    936:        }
                    937:        $output .= '> </option>';
                    938:    }
1.657     raeburn   939:    my @timezones = DateTime::TimeZone->all_names;
                    940:    foreach my $tzone (@timezones) {
                    941:        $output.= '<option value="'.$tzone.'"';
                    942:        if ($tzone eq $selected) {
                    943:            $output.=' selected="selected"';
                    944:        }
                    945:        $output.=">$tzone</option>\n";
1.656     www       946:    }
                    947:    $output.="</select>";
                    948:    return $output;
                    949: }
1.273     raeburn   950: 
1.687     raeburn   951: sub select_datelocale {
                    952:     my ($name,$selected,$onchange,$includeempty)=@_;
                    953:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    954:     if ($includeempty) {
                    955:         $output .= '<option value=""';
                    956:         if ($selected eq '') {
                    957:             $output .= ' selected="selected" ';
                    958:         }
                    959:         $output .= '> </option>';
                    960:     }
                    961:     my (@possibles,%locale_names);
                    962:     my @locales = DateTime::Locale::Catalog::Locales;
                    963:     foreach my $locale (@locales) {
                    964:         if (ref($locale) eq 'HASH') {
                    965:             my $id = $locale->{'id'};
                    966:             if ($id ne '') {
                    967:                 my $en_terr = $locale->{'en_territory'};
                    968:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   969:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   970:                 if (grep(/^en$/,@languages) || !@languages) {
                    971:                     if ($en_terr ne '') {
                    972:                         $locale_names{$id} = '('.$en_terr.')';
                    973:                     } elsif ($native_terr ne '') {
                    974:                         $locale_names{$id} = $native_terr;
                    975:                     }
                    976:                 } else {
                    977:                     if ($native_terr ne '') {
                    978:                         $locale_names{$id} = $native_terr.' ';
                    979:                     } elsif ($en_terr ne '') {
                    980:                         $locale_names{$id} = '('.$en_terr.')';
                    981:                     }
                    982:                 }
                    983:                 push (@possibles,$id);
                    984:             }
                    985:         }
                    986:     }
                    987:     foreach my $item (sort(@possibles)) {
                    988:         $output.= '<option value="'.$item.'"';
                    989:         if ($item eq $selected) {
                    990:             $output.=' selected="selected"';
                    991:         }
                    992:         $output.=">$item";
                    993:         if ($locale_names{$item} ne '') {
                    994:             $output.="  $locale_names{$item}</option>\n";
                    995:         }
                    996:         $output.="</option>\n";
                    997:     }
                    998:     $output.="</select>";
                    999:     return $output;
                   1000: }
                   1001: 
1.792     raeburn  1002: sub select_language {
                   1003:     my ($name,$selected,$includeempty) = @_;
                   1004:     my %langchoices;
                   1005:     if ($includeempty) {
1.1117    raeburn  1006:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1007:     }
                   1008:     foreach my $id (&languageids()) {
                   1009:         my $code = &supportedlanguagecode($id);
                   1010:         if ($code) {
                   1011:             $langchoices{$code} = &plainlanguagedescription($id);
                   1012:         }
                   1013:     }
1.1117    raeburn  1014:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.970     raeburn  1015:     return &select_form($selected,$name,\%langchoices);
1.792     raeburn  1016: }
                   1017: 
1.42      matthew  1018: =pod
1.36      matthew  1019: 
1.1088    foxr     1020: 
                   1021: =item * &list_languages()
                   1022: 
                   1023: Returns an array reference that is suitable for use in language prompters.
                   1024: Each array element is itself a two element array.  The first element
                   1025: is the language code.  The second element a descsriptiuon of the 
                   1026: language itself.  This is suitable for use in e.g.
                   1027: &Apache::edit::select_arg (once dereferenced that is).
                   1028: 
                   1029: =cut 
                   1030: 
                   1031: sub list_languages {
                   1032:     my @lang_choices;
                   1033: 
                   1034:     foreach my $id (&languageids()) {
                   1035: 	my $code = &supportedlanguagecode($id);
                   1036: 	if ($code) {
                   1037: 	    my $selector    = $supported_codes{$id};
                   1038: 	    my $description = &plainlanguagedescription($id);
                   1039: 	    push (@lang_choices, [$selector, $description]);
                   1040: 	}
                   1041:     }
                   1042:     return \@lang_choices;
                   1043: }
                   1044: 
                   1045: =pod
                   1046: 
1.648     raeburn  1047: =item * &linked_select_forms(...)
1.36      matthew  1048: 
                   1049: linked_select_forms returns a string containing a <script></script> block
                   1050: and html for two <select> menus.  The select menus will be linked in that
                   1051: changing the value of the first menu will result in new values being placed
                   1052: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1053: order unless a defined order is provided.
1.36      matthew  1054: 
                   1055: linked_select_forms takes the following ordered inputs:
                   1056: 
                   1057: =over 4
                   1058: 
1.112     bowersj2 1059: =item * $formname, the name of the <form> tag
1.36      matthew  1060: 
1.112     bowersj2 1061: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1062: 
1.112     bowersj2 1063: =item * $firstdefault, the default value for the first menu
1.36      matthew  1064: 
1.112     bowersj2 1065: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1066: 
1.112     bowersj2 1067: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1068: 
1.112     bowersj2 1069: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1070: 
1.609     raeburn  1071: =item * $menuorder, the order of values in the first menu
                   1072: 
1.1115    raeburn  1073: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1074:         event for the first <select> tag
                   1075: 
                   1076: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1077:         event for the second <select> tag
                   1078: 
1.41      ng       1079: =back 
                   1080: 
1.36      matthew  1081: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1082: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1083: values for the first select menu.  The text that coincides with the 
1.41      ng       1084: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1085: and text for the second menu are given in the hash pointed to by 
                   1086: $menu{$choice1}->{'select2'}.  
                   1087: 
1.112     bowersj2 1088:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1089:                        default => "B3",
                   1090:                        select2 => { 
                   1091:                            B1 => "Choice B1",
                   1092:                            B2 => "Choice B2",
                   1093:                            B3 => "Choice B3",
                   1094:                            B4 => "Choice B4"
1.609     raeburn  1095:                            },
                   1096:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1097:                    },
                   1098:                A2 => { text =>"Choice A2" ,
                   1099:                        default => "C2",
                   1100:                        select2 => { 
                   1101:                            C1 => "Choice C1",
                   1102:                            C2 => "Choice C2",
                   1103:                            C3 => "Choice C3"
1.609     raeburn  1104:                            },
                   1105:                        order => ['C2','C1','C3'],
1.112     bowersj2 1106:                    },
                   1107:                A3 => { text =>"Choice A3" ,
                   1108:                        default => "D6",
                   1109:                        select2 => { 
                   1110:                            D1 => "Choice D1",
                   1111:                            D2 => "Choice D2",
                   1112:                            D3 => "Choice D3",
                   1113:                            D4 => "Choice D4",
                   1114:                            D5 => "Choice D5",
                   1115:                            D6 => "Choice D6",
                   1116:                            D7 => "Choice D7"
1.609     raeburn  1117:                            },
                   1118:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1119:                    }
                   1120:                );
1.36      matthew  1121: 
                   1122: =cut
                   1123: 
                   1124: sub linked_select_forms {
                   1125:     my ($formname,
                   1126:         $middletext,
                   1127:         $firstdefault,
                   1128:         $firstselectname,
                   1129:         $secondselectname, 
1.609     raeburn  1130:         $hashref,
                   1131:         $menuorder,
1.1115    raeburn  1132:         $onchangefirst,
                   1133:         $onchangesecond
1.36      matthew  1134:         ) = @_;
                   1135:     my $second = "document.$formname.$secondselectname";
                   1136:     my $first = "document.$formname.$firstselectname";
                   1137:     # output the javascript to do the changing
                   1138:     my $result = '';
1.776     bisitz   1139:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1140:     $result.="// <![CDATA[\n";
1.36      matthew  1141:     $result.="var select2data = new Object();\n";
                   1142:     $" = '","';
                   1143:     my $debug = '';
                   1144:     foreach my $s1 (sort(keys(%$hashref))) {
                   1145:         $result.="select2data.d_$s1 = new Object();\n";        
                   1146:         $result.="select2data.d_$s1.def = new String('".
                   1147:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1148:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1149:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1150:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1151:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1152:         }
1.36      matthew  1153:         $result.="\"@s2values\");\n";
                   1154:         $result.="select2data.d_$s1.texts = new Array(";        
                   1155:         my @s2texts;
                   1156:         foreach my $value (@s2values) {
                   1157:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1158:         }
                   1159:         $result.="\"@s2texts\");\n";
                   1160:     }
                   1161:     $"=' ';
                   1162:     $result.= <<"END";
                   1163: 
                   1164: function select1_changed() {
                   1165:     // Determine new choice
                   1166:     var newvalue = "d_" + $first.value;
                   1167:     // update select2
                   1168:     var values     = select2data[newvalue].values;
                   1169:     var texts      = select2data[newvalue].texts;
                   1170:     var select2def = select2data[newvalue].def;
                   1171:     var i;
                   1172:     // out with the old
                   1173:     for (i = 0; i < $second.options.length; i++) {
                   1174:         $second.options[i] = null;
                   1175:     }
                   1176:     // in with the nuclear
                   1177:     for (i=0;i<values.length; i++) {
                   1178:         $second.options[i] = new Option(values[i]);
1.143     matthew  1179:         $second.options[i].value = values[i];
1.36      matthew  1180:         $second.options[i].text = texts[i];
                   1181:         if (values[i] == select2def) {
                   1182:             $second.options[i].selected = true;
                   1183:         }
                   1184:     }
                   1185: }
1.824     bisitz   1186: // ]]>
1.36      matthew  1187: </script>
                   1188: END
                   1189:     # output the initial values for the selection lists
1.1115    raeburn  1190:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1191:     my @order = sort(keys(%{$hashref}));
                   1192:     if (ref($menuorder) eq 'ARRAY') {
                   1193:         @order = @{$menuorder};
                   1194:     }
                   1195:     foreach my $value (@order) {
1.36      matthew  1196:         $result.="    <option value=\"$value\" ";
1.253     albertel 1197:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1198:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1199:     }
                   1200:     $result .= "</select>\n";
                   1201:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1202:     $result .= $middletext;
1.1115    raeburn  1203:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1204:     if ($onchangesecond) {
                   1205:         $result .= ' onchange="'.$onchangesecond.'"';
                   1206:     }
                   1207:     $result .= ">\n";
1.36      matthew  1208:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1209:     
                   1210:     my @secondorder = sort(keys(%select2));
                   1211:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1212:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1213:     }
                   1214:     foreach my $value (@secondorder) {
1.36      matthew  1215:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1216:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1217:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1218:     }
                   1219:     $result .= "</select>\n";
                   1220:     #    return $debug;
                   1221:     return $result;
                   1222: }   #  end of sub linked_select_forms {
                   1223: 
1.45      matthew  1224: =pod
1.44      bowersj2 1225: 
1.973     raeburn  1226: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1227: 
1.112     bowersj2 1228: Returns a string corresponding to an HTML link to the given help
                   1229: $topic, where $topic corresponds to the name of a .tex file in
                   1230: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1231: spaces. 
                   1232: 
                   1233: $text will optionally be linked to the same topic, allowing you to
                   1234: link text in addition to the graphic. If you do not want to link
                   1235: text, but wish to specify one of the later parameters, pass an
                   1236: empty string. 
                   1237: 
                   1238: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1239: the link will not open a new window. If false, the link will open
                   1240: a new window using Javascript. (Default is false.) 
                   1241: 
                   1242: $width and $height are optional numerical parameters that will
                   1243: override the width and height of the popped up window, which may
1.973     raeburn  1244: be useful for certain help topics with big pictures included.
                   1245: 
                   1246: $imgid is the id of the img tag used for the help icon. This may be
                   1247: used in a javascript call to switch the image src.  See 
                   1248: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1249: 
                   1250: =cut
                   1251: 
                   1252: sub help_open_topic {
1.973     raeburn  1253:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1254:     $text = "" if (not defined $text);
1.44      bowersj2 1255:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1256:     $width = 500 if (not defined $width);
1.44      bowersj2 1257:     $height = 400 if (not defined $height);
                   1258:     my $filename = $topic;
                   1259:     $filename =~ s/ /_/g;
                   1260: 
1.48      bowersj2 1261:     my $template = "";
                   1262:     my $link;
1.572     banghart 1263:     
1.159     www      1264:     $topic=~s/\W/\_/g;
1.44      bowersj2 1265: 
1.572     banghart 1266:     if (!$stayOnPage) {
1.1033    www      1267: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1268:     } elsif ($stayOnPage eq 'popup') {
                   1269:         $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 1270:     } else {
1.48      bowersj2 1271: 	$link = "/adm/help/${filename}.hlp";
                   1272:     }
                   1273: 
                   1274:     # Add the text
1.755     neumanie 1275:     if ($text ne "") {	
1.763     bisitz   1276: 	$template.='<span class="LC_help_open_topic">'
                   1277:                   .'<a target="_top" href="'.$link.'">'
                   1278:                   .$text.'</a>';
1.48      bowersj2 1279:     }
                   1280: 
1.763     bisitz   1281:     # (Always) Add the graphic
1.179     matthew  1282:     my $title = &mt('Online Help');
1.667     raeburn  1283:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1284:     if ($imgid ne '') {
                   1285:         $imgid = ' id="'.$imgid.'"';
                   1286:     }
1.763     bisitz   1287:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1288:               .'<img src="'.$helpicon.'" border="0"'
                   1289:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1290:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1291:               .' /></a>';
                   1292:     if ($text ne "") {	
                   1293:         $template.='</span>';
                   1294:     }
1.44      bowersj2 1295:     return $template;
                   1296: 
1.106     bowersj2 1297: }
                   1298: 
                   1299: # This is a quicky function for Latex cheatsheet editing, since it 
                   1300: # appears in at least four places
                   1301: sub helpLatexCheatsheet {
1.1037    www      1302:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1303:     my $out;
1.106     bowersj2 1304:     my $addOther = '';
1.732     raeburn  1305:     if ($topic) {
1.1037    www      1306: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1307:     }
                   1308:     $out = '<span>' # Start cheatsheet
                   1309: 	  .$addOther
                   1310:           .'<span>'
1.1037    www      1311: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1312: 	  .'</span> <span>'
1.1037    www      1313: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1314: 	  .'</span>';
1.732     raeburn  1315:     unless ($not_author) {
1.763     bisitz   1316:         $out .= ' <span>'
1.1037    www      1317: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.763     bisitz   1318: 	       .'</span>';
1.732     raeburn  1319:     }
1.763     bisitz   1320:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1321:     return $out;
1.172     www      1322: }
                   1323: 
1.430     albertel 1324: sub general_help {
                   1325:     my $helptopic='Student_Intro';
                   1326:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1327: 	$helptopic='Authoring_Intro';
1.907     raeburn  1328:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1329: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1330:     } elsif ($env{'request.role'}=~/^dc/) {
                   1331:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1332:     }
                   1333:     return $helptopic;
                   1334: }
                   1335: 
                   1336: sub update_help_link {
                   1337:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1338:     my $origurl = $ENV{'REQUEST_URI'};
                   1339:     $origurl=~s|^/~|/priv/|;
                   1340:     my $timestamp = time;
                   1341:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1342:         $$datum = &escape($$datum);
                   1343:     }
                   1344: 
                   1345:     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";
                   1346:     my $output .= <<"ENDOUTPUT";
                   1347: <script type="text/javascript">
1.824     bisitz   1348: // <![CDATA[
1.430     albertel 1349: banner_link = '$banner_link';
1.824     bisitz   1350: // ]]>
1.430     albertel 1351: </script>
                   1352: ENDOUTPUT
                   1353:     return $output;
                   1354: }
                   1355: 
                   1356: # now just updates the help link and generates a blue icon
1.193     raeburn  1357: sub help_open_menu {
1.430     albertel 1358:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1359: 	= @_;    
1.949     droeschl 1360:     $stayOnPage = 1;
1.430     albertel 1361:     my $output;
                   1362:     if ($component_help) {
                   1363: 	if (!$text) {
                   1364: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1365: 				       $width,$height);
                   1366: 	} else {
                   1367: 	    my $help_text;
                   1368: 	    $help_text=&unescape($topic);
                   1369: 	    $output='<table><tr><td>'.
                   1370: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1371: 				 $width,$height).'</td></tr></table>';
                   1372: 	}
                   1373:     }
                   1374:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1375:     return $output.$banner_link;
                   1376: }
                   1377: 
                   1378: sub top_nav_help {
                   1379:     my ($text) = @_;
1.436     albertel 1380:     $text = &mt($text);
1.949     droeschl 1381:     my $stay_on_page = 1;
                   1382: 
1.572     banghart 1383:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1384: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1385:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1386: 
1.201     raeburn  1387:     my $title = &mt('Get help');
1.436     albertel 1388: 
                   1389:     return <<"END";
                   1390: $banner_link
                   1391:  <a href="$link" title="$title">$text</a>
                   1392: END
                   1393: }
                   1394: 
                   1395: sub help_menu_js {
                   1396:     my ($text) = @_;
1.949     droeschl 1397:     my $stayOnPage = 1;
1.436     albertel 1398:     my $width = 620;
                   1399:     my $height = 600;
1.430     albertel 1400:     my $helptopic=&general_help();
                   1401:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1402:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1403:     my $start_page =
                   1404:         &Apache::loncommon::start_page('Help Menu', undef,
                   1405: 				       {'frameset'    => 1,
                   1406: 					'js_ready'    => 1,
                   1407: 					'add_entries' => {
                   1408: 					    'border' => '0',
1.579     raeburn  1409: 					    'rows'   => "110,*",},});
1.331     albertel 1410:     my $end_page =
                   1411:         &Apache::loncommon::end_page({'frameset' => 1,
                   1412: 				      'js_ready' => 1,});
                   1413: 
1.436     albertel 1414:     my $template .= <<"ENDTEMPLATE";
                   1415: <script type="text/javascript">
1.877     bisitz   1416: // <![CDATA[
1.253     albertel 1417: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1418: var banner_link = '';
1.243     raeburn  1419: function helpMenu(target) {
                   1420:     var caller = this;
                   1421:     if (target == 'open') {
                   1422:         var newWindow = null;
                   1423:         try {
1.262     albertel 1424:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1425:         }
                   1426:         catch(error) {
                   1427:             writeHelp(caller);
                   1428:             return;
                   1429:         }
                   1430:         if (newWindow) {
                   1431:             caller = newWindow;
                   1432:         }
1.193     raeburn  1433:     }
1.243     raeburn  1434:     writeHelp(caller);
                   1435:     return;
                   1436: }
                   1437: function writeHelp(caller) {
1.1072    raeburn  1438:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" />\\n<frame name="bodyframe" src="$details_link" />\\n$end_page')
1.243     raeburn  1439:     caller.document.close()
                   1440:     caller.focus()
1.193     raeburn  1441: }
1.877     bisitz   1442: // END LON-CAPA Internal -->
1.253     albertel 1443: // ]]>
1.436     albertel 1444: </script>
1.193     raeburn  1445: ENDTEMPLATE
                   1446:     return $template;
                   1447: }
                   1448: 
1.172     www      1449: sub help_open_bug {
                   1450:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1451:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1452:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1453:     $text = "" if (not defined $text);
                   1454: 	$stayOnPage=1;
1.184     albertel 1455:     $width = 600 if (not defined $width);
                   1456:     $height = 600 if (not defined $height);
1.172     www      1457: 
                   1458:     $topic=~s/\W+/\+/g;
                   1459:     my $link='';
                   1460:     my $template='';
1.379     albertel 1461:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1462: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1463:     if (!$stayOnPage)
                   1464:     {
                   1465: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1466:     }
                   1467:     else
                   1468:     {
                   1469: 	$link = $url;
                   1470:     }
                   1471:     # Add the text
                   1472:     if ($text ne "")
                   1473:     {
                   1474: 	$template .= 
                   1475:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1476:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1477:     }
                   1478: 
                   1479:     # Add the graphic
1.179     matthew  1480:     my $title = &mt('Report a Bug');
1.215     albertel 1481:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1482:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1483:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1484: ENDTEMPLATE
                   1485:     if ($text ne '') { $template.='</td></tr></table>' };
                   1486:     return $template;
                   1487: 
                   1488: }
                   1489: 
                   1490: sub help_open_faq {
                   1491:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1492:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1493:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1494:     $text = "" if (not defined $text);
                   1495: 	$stayOnPage=1;
                   1496:     $width = 350 if (not defined $width);
                   1497:     $height = 400 if (not defined $height);
                   1498: 
                   1499:     $topic=~s/\W+/\+/g;
                   1500:     my $link='';
                   1501:     my $template='';
                   1502:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1503:     if (!$stayOnPage)
                   1504:     {
                   1505: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1506:     }
                   1507:     else
                   1508:     {
                   1509: 	$link = $url;
                   1510:     }
                   1511: 
                   1512:     # Add the text
                   1513:     if ($text ne "")
                   1514:     {
                   1515: 	$template .= 
1.173     www      1516:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1517:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1518:     }
                   1519: 
                   1520:     # Add the graphic
1.179     matthew  1521:     my $title = &mt('View the FAQ');
1.215     albertel 1522:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1523:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1524:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1525: ENDTEMPLATE
                   1526:     if ($text ne '') { $template.='</td></tr></table>' };
                   1527:     return $template;
                   1528: 
1.44      bowersj2 1529: }
1.37      matthew  1530: 
1.180     matthew  1531: ###############################################################
                   1532: ###############################################################
                   1533: 
1.45      matthew  1534: =pod
                   1535: 
1.648     raeburn  1536: =item * &change_content_javascript():
1.256     matthew  1537: 
                   1538: This and the next function allow you to create small sections of an
                   1539: otherwise static HTML page that you can update on the fly with
                   1540: Javascript, even in Netscape 4.
                   1541: 
                   1542: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1543: must be written to the HTML page once. It will prove the Javascript
                   1544: function "change(name, content)". Calling the change function with the
                   1545: name of the section 
                   1546: you want to update, matching the name passed to C<changable_area>, and
                   1547: the new content you want to put in there, will put the content into
                   1548: that area.
                   1549: 
                   1550: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1551: to contain room for the original contents. You need to "make space"
                   1552: for whatever changes you wish to make, and be B<sure> to check your
                   1553: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1554: it's adequate for updating a one-line status display, but little more.
                   1555: This script will set the space to 100% width, so you only need to
                   1556: worry about height in Netscape 4.
                   1557: 
                   1558: Modern browsers are much less limiting, and if you can commit to the
                   1559: user not using Netscape 4, this feature may be used freely with
                   1560: pretty much any HTML.
                   1561: 
                   1562: =cut
                   1563: 
                   1564: sub change_content_javascript {
                   1565:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1566:     if ($env{'browser.type'} eq 'netscape' &&
                   1567: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1568: 	return (<<NETSCAPE4);
                   1569: 	function change(name, content) {
                   1570: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1571: 	    doc.open();
                   1572: 	    doc.write(content);
                   1573: 	    doc.close();
                   1574: 	}
                   1575: NETSCAPE4
                   1576:     } else {
                   1577: 	# Otherwise, we need to use semi-standards-compliant code
                   1578: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1579: 	# is really scary, and every useful browser supports it
                   1580: 	return (<<DOMBASED);
                   1581: 	function change(name, content) {
                   1582: 	    element = document.getElementById(name);
                   1583: 	    element.innerHTML = content;
                   1584: 	}
                   1585: DOMBASED
                   1586:     }
                   1587: }
                   1588: 
                   1589: =pod
                   1590: 
1.648     raeburn  1591: =item * &changable_area($name,$origContent):
1.256     matthew  1592: 
                   1593: This provides a "changable area" that can be modified on the fly via
                   1594: the Javascript code provided in C<change_content_javascript>. $name is
                   1595: the name you will use to reference the area later; do not repeat the
                   1596: same name on a given HTML page more then once. $origContent is what
                   1597: the area will originally contain, which can be left blank.
                   1598: 
                   1599: =cut
                   1600: 
                   1601: sub changable_area {
                   1602:     my ($name, $origContent) = @_;
                   1603: 
1.258     albertel 1604:     if ($env{'browser.type'} eq 'netscape' &&
                   1605: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1606: 	# If this is netscape 4, we need to use the Layer tag
                   1607: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1608:     } else {
                   1609: 	return "<span id='$name'>$origContent</span>";
                   1610:     }
                   1611: }
                   1612: 
                   1613: =pod
                   1614: 
1.648     raeburn  1615: =item * &viewport_geometry_js 
1.590     raeburn  1616: 
                   1617: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1618: 
                   1619: =cut
                   1620: 
                   1621: 
                   1622: sub viewport_geometry_js { 
                   1623:     return <<"GEOMETRY";
                   1624: var Geometry = {};
                   1625: function init_geometry() {
                   1626:     if (Geometry.init) { return };
                   1627:     Geometry.init=1;
                   1628:     if (window.innerHeight) {
                   1629:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1630:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1631:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1632:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1633:     }
                   1634:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1635:         Geometry.getViewportHeight =
                   1636:             function() { return document.documentElement.clientHeight; };
                   1637:         Geometry.getViewportWidth =
                   1638:             function() { return document.documentElement.clientWidth; };
                   1639: 
                   1640:         Geometry.getHorizontalScroll =
                   1641:             function() { return document.documentElement.scrollLeft; };
                   1642:         Geometry.getVerticalScroll =
                   1643:             function() { return document.documentElement.scrollTop; };
                   1644:     }
                   1645:     else if (document.body.clientHeight) {
                   1646:         Geometry.getViewportHeight =
                   1647:             function() { return document.body.clientHeight; };
                   1648:         Geometry.getViewportWidth =
                   1649:             function() { return document.body.clientWidth; };
                   1650:         Geometry.getHorizontalScroll =
                   1651:             function() { return document.body.scrollLeft; };
                   1652:         Geometry.getVerticalScroll =
                   1653:             function() { return document.body.scrollTop; };
                   1654:     }
                   1655: }
                   1656: 
                   1657: GEOMETRY
                   1658: }
                   1659: 
                   1660: =pod
                   1661: 
1.648     raeburn  1662: =item * &viewport_size_js()
1.590     raeburn  1663: 
                   1664: 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. 
                   1665: 
                   1666: =cut
                   1667: 
                   1668: sub viewport_size_js {
                   1669:     my $geometry = &viewport_geometry_js();
                   1670:     return <<"DIMS";
                   1671: 
                   1672: $geometry
                   1673: 
                   1674: function getViewportDims(width,height) {
                   1675:     init_geometry();
                   1676:     width.value = Geometry.getViewportWidth();
                   1677:     height.value = Geometry.getViewportHeight();
                   1678:     return;
                   1679: }
                   1680: 
                   1681: DIMS
                   1682: }
                   1683: 
                   1684: =pod
                   1685: 
1.648     raeburn  1686: =item * &resize_textarea_js()
1.565     albertel 1687: 
                   1688: emits the needed javascript to resize a textarea to be as big as possible
                   1689: 
                   1690: creates a function resize_textrea that takes two IDs first should be
                   1691: the id of the element to resize, second should be the id of a div that
                   1692: surrounds everything that comes after the textarea, this routine needs
                   1693: to be attached to the <body> for the onload and onresize events.
                   1694: 
1.648     raeburn  1695: =back
1.565     albertel 1696: 
                   1697: =cut
                   1698: 
                   1699: sub resize_textarea_js {
1.590     raeburn  1700:     my $geometry = &viewport_geometry_js();
1.565     albertel 1701:     return <<"RESIZE";
                   1702:     <script type="text/javascript">
1.824     bisitz   1703: // <![CDATA[
1.590     raeburn  1704: $geometry
1.565     albertel 1705: 
1.588     albertel 1706: function getX(element) {
                   1707:     var x = 0;
                   1708:     while (element) {
                   1709: 	x += element.offsetLeft;
                   1710: 	element = element.offsetParent;
                   1711:     }
                   1712:     return x;
                   1713: }
                   1714: function getY(element) {
                   1715:     var y = 0;
                   1716:     while (element) {
                   1717: 	y += element.offsetTop;
                   1718: 	element = element.offsetParent;
                   1719:     }
                   1720:     return y;
                   1721: }
                   1722: 
                   1723: 
1.565     albertel 1724: function resize_textarea(textarea_id,bottom_id) {
                   1725:     init_geometry();
                   1726:     var textarea        = document.getElementById(textarea_id);
                   1727:     //alert(textarea);
                   1728: 
1.588     albertel 1729:     var textarea_top    = getY(textarea);
1.565     albertel 1730:     var textarea_height = textarea.offsetHeight;
                   1731:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1732:     var bottom_top      = getY(bottom);
1.565     albertel 1733:     var bottom_height   = bottom.offsetHeight;
                   1734:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1735:     var fudge           = 23;
1.565     albertel 1736:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1737:     if (new_height < 300) {
                   1738: 	new_height = 300;
                   1739:     }
                   1740:     textarea.style.height=new_height+'px';
                   1741: }
1.824     bisitz   1742: // ]]>
1.565     albertel 1743: </script>
                   1744: RESIZE
                   1745: 
                   1746: }
                   1747: 
                   1748: =pod
                   1749: 
1.256     matthew  1750: =head1 Excel and CSV file utility routines
                   1751: 
                   1752: =over 4
                   1753: 
                   1754: =cut
                   1755: 
                   1756: ###############################################################
                   1757: ###############################################################
                   1758: 
                   1759: =pod
                   1760: 
1.648     raeburn  1761: =item * &csv_translate($text) 
1.37      matthew  1762: 
1.185     www      1763: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1764: format.
                   1765: 
                   1766: =cut
                   1767: 
1.180     matthew  1768: ###############################################################
                   1769: ###############################################################
1.37      matthew  1770: sub csv_translate {
                   1771:     my $text = shift;
                   1772:     $text =~ s/\"/\"\"/g;
1.209     albertel 1773:     $text =~ s/\n/ /g;
1.37      matthew  1774:     return $text;
                   1775: }
1.180     matthew  1776: 
                   1777: ###############################################################
                   1778: ###############################################################
                   1779: 
                   1780: =pod
                   1781: 
1.648     raeburn  1782: =item * &define_excel_formats()
1.180     matthew  1783: 
                   1784: Define some commonly used Excel cell formats.
                   1785: 
                   1786: Currently supported formats:
                   1787: 
                   1788: =over 4
                   1789: 
                   1790: =item header
                   1791: 
                   1792: =item bold
                   1793: 
                   1794: =item h1
                   1795: 
                   1796: =item h2
                   1797: 
                   1798: =item h3
                   1799: 
1.256     matthew  1800: =item h4
                   1801: 
                   1802: =item i
                   1803: 
1.180     matthew  1804: =item date
                   1805: 
                   1806: =back
                   1807: 
                   1808: Inputs: $workbook
                   1809: 
                   1810: Returns: $format, a hash reference.
                   1811: 
1.1057    foxr     1812: 
1.180     matthew  1813: =cut
                   1814: 
                   1815: ###############################################################
                   1816: ###############################################################
                   1817: sub define_excel_formats {
                   1818:     my ($workbook) = @_;
                   1819:     my $format;
                   1820:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1821:                                                 bottom    => 1,
                   1822:                                                 align     => 'center');
                   1823:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1824:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1825:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1826:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1827:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1828:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1829:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1830:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1831:     return $format;
                   1832: }
                   1833: 
                   1834: ###############################################################
                   1835: ###############################################################
1.113     bowersj2 1836: 
                   1837: =pod
                   1838: 
1.648     raeburn  1839: =item * &create_workbook()
1.255     matthew  1840: 
                   1841: Create an Excel worksheet.  If it fails, output message on the
                   1842: request object and return undefs.
                   1843: 
                   1844: Inputs: Apache request object
                   1845: 
                   1846: Returns (undef) on failure, 
                   1847:     Excel worksheet object, scalar with filename, and formats 
                   1848:     from &Apache::loncommon::define_excel_formats on success
                   1849: 
                   1850: =cut
                   1851: 
                   1852: ###############################################################
                   1853: ###############################################################
                   1854: sub create_workbook {
                   1855:     my ($r) = @_;
                   1856:         #
                   1857:     # Create the excel spreadsheet
                   1858:     my $filename = '/prtspool/'.
1.258     albertel 1859:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1860:         time.'_'.rand(1000000000).'.xls';
                   1861:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1862:     if (! defined($workbook)) {
                   1863:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   1864:         $r->print(
                   1865:             '<p class="LC_error">'
                   1866:            .&mt('Problems occurred in creating the new Excel file.')
                   1867:            .' '.&mt('This error has been logged.')
                   1868:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1869:            .'</p>'
                   1870:         );
1.255     matthew  1871:         return (undef);
                   1872:     }
                   1873:     #
1.1014    foxr     1874:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  1875:     #
                   1876:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1877:     return ($workbook,$filename,$format);
                   1878: }
                   1879: 
                   1880: ###############################################################
                   1881: ###############################################################
                   1882: 
                   1883: =pod
                   1884: 
1.648     raeburn  1885: =item * &create_text_file()
1.113     bowersj2 1886: 
1.542     raeburn  1887: Create a file to write to and eventually make available to the user.
1.256     matthew  1888: If file creation fails, outputs an error message on the request object and 
                   1889: return undefs.
1.113     bowersj2 1890: 
1.256     matthew  1891: Inputs: Apache request object, and file suffix
1.113     bowersj2 1892: 
1.256     matthew  1893: Returns (undef) on failure, 
                   1894:     Filehandle and filename on success.
1.113     bowersj2 1895: 
                   1896: =cut
                   1897: 
1.256     matthew  1898: ###############################################################
                   1899: ###############################################################
                   1900: sub create_text_file {
                   1901:     my ($r,$suffix) = @_;
                   1902:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1903:     my $fh;
                   1904:     my $filename = '/prtspool/'.
1.258     albertel 1905:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1906:         time.'_'.rand(1000000000).'.'.$suffix;
                   1907:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1908:     if (! defined($fh)) {
                   1909:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   1910:         $r->print(
                   1911:             '<p class="LC_error">'
                   1912:            .&mt('Problems occurred in creating the output file.')
                   1913:            .' '.&mt('This error has been logged.')
                   1914:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   1915:            .'</p>'
                   1916:         );
1.113     bowersj2 1917:     }
1.256     matthew  1918:     return ($fh,$filename)
1.113     bowersj2 1919: }
                   1920: 
                   1921: 
1.256     matthew  1922: =pod 
1.113     bowersj2 1923: 
                   1924: =back
                   1925: 
                   1926: =cut
1.37      matthew  1927: 
                   1928: ###############################################################
1.33      matthew  1929: ##        Home server <option> list generating code          ##
                   1930: ###############################################################
1.35      matthew  1931: 
1.169     www      1932: # ------------------------------------------
                   1933: 
                   1934: sub domain_select {
                   1935:     my ($name,$value,$multiple)=@_;
                   1936:     my %domains=map { 
1.514     albertel 1937: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1938:     } &Apache::lonnet::all_domains();
1.169     www      1939:     if ($multiple) {
                   1940: 	$domains{''}=&mt('Any domain');
1.550     albertel 1941: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1942: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1943:     } else {
1.550     albertel 1944: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  1945: 	return &select_form($name,$value,\%domains);
1.169     www      1946:     }
                   1947: }
                   1948: 
1.282     albertel 1949: #-------------------------------------------
                   1950: 
                   1951: =pod
                   1952: 
1.519     raeburn  1953: =head1 Routines for form select boxes
                   1954: 
                   1955: =over 4
                   1956: 
1.648     raeburn  1957: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1958: 
                   1959: Returns a string containing a <select> element int multiple mode
                   1960: 
                   1961: 
                   1962: Args:
                   1963:   $name - name of the <select> element
1.506     raeburn  1964:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1965:   $size - number of rows long the select element is
1.283     albertel 1966:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1967:           (shown text should already have been &mt())
1.506     raeburn  1968:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1969: 
1.282     albertel 1970: =cut
                   1971: 
                   1972: #-------------------------------------------
1.169     www      1973: sub multiple_select_form {
1.284     albertel 1974:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1975:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1976:     my $output='';
1.191     matthew  1977:     if (! defined($size)) {
                   1978:         $size = 4;
1.283     albertel 1979:         if (scalar(keys(%$hash))<4) {
                   1980:             $size = scalar(keys(%$hash));
1.191     matthew  1981:         }
                   1982:     }
1.734     bisitz   1983:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1984:     my @order;
1.506     raeburn  1985:     if (ref($order) eq 'ARRAY')  {
                   1986:         @order = @{$order};
                   1987:     } else {
                   1988:         @order = sort(keys(%$hash));
1.501     banghart 1989:     }
                   1990:     if (exists($$hash{'select_form_order'})) {
                   1991:         @order = @{$$hash{'select_form_order'}};
                   1992:     }
                   1993:         
1.284     albertel 1994:     foreach my $key (@order) {
1.356     albertel 1995:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1996:         $output.='selected="selected" ' if ($selected{$key});
                   1997:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1998:     }
                   1999:     $output.="</select>\n";
                   2000:     return $output;
                   2001: }
                   2002: 
1.88      www      2003: #-------------------------------------------
                   2004: 
                   2005: =pod
                   2006: 
1.970     raeburn  2007: =item * &select_form($defdom,$name,$hashref,$onchange)
1.88      www      2008: 
                   2009: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2010: allow a user to select options from a ref to a hash containing:
                   2011: option_name => displayed text. An optional $onchange can include
                   2012: a javascript onchange item, e.g., onchange="this.form.submit();"  
                   2013: 
1.88      www      2014: See lonrights.pm for an example invocation and use.
                   2015: 
                   2016: =cut
                   2017: 
                   2018: #-------------------------------------------
                   2019: sub select_form {
1.970     raeburn  2020:     my ($def,$name,$hashref,$onchange) = @_;
                   2021:     return unless (ref($hashref) eq 'HASH');
                   2022:     if ($onchange) {
                   2023:         $onchange = ' onchange="'.$onchange.'"';
                   2024:     }
                   2025:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.128     albertel 2026:     my @keys;
1.970     raeburn  2027:     if (exists($hashref->{'select_form_order'})) {
                   2028: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2029:     } else {
1.970     raeburn  2030: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2031:     }
1.356     albertel 2032:     foreach my $key (@keys) {
                   2033:         $selectform.=
                   2034: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2035:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2036:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2037:     }
                   2038:     $selectform.="</select>";
                   2039:     return $selectform;
                   2040: }
                   2041: 
1.475     www      2042: # For display filters
                   2043: 
                   2044: sub display_filter {
1.1074    raeburn  2045:     my ($context) = @_;
1.475     www      2046:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2047:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2048:     my $phraseinput = 'hidden';
                   2049:     my $includeinput = 'hidden';
                   2050:     my ($checked,$includetypestext);
                   2051:     if ($env{'form.displayfilter'} eq 'containing') {
                   2052:         $phraseinput = 'text'; 
                   2053:         if ($context eq 'parmslog') {
                   2054:             $includeinput = 'checkbox';
                   2055:             if ($env{'form.includetypes'}) {
                   2056:                 $checked = ' checked="checked"';
                   2057:             }
                   2058:             $includetypestext = &mt('Include parameter types');
                   2059:         }
                   2060:     } else {
                   2061:         $includetypestext = '&nbsp;';
                   2062:     }
                   2063:     my ($additional,$secondid,$thirdid);
                   2064:     if ($context eq 'parmslog') {
                   2065:         $additional = 
                   2066:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2067:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2068:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2069:             '</label>';
                   2070:         $secondid = 'includetypes';
                   2071:         $thirdid = 'includetypestext';
                   2072:     }
                   2073:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2074:                                                     '$secondid','$thirdid')";
                   2075:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2076: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2077: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2078: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2079:            &mt('Filter: [_1]',
1.477     www      2080: 	   &select_form($env{'form.displayfilter'},
                   2081: 			'displayfilter',
1.970     raeburn  2082: 			{'currentfolder' => 'Current folder/page',
1.477     www      2083: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2084: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2085: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2086:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2087:                          '" />'.$additional;
                   2088: }
                   2089: 
                   2090: sub display_filter_js {
                   2091:     my $includetext = &mt('Include parameter types');
                   2092:     return <<"ENDJS";
                   2093:   
                   2094: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2095:     var firstType = 'hidden';
                   2096:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2097:         firstType = 'text';
                   2098:     }
                   2099:     firstObject = document.getElementById(firstid);
                   2100:     if (typeof(firstObject) == 'object') {
                   2101:         if (firstObject.type != firstType) {
                   2102:             changeInputType(firstObject,firstType);
                   2103:         }
                   2104:     }
                   2105:     if (context == 'parmslog') {
                   2106:         var secondType = 'hidden';
                   2107:         if (firstType == 'text') {
                   2108:             secondType = 'checkbox';
                   2109:         }
                   2110:         secondObject = document.getElementById(secondid);  
                   2111:         if (typeof(secondObject) == 'object') {
                   2112:             if (secondObject.type != secondType) {
                   2113:                 changeInputType(secondObject,secondType);
                   2114:             }
                   2115:         }
                   2116:         var textItem = document.getElementById(thirdid);
                   2117:         var currtext = textItem.innerHTML;
                   2118:         var newtext;
                   2119:         if (firstType == 'text') {
                   2120:             newtext = '$includetext';
                   2121:         } else {
                   2122:             newtext = '&nbsp;';
                   2123:         }
                   2124:         if (currtext != newtext) {
                   2125:             textItem.innerHTML = newtext;
                   2126:         }
                   2127:     }
                   2128:     return;
                   2129: }
                   2130: 
                   2131: function changeInputType(oldObject,newType) {
                   2132:     var newObject = document.createElement('input');
                   2133:     newObject.type = newType;
                   2134:     if (oldObject.size) {
                   2135:         newObject.size = oldObject.size;
                   2136:     }
                   2137:     if (oldObject.value) {
                   2138:         newObject.value = oldObject.value;
                   2139:     }
                   2140:     if (oldObject.name) {
                   2141:         newObject.name = oldObject.name;
                   2142:     }
                   2143:     if (oldObject.id) {
                   2144:         newObject.id = oldObject.id;
                   2145:     }
                   2146:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2147:     return;
                   2148: }
                   2149: 
                   2150: ENDJS
1.475     www      2151: }
                   2152: 
1.167     www      2153: sub gradeleveldescription {
                   2154:     my $gradelevel=shift;
                   2155:     my %gradelevels=(0 => 'Not specified',
                   2156: 		     1 => 'Grade 1',
                   2157: 		     2 => 'Grade 2',
                   2158: 		     3 => 'Grade 3',
                   2159: 		     4 => 'Grade 4',
                   2160: 		     5 => 'Grade 5',
                   2161: 		     6 => 'Grade 6',
                   2162: 		     7 => 'Grade 7',
                   2163: 		     8 => 'Grade 8',
                   2164: 		     9 => 'Grade 9',
                   2165: 		     10 => 'Grade 10',
                   2166: 		     11 => 'Grade 11',
                   2167: 		     12 => 'Grade 12',
                   2168: 		     13 => 'Grade 13',
                   2169: 		     14 => '100 Level',
                   2170: 		     15 => '200 Level',
                   2171: 		     16 => '300 Level',
                   2172: 		     17 => '400 Level',
                   2173: 		     18 => 'Graduate Level');
                   2174:     return &mt($gradelevels{$gradelevel});
                   2175: }
                   2176: 
1.163     www      2177: sub select_level_form {
                   2178:     my ($deflevel,$name)=@_;
                   2179:     unless ($deflevel) { $deflevel=0; }
1.167     www      2180:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2181:     for (my $i=0; $i<=18; $i++) {
                   2182:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2183:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2184:                 ">".&gradeleveldescription($i)."</option>\n";
                   2185:     }
                   2186:     $selectform.="</select>";
                   2187:     return $selectform;
1.163     www      2188: }
1.167     www      2189: 
1.35      matthew  2190: #-------------------------------------------
                   2191: 
1.45      matthew  2192: =pod
                   2193: 
1.1121    raeburn  2194: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms)
1.35      matthew  2195: 
                   2196: Returns a string containing a <select name='$name' size='1'> form to 
                   2197: allow a user to select the domain to preform an operation in.  
                   2198: See loncreateuser.pm for an example invocation and use.
                   2199: 
1.90      www      2200: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2201: selected");
                   2202: 
1.743     raeburn  2203: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2204: 
1.910     raeburn  2205: 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.
                   2206: 
1.1121    raeburn  2207: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2208: 
                   2209: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563     raeburn  2210: 
1.35      matthew  2211: =cut
                   2212: 
                   2213: #-------------------------------------------
1.34      matthew  2214: sub select_dom_form {
1.1121    raeburn  2215:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms) = @_;
1.872     raeburn  2216:     if ($onchange) {
1.874     raeburn  2217:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2218:     }
1.1121    raeburn  2219:     my (@domains,%exclude);
1.910     raeburn  2220:     if (ref($incdoms) eq 'ARRAY') {
                   2221:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2222:     } else {
                   2223:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2224:     }
1.90      www      2225:     if ($includeempty) { @domains=('',@domains); }
1.1121    raeburn  2226:     if (ref($excdoms) eq 'ARRAY') {
                   2227:         map { $exclude{$_} = 1; } @{$excdoms}; 
                   2228:     }
1.743     raeburn  2229:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 2230:     foreach my $dom (@domains) {
1.1121    raeburn  2231:         next if ($exclude{$dom});
1.356     albertel 2232:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2233:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2234:         if ($showdomdesc) {
                   2235:             if ($dom ne '') {
                   2236:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2237:                 if ($domdesc ne '') {
                   2238:                     $selectdomain .= ' ('.$domdesc.')';
                   2239:                 }
                   2240:             } 
                   2241:         }
                   2242:         $selectdomain .= "</option>\n";
1.34      matthew  2243:     }
                   2244:     $selectdomain.="</select>";
                   2245:     return $selectdomain;
                   2246: }
                   2247: 
1.35      matthew  2248: #-------------------------------------------
                   2249: 
1.45      matthew  2250: =pod
                   2251: 
1.648     raeburn  2252: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2253: 
1.586     raeburn  2254: input: 4 arguments (two required, two optional) - 
                   2255:     $domain - domain of new user
                   2256:     $name - name of form element
                   2257:     $default - Value of 'default' causes a default item to be first 
                   2258:                             option, and selected by default. 
                   2259:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2260:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2261: output: returns 2 items: 
1.586     raeburn  2262: (a) form element which contains either:
                   2263:    (i) <select name="$name">
                   2264:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2265:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2266:        </select>
                   2267:        form item if there are multiple library servers in $domain, or
                   2268:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2269:        if there is only one library server in $domain.
                   2270: 
                   2271: (b) number of library servers found.
                   2272: 
                   2273: See loncreateuser.pm for example of use.
1.35      matthew  2274: 
                   2275: =cut
                   2276: 
                   2277: #-------------------------------------------
1.586     raeburn  2278: sub home_server_form_item {
                   2279:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2280:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2281:     my $result;
                   2282:     my $numlib = keys(%servers);
                   2283:     if ($numlib > 1) {
                   2284:         $result .= '<select name="'.$name.'" />'."\n";
                   2285:         if ($default) {
1.804     bisitz   2286:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2287:                        '</option>'."\n";
                   2288:         }
                   2289:         foreach my $hostid (sort(keys(%servers))) {
                   2290:             $result.= '<option value="'.$hostid.'">'.
                   2291: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2292:         }
                   2293:         $result .= '</select>'."\n";
                   2294:     } elsif ($numlib == 1) {
                   2295:         my $hostid;
                   2296:         foreach my $item (keys(%servers)) {
                   2297:             $hostid = $item;
                   2298:         }
                   2299:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2300:                    $hostid.'" />';
                   2301:                    if (!$hide) {
                   2302:                        $result .= $hostid.' '.$servers{$hostid};
                   2303:                    }
                   2304:                    $result .= "\n";
                   2305:     } elsif ($default) {
                   2306:         $result .= '<input type="hidden" name="'.$name.
                   2307:                    '" value="default" />';
                   2308:                    if (!$hide) {
                   2309:                        $result .= &mt('default');
                   2310:                    }
                   2311:                    $result .= "\n";
1.33      matthew  2312:     }
1.586     raeburn  2313:     return ($result,$numlib);
1.33      matthew  2314: }
1.112     bowersj2 2315: 
                   2316: =pod
                   2317: 
1.534     albertel 2318: =back 
                   2319: 
1.112     bowersj2 2320: =cut
1.87      matthew  2321: 
                   2322: ###############################################################
1.112     bowersj2 2323: ##                  Decoding User Agent                      ##
1.87      matthew  2324: ###############################################################
                   2325: 
                   2326: =pod
                   2327: 
1.112     bowersj2 2328: =head1 Decoding the User Agent
                   2329: 
                   2330: =over 4
                   2331: 
                   2332: =item * &decode_user_agent()
1.87      matthew  2333: 
                   2334: Inputs: $r
                   2335: 
                   2336: Outputs:
                   2337: 
                   2338: =over 4
                   2339: 
1.112     bowersj2 2340: =item * $httpbrowser
1.87      matthew  2341: 
1.112     bowersj2 2342: =item * $clientbrowser
1.87      matthew  2343: 
1.112     bowersj2 2344: =item * $clientversion
1.87      matthew  2345: 
1.112     bowersj2 2346: =item * $clientmathml
1.87      matthew  2347: 
1.112     bowersj2 2348: =item * $clientunicode
1.87      matthew  2349: 
1.112     bowersj2 2350: =item * $clientos
1.87      matthew  2351: 
                   2352: =back
                   2353: 
1.157     matthew  2354: =back 
                   2355: 
1.87      matthew  2356: =cut
                   2357: 
                   2358: ###############################################################
                   2359: ###############################################################
                   2360: sub decode_user_agent {
1.247     albertel 2361:     my ($r)=@_;
1.87      matthew  2362:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2363:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2364:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2365:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2366:     my $clientbrowser='unknown';
                   2367:     my $clientversion='0';
                   2368:     my $clientmathml='';
                   2369:     my $clientunicode='0';
                   2370:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2371:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2372: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2373: 	    $clientbrowser=$bname;
                   2374:             $httpbrowser=~/$vreg/i;
                   2375: 	    $clientversion=$1;
                   2376:             $clientmathml=($clientversion>=$minv);
                   2377:             $clientunicode=($clientversion>=$univ);
                   2378: 	}
                   2379:     }
                   2380:     my $clientos='unknown';
                   2381:     if (($httpbrowser=~/linux/i) ||
                   2382:         ($httpbrowser=~/unix/i) ||
                   2383:         ($httpbrowser=~/ux/i) ||
                   2384:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2385:     if (($httpbrowser=~/vax/i) ||
                   2386:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2387:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2388:     if (($httpbrowser=~/mac/i) ||
                   2389:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2390:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2391:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2392:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2393:             $clientunicode,$clientos,);
                   2394: }
                   2395: 
1.32      matthew  2396: ###############################################################
                   2397: ##    Authentication changing form generation subroutines    ##
                   2398: ###############################################################
                   2399: ##
                   2400: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2401: ## hash, and have reasonable default values.
                   2402: ##
                   2403: ##    formname = the name given in the <form> tag.
1.35      matthew  2404: #-------------------------------------------
                   2405: 
1.45      matthew  2406: =pod
                   2407: 
1.112     bowersj2 2408: =head1 Authentication Routines
                   2409: 
                   2410: =over 4
                   2411: 
1.648     raeburn  2412: =item * &authform_xxxxxx()
1.35      matthew  2413: 
                   2414: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2415: handle some of the conveniences required for authentication forms.  
                   2416: This is not an optimal method, but it works.  
                   2417: 
                   2418: =over 4
                   2419: 
1.112     bowersj2 2420: =item * authform_header
1.35      matthew  2421: 
1.112     bowersj2 2422: =item * authform_authorwarning
1.35      matthew  2423: 
1.112     bowersj2 2424: =item * authform_nochange
1.35      matthew  2425: 
1.112     bowersj2 2426: =item * authform_kerberos
1.35      matthew  2427: 
1.112     bowersj2 2428: =item * authform_internal
1.35      matthew  2429: 
1.112     bowersj2 2430: =item * authform_filesystem
1.35      matthew  2431: 
                   2432: =back
                   2433: 
1.648     raeburn  2434: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2435: 
1.35      matthew  2436: =cut
                   2437: 
                   2438: #-------------------------------------------
1.32      matthew  2439: sub authform_header{  
                   2440:     my %in = (
                   2441:         formname => 'cu',
1.80      albertel 2442:         kerb_def_dom => '',
1.32      matthew  2443:         @_,
                   2444:     );
                   2445:     $in{'formname'} = 'document.' . $in{'formname'};
                   2446:     my $result='';
1.80      albertel 2447: 
                   2448: #---------------------------------------------- Code for upper case translation
                   2449:     my $Javascript_toUpperCase;
                   2450:     unless ($in{kerb_def_dom}) {
                   2451:         $Javascript_toUpperCase =<<"END";
                   2452:         switch (choice) {
                   2453:            case 'krb': currentform.elements[choicearg].value =
                   2454:                currentform.elements[choicearg].value.toUpperCase();
                   2455:                break;
                   2456:            default:
                   2457:         }
                   2458: END
                   2459:     } else {
                   2460:         $Javascript_toUpperCase = "";
                   2461:     }
                   2462: 
1.165     raeburn  2463:     my $radioval = "'nochange'";
1.591     raeburn  2464:     if (defined($in{'curr_authtype'})) {
                   2465:         if ($in{'curr_authtype'} ne '') {
                   2466:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2467:         }
1.174     matthew  2468:     }
1.165     raeburn  2469:     my $argfield = 'null';
1.591     raeburn  2470:     if (defined($in{'mode'})) {
1.165     raeburn  2471:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2472:             if (defined($in{'curr_autharg'})) {
                   2473:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2474:                     $argfield = "'$in{'curr_autharg'}'";
                   2475:                 }
                   2476:             }
                   2477:         }
                   2478:     }
                   2479: 
1.32      matthew  2480:     $result.=<<"END";
                   2481: var current = new Object();
1.165     raeburn  2482: current.radiovalue = $radioval;
                   2483: current.argfield = $argfield;
1.32      matthew  2484: 
                   2485: function changed_radio(choice,currentform) {
                   2486:     var choicearg = choice + 'arg';
                   2487:     // If a radio button in changed, we need to change the argfield
                   2488:     if (current.radiovalue != choice) {
                   2489:         current.radiovalue = choice;
                   2490:         if (current.argfield != null) {
                   2491:             currentform.elements[current.argfield].value = '';
                   2492:         }
                   2493:         if (choice == 'nochange') {
                   2494:             current.argfield = null;
                   2495:         } else {
                   2496:             current.argfield = choicearg;
                   2497:             switch(choice) {
                   2498:                 case 'krb': 
                   2499:                     currentform.elements[current.argfield].value = 
                   2500:                         "$in{'kerb_def_dom'}";
                   2501:                 break;
                   2502:               default:
                   2503:                 break;
                   2504:             }
                   2505:         }
                   2506:     }
                   2507:     return;
                   2508: }
1.22      www      2509: 
1.32      matthew  2510: function changed_text(choice,currentform) {
                   2511:     var choicearg = choice + 'arg';
                   2512:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2513:         $Javascript_toUpperCase
1.32      matthew  2514:         // clear old field
                   2515:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2516:             currentform.elements[current.argfield].value = '';
                   2517:         }
                   2518:         current.argfield = choicearg;
                   2519:     }
                   2520:     set_auth_radio_buttons(choice,currentform);
                   2521:     return;
1.20      www      2522: }
1.32      matthew  2523: 
                   2524: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2525:     var numauthchoices = currentform.login.length;
                   2526:     if (typeof numauthchoices  == "undefined") {
                   2527:         return;
                   2528:     } 
1.32      matthew  2529:     var i=0;
1.986     raeburn  2530:     while (i < numauthchoices) {
1.32      matthew  2531:         if (currentform.login[i].value == newvalue) { break; }
                   2532:         i++;
                   2533:     }
1.986     raeburn  2534:     if (i == numauthchoices) {
1.32      matthew  2535:         return;
                   2536:     }
                   2537:     current.radiovalue = newvalue;
                   2538:     currentform.login[i].checked = true;
                   2539:     return;
                   2540: }
                   2541: END
                   2542:     return $result;
                   2543: }
                   2544: 
1.1106    raeburn  2545: sub authform_authorwarning {
1.32      matthew  2546:     my $result='';
1.144     matthew  2547:     $result='<i>'.
                   2548:         &mt('As a general rule, only authors or co-authors should be '.
                   2549:             'filesystem authenticated '.
                   2550:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2551:     return $result;
                   2552: }
                   2553: 
1.1106    raeburn  2554: sub authform_nochange {
1.32      matthew  2555:     my %in = (
                   2556:               formname => 'document.cu',
                   2557:               kerb_def_dom => 'MSU.EDU',
                   2558:               @_,
                   2559:           );
1.1106    raeburn  2560:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586     raeburn  2561:     my $result;
1.1104    raeburn  2562:     if (!$authnum) {
1.1105    raeburn  2563:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2564:     } else {
                   2565:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2566:                   '<input type="radio" name="login" value="nochange" '.
                   2567:                   'checked="checked" onclick="'.
1.281     albertel 2568:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2569: 	    '</label>';
1.586     raeburn  2570:     }
1.32      matthew  2571:     return $result;
                   2572: }
                   2573: 
1.591     raeburn  2574: sub authform_kerberos {
1.32      matthew  2575:     my %in = (
                   2576:               formname => 'document.cu',
                   2577:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2578:               kerb_def_auth => 'krb4',
1.32      matthew  2579:               @_,
                   2580:               );
1.586     raeburn  2581:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2582:         $autharg,$jscall);
1.1106    raeburn  2583:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2584:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2585:        $check5 = ' checked="checked"';
1.80      albertel 2586:     } else {
1.772     bisitz   2587:        $check4 = ' checked="checked"';
1.80      albertel 2588:     }
1.165     raeburn  2589:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2590:     if (defined($in{'curr_authtype'})) {
                   2591:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2592:             $krbcheck = ' checked="checked"';
1.623     raeburn  2593:             if (defined($in{'mode'})) {
                   2594:                 if ($in{'mode'} eq 'modifyuser') {
                   2595:                     $krbcheck = '';
                   2596:                 }
                   2597:             }
1.591     raeburn  2598:             if (defined($in{'curr_kerb_ver'})) {
                   2599:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2600:                     $check5 = ' checked="checked"';
1.591     raeburn  2601:                     $check4 = '';
                   2602:                 } else {
1.772     bisitz   2603:                     $check4 = ' checked="checked"';
1.591     raeburn  2604:                     $check5 = '';
                   2605:                 }
1.586     raeburn  2606:             }
1.591     raeburn  2607:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2608:                 $krbarg = $in{'curr_autharg'};
                   2609:             }
1.586     raeburn  2610:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2611:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2612:                     $result = 
                   2613:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2614:         $in{'curr_autharg'},$krbver);
                   2615:                 } else {
                   2616:                     $result =
                   2617:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2618:                 }
                   2619:                 return $result; 
                   2620:             }
                   2621:         }
                   2622:     } else {
                   2623:         if ($authnum == 1) {
1.784     bisitz   2624:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2625:         }
                   2626:     }
1.586     raeburn  2627:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2628:         return;
1.587     raeburn  2629:     } elsif ($authtype eq '') {
1.591     raeburn  2630:         if (defined($in{'mode'})) {
1.587     raeburn  2631:             if ($in{'mode'} eq 'modifycourse') {
                   2632:                 if ($authnum == 1) {
1.1104    raeburn  2633:                     $authtype = '<input type="radio" name="login" value="krb" />';
1.587     raeburn  2634:                 }
                   2635:             }
                   2636:         }
1.586     raeburn  2637:     }
                   2638:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2639:     if ($authtype eq '') {
                   2640:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2641:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2642:                     $krbcheck.' />';
                   2643:     }
                   2644:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106    raeburn  2645:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2646:          $in{'curr_authtype'} eq 'krb5') ||
1.1106    raeburn  2647:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2648:          $in{'curr_authtype'} eq 'krb4')) {
                   2649:         $result .= &mt
1.144     matthew  2650:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2651:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2652:          '<label>'.$authtype,
1.281     albertel 2653:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2654:              'value="'.$krbarg.'" '.
1.144     matthew  2655:              'onchange="'.$jscall.'" />',
1.281     albertel 2656:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2657:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2658: 	 '</label>');
1.586     raeburn  2659:     } elsif ($can_assign{'krb4'}) {
                   2660:         $result .= &mt
                   2661:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2662:          '[_3] Version 4 [_4]',
                   2663:          '<label>'.$authtype,
                   2664:          '</label><input type="text" size="10" name="krbarg" '.
                   2665:              'value="'.$krbarg.'" '.
                   2666:              'onchange="'.$jscall.'" />',
                   2667:          '<label><input type="hidden" name="krbver" value="4" />',
                   2668:          '</label>');
                   2669:     } elsif ($can_assign{'krb5'}) {
                   2670:         $result .= &mt
                   2671:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2672:          '[_3] Version 5 [_4]',
                   2673:          '<label>'.$authtype,
                   2674:          '</label><input type="text" size="10" name="krbarg" '.
                   2675:              'value="'.$krbarg.'" '.
                   2676:              'onchange="'.$jscall.'" />',
                   2677:          '<label><input type="hidden" name="krbver" value="5" />',
                   2678:          '</label>');
                   2679:     }
1.32      matthew  2680:     return $result;
                   2681: }
                   2682: 
1.1106    raeburn  2683: sub authform_internal {
1.586     raeburn  2684:     my %in = (
1.32      matthew  2685:                 formname => 'document.cu',
                   2686:                 kerb_def_dom => 'MSU.EDU',
                   2687:                 @_,
                   2688:                 );
1.586     raeburn  2689:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  2690:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  2691:     if (defined($in{'curr_authtype'})) {
                   2692:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2693:             if ($can_assign{'int'}) {
1.772     bisitz   2694:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2695:                 if (defined($in{'mode'})) {
                   2696:                     if ($in{'mode'} eq 'modifyuser') {
                   2697:                         $intcheck = '';
                   2698:                     }
                   2699:                 }
1.591     raeburn  2700:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2701:                     $intarg = $in{'curr_autharg'};
                   2702:                 }
                   2703:             } else {
                   2704:                 $result = &mt('Currently internally authenticated.');
                   2705:                 return $result;
1.165     raeburn  2706:             }
                   2707:         }
1.586     raeburn  2708:     } else {
                   2709:         if ($authnum == 1) {
1.784     bisitz   2710:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2711:         }
                   2712:     }
                   2713:     if (!$can_assign{'int'}) {
                   2714:         return;
1.587     raeburn  2715:     } elsif ($authtype eq '') {
1.591     raeburn  2716:         if (defined($in{'mode'})) {
1.587     raeburn  2717:             if ($in{'mode'} eq 'modifycourse') {
                   2718:                 if ($authnum == 1) {
1.1104    raeburn  2719:                     $authtype = '<input type="radio" name="login" value="int" />';
1.587     raeburn  2720:                 }
                   2721:             }
                   2722:         }
1.165     raeburn  2723:     }
1.586     raeburn  2724:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2725:     if ($authtype eq '') {
                   2726:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2727:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2728:     }
1.605     bisitz   2729:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2730:                $intarg.'" onchange="'.$jscall.'" />';
                   2731:     $result = &mt
1.144     matthew  2732:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2733:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2734:     $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  2735:     return $result;
                   2736: }
                   2737: 
1.1104    raeburn  2738: sub authform_local {
1.32      matthew  2739:     my %in = (
                   2740:               formname => 'document.cu',
                   2741:               kerb_def_dom => 'MSU.EDU',
                   2742:               @_,
                   2743:               );
1.586     raeburn  2744:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  2745:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  2746:     if (defined($in{'curr_authtype'})) {
                   2747:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2748:             if ($can_assign{'loc'}) {
1.772     bisitz   2749:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2750:                 if (defined($in{'mode'})) {
                   2751:                     if ($in{'mode'} eq 'modifyuser') {
                   2752:                         $loccheck = '';
                   2753:                     }
                   2754:                 }
1.591     raeburn  2755:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2756:                     $locarg = $in{'curr_autharg'};
                   2757:                 }
                   2758:             } else {
                   2759:                 $result = &mt('Currently using local (institutional) authentication.');
                   2760:                 return $result;
1.165     raeburn  2761:             }
                   2762:         }
1.586     raeburn  2763:     } else {
                   2764:         if ($authnum == 1) {
1.784     bisitz   2765:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2766:         }
                   2767:     }
                   2768:     if (!$can_assign{'loc'}) {
                   2769:         return;
1.587     raeburn  2770:     } elsif ($authtype eq '') {
1.591     raeburn  2771:         if (defined($in{'mode'})) {
1.587     raeburn  2772:             if ($in{'mode'} eq 'modifycourse') {
                   2773:                 if ($authnum == 1) {
1.1104    raeburn  2774:                     $authtype = '<input type="radio" name="login" value="loc" />';
1.587     raeburn  2775:                 }
                   2776:             }
                   2777:         }
1.165     raeburn  2778:     }
1.586     raeburn  2779:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2780:     if ($authtype eq '') {
                   2781:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2782:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2783:                     $jscall.'" />';
                   2784:     }
                   2785:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2786:                $locarg.'" onchange="'.$jscall.'" />';
                   2787:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2788:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2789:     return $result;
                   2790: }
                   2791: 
1.1106    raeburn  2792: sub authform_filesystem {
1.32      matthew  2793:     my %in = (
                   2794:               formname => 'document.cu',
                   2795:               kerb_def_dom => 'MSU.EDU',
                   2796:               @_,
                   2797:               );
1.586     raeburn  2798:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
1.1106    raeburn  2799:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591     raeburn  2800:     if (defined($in{'curr_authtype'})) {
                   2801:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2802:             if ($can_assign{'fsys'}) {
1.772     bisitz   2803:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2804:                 if (defined($in{'mode'})) {
                   2805:                     if ($in{'mode'} eq 'modifyuser') {
                   2806:                         $fsyscheck = '';
                   2807:                     }
                   2808:                 }
1.586     raeburn  2809:             } else {
                   2810:                 $result = &mt('Currently Filesystem Authenticated.');
                   2811:                 return $result;
                   2812:             }           
                   2813:         }
                   2814:     } else {
                   2815:         if ($authnum == 1) {
1.784     bisitz   2816:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2817:         }
                   2818:     }
                   2819:     if (!$can_assign{'fsys'}) {
                   2820:         return;
1.587     raeburn  2821:     } elsif ($authtype eq '') {
1.591     raeburn  2822:         if (defined($in{'mode'})) {
1.587     raeburn  2823:             if ($in{'mode'} eq 'modifycourse') {
                   2824:                 if ($authnum == 1) {
1.1104    raeburn  2825:                     $authtype = '<input type="radio" name="login" value="fsys" />';
1.587     raeburn  2826:                 }
                   2827:             }
                   2828:         }
1.586     raeburn  2829:     }
                   2830:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2831:     if ($authtype eq '') {
                   2832:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2833:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2834:                     $jscall.'" />';
                   2835:     }
                   2836:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2837:                ' onchange="'.$jscall.'" />';
                   2838:     $result = &mt
1.144     matthew  2839:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2840:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2841:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2842:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2843:                   'onchange="'.$jscall.'" />');
1.32      matthew  2844:     return $result;
                   2845: }
                   2846: 
1.586     raeburn  2847: sub get_assignable_auth {
                   2848:     my ($dom) = @_;
                   2849:     if ($dom eq '') {
                   2850:         $dom = $env{'request.role.domain'};
                   2851:     }
                   2852:     my %can_assign = (
                   2853:                           krb4 => 1,
                   2854:                           krb5 => 1,
                   2855:                           int  => 1,
                   2856:                           loc  => 1,
                   2857:                      );
                   2858:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2859:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2860:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2861:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2862:             my $context;
                   2863:             if ($env{'request.role'} =~ /^au/) {
                   2864:                 $context = 'author';
                   2865:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2866:                 $context = 'domain';
                   2867:             } elsif ($env{'request.course.id'}) {
                   2868:                 $context = 'course';
                   2869:             }
                   2870:             if ($context) {
                   2871:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2872:                    %can_assign = %{$authhash->{$context}}; 
                   2873:                 }
                   2874:             }
                   2875:         }
                   2876:     }
                   2877:     my $authnum = 0;
                   2878:     foreach my $key (keys(%can_assign)) {
                   2879:         if ($can_assign{$key}) {
                   2880:             $authnum ++;
                   2881:         }
                   2882:     }
                   2883:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2884:         $authnum --;
                   2885:     }
                   2886:     return ($authnum,%can_assign);
                   2887: }
                   2888: 
1.80      albertel 2889: ###############################################################
                   2890: ##    Get Kerberos Defaults for Domain                 ##
                   2891: ###############################################################
                   2892: ##
                   2893: ## Returns default kerberos version and an associated argument
                   2894: ## as listed in file domain.tab. If not listed, provides
                   2895: ## appropriate default domain and kerberos version.
                   2896: ##
                   2897: #-------------------------------------------
                   2898: 
                   2899: =pod
                   2900: 
1.648     raeburn  2901: =item * &get_kerberos_defaults()
1.80      albertel 2902: 
                   2903: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2904: version and domain. If not found, it defaults to version 4 and the 
                   2905: domain of the server.
1.80      albertel 2906: 
1.648     raeburn  2907: =over 4
                   2908: 
1.80      albertel 2909: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2910: 
1.648     raeburn  2911: =back
                   2912: 
                   2913: =back
                   2914: 
1.80      albertel 2915: =cut
                   2916: 
                   2917: #-------------------------------------------
                   2918: sub get_kerberos_defaults {
                   2919:     my $domain=shift;
1.641     raeburn  2920:     my ($krbdef,$krbdefdom);
                   2921:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2922:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2923:         $krbdef = $domdefaults{'auth_def'};
                   2924:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2925:     } else {
1.80      albertel 2926:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2927:         my $krbdefdom=$1;
                   2928:         $krbdefdom=~tr/a-z/A-Z/;
                   2929:         $krbdef = "krb4";
                   2930:     }
                   2931:     return ($krbdef,$krbdefdom);
                   2932: }
1.112     bowersj2 2933: 
1.32      matthew  2934: 
1.46      matthew  2935: ###############################################################
                   2936: ##                Thesaurus Functions                        ##
                   2937: ###############################################################
1.20      www      2938: 
1.46      matthew  2939: =pod
1.20      www      2940: 
1.112     bowersj2 2941: =head1 Thesaurus Functions
                   2942: 
                   2943: =over 4
                   2944: 
1.648     raeburn  2945: =item * &initialize_keywords()
1.46      matthew  2946: 
                   2947: Initializes the package variable %Keywords if it is empty.  Uses the
                   2948: package variable $thesaurus_db_file.
                   2949: 
                   2950: =cut
                   2951: 
                   2952: ###################################################
                   2953: 
                   2954: sub initialize_keywords {
                   2955:     return 1 if (scalar keys(%Keywords));
                   2956:     # If we are here, %Keywords is empty, so fill it up
                   2957:     #   Make sure the file we need exists...
                   2958:     if (! -e $thesaurus_db_file) {
                   2959:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2960:                                  " failed because it does not exist");
                   2961:         return 0;
                   2962:     }
                   2963:     #   Set up the hash as a database
                   2964:     my %thesaurus_db;
                   2965:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2966:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2967:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2968:                                  $thesaurus_db_file);
                   2969:         return 0;
                   2970:     } 
                   2971:     #  Get the average number of appearances of a word.
                   2972:     my $avecount = $thesaurus_db{'average.count'};
                   2973:     #  Put keywords (those that appear > average) into %Keywords
                   2974:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2975:         my ($count,undef) = split /:/,$data;
                   2976:         $Keywords{$word}++ if ($count > $avecount);
                   2977:     }
                   2978:     untie %thesaurus_db;
                   2979:     # Remove special values from %Keywords.
1.356     albertel 2980:     foreach my $value ('total.count','average.count') {
                   2981:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2982:   }
1.46      matthew  2983:     return 1;
                   2984: }
                   2985: 
                   2986: ###################################################
                   2987: 
                   2988: =pod
                   2989: 
1.648     raeburn  2990: =item * &keyword($word)
1.46      matthew  2991: 
                   2992: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2993: than the average number of times in the thesaurus database.  Calls 
                   2994: &initialize_keywords
                   2995: 
                   2996: =cut
                   2997: 
                   2998: ###################################################
1.20      www      2999: 
                   3000: sub keyword {
1.46      matthew  3001:     return if (!&initialize_keywords());
                   3002:     my $word=lc(shift());
                   3003:     $word=~s/\W//g;
                   3004:     return exists($Keywords{$word});
1.20      www      3005: }
1.46      matthew  3006: 
                   3007: ###############################################################
                   3008: 
                   3009: =pod 
1.20      www      3010: 
1.648     raeburn  3011: =item * &get_related_words()
1.46      matthew  3012: 
1.160     matthew  3013: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3014: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3015: will be returned.  The order of the words returned is determined by the
                   3016: database which holds them.
                   3017: 
                   3018: Uses global $thesaurus_db_file.
                   3019: 
1.1057    foxr     3020: 
1.46      matthew  3021: =cut
                   3022: 
                   3023: ###############################################################
                   3024: sub get_related_words {
                   3025:     my $keyword = shift;
                   3026:     my %thesaurus_db;
                   3027:     if (! -e $thesaurus_db_file) {
                   3028:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3029:                                  "failed because the file does not exist");
                   3030:         return ();
                   3031:     }
                   3032:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3033:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3034:         return ();
                   3035:     } 
                   3036:     my @Words=();
1.429     www      3037:     my $count=0;
1.46      matthew  3038:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3039: 	# The first element is the number of times
                   3040: 	# the word appears.  We do not need it now.
1.429     www      3041: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3042: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3043: 	my $threshold=$mostfrequentcount/10;
                   3044:         foreach my $possibleword (@RelatedWords) {
                   3045:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3046:             if ($wordcount>$threshold) {
                   3047: 		push(@Words,$word);
                   3048:                 $count++;
                   3049:                 if ($count>10) { last; }
                   3050: 	    }
1.20      www      3051:         }
                   3052:     }
1.46      matthew  3053:     untie %thesaurus_db;
                   3054:     return @Words;
1.14      harris41 3055: }
1.1090    foxr     3056: ###############################################################
                   3057: #
                   3058: #  Spell checking
                   3059: #
                   3060: 
                   3061: =pod
                   3062: 
                   3063: =head1 Spell checking
                   3064: 
                   3065: =over 4
                   3066: 
                   3067: =item * &check_spelling($wordlist $language)
                   3068: 
                   3069: Takes a string containing words and feeds it to an external
                   3070: spellcheck program via a pipeline. Returns a string containing
                   3071: them mis-spelled words.
                   3072: 
                   3073: Parameters:
                   3074: 
                   3075: =over 4
                   3076: 
                   3077: =item - $wordlist
                   3078: 
                   3079: String that will be fed into the spellcheck program.
                   3080: 
                   3081: =item - $language
                   3082: 
                   3083: Language string that specifies the language for which the spell
                   3084: check will be performed.
                   3085: 
                   3086: =back
                   3087: 
                   3088: =back
                   3089: 
                   3090: Note: This sub assumes that aspell is installed.
                   3091: 
                   3092: 
                   3093: =cut
                   3094: 
1.46      matthew  3095: 
1.112     bowersj2 3096: =pod
                   3097: 
                   3098: =back
                   3099: 
                   3100: =cut
1.61      www      3101: 
1.1090    foxr     3102: sub check_spelling {
                   3103:     my ($wordlist, $language) = @_;
1.1091    foxr     3104:     my @misspellings;
                   3105:     
                   3106:     # Generate the speller and set the langauge.
                   3107:     # if explicitly selected:
1.1090    foxr     3108: 
1.1091    foxr     3109:     my $speller = Text::Aspell->new;
1.1090    foxr     3110:     if ($language) {
1.1091    foxr     3111: 	$speller->set_option('lang', $language);
1.1090    foxr     3112:     }
                   3113: 
1.1091    foxr     3114:     # Turn the word list into an array of words by splittingon whitespace
1.1090    foxr     3115: 
1.1091    foxr     3116:     my @words = split(/\s+/, $wordlist);
1.1090    foxr     3117: 
1.1091    foxr     3118:     foreach my $word (@words) {
                   3119: 	if(! $speller->check($word)) {
                   3120: 	    push(@misspellings, $word);
1.1090    foxr     3121: 	}
                   3122:     }
1.1091    foxr     3123:     return join(' ', @misspellings);
                   3124:     
1.1090    foxr     3125: }
                   3126: 
1.61      www      3127: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3128: =pod
                   3129: 
1.112     bowersj2 3130: =head1 User Name Functions
                   3131: 
                   3132: =over 4
                   3133: 
1.648     raeburn  3134: =item * &plainname($uname,$udom,$first)
1.81      albertel 3135: 
1.112     bowersj2 3136: Takes a users logon name and returns it as a string in
1.226     albertel 3137: "first middle last generation" form 
                   3138: if $first is set to 'lastname' then it returns it as
                   3139: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3140: 
                   3141: =cut
1.61      www      3142: 
1.295     www      3143: 
1.81      albertel 3144: ###############################################################
1.61      www      3145: sub plainname {
1.226     albertel 3146:     my ($uname,$udom,$first)=@_;
1.537     albertel 3147:     return if (!defined($uname) || !defined($udom));
1.295     www      3148:     my %names=&getnames($uname,$udom);
1.226     albertel 3149:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3150: 					  $names{'middlename'},
                   3151: 					  $names{'lastname'},
                   3152: 					  $names{'generation'},$first);
                   3153:     $name=~s/^\s+//;
1.62      www      3154:     $name=~s/\s+$//;
                   3155:     $name=~s/\s+/ /g;
1.353     albertel 3156:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3157:     return $name;
1.61      www      3158: }
1.66      www      3159: 
                   3160: # -------------------------------------------------------------------- Nickname
1.81      albertel 3161: =pod
                   3162: 
1.648     raeburn  3163: =item * &nickname($uname,$udom)
1.81      albertel 3164: 
                   3165: Gets a users name and returns it as a string as
                   3166: 
                   3167: "&quot;nickname&quot;"
1.66      www      3168: 
1.81      albertel 3169: if the user has a nickname or
                   3170: 
                   3171: "first middle last generation"
                   3172: 
                   3173: if the user does not
                   3174: 
                   3175: =cut
1.66      www      3176: 
                   3177: sub nickname {
                   3178:     my ($uname,$udom)=@_;
1.537     albertel 3179:     return if (!defined($uname) || !defined($udom));
1.295     www      3180:     my %names=&getnames($uname,$udom);
1.68      albertel 3181:     my $name=$names{'nickname'};
1.66      www      3182:     if ($name) {
                   3183:        $name='&quot;'.$name.'&quot;'; 
                   3184:     } else {
                   3185:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3186: 	     $names{'lastname'}.' '.$names{'generation'};
                   3187:        $name=~s/\s+$//;
                   3188:        $name=~s/\s+/ /g;
                   3189:     }
                   3190:     return $name;
                   3191: }
                   3192: 
1.295     www      3193: sub getnames {
                   3194:     my ($uname,$udom)=@_;
1.537     albertel 3195:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3196:     if ($udom eq 'public' && $uname eq 'public') {
                   3197: 	return ('lastname' => &mt('Public'));
                   3198:     }
1.295     www      3199:     my $id=$uname.':'.$udom;
                   3200:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3201:     if ($cached) {
                   3202: 	return %{$names};
                   3203:     } else {
                   3204: 	my %loadnames=&Apache::lonnet::get('environment',
                   3205:                     ['firstname','middlename','lastname','generation','nickname'],
                   3206: 					 $udom,$uname);
                   3207: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3208: 	return %loadnames;
                   3209:     }
                   3210: }
1.61      www      3211: 
1.542     raeburn  3212: # -------------------------------------------------------------------- getemails
1.648     raeburn  3213: 
1.542     raeburn  3214: =pod
                   3215: 
1.648     raeburn  3216: =item * &getemails($uname,$udom)
1.542     raeburn  3217: 
                   3218: Gets a user's email information and returns it as a hash with keys:
                   3219: notification, critnotification, permanentemail
                   3220: 
                   3221: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3222: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3223:  
1.648     raeburn  3224: 
1.542     raeburn  3225: =cut
                   3226: 
1.648     raeburn  3227: 
1.466     albertel 3228: sub getemails {
                   3229:     my ($uname,$udom)=@_;
                   3230:     if ($udom eq 'public' && $uname eq 'public') {
                   3231: 	return;
                   3232:     }
1.467     www      3233:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3234:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3235:     my $id=$uname.':'.$udom;
                   3236:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3237:     if ($cached) {
                   3238: 	return %{$names};
                   3239:     } else {
                   3240: 	my %loadnames=&Apache::lonnet::get('environment',
                   3241:                     			   ['notification','critnotification',
                   3242: 					    'permanentemail'],
                   3243: 					   $udom,$uname);
                   3244: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3245: 	return %loadnames;
                   3246:     }
                   3247: }
                   3248: 
1.551     albertel 3249: sub flush_email_cache {
                   3250:     my ($uname,$udom)=@_;
                   3251:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3252:     if (!$uname) { $uname=$env{'user.name'};   }
                   3253:     return if ($udom eq 'public' && $uname eq 'public');
                   3254:     my $id=$uname.':'.$udom;
                   3255:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3256: }
                   3257: 
1.728     raeburn  3258: # -------------------------------------------------------------------- getlangs
                   3259: 
                   3260: =pod
                   3261: 
                   3262: =item * &getlangs($uname,$udom)
                   3263: 
                   3264: Gets a user's language preference and returns it as a hash with key:
                   3265: language.
                   3266: 
                   3267: =cut
                   3268: 
                   3269: 
                   3270: sub getlangs {
                   3271:     my ($uname,$udom) = @_;
                   3272:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3273:     if (!$uname) { $uname=$env{'user.name'};   }
                   3274:     my $id=$uname.':'.$udom;
                   3275:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3276:     if ($cached) {
                   3277:         return %{$langs};
                   3278:     } else {
                   3279:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3280:                                            $udom,$uname);
                   3281:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3282:         return %loadlangs;
                   3283:     }
                   3284: }
                   3285: 
                   3286: sub flush_langs_cache {
                   3287:     my ($uname,$udom)=@_;
                   3288:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3289:     if (!$uname) { $uname=$env{'user.name'};   }
                   3290:     return if ($udom eq 'public' && $uname eq 'public');
                   3291:     my $id=$uname.':'.$udom;
                   3292:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3293: }
                   3294: 
1.61      www      3295: # ------------------------------------------------------------------ Screenname
1.81      albertel 3296: 
                   3297: =pod
                   3298: 
1.648     raeburn  3299: =item * &screenname($uname,$udom)
1.81      albertel 3300: 
                   3301: Gets a users screenname and returns it as a string
                   3302: 
                   3303: =cut
1.61      www      3304: 
                   3305: sub screenname {
                   3306:     my ($uname,$udom)=@_;
1.258     albertel 3307:     if ($uname eq $env{'user.name'} &&
                   3308: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3309:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3310:     return $names{'screenname'};
1.62      www      3311: }
                   3312: 
1.212     albertel 3313: 
1.802     bisitz   3314: # ------------------------------------------------------------- Confirm Wrapper
                   3315: =pod
                   3316: 
                   3317: =item confirmwrapper
                   3318: 
                   3319: Wrap messages about completion of operation in box
                   3320: 
                   3321: =cut
                   3322: 
                   3323: sub confirmwrapper {
                   3324:     my ($message)=@_;
                   3325:     if ($message) {
                   3326:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3327:                .$message."\n"
                   3328:                .'</div>'."\n";
                   3329:     } else {
                   3330:         return $message;
                   3331:     }
                   3332: }
                   3333: 
1.62      www      3334: # ------------------------------------------------------------- Message Wrapper
                   3335: 
                   3336: sub messagewrapper {
1.369     www      3337:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3338:     return 
1.441     albertel 3339:         '<a href="/adm/email?compose=individual&amp;'.
                   3340:         'recname='.$username.'&amp;recdom='.$domain.
                   3341: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3342:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3343: }
1.802     bisitz   3344: 
1.74      www      3345: # --------------------------------------------------------------- Notes Wrapper
                   3346: 
                   3347: sub noteswrapper {
                   3348:     my ($link,$un,$do)=@_;
                   3349:     return 
1.896     amueller 3350: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3351: }
1.802     bisitz   3352: 
1.62      www      3353: # ------------------------------------------------------------- Aboutme Wrapper
                   3354: 
                   3355: sub aboutmewrapper {
1.1070    raeburn  3356:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3357:     if (!defined($username)  && !defined($domain)) {
                   3358:         return;
                   3359:     }
1.1096    raeburn  3360:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3361: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3362: }
                   3363: 
                   3364: # ------------------------------------------------------------ Syllabus Wrapper
                   3365: 
                   3366: sub syllabuswrapper {
1.707     bisitz   3367:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3368:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3369: }
1.14      harris41 3370: 
1.802     bisitz   3371: # -----------------------------------------------------------------------------
                   3372: 
1.208     matthew  3373: sub track_student_link {
1.887     raeburn  3374:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3375:     my $link ="/adm/trackstudent?";
1.208     matthew  3376:     my $title = 'View recent activity';
                   3377:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3378:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3379:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3380:         $title .= ' of this student';
1.268     albertel 3381:     } 
1.208     matthew  3382:     if (defined($target) && $target !~ /^\s*$/) {
                   3383:         $target = qq{target="$target"};
                   3384:     } else {
                   3385:         $target = '';
                   3386:     }
1.268     albertel 3387:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3388:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3389:     $title = &mt($title);
                   3390:     $linktext = &mt($linktext);
1.448     albertel 3391:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3392: 	&help_open_topic('View_recent_activity');
1.208     matthew  3393: }
                   3394: 
1.781     raeburn  3395: sub slot_reservations_link {
                   3396:     my ($linktext,$sname,$sdom,$target) = @_;
                   3397:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3398:     my $title = 'View slot reservation history';
                   3399:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3400:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3401:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3402:         $title .= ' of this student';
                   3403:     }
                   3404:     if (defined($target) && $target !~ /^\s*$/) {
                   3405:         $target = qq{target="$target"};
                   3406:     } else {
                   3407:         $target = '';
                   3408:     }
                   3409:     $title = &mt($title);
                   3410:     $linktext = &mt($linktext);
                   3411:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3412: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3413: 
                   3414: }
                   3415: 
1.508     www      3416: # ===================================================== Display a student photo
                   3417: 
                   3418: 
1.509     albertel 3419: sub student_image_tag {
1.508     www      3420:     my ($domain,$user)=@_;
                   3421:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3422:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3423: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3424:     } else {
                   3425: 	return '';
                   3426:     }
                   3427: }
                   3428: 
1.112     bowersj2 3429: =pod
                   3430: 
                   3431: =back
                   3432: 
                   3433: =head1 Access .tab File Data
                   3434: 
                   3435: =over 4
                   3436: 
1.648     raeburn  3437: =item * &languageids() 
1.112     bowersj2 3438: 
                   3439: returns list of all language ids
                   3440: 
                   3441: =cut
                   3442: 
1.14      harris41 3443: sub languageids {
1.16      harris41 3444:     return sort(keys(%language));
1.14      harris41 3445: }
                   3446: 
1.112     bowersj2 3447: =pod
                   3448: 
1.648     raeburn  3449: =item * &languagedescription() 
1.112     bowersj2 3450: 
                   3451: returns description of a specified language id
                   3452: 
                   3453: =cut
                   3454: 
1.14      harris41 3455: sub languagedescription {
1.125     www      3456:     my $code=shift;
                   3457:     return  ($supported_language{$code}?'* ':'').
                   3458:             $language{$code}.
1.126     www      3459: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3460: }
                   3461: 
1.1048    foxr     3462: =pod
                   3463: 
                   3464: =item * &plainlanguagedescription
                   3465: 
                   3466: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3467: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3468: 
                   3469: =cut
                   3470: 
1.145     www      3471: sub plainlanguagedescription {
                   3472:     my $code=shift;
                   3473:     return $language{$code};
                   3474: }
                   3475: 
1.1048    foxr     3476: =pod
                   3477: 
                   3478: =item * &supportedlanguagecode
                   3479: 
                   3480: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3481: code.
                   3482: 
                   3483: =cut
                   3484: 
1.145     www      3485: sub supportedlanguagecode {
                   3486:     my $code=shift;
                   3487:     return $supported_language{$code};
1.97      www      3488: }
                   3489: 
1.112     bowersj2 3490: =pod
                   3491: 
1.1048    foxr     3492: =item * &latexlanguage()
                   3493: 
                   3494: Given a language key code returns the correspondnig language to use
                   3495: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3496: is no supported hyphenation for the language code.
                   3497: 
                   3498: =cut
                   3499: 
                   3500: sub latexlanguage {
                   3501:     my $code = shift;
                   3502:     return $latex_language{$code};
                   3503: }
                   3504: 
                   3505: =pod
                   3506: 
                   3507: =item * &latexhyphenation()
                   3508: 
                   3509: Same as above but what's supplied is the language as it might be stored
                   3510: in the metadata.
                   3511: 
                   3512: =cut
                   3513: 
                   3514: sub latexhyphenation {
                   3515:     my $key = shift;
                   3516:     return $latex_language_bykey{$key};
                   3517: }
                   3518: 
                   3519: =pod
                   3520: 
1.648     raeburn  3521: =item * &copyrightids() 
1.112     bowersj2 3522: 
                   3523: returns list of all copyrights
                   3524: 
                   3525: =cut
                   3526: 
                   3527: sub copyrightids {
                   3528:     return sort(keys(%cprtag));
                   3529: }
                   3530: 
                   3531: =pod
                   3532: 
1.648     raeburn  3533: =item * &copyrightdescription() 
1.112     bowersj2 3534: 
                   3535: returns description of a specified copyright id
                   3536: 
                   3537: =cut
                   3538: 
                   3539: sub copyrightdescription {
1.166     www      3540:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3541: }
1.197     matthew  3542: 
                   3543: =pod
                   3544: 
1.648     raeburn  3545: =item * &source_copyrightids() 
1.192     taceyjo1 3546: 
                   3547: returns list of all source copyrights
                   3548: 
                   3549: =cut
                   3550: 
                   3551: sub source_copyrightids {
                   3552:     return sort(keys(%scprtag));
                   3553: }
                   3554: 
                   3555: =pod
                   3556: 
1.648     raeburn  3557: =item * &source_copyrightdescription() 
1.192     taceyjo1 3558: 
                   3559: returns description of a specified source copyright id
                   3560: 
                   3561: =cut
                   3562: 
                   3563: sub source_copyrightdescription {
                   3564:     return &mt($scprtag{shift(@_)});
                   3565: }
1.112     bowersj2 3566: 
                   3567: =pod
                   3568: 
1.648     raeburn  3569: =item * &filecategories() 
1.112     bowersj2 3570: 
                   3571: returns list of all file categories
                   3572: 
                   3573: =cut
                   3574: 
                   3575: sub filecategories {
                   3576:     return sort(keys(%category_extensions));
                   3577: }
                   3578: 
                   3579: =pod
                   3580: 
1.648     raeburn  3581: =item * &filecategorytypes() 
1.112     bowersj2 3582: 
                   3583: returns list of file types belonging to a given file
                   3584: category
                   3585: 
                   3586: =cut
                   3587: 
                   3588: sub filecategorytypes {
1.356     albertel 3589:     my ($cat) = @_;
                   3590:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3591: }
                   3592: 
                   3593: =pod
                   3594: 
1.648     raeburn  3595: =item * &fileembstyle() 
1.112     bowersj2 3596: 
                   3597: returns embedding style for a specified file type
                   3598: 
                   3599: =cut
                   3600: 
                   3601: sub fileembstyle {
                   3602:     return $fe{lc(shift(@_))};
1.169     www      3603: }
                   3604: 
1.351     www      3605: sub filemimetype {
                   3606:     return $fm{lc(shift(@_))};
                   3607: }
                   3608: 
1.169     www      3609: 
                   3610: sub filecategoryselect {
                   3611:     my ($name,$value)=@_;
1.189     matthew  3612:     return &select_form($value,$name,
1.970     raeburn  3613:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3614: }
                   3615: 
                   3616: =pod
                   3617: 
1.648     raeburn  3618: =item * &filedescription() 
1.112     bowersj2 3619: 
                   3620: returns description for a specified file type
                   3621: 
                   3622: =cut
                   3623: 
                   3624: sub filedescription {
1.188     matthew  3625:     my $file_description = $fd{lc(shift())};
                   3626:     $file_description =~ s:([\[\]]):~$1:g;
                   3627:     return &mt($file_description);
1.112     bowersj2 3628: }
                   3629: 
                   3630: =pod
                   3631: 
1.648     raeburn  3632: =item * &filedescriptionex() 
1.112     bowersj2 3633: 
                   3634: returns description for a specified file type with
                   3635: extra formatting
                   3636: 
                   3637: =cut
                   3638: 
                   3639: sub filedescriptionex {
                   3640:     my $ex=shift;
1.188     matthew  3641:     my $file_description = $fd{lc($ex)};
                   3642:     $file_description =~ s:([\[\]]):~$1:g;
                   3643:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3644: }
                   3645: 
                   3646: # End of .tab access
                   3647: =pod
                   3648: 
                   3649: =back
                   3650: 
                   3651: =cut
                   3652: 
                   3653: # ------------------------------------------------------------------ File Types
                   3654: sub fileextensions {
                   3655:     return sort(keys(%fe));
                   3656: }
                   3657: 
1.97      www      3658: # ----------------------------------------------------------- Display Languages
                   3659: # returns a hash with all desired display languages
                   3660: #
                   3661: 
                   3662: sub display_languages {
                   3663:     my %languages=();
1.695     raeburn  3664:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3665: 	$languages{$lang}=1;
1.97      www      3666:     }
                   3667:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3668:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3669: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3670: 	    $languages{$lang}=1;
1.97      www      3671:         }
                   3672:     }
                   3673:     return %languages;
1.14      harris41 3674: }
                   3675: 
1.582     albertel 3676: sub languages {
                   3677:     my ($possible_langs) = @_;
1.695     raeburn  3678:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3679:     if (!ref($possible_langs)) {
                   3680: 	if( wantarray ) {
                   3681: 	    return @preferred_langs;
                   3682: 	} else {
                   3683: 	    return $preferred_langs[0];
                   3684: 	}
                   3685:     }
                   3686:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3687:     my @preferred_possibilities;
                   3688:     foreach my $preferred_lang (@preferred_langs) {
                   3689: 	if (exists($possibilities{$preferred_lang})) {
                   3690: 	    push(@preferred_possibilities, $preferred_lang);
                   3691: 	}
                   3692:     }
                   3693:     if( wantarray ) {
                   3694: 	return @preferred_possibilities;
                   3695:     }
                   3696:     return $preferred_possibilities[0];
                   3697: }
                   3698: 
1.742     raeburn  3699: sub user_lang {
                   3700:     my ($touname,$toudom,$fromcid) = @_;
                   3701:     my @userlangs;
                   3702:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3703:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3704:                     $env{'course.'.$fromcid.'.languages'}));
                   3705:     } else {
                   3706:         my %langhash = &getlangs($touname,$toudom);
                   3707:         if ($langhash{'languages'} ne '') {
                   3708:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3709:         } else {
                   3710:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3711:             if ($domdefs{'lang_def'} ne '') {
                   3712:                 @userlangs = ($domdefs{'lang_def'});
                   3713:             }
                   3714:         }
                   3715:     }
                   3716:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3717:     my $user_lh = Apache::localize->get_handle(@languages);
                   3718:     return $user_lh;
                   3719: }
                   3720: 
                   3721: 
1.112     bowersj2 3722: ###############################################################
                   3723: ##               Student Answer Attempts                     ##
                   3724: ###############################################################
                   3725: 
                   3726: =pod
                   3727: 
                   3728: =head1 Alternate Problem Views
                   3729: 
                   3730: =over 4
                   3731: 
1.648     raeburn  3732: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3733:     $getattempt, $regexp, $gradesub)
                   3734: 
                   3735: Return string with previous attempt on problem. Arguments:
                   3736: 
                   3737: =over 4
                   3738: 
                   3739: =item * $symb: Problem, including path
                   3740: 
                   3741: =item * $username: username of the desired student
                   3742: 
                   3743: =item * $domain: domain of the desired student
1.14      harris41 3744: 
1.112     bowersj2 3745: =item * $course: Course ID
1.14      harris41 3746: 
1.112     bowersj2 3747: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3748:     something
1.14      harris41 3749: 
1.112     bowersj2 3750: =item * $regexp: if string matches this regexp, the string will be
                   3751:     sent to $gradesub
1.14      harris41 3752: 
1.112     bowersj2 3753: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3754: 
1.112     bowersj2 3755: =back
1.14      harris41 3756: 
1.112     bowersj2 3757: The output string is a table containing all desired attempts, if any.
1.16      harris41 3758: 
1.112     bowersj2 3759: =cut
1.1       albertel 3760: 
                   3761: sub get_previous_attempt {
1.43      ng       3762:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3763:   my $prevattempts='';
1.43      ng       3764:   no strict 'refs';
1.1       albertel 3765:   if ($symb) {
1.3       albertel 3766:     my (%returnhash)=
                   3767:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3768:     if ($returnhash{'version'}) {
                   3769:       my %lasthash=();
                   3770:       my $version;
                   3771:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3772:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3773: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3774:         }
1.1       albertel 3775:       }
1.596     albertel 3776:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3777:       $prevattempts.='<th>'.&mt('History').'</th>';
1.978     raeburn  3778:       my (%typeparts,%lasthidden);
1.945     raeburn  3779:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 3780:       foreach my $key (sort(keys(%lasthash))) {
                   3781: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3782: 	if ($#parts > 0) {
1.31      albertel 3783: 	  my $data=$parts[-1];
1.989     raeburn  3784:           next if ($data eq 'foilorder');
1.31      albertel 3785: 	  pop(@parts);
1.1010    www      3786:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  3787:           if ($data eq 'type') {
                   3788:               unless ($showsurv) {
                   3789:                   my $id = join(',',@parts);
                   3790:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  3791:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   3792:                       $lasthidden{$ign.'.'.$id} = 1;
                   3793:                   }
1.945     raeburn  3794:               }
1.1010    www      3795:           } 
1.31      albertel 3796: 	} else {
1.41      ng       3797: 	  if ($#parts == 0) {
                   3798: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3799: 	  } else {
                   3800: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3801: 	  }
1.31      albertel 3802: 	}
1.16      harris41 3803:       }
1.596     albertel 3804:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3805:       if ($getattempt eq '') {
                   3806: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.945     raeburn  3807:             my @hidden;
                   3808:             if (%typeparts) {
                   3809:                 foreach my $id (keys(%typeparts)) {
                   3810:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
                   3811:                         push(@hidden,$id);
                   3812:                     }
                   3813:                 }
                   3814:             }
                   3815:             $prevattempts.=&start_data_table_row().
                   3816:                            '<td>'.&mt('Transaction [_1]',$version).'</td>';
                   3817:             if (@hidden) {
                   3818:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3819:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3820:                     my $hide;
                   3821:                     foreach my $id (@hidden) {
                   3822:                         if ($key =~ /^\Q$id\E/) {
                   3823:                             $hide = 1;
                   3824:                             last;
                   3825:                         }
                   3826:                     }
                   3827:                     if ($hide) {
                   3828:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3829:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3830:                             my $value = &format_previous_attempt_value($key,
                   3831:                                              $returnhash{$version.':'.$key});
                   3832:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3833:                         } else {
                   3834:                             $prevattempts.='<td>&nbsp;</td>';
                   3835:                         }
                   3836:                     } else {
                   3837:                         if ($key =~ /\./) {
                   3838:                             my $value = &format_previous_attempt_value($key,
                   3839:                                               $returnhash{$version.':'.$key});
                   3840:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3841:                         } else {
                   3842:                             $prevattempts.='<td>&nbsp;</td>';
                   3843:                         }
                   3844:                     }
                   3845:                 }
                   3846:             } else {
                   3847: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3848:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  3849: 		    my $value = &format_previous_attempt_value($key,
                   3850: 			            $returnhash{$version.':'.$key});
                   3851: 		    $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3852: 	        }
                   3853:             }
                   3854: 	    $prevattempts.=&end_data_table_row();
1.40      ng       3855: 	 }
1.1       albertel 3856:       }
1.945     raeburn  3857:       my @currhidden = keys(%lasthidden);
1.596     albertel 3858:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3859:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  3860:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  3861:           if (%typeparts) {
                   3862:               my $hidden;
                   3863:               foreach my $id (@currhidden) {
                   3864:                   if ($key =~ /^\Q$id\E/) {
                   3865:                       $hidden = 1;
                   3866:                       last;
                   3867:                   }
                   3868:               }
                   3869:               if ($hidden) {
                   3870:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   3871:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   3872:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3873:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3874:                           $value = &$gradesub($value);
                   3875:                       }
                   3876:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3877:                   } else {
                   3878:                       $prevattempts.='<td>&nbsp;</td>';
                   3879:                   }
                   3880:               } else {
                   3881:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3882:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3883:                       $value = &$gradesub($value);
                   3884:                   }
                   3885:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3886:               }
                   3887:           } else {
                   3888: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   3889: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   3890:                   $value = &$gradesub($value);
                   3891:               }
                   3892: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   3893:           }
1.16      harris41 3894:       }
1.596     albertel 3895:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3896:     } else {
1.596     albertel 3897:       $prevattempts=
                   3898: 	  &start_data_table().&start_data_table_row().
                   3899: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3900: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3901:     }
                   3902:   } else {
1.596     albertel 3903:     $prevattempts=
                   3904: 	  &start_data_table().&start_data_table_row().
                   3905: 	  '<td>'.&mt('No data.').'</td>'.
                   3906: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3907:   }
1.10      albertel 3908: }
                   3909: 
1.581     albertel 3910: sub format_previous_attempt_value {
                   3911:     my ($key,$value) = @_;
1.1011    www      3912:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 3913: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3914:     } elsif (ref($value) eq 'ARRAY') {
                   3915: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  3916:     } elsif ($key =~ /answerstring$/) {
                   3917:         my %answers = &Apache::lonnet::str2hash($value);
                   3918:         my @anskeys = sort(keys(%answers));
                   3919:         if (@anskeys == 1) {
                   3920:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  3921:             if ($answer =~ m{\0}) {
                   3922:                 $answer =~ s{\0}{,}g;
1.988     raeburn  3923:             }
                   3924:             my $tag_internal_answer_name = 'INTERNAL';
                   3925:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   3926:                 $value = $answer; 
                   3927:             } else {
                   3928:                 $value = $anskeys[0].'='.$answer;
                   3929:             }
                   3930:         } else {
                   3931:             foreach my $ans (@anskeys) {
                   3932:                 my $answer = $answers{$ans};
1.1001    raeburn  3933:                 if ($answer =~ m{\0}) {
                   3934:                     $answer =~ s{\0}{,}g;
1.988     raeburn  3935:                 }
                   3936:                 $value .=  $ans.'='.$answer.'<br />';;
                   3937:             } 
                   3938:         }
1.581     albertel 3939:     } else {
                   3940: 	$value = &unescape($value);
                   3941:     }
                   3942:     return $value;
                   3943: }
                   3944: 
                   3945: 
1.107     albertel 3946: sub relative_to_absolute {
                   3947:     my ($url,$output)=@_;
                   3948:     my $parser=HTML::TokeParser->new(\$output);
                   3949:     my $token;
                   3950:     my $thisdir=$url;
                   3951:     my @rlinks=();
                   3952:     while ($token=$parser->get_token) {
                   3953: 	if ($token->[0] eq 'S') {
                   3954: 	    if ($token->[1] eq 'a') {
                   3955: 		if ($token->[2]->{'href'}) {
                   3956: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3957: 		}
                   3958: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3959: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3960: 	    } elsif ($token->[1] eq 'base') {
                   3961: 		$thisdir=$token->[2]->{'href'};
                   3962: 	    }
                   3963: 	}
                   3964:     }
                   3965:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3966:     foreach my $link (@rlinks) {
1.726     raeburn  3967: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3968: 		($link=~/^\//) ||
                   3969: 		($link=~/^javascript:/i) ||
                   3970: 		($link=~/^mailto:/i) ||
                   3971: 		($link=~/^\#/)) {
                   3972: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3973: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3974: 	}
                   3975:     }
                   3976: # -------------------------------------------------- Deal with Applet codebases
                   3977:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3978:     return $output;
                   3979: }
                   3980: 
1.112     bowersj2 3981: =pod
                   3982: 
1.648     raeburn  3983: =item * &get_student_view()
1.112     bowersj2 3984: 
                   3985: show a snapshot of what student was looking at
                   3986: 
                   3987: =cut
                   3988: 
1.10      albertel 3989: sub get_student_view {
1.186     albertel 3990:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3991:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3992:   my (%form);
1.10      albertel 3993:   my @elements=('symb','courseid','domain','username');
                   3994:   foreach my $element (@elements) {
1.186     albertel 3995:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3996:   }
1.186     albertel 3997:   if (defined($moreenv)) {
                   3998:       %form=(%form,%{$moreenv});
                   3999:   }
1.236     albertel 4000:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4001:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4002:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4003:   $userview=~s/\<body[^\>]*\>//gi;
                   4004:   $userview=~s/\<\/body\>//gi;
                   4005:   $userview=~s/\<html\>//gi;
                   4006:   $userview=~s/\<\/html\>//gi;
                   4007:   $userview=~s/\<head\>//gi;
                   4008:   $userview=~s/\<\/head\>//gi;
                   4009:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4010:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4011:   if (wantarray) {
                   4012:      return ($userview,$response);
                   4013:   } else {
                   4014:      return $userview;
                   4015:   }
                   4016: }
                   4017: 
                   4018: sub get_student_view_with_retries {
                   4019:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4020: 
                   4021:     my $ok = 0;                 # True if we got a good response.
                   4022:     my $content;
                   4023:     my $response;
                   4024: 
                   4025:     # Try to get the student_view done. within the retries count:
                   4026:     
                   4027:     do {
                   4028:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4029:          $ok      = $response->is_success;
                   4030:          if (!$ok) {
                   4031:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4032:          }
                   4033:          $retries--;
                   4034:     } while (!$ok && ($retries > 0));
                   4035:     
                   4036:     if (!$ok) {
                   4037:        $content = '';          # On error return an empty content.
                   4038:     }
1.651     www      4039:     if (wantarray) {
                   4040:        return ($content, $response);
                   4041:     } else {
                   4042:        return $content;
                   4043:     }
1.11      albertel 4044: }
                   4045: 
1.112     bowersj2 4046: =pod
                   4047: 
1.648     raeburn  4048: =item * &get_student_answers() 
1.112     bowersj2 4049: 
                   4050: show a snapshot of how student was answering problem
                   4051: 
                   4052: =cut
                   4053: 
1.11      albertel 4054: sub get_student_answers {
1.100     sakharuk 4055:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4056:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4057:   my (%moreenv);
1.11      albertel 4058:   my @elements=('symb','courseid','domain','username');
                   4059:   foreach my $element (@elements) {
1.186     albertel 4060:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4061:   }
1.186     albertel 4062:   $moreenv{'grade_target'}='answer';
                   4063:   %moreenv=(%form,%moreenv);
1.497     raeburn  4064:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4065:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4066:   return $userview;
1.1       albertel 4067: }
1.116     albertel 4068: 
                   4069: =pod
                   4070: 
                   4071: =item * &submlink()
                   4072: 
1.242     albertel 4073: Inputs: $text $uname $udom $symb $target
1.116     albertel 4074: 
                   4075: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4076: 
                   4077: =cut
                   4078: 
                   4079: ###############################################
                   4080: sub submlink {
1.242     albertel 4081:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4082:     if (!($uname && $udom)) {
                   4083: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4084: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4085: 	if (!$symb) { $symb=$cursymb; }
                   4086:     }
1.254     matthew  4087:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4088:     $symb=&escape($symb);
1.960     bisitz   4089:     if ($target) { $target=" target=\"$target\""; }
                   4090:     return
                   4091:         '<a href="/adm/grades?command=submission'.
                   4092:         '&amp;symb='.$symb.
                   4093:         '&amp;student='.$uname.
                   4094:         '&amp;userdom='.$udom.'"'.
                   4095:         $target.'>'.$text.'</a>';
1.242     albertel 4096: }
                   4097: ##############################################
                   4098: 
                   4099: =pod
                   4100: 
                   4101: =item * &pgrdlink()
                   4102: 
                   4103: Inputs: $text $uname $udom $symb $target
                   4104: 
                   4105: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4106: 
                   4107: =cut
                   4108: 
                   4109: ###############################################
                   4110: sub pgrdlink {
                   4111:     my $link=&submlink(@_);
                   4112:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4113:     return $link;
                   4114: }
                   4115: ##############################################
                   4116: 
                   4117: =pod
                   4118: 
                   4119: =item * &pprmlink()
                   4120: 
                   4121: Inputs: $text $uname $udom $symb $target
                   4122: 
                   4123: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4124: student and a specific resource
1.242     albertel 4125: 
                   4126: =cut
                   4127: 
                   4128: ###############################################
                   4129: sub pprmlink {
                   4130:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4131:     if (!($uname && $udom)) {
                   4132: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4133: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4134: 	if (!$symb) { $symb=$cursymb; }
                   4135:     }
1.254     matthew  4136:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4137:     $symb=&escape($symb);
1.242     albertel 4138:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4139:     return '<a href="/adm/parmset?command=set&amp;'.
                   4140: 	'symb='.$symb.'&amp;uname='.$uname.
                   4141: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4142: }
                   4143: ##############################################
1.37      matthew  4144: 
1.112     bowersj2 4145: =pod
                   4146: 
                   4147: =back
                   4148: 
                   4149: =cut
                   4150: 
1.37      matthew  4151: ###############################################
1.51      www      4152: 
                   4153: 
                   4154: sub timehash {
1.687     raeburn  4155:     my ($thistime) = @_;
                   4156:     my $timezone = &Apache::lonlocal::gettimezone();
                   4157:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4158:                      ->set_time_zone($timezone);
                   4159:     my $wday = $dt->day_of_week();
                   4160:     if ($wday == 7) { $wday = 0; }
                   4161:     return ( 'second' => $dt->second(),
                   4162:              'minute' => $dt->minute(),
                   4163:              'hour'   => $dt->hour(),
                   4164:              'day'     => $dt->day_of_month(),
                   4165:              'month'   => $dt->month(),
                   4166:              'year'    => $dt->year(),
                   4167:              'weekday' => $wday,
                   4168:              'dayyear' => $dt->day_of_year(),
                   4169:              'dlsav'   => $dt->is_dst() );
1.51      www      4170: }
                   4171: 
1.370     www      4172: sub utc_string {
                   4173:     my ($date)=@_;
1.371     www      4174:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4175: }
                   4176: 
1.51      www      4177: sub maketime {
                   4178:     my %th=@_;
1.687     raeburn  4179:     my ($epoch_time,$timezone,$dt);
                   4180:     $timezone = &Apache::lonlocal::gettimezone();
                   4181:     eval {
                   4182:         $dt = DateTime->new( year   => $th{'year'},
                   4183:                              month  => $th{'month'},
                   4184:                              day    => $th{'day'},
                   4185:                              hour   => $th{'hour'},
                   4186:                              minute => $th{'minute'},
                   4187:                              second => $th{'second'},
                   4188:                              time_zone => $timezone,
                   4189:                          );
                   4190:     };
                   4191:     if (!$@) {
                   4192:         $epoch_time = $dt->epoch;
                   4193:         if ($epoch_time) {
                   4194:             return $epoch_time;
                   4195:         }
                   4196:     }
1.51      www      4197:     return POSIX::mktime(
                   4198:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4199:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4200: }
                   4201: 
                   4202: #########################################
1.51      www      4203: 
                   4204: sub findallcourses {
1.482     raeburn  4205:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4206:     my %roles;
                   4207:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4208:     my %courses;
1.51      www      4209:     my $now=time;
1.482     raeburn  4210:     if (!defined($uname)) {
                   4211:         $uname = $env{'user.name'};
                   4212:     }
                   4213:     if (!defined($udom)) {
                   4214:         $udom = $env{'user.domain'};
                   4215:     }
                   4216:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4217:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4218:         if (!%roles) {
                   4219:             %roles = (
                   4220:                        cc => 1,
1.907     raeburn  4221:                        co => 1,
1.482     raeburn  4222:                        in => 1,
                   4223:                        ep => 1,
                   4224:                        ta => 1,
                   4225:                        cr => 1,
                   4226:                        st => 1,
                   4227:              );
                   4228:         }
                   4229:         foreach my $entry (keys(%roleshash)) {
                   4230:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4231:             if ($trole =~ /^cr/) { 
                   4232:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4233:             } else {
                   4234:                 next if (!exists($roles{$trole}));
                   4235:             }
                   4236:             if ($tend) {
                   4237:                 next if ($tend < $now);
                   4238:             }
                   4239:             if ($tstart) {
                   4240:                 next if ($tstart > $now);
                   4241:             }
1.1058    raeburn  4242:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4243:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4244:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4245:             if ($secpart eq '') {
                   4246:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4247:                 $sec = 'none';
1.1058    raeburn  4248:                 $value .= $cnum.'/';
1.482     raeburn  4249:             } else {
                   4250:                 $cnum = $cnumpart;
                   4251:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4252:                 $value .= $cnum.'/'.$sec;
                   4253:             }
                   4254:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4255:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4256:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4257:                 }
                   4258:             } else {
                   4259:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4260:             }
1.482     raeburn  4261:         }
                   4262:     } else {
                   4263:         foreach my $key (keys(%env)) {
1.483     albertel 4264: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4265:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4266: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4267: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4268: 	        next if (%roles && !exists($roles{$role}));
                   4269: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4270:                 my $active=1;
                   4271:                 if ($starttime) {
                   4272: 		    if ($now<$starttime) { $active=0; }
                   4273:                 }
                   4274:                 if ($endtime) {
                   4275:                     if ($now>$endtime) { $active=0; }
                   4276:                 }
                   4277:                 if ($active) {
1.1058    raeburn  4278:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4279:                     if ($sec eq '') {
                   4280:                         $sec = 'none';
1.1058    raeburn  4281:                     } else {
                   4282:                         $value .= $sec;
                   4283:                     }
                   4284:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4285:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4286:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4287:                         }
                   4288:                     } else {
                   4289:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4290:                     }
1.474     raeburn  4291:                 }
                   4292:             }
1.51      www      4293:         }
                   4294:     }
1.474     raeburn  4295:     return %courses;
1.51      www      4296: }
1.37      matthew  4297: 
1.54      www      4298: ###############################################
1.474     raeburn  4299: 
                   4300: sub blockcheck {
1.1062    raeburn  4301:     my ($setters,$activity,$uname,$udom,$url) = @_;
1.490     raeburn  4302: 
                   4303:     if (!defined($udom)) {
                   4304:         $udom = $env{'user.domain'};
                   4305:     }
                   4306:     if (!defined($uname)) {
                   4307:         $uname = $env{'user.name'};
                   4308:     }
                   4309: 
                   4310:     # If uname and udom are for a course, check for blocks in the course.
                   4311: 
                   4312:     if (&Apache::lonnet::is_course($udom,$uname)) {
1.1062    raeburn  4313:         my ($startblock,$endblock,$triggerblock) = 
                   4314:             &get_blocks($setters,$activity,$udom,$uname,$url);
                   4315:         return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4316:     }
1.474     raeburn  4317: 
1.502     raeburn  4318:     my $startblock = 0;
                   4319:     my $endblock = 0;
1.1062    raeburn  4320:     my $triggerblock = '';
1.482     raeburn  4321:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4322: 
1.490     raeburn  4323:     # If uname is for a user, and activity is course-specific, i.e.,
                   4324:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4325: 
1.490     raeburn  4326:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   4327:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   4328:         foreach my $key (keys(%live_courses)) {
                   4329:             if ($key ne $env{'request.course.id'}) {
                   4330:                 delete($live_courses{$key});
                   4331:             }
                   4332:         }
                   4333:     }
                   4334: 
                   4335:     my $otheruser = 0;
                   4336:     my %own_courses;
                   4337:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4338:         # Resource belongs to user other than current user.
                   4339:         $otheruser = 1;
                   4340:         # Gather courses for current user
                   4341:         %own_courses = 
                   4342:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4343:     }
                   4344: 
                   4345:     # Gather active course roles - course coordinator, instructor, 
                   4346:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4347: 
                   4348:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4349:         my ($cdom,$cnum);
                   4350:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4351:             $cdom = $env{'course.'.$course.'.domain'};
                   4352:             $cnum = $env{'course.'.$course.'.num'};
                   4353:         } else {
1.490     raeburn  4354:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4355:         }
                   4356:         my $no_ownblock = 0;
                   4357:         my $no_userblock = 0;
1.533     raeburn  4358:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4359:             # Check if current user has 'evb' priv for this
                   4360:             if (defined($own_courses{$course})) {
                   4361:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4362:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4363:                     if ($sec ne 'none') {
                   4364:                         $checkrole .= '/'.$sec;
                   4365:                     }
                   4366:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4367:                         $no_ownblock = 1;
                   4368:                         last;
                   4369:                     }
                   4370:                 }
                   4371:             }
                   4372:             # if they have 'evb' priv and are currently not playing student
                   4373:             next if (($no_ownblock) &&
                   4374:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4375:         }
1.474     raeburn  4376:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4377:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4378:             if ($sec ne 'none') {
1.482     raeburn  4379:                 $checkrole .= '/'.$sec;
1.474     raeburn  4380:             }
1.490     raeburn  4381:             if ($otheruser) {
                   4382:                 # Resource belongs to user other than current user.
                   4383:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4384:                 my (%allroles,%userroles);
                   4385:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4386:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4387:                         my ($trole,$tdom,$tnum,$tsec);
                   4388:                         if ($entry =~ /^cr/) {
                   4389:                             ($trole,$tdom,$tnum,$tsec) = 
                   4390:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4391:                         } else {
                   4392:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4393:                         }
                   4394:                         my ($spec,$area,$trest);
                   4395:                         $area = '/'.$tdom.'/'.$tnum;
                   4396:                         $trest = $tnum;
                   4397:                         if ($tsec ne '') {
                   4398:                             $area .= '/'.$tsec;
                   4399:                             $trest .= '/'.$tsec;
                   4400:                         }
                   4401:                         $spec = $trole.'.'.$area;
                   4402:                         if ($trole =~ /^cr/) {
                   4403:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4404:                                                               $tdom,$spec,$trest,$area);
                   4405:                         } else {
                   4406:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4407:                                                                 $tdom,$spec,$trest,$area);
                   4408:                         }
                   4409:                     }
                   4410:                     my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
                   4411:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4412:                         if ($1) {
                   4413:                             $no_userblock = 1;
                   4414:                             last;
                   4415:                         }
1.486     raeburn  4416:                     }
                   4417:                 }
1.490     raeburn  4418:             } else {
                   4419:                 # Resource belongs to current user
                   4420:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4421:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4422:                     $no_ownblock = 1;
                   4423:                     last;
                   4424:                 }
1.474     raeburn  4425:             }
                   4426:         }
                   4427:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4428:         next if (($no_ownblock) &&
1.491     albertel 4429:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4430:         next if ($no_userblock);
1.474     raeburn  4431: 
1.866     kalberla 4432:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  4433:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4434:         
1.1062    raeburn  4435:         my ($start,$end,$trigger) = 
                   4436:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4437:         if (($start != 0) && 
                   4438:             (($startblock == 0) || ($startblock > $start))) {
                   4439:             $startblock = $start;
1.1062    raeburn  4440:             if ($trigger ne '') {
                   4441:                 $triggerblock = $trigger;
                   4442:             }
1.502     raeburn  4443:         }
                   4444:         if (($end != 0)  &&
                   4445:             (($endblock == 0) || ($endblock < $end))) {
                   4446:             $endblock = $end;
1.1062    raeburn  4447:             if ($trigger ne '') {
                   4448:                 $triggerblock = $trigger;
                   4449:             }
1.502     raeburn  4450:         }
1.490     raeburn  4451:     }
1.1062    raeburn  4452:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4453: }
                   4454: 
                   4455: sub get_blocks {
1.1062    raeburn  4456:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4457:     my $startblock = 0;
                   4458:     my $endblock = 0;
1.1062    raeburn  4459:     my $triggerblock = '';
1.490     raeburn  4460:     my $course = $cdom.'_'.$cnum;
                   4461:     $setters->{$course} = {};
                   4462:     $setters->{$course}{'staff'} = [];
                   4463:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4464:     $setters->{$course}{'triggers'} = [];
                   4465:     my (@blockers,%triggered);
                   4466:     my $now = time;
                   4467:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4468:     if ($activity eq 'docs') {
                   4469:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4470:         foreach my $block (@blockers) {
                   4471:             if ($block =~ /^firstaccess____(.+)$/) {
                   4472:                 my $item = $1;
                   4473:                 my $type = 'map';
                   4474:                 my $timersymb = $item;
                   4475:                 if ($item eq 'course') {
                   4476:                     $type = 'course';
                   4477:                 } elsif ($item =~ /___\d+___/) {
                   4478:                     $type = 'resource';
                   4479:                 } else {
                   4480:                     $timersymb = &Apache::lonnet::symbread($item);
                   4481:                 }
                   4482:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4483:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4484:                 $triggered{$block} = {
                   4485:                                        start => $start,
                   4486:                                        end   => $end,
                   4487:                                        type  => $type,
                   4488:                                      };
                   4489:             }
                   4490:         }
                   4491:     } else {
                   4492:         foreach my $block (keys(%commblocks)) {
                   4493:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4494:                 my ($start,$end) = ($1,$2);
                   4495:                 if ($start <= time && $end >= time) {
                   4496:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4497:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4498:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4499:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4500:                                     push(@blockers,$block);
                   4501:                                 }
                   4502:                             }
                   4503:                         }
                   4504:                     }
                   4505:                 }
                   4506:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4507:                 my $item = $1;
                   4508:                 my $timersymb = $item; 
                   4509:                 my $type = 'map';
                   4510:                 if ($item eq 'course') {
                   4511:                     $type = 'course';
                   4512:                 } elsif ($item =~ /___\d+___/) {
                   4513:                     $type = 'resource';
                   4514:                 } else {
                   4515:                     $timersymb = &Apache::lonnet::symbread($item);
                   4516:                 }
                   4517:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4518:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4519:                 if ($start && $end) {
                   4520:                     if (($start <= time) && ($end >= time)) {
                   4521:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4522:                             push(@blockers,$block);
                   4523:                             $triggered{$block} = {
                   4524:                                                    start => $start,
                   4525:                                                    end   => $end,
                   4526:                                                    type  => $type,
                   4527:                                                  };
                   4528:                         }
                   4529:                     }
1.490     raeburn  4530:                 }
1.1062    raeburn  4531:             }
                   4532:         }
                   4533:     }
                   4534:     foreach my $blocker (@blockers) {
                   4535:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4536:             &parse_block_record($commblocks{$blocker});
                   4537:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4538:         my ($start,$end,$triggertype);
                   4539:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4540:             ($start,$end) = ($1,$2);
                   4541:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4542:             $start = $triggered{$blocker}{'start'};
                   4543:             $end = $triggered{$blocker}{'end'};
                   4544:             $triggertype = $triggered{$blocker}{'type'};
                   4545:         }
                   4546:         if ($start) {
                   4547:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4548:             if ($triggertype) {
                   4549:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4550:             } else {
                   4551:                 push(@{$$setters{$course}{'triggers'}},0);
                   4552:             }
                   4553:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4554:                 $startblock = $start;
                   4555:                 if ($triggertype) {
                   4556:                     $triggerblock = $blocker;
1.474     raeburn  4557:                 }
                   4558:             }
1.1062    raeburn  4559:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4560:                $endblock = $end;
                   4561:                if ($triggertype) {
                   4562:                    $triggerblock = $blocker;
                   4563:                }
                   4564:             }
1.474     raeburn  4565:         }
                   4566:     }
1.1062    raeburn  4567:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4568: }
                   4569: 
                   4570: sub parse_block_record {
                   4571:     my ($record) = @_;
                   4572:     my ($setuname,$setudom,$title,$blocks);
                   4573:     if (ref($record) eq 'HASH') {
                   4574:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4575:         $title = &unescape($record->{'event'});
                   4576:         $blocks = $record->{'blocks'};
                   4577:     } else {
                   4578:         my @data = split(/:/,$record,3);
                   4579:         if (scalar(@data) eq 2) {
                   4580:             $title = $data[1];
                   4581:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4582:         } else {
                   4583:             ($setuname,$setudom,$title) = @data;
                   4584:         }
                   4585:         $blocks = { 'com' => 'on' };
                   4586:     }
                   4587:     return ($setuname,$setudom,$title,$blocks);
                   4588: }
                   4589: 
1.854     kalberla 4590: sub blocking_status {
1.1062    raeburn  4591:     my ($activity,$uname,$udom,$url) = @_;
1.1061    raeburn  4592:     my %setters;
1.890     droeschl 4593: 
1.1061    raeburn  4594: # check for active blocking
1.1062    raeburn  4595:     my ($startblock,$endblock,$triggerblock) = 
                   4596:         &blockcheck(\%setters,$activity,$uname,$udom,$url);
                   4597:     my $blocked = 0;
                   4598:     if ($startblock && $endblock) {
                   4599:         $blocked = 1;
                   4600:     }
1.890     droeschl 4601: 
1.1061    raeburn  4602: # caller just wants to know whether a block is active
                   4603:     if (!wantarray) { return $blocked; }
                   4604: 
                   4605: # build a link to a popup window containing the details
                   4606:     my $querystring  = "?activity=$activity";
                   4607: # $uname and $udom decide whose portfolio the user is trying to look at
1.1062    raeburn  4608:     if ($activity eq 'port') {
                   4609:         $querystring .= "&amp;udom=$udom"      if $udom;
                   4610:         $querystring .= "&amp;uname=$uname"    if $uname;
                   4611:     } elsif ($activity eq 'docs') {
                   4612:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4613:     }
1.1061    raeburn  4614: 
                   4615:     my $output .= <<'END_MYBLOCK';
                   4616: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4617:     var options = "width=" + w + ",height=" + h + ",";
                   4618:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4619:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4620:     var newWin = window.open(url, wdwName, options);
                   4621:     newWin.focus();
                   4622: }
1.890     droeschl 4623: END_MYBLOCK
1.854     kalberla 4624: 
1.1061    raeburn  4625:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4626:   
1.1061    raeburn  4627:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  4628:     my $text = &mt('Communication Blocked');
                   4629:     if ($activity eq 'docs') {
                   4630:         $text = &mt('Content Access Blocked');
1.1063    raeburn  4631:     } elsif ($activity eq 'printout') {
                   4632:         $text = &mt('Printing Blocked');
1.1062    raeburn  4633:     }
1.1061    raeburn  4634:     $output .= <<"END_BLOCK";
1.867     kalberla 4635: <div class='LC_comblock'>
1.869     kalberla 4636:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4637:   title='$text'>
                   4638:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4639:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4640:   title='$text'>$text</a>
1.867     kalberla 4641: </div>
                   4642: 
                   4643: END_BLOCK
1.474     raeburn  4644: 
1.1061    raeburn  4645:     return ($blocked, $output);
1.854     kalberla 4646: }
1.490     raeburn  4647: 
1.60      matthew  4648: ###############################################
                   4649: 
1.682     raeburn  4650: sub check_ip_acc {
                   4651:     my ($acc)=@_;
                   4652:     &Apache::lonxml::debug("acc is $acc");
                   4653:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4654:         return 1;
                   4655:     }
                   4656:     my $allowed=0;
                   4657:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4658: 
                   4659:     my $name;
                   4660:     foreach my $pattern (split(',',$acc)) {
                   4661:         $pattern =~ s/^\s*//;
                   4662:         $pattern =~ s/\s*$//;
                   4663:         if ($pattern =~ /\*$/) {
                   4664:             #35.8.*
                   4665:             $pattern=~s/\*//;
                   4666:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4667:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4668:             #35.8.3.[34-56]
                   4669:             my $low=$2;
                   4670:             my $high=$3;
                   4671:             $pattern=$1;
                   4672:             if ($ip =~ /^\Q$pattern\E/) {
                   4673:                 my $last=(split(/\./,$ip))[3];
                   4674:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4675:             }
                   4676:         } elsif ($pattern =~ /^\*/) {
                   4677:             #*.msu.edu
                   4678:             $pattern=~s/\*//;
                   4679:             if (!defined($name)) {
                   4680:                 use Socket;
                   4681:                 my $netaddr=inet_aton($ip);
                   4682:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4683:             }
                   4684:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4685:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4686:             #127.0.0.1
                   4687:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4688:         } else {
                   4689:             #some.name.com
                   4690:             if (!defined($name)) {
                   4691:                 use Socket;
                   4692:                 my $netaddr=inet_aton($ip);
                   4693:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4694:             }
                   4695:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4696:         }
                   4697:         if ($allowed) { last; }
                   4698:     }
                   4699:     return $allowed;
                   4700: }
                   4701: 
                   4702: ###############################################
                   4703: 
1.60      matthew  4704: =pod
                   4705: 
1.112     bowersj2 4706: =head1 Domain Template Functions
                   4707: 
                   4708: =over 4
                   4709: 
                   4710: =item * &determinedomain()
1.60      matthew  4711: 
                   4712: Inputs: $domain (usually will be undef)
                   4713: 
1.63      www      4714: Returns: Determines which domain should be used for designs
1.60      matthew  4715: 
                   4716: =cut
1.54      www      4717: 
1.60      matthew  4718: ###############################################
1.63      www      4719: sub determinedomain {
                   4720:     my $domain=shift;
1.531     albertel 4721:     if (! $domain) {
1.60      matthew  4722:         # Determine domain if we have not been given one
1.893     raeburn  4723:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4724:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4725:         if ($env{'request.role.domain'}) { 
                   4726:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4727:         }
                   4728:     }
1.63      www      4729:     return $domain;
                   4730: }
                   4731: ###############################################
1.517     raeburn  4732: 
1.518     albertel 4733: sub devalidate_domconfig_cache {
                   4734:     my ($udom)=@_;
                   4735:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4736: }
                   4737: 
                   4738: # ---------------------- Get domain configuration for a domain
                   4739: sub get_domainconf {
                   4740:     my ($udom) = @_;
                   4741:     my $cachetime=1800;
                   4742:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4743:     if (defined($cached)) { return %{$result}; }
                   4744: 
                   4745:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  4746: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  4747:     my (%designhash,%legacy);
1.518     albertel 4748:     if (keys(%domconfig) > 0) {
                   4749:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4750:             if (keys(%{$domconfig{'login'}})) {
                   4751:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4752:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.946     raeburn  4753:                         if ($key eq 'loginvia') {
                   4754:                             if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') {
1.1013    raeburn  4755:                                 foreach my $hostname (keys(%{$domconfig{'login'}{'loginvia'}})) {
1.948     raeburn  4756:                                     if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') {
                   4757:                                         if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   4758:                                             my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   4759:                                             $designhash{$udom.'.login.loginvia'} = $server;
                   4760:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   4761: 
                   4762:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   4763:                                             } else {
1.1013    raeburn  4764:                                                 $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
1.948     raeburn  4765:                                             }
                   4766:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) {
                   4767:                                                 $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'};
                   4768:                                             }
1.946     raeburn  4769:                                         }
                   4770:                                     }
                   4771:                                 }
                   4772:                             }
                   4773:                         } else {
                   4774:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4775:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4776:                                     $domconfig{'login'}{$key}{$img};
                   4777:                             }
1.699     raeburn  4778:                         }
                   4779:                     } else {
                   4780:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4781:                     }
1.632     raeburn  4782:                 }
                   4783:             } else {
                   4784:                 $legacy{'login'} = 1;
1.518     albertel 4785:             }
1.632     raeburn  4786:         } else {
                   4787:             $legacy{'login'} = 1;
1.518     albertel 4788:         }
                   4789:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4790:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4791:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4792:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4793:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4794:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4795:                         }
1.518     albertel 4796:                     }
                   4797:                 }
1.632     raeburn  4798:             } else {
                   4799:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4800:             }
1.632     raeburn  4801:         } else {
                   4802:             $legacy{'rolecolors'} = 1;
1.518     albertel 4803:         }
1.948     raeburn  4804:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   4805:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   4806:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   4807:             }
                   4808:         }
1.632     raeburn  4809:         if (keys(%legacy) > 0) {
                   4810:             my %legacyhash = &get_legacy_domconf($udom);
                   4811:             foreach my $item (keys(%legacyhash)) {
                   4812:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4813:                     if ($legacy{'login'}) { 
                   4814:                         $designhash{$item} = $legacyhash{$item};
                   4815:                     }
                   4816:                 } else {
                   4817:                     if ($legacy{'rolecolors'}) {
                   4818:                         $designhash{$item} = $legacyhash{$item};
                   4819:                     }
1.518     albertel 4820:                 }
                   4821:             }
                   4822:         }
1.632     raeburn  4823:     } else {
                   4824:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4825:     }
                   4826:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4827: 				  $cachetime);
                   4828:     return %designhash;
                   4829: }
                   4830: 
1.632     raeburn  4831: sub get_legacy_domconf {
                   4832:     my ($udom) = @_;
                   4833:     my %legacyhash;
                   4834:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4835:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4836:     if (-e $designfile) {
                   4837:         if ( open (my $fh,"<$designfile") ) {
                   4838:             while (my $line = <$fh>) {
                   4839:                 next if ($line =~ /^\#/);
                   4840:                 chomp($line);
                   4841:                 my ($key,$val)=(split(/\=/,$line));
                   4842:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4843:             }
                   4844:             close($fh);
                   4845:         }
                   4846:     }
1.1026    raeburn  4847:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  4848:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4849:     }
                   4850:     return %legacyhash;
                   4851: }
                   4852: 
1.63      www      4853: =pod
                   4854: 
1.112     bowersj2 4855: =item * &domainlogo()
1.63      www      4856: 
                   4857: Inputs: $domain (usually will be undef)
                   4858: 
                   4859: Returns: A link to a domain logo, if the domain logo exists.
                   4860: If the domain logo does not exist, a description of the domain.
                   4861: 
                   4862: =cut
1.112     bowersj2 4863: 
1.63      www      4864: ###############################################
                   4865: sub domainlogo {
1.517     raeburn  4866:     my $domain = &determinedomain(shift);
1.518     albertel 4867:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4868:     # See if there is a logo
                   4869:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4870:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4871:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4872: 	    if ($imgsrc =~ m{^/res/}) {
                   4873: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4874: 		&Apache::lonnet::repcopy($local_name);
                   4875: 	    }
                   4876: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4877:         } 
                   4878:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4879:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4880:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4881:     } else {
1.60      matthew  4882:         return '';
1.59      www      4883:     }
                   4884: }
1.63      www      4885: ##############################################
                   4886: 
                   4887: =pod
                   4888: 
1.112     bowersj2 4889: =item * &designparm()
1.63      www      4890: 
                   4891: Inputs: $which parameter; $domain (usually will be undef)
                   4892: 
                   4893: Returns: value of designparamter $which
                   4894: 
                   4895: =cut
1.112     bowersj2 4896: 
1.397     albertel 4897: 
1.400     albertel 4898: ##############################################
1.397     albertel 4899: sub designparm {
                   4900:     my ($which,$domain)=@_;
                   4901:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4902:         return $env{'environment.color.'.$which};
1.96      www      4903:     }
1.63      www      4904:     $domain=&determinedomain($domain);
1.1016    raeburn  4905:     my %domdesign;
                   4906:     unless ($domain eq 'public') {
                   4907:         %domdesign = &get_domainconf($domain);
                   4908:     }
1.520     raeburn  4909:     my $output;
1.517     raeburn  4910:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4911:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4912:     } else {
1.520     raeburn  4913:         $output = $defaultdesign{$which};
                   4914:     }
                   4915:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4916:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4917:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4918:             if ($output =~ m{^/res/}) {
                   4919:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4920:                 &Apache::lonnet::repcopy($local_name);
                   4921:             }
1.520     raeburn  4922:             $output = &lonhttpdurl($output);
                   4923:         }
1.63      www      4924:     }
1.520     raeburn  4925:     return $output;
1.63      www      4926: }
1.59      www      4927: 
1.822     bisitz   4928: ##############################################
                   4929: =pod
                   4930: 
1.832     bisitz   4931: =item * &authorspace()
                   4932: 
1.1028    raeburn  4933: Inputs: $url (usually will be undef).
1.832     bisitz   4934: 
1.1028    raeburn  4935: Returns: Path to Construction Space containing the resource or 
                   4936:          directory being viewed (or for which action is being taken). 
                   4937:          If $url is provided, and begins /priv/<domain>/<uname>
                   4938:          the path will be that portion of the $context argument.
                   4939:          Otherwise the path will be for the author space of the current
                   4940:          user when the current role is author, or for that of the 
                   4941:          co-author/assistant co-author space when the current role 
                   4942:          is co-author or assistant co-author.
1.832     bisitz   4943: 
                   4944: =cut
                   4945: 
                   4946: sub authorspace {
1.1028    raeburn  4947:     my ($url) = @_;
                   4948:     if ($url ne '') {
                   4949:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   4950:            return $1;
                   4951:         }
                   4952:     }
1.832     bisitz   4953:     my $caname = '';
1.1024    www      4954:     my $cadom = '';
1.1028    raeburn  4955:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      4956:         ($cadom,$caname) =
1.832     bisitz   4957:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  4958:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   4959:         $caname = $env{'user.name'};
1.1024    www      4960:         $cadom = $env{'user.domain'};
1.832     bisitz   4961:     }
1.1028    raeburn  4962:     if (($caname ne '') && ($cadom ne '')) {
                   4963:         return "/priv/$cadom/$caname/";
                   4964:     }
                   4965:     return;
1.832     bisitz   4966: }
                   4967: 
                   4968: ##############################################
                   4969: =pod
                   4970: 
1.822     bisitz   4971: =item * &head_subbox()
                   4972: 
                   4973: Inputs: $content (contains HTML code with page functions, etc.)
                   4974: 
                   4975: Returns: HTML div with $content
                   4976:          To be included in page header
                   4977: 
                   4978: =cut
                   4979: 
                   4980: sub head_subbox {
                   4981:     my ($content)=@_;
                   4982:     my $output =
1.993     raeburn  4983:         '<div class="LC_head_subbox">'
1.822     bisitz   4984:        .$content
                   4985:        .'</div>'
                   4986: }
                   4987: 
                   4988: ##############################################
                   4989: =pod
                   4990: 
                   4991: =item * &CSTR_pageheader()
                   4992: 
1.1026    raeburn  4993: Input: (optional) filename from which breadcrumb trail is built.
                   4994:        In most cases no input as needed, as $env{'request.filename'}
                   4995:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   4996: 
                   4997: Returns: HTML div with CSTR path and recent box
                   4998:          To be included on Construction Space pages
                   4999: 
                   5000: =cut
                   5001: 
                   5002: sub CSTR_pageheader {
1.1026    raeburn  5003:     my ($trailfile) = @_;
                   5004:     if ($trailfile eq '') {
                   5005:         $trailfile = $env{'request.filename'};
                   5006:     }
                   5007: 
                   5008: # this is for resources; directories have customtitle, and crumbs
                   5009: # and select recent are created in lonpubdir.pm
                   5010: 
                   5011:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5012:     my ($udom,$uname,$thisdisfn)=
1.1113    raeburn  5013:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5014:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5015:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5016: 
                   5017:     my $parentpath = '';
                   5018:     my $lastitem = '';
                   5019:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5020:         $parentpath = $1;
                   5021:         $lastitem = $2;
                   5022:     } else {
                   5023:         $lastitem = $thisdisfn;
                   5024:     }
1.921     bisitz   5025: 
                   5026:     my $output =
1.822     bisitz   5027:          '<div>'
                   5028:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   5029:         .'<b>'.&mt('Construction Space:').'</b> '
                   5030:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5031:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5032:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5033: 
                   5034:     if ($lastitem) {
                   5035:         $output .=
                   5036:              '<span class="LC_filename">'
                   5037:             .$lastitem
                   5038:             .'</span>';
                   5039:     }
                   5040:     $output .=
                   5041:          '<br />'
1.822     bisitz   5042:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5043:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5044:         .'</form>'
                   5045:         .&Apache::lonmenu::constspaceform()
                   5046:         .'</div>';
1.921     bisitz   5047: 
                   5048:     return $output;
1.822     bisitz   5049: }
                   5050: 
1.60      matthew  5051: ###############################################
                   5052: ###############################################
                   5053: 
                   5054: =pod
                   5055: 
1.112     bowersj2 5056: =back
                   5057: 
1.549     albertel 5058: =head1 HTML Helpers
1.112     bowersj2 5059: 
                   5060: =over 4
                   5061: 
                   5062: =item * &bodytag()
1.60      matthew  5063: 
                   5064: Returns a uniform header for LON-CAPA web pages.
                   5065: 
                   5066: Inputs: 
                   5067: 
1.112     bowersj2 5068: =over 4
                   5069: 
                   5070: =item * $title, A title to be displayed on the page.
                   5071: 
                   5072: =item * $function, the current role (can be undef).
                   5073: 
                   5074: =item * $addentries, extra parameters for the <body> tag.
                   5075: 
                   5076: =item * $bodyonly, if defined, only return the <body> tag.
                   5077: 
                   5078: =item * $domain, if defined, force a given domain.
                   5079: 
                   5080: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5081:             text interface only)
1.60      matthew  5082: 
1.814     bisitz   5083: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5084:                      navigational links
1.317     albertel 5085: 
1.338     albertel 5086: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5087: 
1.460     albertel 5088: =item * $args, optional argument valid values are
                   5089:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 5090:             inherit_jsmath -> when creating popup window in a page,
                   5091:                               should it have jsmath forced on by the
                   5092:                               current page
1.460     albertel 5093: 
1.1096    raeburn  5094: =item * $advtoolsref, optional argument, ref to an array containing
                   5095:             inlineremote items to be added in "Functions" menu below
                   5096:             breadcrumbs.
                   5097: 
1.112     bowersj2 5098: =back
                   5099: 
1.60      matthew  5100: Returns: A uniform header for LON-CAPA web pages.  
                   5101: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5102: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5103: other decorations will be returned.
                   5104: 
                   5105: =cut
                   5106: 
1.54      www      5107: sub bodytag {
1.831     bisitz   5108:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096    raeburn  5109:         $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339     albertel 5110: 
1.954     raeburn  5111:     my $public;
                   5112:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5113:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5114:         $public = 1;
                   5115:     }
1.460     albertel 5116:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 5117: 
1.183     matthew  5118:     $function = &get_users_function() if (!$function);
1.339     albertel 5119:     my $img =    &designparm($function.'.img',$domain);
                   5120:     my $font =   &designparm($function.'.font',$domain);
                   5121:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5122: 
1.803     bisitz   5123:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5124: 		   'bgcolor' => $pgbg,
1.339     albertel 5125: 		   'text'    => $font,
                   5126:                    'alink'   => &designparm($function.'.alink',$domain),
                   5127: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5128: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5129:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5130: 
1.63      www      5131:  # role and realm
1.378     raeburn  5132:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   5133:     if ($role  eq 'ca') {
1.479     albertel 5134:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5135:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5136:     } 
1.55      www      5137: # realm
1.258     albertel 5138:     if ($env{'request.course.id'}) {
1.378     raeburn  5139:         if ($env{'request.role'} !~ /^cr/) {
                   5140:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   5141:         }
1.898     raeburn  5142:         if ($env{'request.course.sec'}) {
                   5143:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5144:         }   
1.359     albertel 5145: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5146:     } else {
                   5147:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5148:     }
1.433     albertel 5149: 
1.359     albertel 5150:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5151: 
1.438     albertel 5152:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5153: 
1.101     www      5154: # construct main body tag
1.359     albertel 5155:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 5156: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 5157: 
1.530     albertel 5158:     if ($bodyonly) {
1.60      matthew  5159:         return $bodytag;
1.798     tempelho 5160:     } 
1.359     albertel 5161: 
1.410     albertel 5162:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.954     raeburn  5163:     if ($public) {
1.433     albertel 5164: 	undef($role);
1.434     albertel 5165:     } else {
1.1070    raeburn  5166: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5167:                                 undef,'LC_menubuttons_link');
1.433     albertel 5168:     }
1.359     albertel 5169:     
1.762     bisitz   5170:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5171:     #
                   5172:     # Extra info if you are the DC
                   5173:     my $dc_info = '';
                   5174:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5175:                         $env{'course.'.$env{'request.course.id'}.
                   5176:                                  '.domain'}.'/'})) {
                   5177:         my $cid = $env{'request.course.id'};
1.917     raeburn  5178:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5179:         $dc_info =~ s/\s+$//;
1.359     albertel 5180:     }
                   5181: 
1.898     raeburn  5182:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 5183:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5184: 
1.916     droeschl 5185:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   5186:             return $bodytag; 
                   5187:         } 
1.903     droeschl 5188: 
                   5189:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5190: 
                   5191:         #    if ($env{'request.state'} eq 'construct') {
                   5192:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5193:         #    }
                   5194: 
1.359     albertel 5195: 
                   5196: 
1.916     droeschl 5197:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  5198:              if ($dc_info) {
                   5199:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5200:              }
1.916     droeschl 5201:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   5202:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5203:             return $bodytag;
                   5204:         }
1.894     droeschl 5205: 
1.927     raeburn  5206:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5207:             $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   5208:         }
1.916     droeschl 5209: 
1.903     droeschl 5210:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   5211:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   5212: 
1.903     droeschl 5213:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 5214: 
1.917     raeburn  5215:         if ($dc_info) {
                   5216:             $dc_info = &dc_courseid_toggle($dc_info);
                   5217:         }
                   5218:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5219: 
1.903     droeschl 5220:         #don't show menus for public users
1.954     raeburn  5221:         if (!$public){
1.903     droeschl 5222:             $bodytag .= Apache::lonmenu::secondary_menu();
                   5223:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5224:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5225:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5226:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5227:                                 $args->{'bread_crumbs'});
1.1096    raeburn  5228:             } elsif ($forcereg) {
                   5229:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
                   5230:                                                             $args->{'group'});
                   5231:             } else {
                   5232:                 $bodytag .= 
                   5233:                     &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5234:                                                         $forcereg,$args->{'group'},
                   5235:                                                         $args->{'bread_crumbs'},
                   5236:                                                         $advtoolsref);
1.920     raeburn  5237:             }
1.903     droeschl 5238:         }else{
                   5239:             # this is to seperate menu from content when there's no secondary
                   5240:             # menu. Especially needed for public accessible ressources.
                   5241:             $bodytag .= '<hr style="clear:both" />';
                   5242:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5243:         }
1.903     droeschl 5244: 
1.235     raeburn  5245:         return $bodytag;
1.182     matthew  5246: }
                   5247: 
1.917     raeburn  5248: sub dc_courseid_toggle {
                   5249:     my ($dc_info) = @_;
1.980     raeburn  5250:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5251:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5252:            &mt('(More ...)').'</a></span>'.
                   5253:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5254: }
                   5255: 
1.330     albertel 5256: sub make_attr_string {
                   5257:     my ($register,$attr_ref) = @_;
                   5258: 
                   5259:     if ($attr_ref && !ref($attr_ref)) {
                   5260: 	die("addentries Must be a hash ref ".
                   5261: 	    join(':',caller(1))." ".
                   5262: 	    join(':',caller(0))." ");
                   5263:     }
                   5264: 
                   5265:     if ($register) {
1.339     albertel 5266: 	my ($on_load,$on_unload);
                   5267: 	foreach my $key (keys(%{$attr_ref})) {
                   5268: 	    if      (lc($key) eq 'onload') {
                   5269: 		$on_load.=$attr_ref->{$key}.';';
                   5270: 		delete($attr_ref->{$key});
                   5271: 
                   5272: 	    } elsif (lc($key) eq 'onunload') {
                   5273: 		$on_unload.=$attr_ref->{$key}.';';
                   5274: 		delete($attr_ref->{$key});
                   5275: 	    }
                   5276: 	}
1.953     droeschl 5277: 	$attr_ref->{'onload'}  = $on_load;
                   5278: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 5279:     }
1.339     albertel 5280: 
1.330     albertel 5281:     my $attr_string;
                   5282:     foreach my $attr (keys(%$attr_ref)) {
                   5283: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5284:     }
                   5285:     return $attr_string;
                   5286: }
                   5287: 
                   5288: 
1.182     matthew  5289: ###############################################
1.251     albertel 5290: ###############################################
                   5291: 
                   5292: =pod
                   5293: 
                   5294: =item * &endbodytag()
                   5295: 
                   5296: Returns a uniform footer for LON-CAPA web pages.
                   5297: 
1.635     raeburn  5298: Inputs: 1 - optional reference to an args hash
                   5299: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5300: a 'Continue' link is not displayed if the page contains an
                   5301: internal redirect in the <head></head> section,
                   5302: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5303: 
                   5304: =cut
                   5305: 
                   5306: sub endbodytag {
1.635     raeburn  5307:     my ($args) = @_;
1.1080    raeburn  5308:     my $endbodytag;
                   5309:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5310:         $endbodytag='</body>';
                   5311:     }
1.269     albertel 5312:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 5313:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5314:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5315: 	    $endbodytag=
                   5316: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5317: 	        &mt('Continue').'</a>'.
                   5318: 	        $endbodytag;
                   5319:         }
1.315     albertel 5320:     }
1.251     albertel 5321:     return $endbodytag;
                   5322: }
                   5323: 
1.352     albertel 5324: =pod
                   5325: 
                   5326: =item * &standard_css()
                   5327: 
                   5328: Returns a style sheet
                   5329: 
                   5330: Inputs: (all optional)
                   5331:             domain         -> force to color decorate a page for a specific
                   5332:                                domain
                   5333:             function       -> force usage of a specific rolish color scheme
                   5334:             bgcolor        -> override the default page bgcolor
                   5335: 
                   5336: =cut
                   5337: 
1.343     albertel 5338: sub standard_css {
1.345     albertel 5339:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5340:     $function  = &get_users_function() if (!$function);
                   5341:     my $img    = &designparm($function.'.img',   $domain);
                   5342:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5343:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5344:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5345: #second colour for later usage
1.345     albertel 5346:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5347:     my $pgbg_or_bgcolor =
                   5348: 	         $bgcolor ||
1.352     albertel 5349: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5350:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5351:     my $alink  = &designparm($function.'.alink', $domain);
                   5352:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5353:     my $link   = &designparm($function.'.link',  $domain);
                   5354: 
1.602     albertel 5355:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5356:     my $mono                 = 'monospace';
1.850     bisitz   5357:     my $data_table_head      = $sidebg;
                   5358:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5359:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5360:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5361:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5362:     my $mail_new             = '#FFBB77';
                   5363:     my $mail_new_hover       = '#DD9955';
                   5364:     my $mail_read            = '#BBBB77';
                   5365:     my $mail_read_hover      = '#999944';
                   5366:     my $mail_replied         = '#AAAA88';
                   5367:     my $mail_replied_hover   = '#888855';
                   5368:     my $mail_other           = '#99BBBB';
                   5369:     my $mail_other_hover     = '#669999';
1.391     albertel 5370:     my $table_header         = '#DDDDDD';
1.489     raeburn  5371:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5372:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5373:     my $button_hover         = '#BF2317';
1.392     albertel 5374: 
1.608     albertel 5375:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5376:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5377:                                              : '0 3px 0 4px';
1.448     albertel 5378: 
1.523     albertel 5379: 
1.343     albertel 5380:     return <<END;
1.947     droeschl 5381: 
                   5382: /* needed for iframe to allow 100% height in FF */
                   5383: body, html { 
                   5384:     margin: 0;
                   5385:     padding: 0 0.5%;
                   5386:     height: 99%; /* to avoid scrollbars */
                   5387: }
                   5388: 
1.795     www      5389: body {
1.911     bisitz   5390:   font-family: $sans;
                   5391:   line-height:130%;
                   5392:   font-size:0.83em;
                   5393:   color:$font;
1.795     www      5394: }
                   5395: 
1.959     onken    5396: a:focus,
                   5397: a:focus img {
1.795     www      5398:   color: red;
                   5399: }
1.698     harmsja  5400: 
1.911     bisitz   5401: form, .inline {
                   5402:   display: inline;
1.795     www      5403: }
1.721     harmsja  5404: 
1.795     www      5405: .LC_right {
1.911     bisitz   5406:   text-align:right;
1.795     www      5407: }
                   5408: 
                   5409: .LC_middle {
1.911     bisitz   5410:   vertical-align:middle;
1.795     www      5411: }
1.721     harmsja  5412: 
1.911     bisitz   5413: .LC_400Box {
                   5414:   width:400px;
                   5415: }
1.721     harmsja  5416: 
1.947     droeschl 5417: .LC_iframecontainer {
                   5418:     width: 98%;
                   5419:     margin: 0;
                   5420:     position: fixed;
                   5421:     top: 8.5em;
                   5422:     bottom: 0;
                   5423: }
                   5424: 
                   5425: .LC_iframecontainer iframe{
                   5426:     border: none;
                   5427:     width: 100%;
                   5428:     height: 100%;
                   5429: }
                   5430: 
1.778     bisitz   5431: .LC_filename {
                   5432:   font-family: $mono;
                   5433:   white-space:pre;
1.921     bisitz   5434:   font-size: 120%;
1.778     bisitz   5435: }
                   5436: 
                   5437: .LC_fileicon {
                   5438:   border: none;
                   5439:   height: 1.3em;
                   5440:   vertical-align: text-bottom;
                   5441:   margin-right: 0.3em;
                   5442:   text-decoration:none;
                   5443: }
                   5444: 
1.1008    www      5445: .LC_setting {
                   5446:   text-decoration:underline;
                   5447: }
                   5448: 
1.350     albertel 5449: .LC_error {
                   5450:   color: red;
                   5451: }
1.795     www      5452: 
1.1097    bisitz   5453: .LC_warning {
                   5454:   color: darkorange;
                   5455: }
                   5456: 
1.457     albertel 5457: .LC_diff_removed {
1.733     bisitz   5458:   color: red;
1.394     albertel 5459: }
1.532     albertel 5460: 
                   5461: .LC_info,
1.457     albertel 5462: .LC_success,
                   5463: .LC_diff_added {
1.350     albertel 5464:   color: green;
                   5465: }
1.795     www      5466: 
1.802     bisitz   5467: div.LC_confirm_box {
                   5468:   background-color: #FAFAFA;
                   5469:   border: 1px solid $lg_border_color;
                   5470:   margin-right: 0;
                   5471:   padding: 5px;
                   5472: }
                   5473: 
                   5474: div.LC_confirm_box .LC_error img,
                   5475: div.LC_confirm_box .LC_success img {
                   5476:   vertical-align: middle;
                   5477: }
                   5478: 
1.440     albertel 5479: .LC_icon {
1.771     droeschl 5480:   border: none;
1.790     droeschl 5481:   vertical-align: middle;
1.771     droeschl 5482: }
                   5483: 
1.543     albertel 5484: .LC_docs_spacer {
                   5485:   width: 25px;
                   5486:   height: 1px;
1.771     droeschl 5487:   border: none;
1.543     albertel 5488: }
1.346     albertel 5489: 
1.532     albertel 5490: .LC_internal_info {
1.735     bisitz   5491:   color: #999999;
1.532     albertel 5492: }
                   5493: 
1.794     www      5494: .LC_discussion {
1.1050    www      5495:   background: $data_table_dark;
1.911     bisitz   5496:   border: 1px solid black;
                   5497:   margin: 2px;
1.794     www      5498: }
                   5499: 
                   5500: .LC_disc_action_left {
1.1050    www      5501:   background: $sidebg;
1.911     bisitz   5502:   text-align: left;
1.1050    www      5503:   padding: 4px;
                   5504:   margin: 2px;
1.794     www      5505: }
                   5506: 
                   5507: .LC_disc_action_right {
1.1050    www      5508:   background: $sidebg;
1.911     bisitz   5509:   text-align: right;
1.1050    www      5510:   padding: 4px;
                   5511:   margin: 2px;
1.794     www      5512: }
                   5513: 
                   5514: .LC_disc_new_item {
1.911     bisitz   5515:   background: white;
                   5516:   border: 2px solid red;
1.1050    www      5517:   margin: 4px;
                   5518:   padding: 4px;
1.794     www      5519: }
                   5520: 
                   5521: .LC_disc_old_item {
1.911     bisitz   5522:   background: white;
1.1050    www      5523:   margin: 4px;
                   5524:   padding: 4px;
1.794     www      5525: }
                   5526: 
1.458     albertel 5527: table.LC_pastsubmission {
                   5528:   border: 1px solid black;
                   5529:   margin: 2px;
                   5530: }
                   5531: 
1.924     bisitz   5532: table#LC_menubuttons {
1.345     albertel 5533:   width: 100%;
                   5534:   background: $pgbg;
1.392     albertel 5535:   border: 2px;
1.402     albertel 5536:   border-collapse: separate;
1.803     bisitz   5537:   padding: 0;
1.345     albertel 5538: }
1.392     albertel 5539: 
1.801     tempelho 5540: table#LC_title_bar a {
                   5541:   color: $fontmenu;
                   5542: }
1.836     bisitz   5543: 
1.807     droeschl 5544: table#LC_title_bar {
1.819     tempelho 5545:   clear: both;
1.836     bisitz   5546:   display: none;
1.807     droeschl 5547: }
                   5548: 
1.795     www      5549: table#LC_title_bar,
1.933     droeschl 5550: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5551: table#LC_title_bar.LC_with_remote {
1.359     albertel 5552:   width: 100%;
1.392     albertel 5553:   border-color: $pgbg;
                   5554:   border-style: solid;
                   5555:   border-width: $border;
1.379     albertel 5556:   background: $pgbg;
1.801     tempelho 5557:   color: $fontmenu;
1.392     albertel 5558:   border-collapse: collapse;
1.803     bisitz   5559:   padding: 0;
1.819     tempelho 5560:   margin: 0;
1.359     albertel 5561: }
1.795     www      5562: 
1.933     droeschl 5563: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5564:     margin: 0;
                   5565:     padding: 0;
1.933     droeschl 5566:     position: relative;
                   5567:     list-style: none;
1.913     droeschl 5568: }
1.933     droeschl 5569: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5570:     display: inline;
                   5571: }
1.933     droeschl 5572: 
                   5573: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5574:     padding: 0;
1.933     droeschl 5575:     margin: 0;
                   5576:     float: left;
1.913     droeschl 5577: }
1.933     droeschl 5578: .LC_breadcrumb_tools_tools {
                   5579:     padding: 0;
                   5580:     margin: 0;
1.913     droeschl 5581:     float: right;
                   5582: }
                   5583: 
1.359     albertel 5584: table#LC_title_bar td {
                   5585:   background: $tabbg;
                   5586: }
1.795     www      5587: 
1.911     bisitz   5588: table#LC_menubuttons img {
1.803     bisitz   5589:   border: none;
1.346     albertel 5590: }
1.795     www      5591: 
1.842     droeschl 5592: .LC_breadcrumbs_component {
1.911     bisitz   5593:   float: right;
                   5594:   margin: 0 1em;
1.357     albertel 5595: }
1.842     droeschl 5596: .LC_breadcrumbs_component img {
1.911     bisitz   5597:   vertical-align: middle;
1.777     tempelho 5598: }
1.795     www      5599: 
1.383     albertel 5600: td.LC_table_cell_checkbox {
                   5601:   text-align: center;
                   5602: }
1.795     www      5603: 
                   5604: .LC_fontsize_small {
1.911     bisitz   5605:   font-size: 70%;
1.705     tempelho 5606: }
                   5607: 
1.844     bisitz   5608: #LC_breadcrumbs {
1.911     bisitz   5609:   clear:both;
                   5610:   background: $sidebg;
                   5611:   border-bottom: 1px solid $lg_border_color;
                   5612:   line-height: 2.5em;
1.933     droeschl 5613:   overflow: hidden;
1.911     bisitz   5614:   margin: 0;
                   5615:   padding: 0;
1.995     raeburn  5616:   text-align: left;
1.819     tempelho 5617: }
1.862     bisitz   5618: 
1.1098    bisitz   5619: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   5620:   clear:both;
                   5621:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5622:   border: 1px solid $sidebg;
1.1098    bisitz   5623:   margin: 0 0 10px 0;
1.966     bisitz   5624:   padding: 3px;
1.995     raeburn  5625:   text-align: left;
1.822     bisitz   5626: }
                   5627: 
1.795     www      5628: .LC_fontsize_medium {
1.911     bisitz   5629:   font-size: 85%;
1.705     tempelho 5630: }
                   5631: 
1.795     www      5632: .LC_fontsize_large {
1.911     bisitz   5633:   font-size: 120%;
1.705     tempelho 5634: }
                   5635: 
1.346     albertel 5636: .LC_menubuttons_inline_text {
                   5637:   color: $font;
1.698     harmsja  5638:   font-size: 90%;
1.701     harmsja  5639:   padding-left:3px;
1.346     albertel 5640: }
                   5641: 
1.934     droeschl 5642: .LC_menubuttons_inline_text img{
                   5643:   vertical-align: middle;
                   5644: }
                   5645: 
1.1051    www      5646: li.LC_menubuttons_inline_text img {
1.951     onken    5647:   cursor:pointer;
1.1002    droeschl 5648:   text-decoration: none;
1.951     onken    5649: }
                   5650: 
1.526     www      5651: .LC_menubuttons_link {
                   5652:   text-decoration: none;
                   5653: }
1.795     www      5654: 
1.522     albertel 5655: .LC_menubuttons_category {
1.521     www      5656:   color: $font;
1.526     www      5657:   background: $pgbg;
1.521     www      5658:   font-size: larger;
                   5659:   font-weight: bold;
                   5660: }
                   5661: 
1.346     albertel 5662: td.LC_menubuttons_text {
1.911     bisitz   5663:   color: $font;
1.346     albertel 5664: }
1.706     harmsja  5665: 
1.346     albertel 5666: .LC_current_location {
                   5667:   background: $tabbg;
                   5668: }
1.795     www      5669: 
1.938     bisitz   5670: table.LC_data_table {
1.347     albertel 5671:   border: 1px solid #000000;
1.402     albertel 5672:   border-collapse: separate;
1.426     albertel 5673:   border-spacing: 1px;
1.610     albertel 5674:   background: $pgbg;
1.347     albertel 5675: }
1.795     www      5676: 
1.422     albertel 5677: .LC_data_table_dense {
                   5678:   font-size: small;
                   5679: }
1.795     www      5680: 
1.507     raeburn  5681: table.LC_nested_outer {
                   5682:   border: 1px solid #000000;
1.589     raeburn  5683:   border-collapse: collapse;
1.803     bisitz   5684:   border-spacing: 0;
1.507     raeburn  5685:   width: 100%;
                   5686: }
1.795     www      5687: 
1.879     raeburn  5688: table.LC_innerpickbox,
1.507     raeburn  5689: table.LC_nested {
1.803     bisitz   5690:   border: none;
1.589     raeburn  5691:   border-collapse: collapse;
1.803     bisitz   5692:   border-spacing: 0;
1.507     raeburn  5693:   width: 100%;
                   5694: }
1.795     www      5695: 
1.911     bisitz   5696: table.LC_data_table tr th,
                   5697: table.LC_calendar tr th,
1.879     raeburn  5698: table.LC_prior_tries tr th,
                   5699: table.LC_innerpickbox tr th {
1.349     albertel 5700:   font-weight: bold;
                   5701:   background-color: $data_table_head;
1.801     tempelho 5702:   color:$fontmenu;
1.701     harmsja  5703:   font-size:90%;
1.347     albertel 5704: }
1.795     www      5705: 
1.879     raeburn  5706: table.LC_innerpickbox tr th,
                   5707: table.LC_innerpickbox tr td {
                   5708:   vertical-align: top;
                   5709: }
                   5710: 
1.711     raeburn  5711: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5712:   background-color: #CCCCCC;
1.711     raeburn  5713:   font-weight: bold;
                   5714:   text-align: left;
                   5715: }
1.795     www      5716: 
1.912     bisitz   5717: table.LC_data_table tr.LC_odd_row > td {
                   5718:   background-color: $data_table_light;
                   5719:   padding: 2px;
                   5720:   vertical-align: top;
                   5721: }
                   5722: 
1.809     bisitz   5723: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5724:   background-color: $data_table_light;
1.912     bisitz   5725:   vertical-align: top;
                   5726: }
                   5727: 
                   5728: table.LC_data_table tr.LC_even_row > td {
                   5729:   background-color: $data_table_dark;
1.425     albertel 5730:   padding: 2px;
1.900     bisitz   5731:   vertical-align: top;
1.347     albertel 5732: }
1.795     www      5733: 
1.809     bisitz   5734: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5735:   background-color: $data_table_dark;
1.900     bisitz   5736:   vertical-align: top;
1.347     albertel 5737: }
1.795     www      5738: 
1.425     albertel 5739: table.LC_data_table tr.LC_data_table_highlight td {
                   5740:   background-color: $data_table_darker;
                   5741: }
1.795     www      5742: 
1.639     raeburn  5743: table.LC_data_table tr td.LC_leftcol_header {
                   5744:   background-color: $data_table_head;
                   5745:   font-weight: bold;
                   5746: }
1.795     www      5747: 
1.451     albertel 5748: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5749: table.LC_nested tr.LC_empty_row td {
1.421     albertel 5750:   font-weight: bold;
                   5751:   font-style: italic;
                   5752:   text-align: center;
                   5753:   padding: 8px;
1.347     albertel 5754: }
1.795     www      5755: 
1.1114    raeburn  5756: table.LC_data_table tr.LC_empty_row td,
                   5757: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   5758:   background-color: $sidebg;
                   5759: }
                   5760: 
                   5761: table.LC_nested tr.LC_empty_row td {
                   5762:   background-color: #FFFFFF;
                   5763: }
                   5764: 
1.890     droeschl 5765: table.LC_caption {
                   5766: }
                   5767: 
1.507     raeburn  5768: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5769:   padding: 4ex
                   5770: }
1.795     www      5771: 
1.507     raeburn  5772: table.LC_nested_outer tr th {
                   5773:   font-weight: bold;
1.801     tempelho 5774:   color:$fontmenu;
1.507     raeburn  5775:   background-color: $data_table_head;
1.701     harmsja  5776:   font-size: small;
1.507     raeburn  5777:   border-bottom: 1px solid #000000;
                   5778: }
1.795     www      5779: 
1.507     raeburn  5780: table.LC_nested_outer tr td.LC_subheader {
                   5781:   background-color: $data_table_head;
                   5782:   font-weight: bold;
                   5783:   font-size: small;
                   5784:   border-bottom: 1px solid #000000;
                   5785:   text-align: right;
1.451     albertel 5786: }
1.795     www      5787: 
1.507     raeburn  5788: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5789:   background-color: #CCCCCC;
1.451     albertel 5790:   font-weight: bold;
                   5791:   font-size: small;
1.507     raeburn  5792:   text-align: center;
                   5793: }
1.795     www      5794: 
1.589     raeburn  5795: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5796: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5797:   text-align: left;
1.451     albertel 5798: }
1.795     www      5799: 
1.507     raeburn  5800: table.LC_nested td {
1.735     bisitz   5801:   background-color: #FFFFFF;
1.451     albertel 5802:   font-size: small;
1.507     raeburn  5803: }
1.795     www      5804: 
1.507     raeburn  5805: table.LC_nested_outer tr th.LC_right_item,
                   5806: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5807: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5808: table.LC_nested tr td.LC_right_item {
1.451     albertel 5809:   text-align: right;
                   5810: }
                   5811: 
1.507     raeburn  5812: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5813:   background-color: #EEEEEE;
1.451     albertel 5814: }
                   5815: 
1.473     raeburn  5816: table.LC_createuser {
                   5817: }
                   5818: 
                   5819: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5820:   font-size: small;
1.473     raeburn  5821: }
                   5822: 
                   5823: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5824:   background-color: #CCCCCC;
1.473     raeburn  5825:   font-weight: bold;
                   5826:   text-align: center;
                   5827: }
                   5828: 
1.349     albertel 5829: table.LC_calendar {
                   5830:   border: 1px solid #000000;
                   5831:   border-collapse: collapse;
1.917     raeburn  5832:   width: 98%;
1.349     albertel 5833: }
1.795     www      5834: 
1.349     albertel 5835: table.LC_calendar_pickdate {
                   5836:   font-size: xx-small;
                   5837: }
1.795     www      5838: 
1.349     albertel 5839: table.LC_calendar tr td {
                   5840:   border: 1px solid #000000;
                   5841:   vertical-align: top;
1.917     raeburn  5842:   width: 14%;
1.349     albertel 5843: }
1.795     www      5844: 
1.349     albertel 5845: table.LC_calendar tr td.LC_calendar_day_empty {
                   5846:   background-color: $data_table_dark;
                   5847: }
1.795     www      5848: 
1.779     bisitz   5849: table.LC_calendar tr td.LC_calendar_day_current {
                   5850:   background-color: $data_table_highlight;
1.777     tempelho 5851: }
1.795     www      5852: 
1.938     bisitz   5853: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 5854:   background-color: $mail_new;
                   5855: }
1.795     www      5856: 
1.938     bisitz   5857: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 5858:   background-color: $mail_new_hover;
                   5859: }
1.795     www      5860: 
1.938     bisitz   5861: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 5862:   background-color: $mail_read;
                   5863: }
1.795     www      5864: 
1.938     bisitz   5865: /*
                   5866: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 5867:   background-color: $mail_read_hover;
                   5868: }
1.938     bisitz   5869: */
1.795     www      5870: 
1.938     bisitz   5871: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 5872:   background-color: $mail_replied;
                   5873: }
1.795     www      5874: 
1.938     bisitz   5875: /*
                   5876: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 5877:   background-color: $mail_replied_hover;
                   5878: }
1.938     bisitz   5879: */
1.795     www      5880: 
1.938     bisitz   5881: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 5882:   background-color: $mail_other;
                   5883: }
1.795     www      5884: 
1.938     bisitz   5885: /*
                   5886: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 5887:   background-color: $mail_other_hover;
                   5888: }
1.938     bisitz   5889: */
1.494     raeburn  5890: 
1.777     tempelho 5891: table.LC_data_table tr > td.LC_browser_file,
                   5892: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5893:   background: #AAEE77;
1.389     albertel 5894: }
1.795     www      5895: 
1.777     tempelho 5896: table.LC_data_table tr > td.LC_browser_file_locked,
                   5897: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5898:   background: #FFAA99;
1.387     albertel 5899: }
1.795     www      5900: 
1.777     tempelho 5901: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5902:   background: #888888;
1.779     bisitz   5903: }
1.795     www      5904: 
1.777     tempelho 5905: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5906: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5907:   background: #F8F866;
1.777     tempelho 5908: }
1.795     www      5909: 
1.696     bisitz   5910: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5911:   background: #E0E8FF;
1.387     albertel 5912: }
1.696     bisitz   5913: 
1.707     bisitz   5914: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5915:   /* background: #77FF77; */
1.707     bisitz   5916: }
1.795     www      5917: 
1.707     bisitz   5918: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   5919:   border-right: 8px solid #FFFF77;
1.707     bisitz   5920: }
1.795     www      5921: 
1.707     bisitz   5922: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   5923:   border-right: 8px solid #FFAA77;
1.707     bisitz   5924: }
1.795     www      5925: 
1.707     bisitz   5926: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   5927:   border-right: 8px solid #FF7777;
1.707     bisitz   5928: }
1.795     www      5929: 
1.707     bisitz   5930: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   5931:   border-right: 8px solid #AAFF77;
1.707     bisitz   5932: }
1.795     www      5933: 
1.707     bisitz   5934: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   5935:   border-right: 8px solid #11CC55;
1.707     bisitz   5936: }
                   5937: 
1.388     albertel 5938: span.LC_current_location {
1.701     harmsja  5939:   font-size:larger;
1.388     albertel 5940:   background: $pgbg;
                   5941: }
1.387     albertel 5942: 
1.1029    www      5943: span.LC_current_nav_location {
                   5944:   font-weight:bold;
                   5945:   background: $sidebg;
                   5946: }
                   5947: 
1.395     albertel 5948: span.LC_parm_menu_item {
                   5949:   font-size: larger;
                   5950: }
1.795     www      5951: 
1.395     albertel 5952: span.LC_parm_scope_all {
                   5953:   color: red;
                   5954: }
1.795     www      5955: 
1.395     albertel 5956: span.LC_parm_scope_folder {
                   5957:   color: green;
                   5958: }
1.795     www      5959: 
1.395     albertel 5960: span.LC_parm_scope_resource {
                   5961:   color: orange;
                   5962: }
1.795     www      5963: 
1.395     albertel 5964: span.LC_parm_part {
                   5965:   color: blue;
                   5966: }
1.795     www      5967: 
1.911     bisitz   5968: span.LC_parm_folder,
                   5969: span.LC_parm_symb {
1.395     albertel 5970:   font-size: x-small;
                   5971:   font-family: $mono;
                   5972:   color: #AAAAAA;
                   5973: }
                   5974: 
1.977     bisitz   5975: ul.LC_parm_parmlist li {
                   5976:   display: inline-block;
                   5977:   padding: 0.3em 0.8em;
                   5978:   vertical-align: top;
                   5979:   width: 150px;
                   5980:   border-top:1px solid $lg_border_color;
                   5981: }
                   5982: 
1.795     www      5983: td.LC_parm_overview_level_menu,
                   5984: td.LC_parm_overview_map_menu,
                   5985: td.LC_parm_overview_parm_selectors,
                   5986: td.LC_parm_overview_restrictions  {
1.396     albertel 5987:   border: 1px solid black;
                   5988:   border-collapse: collapse;
                   5989: }
1.795     www      5990: 
1.396     albertel 5991: table.LC_parm_overview_restrictions td {
                   5992:   border-width: 1px 4px 1px 4px;
                   5993:   border-style: solid;
                   5994:   border-color: $pgbg;
                   5995:   text-align: center;
                   5996: }
1.795     www      5997: 
1.396     albertel 5998: table.LC_parm_overview_restrictions th {
                   5999:   background: $tabbg;
                   6000:   border-width: 1px 4px 1px 4px;
                   6001:   border-style: solid;
                   6002:   border-color: $pgbg;
                   6003: }
1.795     www      6004: 
1.398     albertel 6005: table#LC_helpmenu {
1.803     bisitz   6006:   border: none;
1.398     albertel 6007:   height: 55px;
1.803     bisitz   6008:   border-spacing: 0;
1.398     albertel 6009: }
                   6010: 
                   6011: table#LC_helpmenu fieldset legend {
                   6012:   font-size: larger;
                   6013: }
1.795     www      6014: 
1.397     albertel 6015: table#LC_helpmenu_links {
                   6016:   width: 100%;
                   6017:   border: 1px solid black;
                   6018:   background: $pgbg;
1.803     bisitz   6019:   padding: 0;
1.397     albertel 6020:   border-spacing: 1px;
                   6021: }
1.795     www      6022: 
1.397     albertel 6023: table#LC_helpmenu_links tr td {
                   6024:   padding: 1px;
                   6025:   background: $tabbg;
1.399     albertel 6026:   text-align: center;
                   6027:   font-weight: bold;
1.397     albertel 6028: }
1.396     albertel 6029: 
1.795     www      6030: table#LC_helpmenu_links a:link,
                   6031: table#LC_helpmenu_links a:visited,
1.397     albertel 6032: table#LC_helpmenu_links a:active {
                   6033:   text-decoration: none;
                   6034:   color: $font;
                   6035: }
1.795     www      6036: 
1.397     albertel 6037: table#LC_helpmenu_links a:hover {
                   6038:   text-decoration: underline;
                   6039:   color: $vlink;
                   6040: }
1.396     albertel 6041: 
1.417     albertel 6042: .LC_chrt_popup_exists {
                   6043:   border: 1px solid #339933;
                   6044:   margin: -1px;
                   6045: }
1.795     www      6046: 
1.417     albertel 6047: .LC_chrt_popup_up {
                   6048:   border: 1px solid yellow;
                   6049:   margin: -1px;
                   6050: }
1.795     www      6051: 
1.417     albertel 6052: .LC_chrt_popup {
                   6053:   border: 1px solid #8888FF;
                   6054:   background: #CCCCFF;
                   6055: }
1.795     www      6056: 
1.421     albertel 6057: table.LC_pick_box {
                   6058:   border-collapse: separate;
                   6059:   background: white;
                   6060:   border: 1px solid black;
                   6061:   border-spacing: 1px;
                   6062: }
1.795     www      6063: 
1.421     albertel 6064: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6065:   background: $sidebg;
1.421     albertel 6066:   font-weight: bold;
1.900     bisitz   6067:   text-align: left;
1.740     bisitz   6068:   vertical-align: top;
1.421     albertel 6069:   width: 184px;
                   6070:   padding: 8px;
                   6071: }
1.795     www      6072: 
1.579     raeburn  6073: table.LC_pick_box td.LC_pick_box_value {
                   6074:   text-align: left;
                   6075:   padding: 8px;
                   6076: }
1.795     www      6077: 
1.579     raeburn  6078: table.LC_pick_box td.LC_pick_box_select {
                   6079:   text-align: left;
                   6080:   padding: 8px;
                   6081: }
1.795     www      6082: 
1.424     albertel 6083: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6084:   padding: 0;
1.421     albertel 6085:   height: 1px;
                   6086:   background: black;
                   6087: }
1.795     www      6088: 
1.421     albertel 6089: table.LC_pick_box td.LC_pick_box_submit {
                   6090:   text-align: right;
                   6091: }
1.795     www      6092: 
1.579     raeburn  6093: table.LC_pick_box td.LC_evenrow_value {
                   6094:   text-align: left;
                   6095:   padding: 8px;
                   6096:   background-color: $data_table_light;
                   6097: }
1.795     www      6098: 
1.579     raeburn  6099: table.LC_pick_box td.LC_oddrow_value {
                   6100:   text-align: left;
                   6101:   padding: 8px;
                   6102:   background-color: $data_table_light;
                   6103: }
1.795     www      6104: 
1.579     raeburn  6105: span.LC_helpform_receipt_cat {
                   6106:   font-weight: bold;
                   6107: }
1.795     www      6108: 
1.424     albertel 6109: table.LC_group_priv_box {
                   6110:   background: white;
                   6111:   border: 1px solid black;
                   6112:   border-spacing: 1px;
                   6113: }
1.795     www      6114: 
1.424     albertel 6115: table.LC_group_priv_box td.LC_pick_box_title {
                   6116:   background: $tabbg;
                   6117:   font-weight: bold;
                   6118:   text-align: right;
                   6119:   width: 184px;
                   6120: }
1.795     www      6121: 
1.424     albertel 6122: table.LC_group_priv_box td.LC_groups_fixed {
                   6123:   background: $data_table_light;
                   6124:   text-align: center;
                   6125: }
1.795     www      6126: 
1.424     albertel 6127: table.LC_group_priv_box td.LC_groups_optional {
                   6128:   background: $data_table_dark;
                   6129:   text-align: center;
                   6130: }
1.795     www      6131: 
1.424     albertel 6132: table.LC_group_priv_box td.LC_groups_functionality {
                   6133:   background: $data_table_darker;
                   6134:   text-align: center;
                   6135:   font-weight: bold;
                   6136: }
1.795     www      6137: 
1.424     albertel 6138: table.LC_group_priv td {
                   6139:   text-align: left;
1.803     bisitz   6140:   padding: 0;
1.424     albertel 6141: }
                   6142: 
                   6143: .LC_navbuttons {
                   6144:   margin: 2ex 0ex 2ex 0ex;
                   6145: }
1.795     www      6146: 
1.423     albertel 6147: .LC_topic_bar {
                   6148:   font-weight: bold;
                   6149:   background: $tabbg;
1.918     wenzelju 6150:   margin: 1em 0em 1em 2em;
1.805     bisitz   6151:   padding: 3px;
1.918     wenzelju 6152:   font-size: 1.2em;
1.423     albertel 6153: }
1.795     www      6154: 
1.423     albertel 6155: .LC_topic_bar span {
1.918     wenzelju 6156:   left: 0.5em;
                   6157:   position: absolute;
1.423     albertel 6158:   vertical-align: middle;
1.918     wenzelju 6159:   font-size: 1.2em;
1.423     albertel 6160: }
1.795     www      6161: 
1.423     albertel 6162: table.LC_course_group_status {
                   6163:   margin: 20px;
                   6164: }
1.795     www      6165: 
1.423     albertel 6166: table.LC_status_selector td {
                   6167:   vertical-align: top;
                   6168:   text-align: center;
1.424     albertel 6169:   padding: 4px;
                   6170: }
1.795     www      6171: 
1.599     albertel 6172: div.LC_feedback_link {
1.616     albertel 6173:   clear: both;
1.829     kalberla 6174:   background: $sidebg;
1.779     bisitz   6175:   width: 100%;
1.829     kalberla 6176:   padding-bottom: 10px;
                   6177:   border: 1px $tabbg solid;
1.833     kalberla 6178:   height: 22px;
                   6179:   line-height: 22px;
                   6180:   padding-top: 5px;
                   6181: }
                   6182: 
                   6183: div.LC_feedback_link img {
                   6184:   height: 22px;
1.867     kalberla 6185:   vertical-align:middle;
1.829     kalberla 6186: }
                   6187: 
1.911     bisitz   6188: div.LC_feedback_link a {
1.829     kalberla 6189:   text-decoration: none;
1.489     raeburn  6190: }
1.795     www      6191: 
1.867     kalberla 6192: div.LC_comblock {
1.911     bisitz   6193:   display:inline;
1.867     kalberla 6194:   color:$font;
                   6195:   font-size:90%;
                   6196: }
                   6197: 
                   6198: div.LC_feedback_link div.LC_comblock {
                   6199:   padding-left:5px;
                   6200: }
                   6201: 
                   6202: div.LC_feedback_link div.LC_comblock a {
                   6203:   color:$font;
                   6204: }
                   6205: 
1.489     raeburn  6206: span.LC_feedback_link {
1.858     bisitz   6207:   /* background: $feedback_link_bg; */
1.599     albertel 6208:   font-size: larger;
                   6209: }
1.795     www      6210: 
1.599     albertel 6211: span.LC_message_link {
1.858     bisitz   6212:   /* background: $feedback_link_bg; */
1.599     albertel 6213:   font-size: larger;
                   6214:   position: absolute;
                   6215:   right: 1em;
1.489     raeburn  6216: }
1.421     albertel 6217: 
1.515     albertel 6218: table.LC_prior_tries {
1.524     albertel 6219:   border: 1px solid #000000;
                   6220:   border-collapse: separate;
                   6221:   border-spacing: 1px;
1.515     albertel 6222: }
1.523     albertel 6223: 
1.515     albertel 6224: table.LC_prior_tries td {
1.524     albertel 6225:   padding: 2px;
1.515     albertel 6226: }
1.523     albertel 6227: 
                   6228: .LC_answer_correct {
1.795     www      6229:   background: lightgreen;
                   6230:   color: darkgreen;
                   6231:   padding: 6px;
1.523     albertel 6232: }
1.795     www      6233: 
1.523     albertel 6234: .LC_answer_charged_try {
1.797     www      6235:   background: #FFAAAA;
1.795     www      6236:   color: darkred;
                   6237:   padding: 6px;
1.523     albertel 6238: }
1.795     www      6239: 
1.779     bisitz   6240: .LC_answer_not_charged_try,
1.523     albertel 6241: .LC_answer_no_grade,
                   6242: .LC_answer_late {
1.795     www      6243:   background: lightyellow;
1.523     albertel 6244:   color: black;
1.795     www      6245:   padding: 6px;
1.523     albertel 6246: }
1.795     www      6247: 
1.523     albertel 6248: .LC_answer_previous {
1.795     www      6249:   background: lightblue;
                   6250:   color: darkblue;
                   6251:   padding: 6px;
1.523     albertel 6252: }
1.795     www      6253: 
1.779     bisitz   6254: .LC_answer_no_message {
1.777     tempelho 6255:   background: #FFFFFF;
                   6256:   color: black;
1.795     www      6257:   padding: 6px;
1.779     bisitz   6258: }
1.795     www      6259: 
1.779     bisitz   6260: .LC_answer_unknown {
                   6261:   background: orange;
                   6262:   color: black;
1.795     www      6263:   padding: 6px;
1.777     tempelho 6264: }
1.795     www      6265: 
1.529     albertel 6266: span.LC_prior_numerical,
                   6267: span.LC_prior_string,
                   6268: span.LC_prior_custom,
                   6269: span.LC_prior_reaction,
                   6270: span.LC_prior_math {
1.925     bisitz   6271:   font-family: $mono;
1.523     albertel 6272:   white-space: pre;
                   6273: }
                   6274: 
1.525     albertel 6275: span.LC_prior_string {
1.925     bisitz   6276:   font-family: $mono;
1.525     albertel 6277:   white-space: pre;
                   6278: }
                   6279: 
1.523     albertel 6280: table.LC_prior_option {
                   6281:   width: 100%;
                   6282:   border-collapse: collapse;
                   6283: }
1.795     www      6284: 
1.911     bisitz   6285: table.LC_prior_rank,
1.795     www      6286: table.LC_prior_match {
1.528     albertel 6287:   border-collapse: collapse;
                   6288: }
1.795     www      6289: 
1.528     albertel 6290: table.LC_prior_option tr td,
                   6291: table.LC_prior_rank tr td,
                   6292: table.LC_prior_match tr td {
1.524     albertel 6293:   border: 1px solid #000000;
1.515     albertel 6294: }
                   6295: 
1.855     bisitz   6296: .LC_nobreak {
1.544     albertel 6297:   white-space: nowrap;
1.519     raeburn  6298: }
                   6299: 
1.576     raeburn  6300: span.LC_cusr_emph {
                   6301:   font-style: italic;
                   6302: }
                   6303: 
1.633     raeburn  6304: span.LC_cusr_subheading {
                   6305:   font-weight: normal;
                   6306:   font-size: 85%;
                   6307: }
                   6308: 
1.861     bisitz   6309: div.LC_docs_entry_move {
1.859     bisitz   6310:   border: 1px solid #BBBBBB;
1.545     albertel 6311:   background: #DDDDDD;
1.861     bisitz   6312:   width: 22px;
1.859     bisitz   6313:   padding: 1px;
                   6314:   margin: 0;
1.545     albertel 6315: }
                   6316: 
1.861     bisitz   6317: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6318: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6319:   font-size: x-small;
                   6320: }
1.795     www      6321: 
1.861     bisitz   6322: .LC_docs_entry_parameter {
                   6323:   white-space: nowrap;
                   6324: }
                   6325: 
1.544     albertel 6326: .LC_docs_copy {
1.545     albertel 6327:   color: #000099;
1.544     albertel 6328: }
1.795     www      6329: 
1.544     albertel 6330: .LC_docs_cut {
1.545     albertel 6331:   color: #550044;
1.544     albertel 6332: }
1.795     www      6333: 
1.544     albertel 6334: .LC_docs_rename {
1.545     albertel 6335:   color: #009900;
1.544     albertel 6336: }
1.795     www      6337: 
1.544     albertel 6338: .LC_docs_remove {
1.545     albertel 6339:   color: #990000;
                   6340: }
                   6341: 
1.547     albertel 6342: .LC_docs_reinit_warn,
                   6343: .LC_docs_ext_edit {
                   6344:   font-size: x-small;
                   6345: }
                   6346: 
1.545     albertel 6347: table.LC_docs_adddocs td,
                   6348: table.LC_docs_adddocs th {
                   6349:   border: 1px solid #BBBBBB;
                   6350:   padding: 4px;
                   6351:   background: #DDDDDD;
1.543     albertel 6352: }
                   6353: 
1.584     albertel 6354: table.LC_sty_begin {
                   6355:   background: #BBFFBB;
                   6356: }
1.795     www      6357: 
1.584     albertel 6358: table.LC_sty_end {
                   6359:   background: #FFBBBB;
                   6360: }
                   6361: 
1.589     raeburn  6362: table.LC_double_column {
1.803     bisitz   6363:   border-width: 0;
1.589     raeburn  6364:   border-collapse: collapse;
                   6365:   width: 100%;
                   6366:   padding: 2px;
                   6367: }
                   6368: 
                   6369: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6370:   top: 2px;
1.589     raeburn  6371:   left: 2px;
                   6372:   width: 47%;
                   6373:   vertical-align: top;
                   6374: }
                   6375: 
                   6376: table.LC_double_column tr td.LC_right_col {
                   6377:   top: 2px;
1.779     bisitz   6378:   right: 2px;
1.589     raeburn  6379:   width: 47%;
                   6380:   vertical-align: top;
                   6381: }
                   6382: 
1.591     raeburn  6383: div.LC_left_float {
                   6384:   float: left;
                   6385:   padding-right: 5%;
1.597     albertel 6386:   padding-bottom: 4px;
1.591     raeburn  6387: }
                   6388: 
                   6389: div.LC_clear_float_header {
1.597     albertel 6390:   padding-bottom: 2px;
1.591     raeburn  6391: }
                   6392: 
                   6393: div.LC_clear_float_footer {
1.597     albertel 6394:   padding-top: 10px;
1.591     raeburn  6395:   clear: both;
                   6396: }
                   6397: 
1.597     albertel 6398: div.LC_grade_show_user {
1.941     bisitz   6399: /*  border-left: 5px solid $sidebg; */
                   6400:   border-top: 5px solid #000000;
                   6401:   margin: 50px 0 0 0;
1.936     bisitz   6402:   padding: 15px 0 5px 10px;
1.597     albertel 6403: }
1.795     www      6404: 
1.936     bisitz   6405: div.LC_grade_show_user_odd_row {
1.941     bisitz   6406: /*  border-left: 5px solid #000000; */
                   6407: }
                   6408: 
                   6409: div.LC_grade_show_user div.LC_Box {
                   6410:   margin-right: 50px;
1.597     albertel 6411: }
                   6412: 
                   6413: div.LC_grade_submissions,
                   6414: div.LC_grade_message_center,
1.936     bisitz   6415: div.LC_grade_info_links {
1.597     albertel 6416:   margin: 5px;
                   6417:   width: 99%;
                   6418:   background: #FFFFFF;
                   6419: }
1.795     www      6420: 
1.597     albertel 6421: div.LC_grade_submissions_header,
1.936     bisitz   6422: div.LC_grade_message_center_header {
1.705     tempelho 6423:   font-weight: bold;
                   6424:   font-size: large;
1.597     albertel 6425: }
1.795     www      6426: 
1.597     albertel 6427: div.LC_grade_submissions_body,
1.936     bisitz   6428: div.LC_grade_message_center_body {
1.597     albertel 6429:   border: 1px solid black;
                   6430:   width: 99%;
                   6431:   background: #FFFFFF;
                   6432: }
1.795     www      6433: 
1.613     albertel 6434: table.LC_scantron_action {
                   6435:   width: 100%;
                   6436: }
1.795     www      6437: 
1.613     albertel 6438: table.LC_scantron_action tr th {
1.698     harmsja  6439:   font-weight:bold;
                   6440:   font-style:normal;
1.613     albertel 6441: }
1.795     www      6442: 
1.779     bisitz   6443: .LC_edit_problem_header,
1.614     albertel 6444: div.LC_edit_problem_footer {
1.705     tempelho 6445:   font-weight: normal;
                   6446:   font-size:  medium;
1.602     albertel 6447:   margin: 2px;
1.1060    bisitz   6448:   background-color: $sidebg;
1.600     albertel 6449: }
1.795     www      6450: 
1.600     albertel 6451: div.LC_edit_problem_header,
1.602     albertel 6452: div.LC_edit_problem_header div,
1.614     albertel 6453: div.LC_edit_problem_footer,
                   6454: div.LC_edit_problem_footer div,
1.602     albertel 6455: div.LC_edit_problem_editxml_header,
                   6456: div.LC_edit_problem_editxml_header div {
1.600     albertel 6457:   margin-top: 5px;
                   6458: }
1.795     www      6459: 
1.600     albertel 6460: div.LC_edit_problem_header_title {
1.705     tempelho 6461:   font-weight: bold;
                   6462:   font-size: larger;
1.602     albertel 6463:   background: $tabbg;
                   6464:   padding: 3px;
1.1060    bisitz   6465:   margin: 0 0 5px 0;
1.602     albertel 6466: }
1.795     www      6467: 
1.602     albertel 6468: table.LC_edit_problem_header_title {
                   6469:   width: 100%;
1.600     albertel 6470:   background: $tabbg;
1.602     albertel 6471: }
                   6472: 
                   6473: div.LC_edit_problem_discards {
                   6474:   float: left;
                   6475:   padding-bottom: 5px;
                   6476: }
1.795     www      6477: 
1.602     albertel 6478: div.LC_edit_problem_saves {
                   6479:   float: right;
                   6480:   padding-bottom: 5px;
1.600     albertel 6481: }
1.795     www      6482: 
1.1124    bisitz   6483: .LC_edit_opt {
                   6484:   padding-left: 1em;
                   6485:   white-space: nowrap;
                   6486: }
                   6487: 
1.911     bisitz   6488: img.stift {
1.803     bisitz   6489:   border-width: 0;
                   6490:   vertical-align: middle;
1.677     riegler  6491: }
1.680     riegler  6492: 
1.923     bisitz   6493: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6494:   vertical-align: top;
1.777     tempelho 6495: }
1.795     www      6496: 
1.716     raeburn  6497: div.LC_createcourse {
1.911     bisitz   6498:   margin: 10px 10px 10px 10px;
1.716     raeburn  6499: }
                   6500: 
1.917     raeburn  6501: .LC_dccid {
                   6502:   margin: 0.2em 0 0 0;
                   6503:   padding: 0;
                   6504:   font-size: 90%;
                   6505:   display:none;
                   6506: }
                   6507: 
1.897     wenzelju 6508: ol.LC_primary_menu a:hover,
1.721     harmsja  6509: ol#LC_MenuBreadcrumbs a:hover,
                   6510: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6511: ul#LC_secondary_menu a:hover,
1.721     harmsja  6512: .LC_FormSectionClearButton input:hover
1.795     www      6513: ul.LC_TabContent   li:hover a {
1.952     onken    6514:   color:$button_hover;
1.911     bisitz   6515:   text-decoration:none;
1.693     droeschl 6516: }
                   6517: 
1.779     bisitz   6518: h1 {
1.911     bisitz   6519:   padding: 0;
                   6520:   line-height:130%;
1.693     droeschl 6521: }
1.698     harmsja  6522: 
1.911     bisitz   6523: h2,
                   6524: h3,
                   6525: h4,
                   6526: h5,
                   6527: h6 {
                   6528:   margin: 5px 0 5px 0;
                   6529:   padding: 0;
                   6530:   line-height:130%;
1.693     droeschl 6531: }
1.795     www      6532: 
                   6533: .LC_hcell {
1.911     bisitz   6534:   padding:3px 15px 3px 15px;
                   6535:   margin: 0;
                   6536:   background-color:$tabbg;
                   6537:   color:$fontmenu;
                   6538:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6539: }
1.795     www      6540: 
1.840     bisitz   6541: .LC_Box > .LC_hcell {
1.911     bisitz   6542:   margin: 0 -10px 10px -10px;
1.835     bisitz   6543: }
                   6544: 
1.721     harmsja  6545: .LC_noBorder {
1.911     bisitz   6546:   border: 0;
1.698     harmsja  6547: }
1.693     droeschl 6548: 
1.721     harmsja  6549: .LC_FormSectionClearButton input {
1.911     bisitz   6550:   background-color:transparent;
                   6551:   border: none;
                   6552:   cursor:pointer;
                   6553:   text-decoration:underline;
1.693     droeschl 6554: }
1.763     bisitz   6555: 
                   6556: .LC_help_open_topic {
1.911     bisitz   6557:   color: #FFFFFF;
                   6558:   background-color: #EEEEFF;
                   6559:   margin: 1px;
                   6560:   padding: 4px;
                   6561:   border: 1px solid #000033;
                   6562:   white-space: nowrap;
                   6563:   /* vertical-align: middle; */
1.759     neumanie 6564: }
1.693     droeschl 6565: 
1.911     bisitz   6566: dl,
                   6567: ul,
                   6568: div,
                   6569: fieldset {
                   6570:   margin: 10px 10px 10px 0;
                   6571:   /* overflow: hidden; */
1.693     droeschl 6572: }
1.795     www      6573: 
1.838     bisitz   6574: fieldset > legend {
1.911     bisitz   6575:   font-weight: bold;
                   6576:   padding: 0 5px 0 5px;
1.838     bisitz   6577: }
                   6578: 
1.813     bisitz   6579: #LC_nav_bar {
1.911     bisitz   6580:   float: left;
1.995     raeburn  6581:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   6582:   margin: 0 0 2px 0;
1.807     droeschl 6583: }
                   6584: 
1.916     droeschl 6585: #LC_realm {
                   6586:   margin: 0.2em 0 0 0;
                   6587:   padding: 0;
                   6588:   font-weight: bold;
                   6589:   text-align: center;
1.995     raeburn  6590:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 6591: }
                   6592: 
1.911     bisitz   6593: #LC_nav_bar em {
                   6594:   font-weight: bold;
                   6595:   font-style: normal;
1.807     droeschl 6596: }
                   6597: 
1.897     wenzelju 6598: ol.LC_primary_menu {
1.911     bisitz   6599:   float: right;
1.934     droeschl 6600:   margin: 0;
1.1076    raeburn  6601:   padding: 0;
1.995     raeburn  6602:   background-color: $pgbg_or_bgcolor;
1.807     droeschl 6603: }
                   6604: 
1.852     droeschl 6605: ol#LC_PathBreadcrumbs {
1.911     bisitz   6606:   margin: 0;
1.693     droeschl 6607: }
                   6608: 
1.897     wenzelju 6609: ol.LC_primary_menu li {
1.1076    raeburn  6610:   color: RGB(80, 80, 80);
                   6611:   vertical-align: middle;
                   6612:   text-align: left;
                   6613:   list-style: none;
                   6614:   float: left;
                   6615: }
                   6616: 
                   6617: ol.LC_primary_menu li a {
                   6618:   display: block;
                   6619:   margin: 0;
                   6620:   padding: 0 5px 0 10px;
                   6621:   text-decoration: none;
                   6622: }
                   6623: 
                   6624: ol.LC_primary_menu li ul {
                   6625:   display: none;
                   6626:   width: 10em;
                   6627:   background-color: $data_table_light;
                   6628: }
                   6629: 
                   6630: ol.LC_primary_menu li:hover ul, ol.LC_primary_menu li.hover ul {
                   6631:   display: block;
                   6632:   position: absolute;
                   6633:   margin: 0;
                   6634:   padding: 0;
1.1078    raeburn  6635:   z-index: 2;
1.1076    raeburn  6636: }
                   6637: 
                   6638: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
                   6639:   font-size: 90%;
1.911     bisitz   6640:   vertical-align: top;
1.1076    raeburn  6641:   float: none;
1.1079    raeburn  6642:   border-left: 1px solid black;
                   6643:   border-right: 1px solid black;
1.1076    raeburn  6644: }
                   6645: 
                   6646: ol.LC_primary_menu li:hover li a, ol.LC_primary_menu li.hover li a {
1.1078    raeburn  6647:   background-color:$data_table_light;
1.1076    raeburn  6648: }
                   6649: 
                   6650: ol.LC_primary_menu li li a:hover {
                   6651:    color:$button_hover;
                   6652:    background-color:$data_table_dark;
1.693     droeschl 6653: }
                   6654: 
1.897     wenzelju 6655: ol.LC_primary_menu li img {
1.911     bisitz   6656:   vertical-align: bottom;
1.934     droeschl 6657:   height: 1.1em;
1.1077    raeburn  6658:   margin: 0.2em 0 0 0;
1.693     droeschl 6659: }
                   6660: 
1.897     wenzelju 6661: ol.LC_primary_menu a {
1.911     bisitz   6662:   color: RGB(80, 80, 80);
                   6663:   text-decoration: none;
1.693     droeschl 6664: }
1.795     www      6665: 
1.949     droeschl 6666: ol.LC_primary_menu a.LC_new_message {
                   6667:   font-weight:bold;
                   6668:   color: darkred;
                   6669: }
                   6670: 
1.975     raeburn  6671: ol.LC_docs_parameters {
                   6672:   margin-left: 0;
                   6673:   padding: 0;
                   6674:   list-style: none;
                   6675: }
                   6676: 
                   6677: ol.LC_docs_parameters li {
                   6678:   margin: 0;
                   6679:   padding-right: 20px;
                   6680:   display: inline;
                   6681: }
                   6682: 
1.976     raeburn  6683: ol.LC_docs_parameters li:before {
                   6684:   content: "\\002022 \\0020";
                   6685: }
                   6686: 
                   6687: li.LC_docs_parameters_title {
                   6688:   font-weight: bold;
                   6689: }
                   6690: 
                   6691: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   6692:   content: "";
                   6693: }
                   6694: 
1.897     wenzelju 6695: ul#LC_secondary_menu {
1.1107    raeburn  6696:   clear: right;
1.911     bisitz   6697:   color: $fontmenu;
                   6698:   background: $tabbg;
                   6699:   list-style: none;
                   6700:   padding: 0;
                   6701:   margin: 0;
                   6702:   width: 100%;
1.995     raeburn  6703:   text-align: left;
1.1107    raeburn  6704:   float: left;
1.808     droeschl 6705: }
                   6706: 
1.897     wenzelju 6707: ul#LC_secondary_menu li {
1.911     bisitz   6708:   font-weight: bold;
                   6709:   line-height: 1.8em;
1.1107    raeburn  6710:   border-right: 1px solid black;
                   6711:   float: left;
                   6712: }
                   6713: 
                   6714: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   6715:   background-color: $data_table_light;
                   6716: }
                   6717: 
                   6718: ul#LC_secondary_menu li a {
1.911     bisitz   6719:   padding: 0 0.8em;
1.1107    raeburn  6720: }
                   6721: 
                   6722: ul#LC_secondary_menu li ul {
                   6723:   display: none;
                   6724: }
                   6725: 
                   6726: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   6727:   display: block;
                   6728:   position: absolute;
                   6729:   margin: 0;
                   6730:   padding: 0;
                   6731:   list-style:none;
                   6732:   float: none;
                   6733:   background-color: $data_table_light;
                   6734:   z-index: 2;
                   6735:   margin-left: -1px;
                   6736: }
                   6737: 
                   6738: ul#LC_secondary_menu li ul li {
                   6739:   font-size: 90%;
                   6740:   vertical-align: top;
                   6741:   border-left: 1px solid black;
1.911     bisitz   6742:   border-right: 1px solid black;
1.1119    raeburn  6743:   background-color: $data_table_light;
1.1107    raeburn  6744:   list-style:none;
                   6745:   float: none;
                   6746: }
                   6747: 
                   6748: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   6749:   background-color: $data_table_dark;
1.807     droeschl 6750: }
                   6751: 
1.847     tempelho 6752: ul.LC_TabContent {
1.911     bisitz   6753:   display:block;
                   6754:   background: $sidebg;
                   6755:   border-bottom: solid 1px $lg_border_color;
                   6756:   list-style:none;
1.1020    raeburn  6757:   margin: -1px -10px 0 -10px;
1.911     bisitz   6758:   padding: 0;
1.693     droeschl 6759: }
                   6760: 
1.795     www      6761: ul.LC_TabContent li,
                   6762: ul.LC_TabContentBigger li {
1.911     bisitz   6763:   float:left;
1.741     harmsja  6764: }
1.795     www      6765: 
1.897     wenzelju 6766: ul#LC_secondary_menu li a {
1.911     bisitz   6767:   color: $fontmenu;
                   6768:   text-decoration: none;
1.693     droeschl 6769: }
1.795     www      6770: 
1.721     harmsja  6771: ul.LC_TabContent {
1.952     onken    6772:   min-height:20px;
1.721     harmsja  6773: }
1.795     www      6774: 
                   6775: ul.LC_TabContent li {
1.911     bisitz   6776:   vertical-align:middle;
1.959     onken    6777:   padding: 0 16px 0 10px;
1.911     bisitz   6778:   background-color:$tabbg;
                   6779:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  6780:   border-left: solid 1px $font;
1.721     harmsja  6781: }
1.795     www      6782: 
1.847     tempelho 6783: ul.LC_TabContent .right {
1.911     bisitz   6784:   float:right;
1.847     tempelho 6785: }
                   6786: 
1.911     bisitz   6787: ul.LC_TabContent li a,
                   6788: ul.LC_TabContent li {
                   6789:   color:rgb(47,47,47);
                   6790:   text-decoration:none;
                   6791:   font-size:95%;
                   6792:   font-weight:bold;
1.952     onken    6793:   min-height:20px;
                   6794: }
                   6795: 
1.959     onken    6796: ul.LC_TabContent li a:hover,
                   6797: ul.LC_TabContent li a:focus {
1.952     onken    6798:   color: $button_hover;
1.959     onken    6799:   background:none;
                   6800:   outline:none;
1.952     onken    6801: }
                   6802: 
                   6803: ul.LC_TabContent li:hover {
                   6804:   color: $button_hover;
                   6805:   cursor:pointer;
1.721     harmsja  6806: }
1.795     www      6807: 
1.911     bisitz   6808: ul.LC_TabContent li.active {
1.952     onken    6809:   color: $font;
1.911     bisitz   6810:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    6811:   border-bottom:solid 1px #FFFFFF;
                   6812:   cursor: default;
1.744     ehlerst  6813: }
1.795     www      6814: 
1.959     onken    6815: ul.LC_TabContent li.active a {
                   6816:   color:$font;
                   6817:   background:#FFFFFF;
                   6818:   outline: none;
                   6819: }
1.1047    raeburn  6820: 
                   6821: ul.LC_TabContent li.goback {
                   6822:   float: left;
                   6823:   border-left: none;
                   6824: }
                   6825: 
1.870     tempelho 6826: #maincoursedoc {
1.911     bisitz   6827:   clear:both;
1.870     tempelho 6828: }
                   6829: 
                   6830: ul.LC_TabContentBigger {
1.911     bisitz   6831:   display:block;
                   6832:   list-style:none;
                   6833:   padding: 0;
1.870     tempelho 6834: }
                   6835: 
1.795     www      6836: ul.LC_TabContentBigger li {
1.911     bisitz   6837:   vertical-align:bottom;
                   6838:   height: 30px;
                   6839:   font-size:110%;
                   6840:   font-weight:bold;
                   6841:   color: #737373;
1.841     tempelho 6842: }
                   6843: 
1.957     onken    6844: ul.LC_TabContentBigger li.active {
                   6845:   position: relative;
                   6846:   top: 1px;
                   6847: }
                   6848: 
1.870     tempelho 6849: ul.LC_TabContentBigger li a {
1.911     bisitz   6850:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6851:   height: 30px;
                   6852:   line-height: 30px;
                   6853:   text-align: center;
                   6854:   display: block;
                   6855:   text-decoration: none;
1.958     onken    6856:   outline: none;  
1.741     harmsja  6857: }
1.795     www      6858: 
1.870     tempelho 6859: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6860:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6861:   color:$font;
1.744     ehlerst  6862: }
1.795     www      6863: 
1.870     tempelho 6864: ul.LC_TabContentBigger li b {
1.911     bisitz   6865:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6866:   display: block;
                   6867:   float: left;
                   6868:   padding: 0 30px;
1.957     onken    6869:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 6870: }
                   6871: 
1.956     onken    6872: ul.LC_TabContentBigger li:hover b {
                   6873:   color:$button_hover;
                   6874: }
                   6875: 
1.870     tempelho 6876: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6877:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6878:   color:$font;
1.957     onken    6879:   border: 0;
1.741     harmsja  6880: }
1.693     droeschl 6881: 
1.870     tempelho 6882: 
1.862     bisitz   6883: ul.LC_CourseBreadcrumbs {
                   6884:   background: $sidebg;
1.1020    raeburn  6885:   height: 2em;
1.862     bisitz   6886:   padding-left: 10px;
1.1020    raeburn  6887:   margin: 0;
1.862     bisitz   6888:   list-style-position: inside;
                   6889: }
                   6890: 
1.911     bisitz   6891: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6892: ol#LC_PathBreadcrumbs {
1.911     bisitz   6893:   padding-left: 10px;
                   6894:   margin: 0;
1.933     droeschl 6895:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 6896: }
                   6897: 
1.911     bisitz   6898: ol#LC_MenuBreadcrumbs li,
                   6899: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6900: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6901:   display: inline;
1.933     droeschl 6902:   white-space: normal;  
1.693     droeschl 6903: }
                   6904: 
1.823     bisitz   6905: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6906: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6907:   text-decoration: none;
                   6908:   font-size:90%;
1.693     droeschl 6909: }
1.795     www      6910: 
1.969     droeschl 6911: ol#LC_MenuBreadcrumbs h1 {
                   6912:   display: inline;
                   6913:   font-size: 90%;
                   6914:   line-height: 2.5em;
                   6915:   margin: 0;
                   6916:   padding: 0;
                   6917: }
                   6918: 
1.795     www      6919: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6920:   text-decoration:none;
                   6921:   font-size:100%;
                   6922:   font-weight:bold;
1.693     droeschl 6923: }
1.795     www      6924: 
1.840     bisitz   6925: .LC_Box {
1.911     bisitz   6926:   border: solid 1px $lg_border_color;
                   6927:   padding: 0 10px 10px 10px;
1.746     neumanie 6928: }
1.795     www      6929: 
1.1020    raeburn  6930: .LC_DocsBox {
                   6931:   border: solid 1px $lg_border_color;
                   6932:   padding: 0 0 10px 10px;
                   6933: }
                   6934: 
1.795     www      6935: .LC_AboutMe_Image {
1.911     bisitz   6936:   float:left;
                   6937:   margin-right:10px;
1.747     neumanie 6938: }
1.795     www      6939: 
                   6940: .LC_Clear_AboutMe_Image {
1.911     bisitz   6941:   clear:left;
1.747     neumanie 6942: }
1.795     www      6943: 
1.721     harmsja  6944: dl.LC_ListStyleClean dt {
1.911     bisitz   6945:   padding-right: 5px;
                   6946:   display: table-header-group;
1.693     droeschl 6947: }
                   6948: 
1.721     harmsja  6949: dl.LC_ListStyleClean dd {
1.911     bisitz   6950:   display: table-row;
1.693     droeschl 6951: }
                   6952: 
1.721     harmsja  6953: .LC_ListStyleClean,
                   6954: .LC_ListStyleSimple,
                   6955: .LC_ListStyleNormal,
1.795     www      6956: .LC_ListStyleSpecial {
1.911     bisitz   6957:   /* display:block; */
                   6958:   list-style-position: inside;
                   6959:   list-style-type: none;
                   6960:   overflow: hidden;
                   6961:   padding: 0;
1.693     droeschl 6962: }
                   6963: 
1.721     harmsja  6964: .LC_ListStyleSimple li,
                   6965: .LC_ListStyleSimple dd,
                   6966: .LC_ListStyleNormal li,
                   6967: .LC_ListStyleNormal dd,
                   6968: .LC_ListStyleSpecial li,
1.795     www      6969: .LC_ListStyleSpecial dd {
1.911     bisitz   6970:   margin: 0;
                   6971:   padding: 5px 5px 5px 10px;
                   6972:   clear: both;
1.693     droeschl 6973: }
                   6974: 
1.721     harmsja  6975: .LC_ListStyleClean li,
                   6976: .LC_ListStyleClean dd {
1.911     bisitz   6977:   padding-top: 0;
                   6978:   padding-bottom: 0;
1.693     droeschl 6979: }
                   6980: 
1.721     harmsja  6981: .LC_ListStyleSimple dd,
1.795     www      6982: .LC_ListStyleSimple li {
1.911     bisitz   6983:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6984: }
                   6985: 
1.721     harmsja  6986: .LC_ListStyleSpecial li,
                   6987: .LC_ListStyleSpecial dd {
1.911     bisitz   6988:   list-style-type: none;
                   6989:   background-color: RGB(220, 220, 220);
                   6990:   margin-bottom: 4px;
1.693     droeschl 6991: }
                   6992: 
1.721     harmsja  6993: table.LC_SimpleTable {
1.911     bisitz   6994:   margin:5px;
                   6995:   border:solid 1px $lg_border_color;
1.795     www      6996: }
1.693     droeschl 6997: 
1.721     harmsja  6998: table.LC_SimpleTable tr {
1.911     bisitz   6999:   padding: 0;
                   7000:   border:solid 1px $lg_border_color;
1.693     droeschl 7001: }
1.795     www      7002: 
                   7003: table.LC_SimpleTable thead {
1.911     bisitz   7004:   background:rgb(220,220,220);
1.693     droeschl 7005: }
                   7006: 
1.721     harmsja  7007: div.LC_columnSection {
1.911     bisitz   7008:   display: block;
                   7009:   clear: both;
                   7010:   overflow: hidden;
                   7011:   margin: 0;
1.693     droeschl 7012: }
                   7013: 
1.721     harmsja  7014: div.LC_columnSection>* {
1.911     bisitz   7015:   float: left;
                   7016:   margin: 10px 20px 10px 0;
                   7017:   overflow:hidden;
1.693     droeschl 7018: }
1.721     harmsja  7019: 
1.795     www      7020: table em {
1.911     bisitz   7021:   font-weight: bold;
                   7022:   font-style: normal;
1.748     schulted 7023: }
1.795     www      7024: 
1.779     bisitz   7025: table.LC_tableBrowseRes,
1.795     www      7026: table.LC_tableOfContent {
1.911     bisitz   7027:   border:none;
                   7028:   border-spacing: 1px;
                   7029:   padding: 3px;
                   7030:   background-color: #FFFFFF;
                   7031:   font-size: 90%;
1.753     droeschl 7032: }
1.789     droeschl 7033: 
1.911     bisitz   7034: table.LC_tableOfContent {
                   7035:   border-collapse: collapse;
1.789     droeschl 7036: }
                   7037: 
1.771     droeschl 7038: table.LC_tableBrowseRes a,
1.768     schulted 7039: table.LC_tableOfContent a {
1.911     bisitz   7040:   background-color: transparent;
                   7041:   text-decoration: none;
1.753     droeschl 7042: }
                   7043: 
1.795     www      7044: table.LC_tableOfContent img {
1.911     bisitz   7045:   border: none;
                   7046:   height: 1.3em;
                   7047:   vertical-align: text-bottom;
                   7048:   margin-right: 0.3em;
1.753     droeschl 7049: }
1.757     schulted 7050: 
1.795     www      7051: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7052:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7053: }
                   7054: 
1.795     www      7055: a#LC_content_toolbar_everything {
1.911     bisitz   7056:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7057: }
                   7058: 
1.795     www      7059: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7060:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7061: }
                   7062: 
1.795     www      7063: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7064:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7065: }
                   7066: 
1.795     www      7067: a#LC_content_toolbar_changefolder {
1.911     bisitz   7068:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7069: }
                   7070: 
1.795     www      7071: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7072:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7073: }
                   7074: 
1.1043    raeburn  7075: a#LC_content_toolbar_edittoplevel {
                   7076:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7077: }
                   7078: 
1.795     www      7079: ul#LC_toolbar li a:hover {
1.911     bisitz   7080:   background-position: bottom center;
1.757     schulted 7081: }
                   7082: 
1.795     www      7083: ul#LC_toolbar {
1.911     bisitz   7084:   padding: 0;
                   7085:   margin: 2px;
                   7086:   list-style:none;
                   7087:   position:relative;
                   7088:   background-color:white;
1.1082    raeburn  7089:   overflow: auto;
1.757     schulted 7090: }
                   7091: 
1.795     www      7092: ul#LC_toolbar li {
1.911     bisitz   7093:   border:1px solid white;
                   7094:   padding: 0;
                   7095:   margin: 0;
                   7096:   float: left;
                   7097:   display:inline;
                   7098:   vertical-align:middle;
1.1082    raeburn  7099:   white-space: nowrap;
1.911     bisitz   7100: }
1.757     schulted 7101: 
1.783     amueller 7102: 
1.795     www      7103: a.LC_toolbarItem {
1.911     bisitz   7104:   display:block;
                   7105:   padding: 0;
                   7106:   margin: 0;
                   7107:   height: 32px;
                   7108:   width: 32px;
                   7109:   color:white;
                   7110:   border: none;
                   7111:   background-repeat:no-repeat;
                   7112:   background-color:transparent;
1.757     schulted 7113: }
                   7114: 
1.915     droeschl 7115: ul.LC_funclist {
                   7116:     margin: 0;
                   7117:     padding: 0.5em 1em 0.5em 0;
                   7118: }
                   7119: 
1.933     droeschl 7120: ul.LC_funclist > li:first-child {
                   7121:     font-weight:bold; 
                   7122:     margin-left:0.8em;
                   7123: }
                   7124: 
1.915     droeschl 7125: ul.LC_funclist + ul.LC_funclist {
                   7126:     /* 
                   7127:        left border as a seperator if we have more than
                   7128:        one list 
                   7129:     */
                   7130:     border-left: 1px solid $sidebg;
                   7131:     /* 
                   7132:        this hides the left border behind the border of the 
                   7133:        outer box if element is wrapped to the next 'line' 
                   7134:     */
                   7135:     margin-left: -1px;
                   7136: }
                   7137: 
1.843     bisitz   7138: ul.LC_funclist li {
1.915     droeschl 7139:   display: inline;
1.782     bisitz   7140:   white-space: nowrap;
1.915     droeschl 7141:   margin: 0 0 0 25px;
                   7142:   line-height: 150%;
1.782     bisitz   7143: }
                   7144: 
1.974     wenzelju 7145: .LC_hidden {
                   7146:   display: none;
                   7147: }
                   7148: 
1.1030    www      7149: .LCmodal-overlay {
                   7150: 		position:fixed;
                   7151: 		top:0;
                   7152: 		right:0;
                   7153: 		bottom:0;
                   7154: 		left:0;
                   7155: 		height:100%;
                   7156: 		width:100%;
                   7157: 		margin:0;
                   7158: 		padding:0;
                   7159: 		background:#999;
                   7160: 		opacity:.75;
                   7161: 		filter: alpha(opacity=75);
                   7162: 		-moz-opacity: 0.75;
                   7163: 		z-index:101;
                   7164: }
                   7165: 
                   7166: * html .LCmodal-overlay {   
                   7167: 		position: absolute;
                   7168: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7169: }
                   7170: 
                   7171: .LCmodal-window {
                   7172: 		position:fixed;
                   7173: 		top:50%;
                   7174: 		left:50%;
                   7175: 		margin:0;
                   7176: 		padding:0;
                   7177: 		z-index:102;
                   7178: 	}
                   7179: 
                   7180: * html .LCmodal-window {
                   7181: 		position:absolute;
                   7182: }
                   7183: 
                   7184: .LCclose-window {
                   7185: 		position:absolute;
                   7186: 		width:32px;
                   7187: 		height:32px;
                   7188: 		right:8px;
                   7189: 		top:8px;
                   7190: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7191: 		text-indent:-99999px;
                   7192: 		overflow:hidden;
                   7193: 		cursor:pointer;
                   7194: }
                   7195: 
1.1100    raeburn  7196: /*
                   7197:   styles used by TTH when "Default set of options to pass to tth/m
                   7198:   when converting TeX" in course settings has been set
                   7199: 
                   7200:   option passed: -t
                   7201: 
                   7202: */
                   7203: 
                   7204: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7205: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7206: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7207: td div.norm {line-height:normal;}
                   7208: 
                   7209: /*
                   7210:   option passed -y3
                   7211: */
                   7212: 
                   7213: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7214: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7215: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7216: 
1.343     albertel 7217: END
                   7218: }
                   7219: 
1.306     albertel 7220: =pod
                   7221: 
                   7222: =item * &headtag()
                   7223: 
                   7224: Returns a uniform footer for LON-CAPA web pages.
                   7225: 
1.307     albertel 7226: Inputs: $title - optional title for the head
                   7227:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7228:         $args - optional arguments
1.319     albertel 7229:             force_register - if is true call registerurl so the remote is 
                   7230:                              informed
1.415     albertel 7231:             redirect       -> array ref of
                   7232:                                    1- seconds before redirect occurs
                   7233:                                    2- url to redirect to
                   7234:                                    3- whether the side effect should occur
1.315     albertel 7235:                            (side effect of setting 
                   7236:                                $env{'internal.head.redirect'} to the url 
                   7237:                                redirected too)
1.352     albertel 7238:             domain         -> force to color decorate a page for a specific
                   7239:                                domain
                   7240:             function       -> force usage of a specific rolish color scheme
                   7241:             bgcolor        -> override the default page bgcolor
1.460     albertel 7242:             no_auto_mt_title
                   7243:                            -> prevent &mt()ing the title arg
1.464     albertel 7244: 
1.306     albertel 7245: =cut
                   7246: 
                   7247: sub headtag {
1.313     albertel 7248:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7249:     
1.363     albertel 7250:     my $function = $args->{'function'} || &get_users_function();
                   7251:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7252:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 7253:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7254: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7255: 		   #time(),
1.418     albertel 7256: 		   $env{'environment.color.timestamp'},
1.363     albertel 7257: 		   $function,$domain,$bgcolor);
                   7258: 
1.369     www      7259:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7260: 
1.308     albertel 7261:     my $result =
                   7262: 	'<head>'.
1.461     albertel 7263: 	&font_settings();
1.319     albertel 7264: 
1.1064    raeburn  7265:     my $inhibitprint = &print_suppression();
                   7266: 
1.461     albertel 7267:     if (!$args->{'frameset'}) {
                   7268: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7269:     }
1.962     droeschl 7270:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   7271:         $result .= Apache::lonxml::display_title();
1.319     albertel 7272:     }
1.436     albertel 7273:     if (!$args->{'no_nav_bar'} 
                   7274: 	&& !$args->{'only_body'}
                   7275: 	&& !$args->{'frameset'}) {
                   7276: 	$result .= &help_menu_js();
1.1032    www      7277:         $result.=&modal_window();
1.1038    www      7278:         $result.=&togglebox_script();
1.1034    www      7279:         $result.=&wishlist_window();
1.1041    www      7280:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7281:     } else {
                   7282:         if ($args->{'add_modal'}) {
                   7283:            $result.=&modal_window();
                   7284:         }
                   7285:         if ($args->{'add_wishlist'}) {
                   7286:            $result.=&wishlist_window();
                   7287:         }
1.1038    www      7288:         if ($args->{'add_togglebox'}) {
                   7289:            $result.=&togglebox_script();
                   7290:         }
1.1041    www      7291:         if ($args->{'add_progressbar'}) {
                   7292:            $result.=&LCprogressbarUpdate_script();
                   7293:         }
1.436     albertel 7294:     }
1.314     albertel 7295:     if (ref($args->{'redirect'})) {
1.414     albertel 7296: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7297: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7298: 	if (!$inhibit_continue) {
                   7299: 	    $env{'internal.head.redirect'} = $url;
                   7300: 	}
1.313     albertel 7301: 	$result.=<<ADDMETA
                   7302: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7303: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7304: ADDMETA
                   7305:     }
1.306     albertel 7306:     if (!defined($title)) {
                   7307: 	$title = 'The LearningOnline Network with CAPA';
                   7308:     }
1.460     albertel 7309:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7310:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 7311: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
1.1064    raeburn  7312:         .$inhibitprint
1.414     albertel 7313: 	.$head_extra;
1.962     droeschl 7314:     return $result.'</head>';
1.306     albertel 7315: }
                   7316: 
                   7317: =pod
                   7318: 
1.340     albertel 7319: =item * &font_settings()
                   7320: 
                   7321: Returns neccessary <meta> to set the proper encoding
                   7322: 
                   7323: Inputs: none
                   7324: 
                   7325: =cut
                   7326: 
                   7327: sub font_settings {
                   7328:     my $headerstring='';
1.647     www      7329:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 7330: 	$headerstring.=
                   7331: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   7332:     }
                   7333:     return $headerstring;
                   7334: }
                   7335: 
1.341     albertel 7336: =pod
                   7337: 
1.1064    raeburn  7338: =item * &print_suppression()
                   7339: 
                   7340: In course context returns css which causes the body to be blank when media="print",
                   7341: if printout generation is unavailable for the current resource.
                   7342: 
                   7343: This could be because:
                   7344: 
                   7345: (a) printstartdate is in the future
                   7346: 
                   7347: (b) printenddate is in the past
                   7348: 
                   7349: (c) there is an active exam block with "printout"
                   7350: functionality blocked
                   7351: 
                   7352: Users with pav, pfo or evb privileges are exempt.
                   7353: 
                   7354: Inputs: none
                   7355: 
                   7356: =cut
                   7357: 
                   7358: 
                   7359: sub print_suppression {
                   7360:     my $noprint;
                   7361:     if ($env{'request.course.id'}) {
                   7362:         my $scope = $env{'request.course.id'};
                   7363:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7364:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   7365:             return;
                   7366:         }
                   7367:         if ($env{'request.course.sec'} ne '') {
                   7368:             $scope .= "/$env{'request.course.sec'}";
                   7369:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7370:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  7371:                 return;
1.1064    raeburn  7372:             }
                   7373:         }
                   7374:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7375:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1065    raeburn  7376:         my $blocked = &blocking_status('printout',$cnum,$cdom);
1.1064    raeburn  7377:         if ($blocked) {
                   7378:             my $checkrole = "cm./$cdom/$cnum";
                   7379:             if ($env{'request.course.sec'} ne '') {
                   7380:                 $checkrole .= "/$env{'request.course.sec'}";
                   7381:             }
                   7382:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   7383:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   7384:                 $noprint = 1;
                   7385:             }
                   7386:         }
                   7387:         unless ($noprint) {
                   7388:             my $symb = &Apache::lonnet::symbread();
                   7389:             if ($symb ne '') {
                   7390:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   7391:                 if (ref($navmap)) {
                   7392:                     my $res = $navmap->getBySymb($symb);
                   7393:                     if (ref($res)) {
                   7394:                         if (!$res->resprintable()) {
                   7395:                             $noprint = 1;
                   7396:                         }
                   7397:                     }
                   7398:                 }
                   7399:             }
                   7400:         }
                   7401:         if ($noprint) {
                   7402:             return <<"ENDSTYLE";
                   7403: <style type="text/css" media="print">
                   7404:     body { display:none }
                   7405: </style>
                   7406: ENDSTYLE
                   7407:         }
                   7408:     }
                   7409:     return;
                   7410: }
                   7411: 
                   7412: =pod
                   7413: 
1.341     albertel 7414: =item * &xml_begin()
                   7415: 
                   7416: Returns the needed doctype and <html>
                   7417: 
                   7418: Inputs: none
                   7419: 
                   7420: =cut
                   7421: 
                   7422: sub xml_begin {
                   7423:     my $output='';
                   7424: 
                   7425:     if ($env{'browser.mathml'}) {
                   7426: 	$output='<?xml version="1.0"?>'
                   7427:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   7428: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   7429:             
                   7430: #	    .'<!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">] >'
                   7431: 	    .'<!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">'
                   7432:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   7433: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   7434:     } else {
1.849     bisitz   7435: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   7436:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 7437:     }
                   7438:     return $output;
                   7439: }
1.340     albertel 7440: 
                   7441: =pod
                   7442: 
1.306     albertel 7443: =item * &start_page()
                   7444: 
                   7445: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   7446: 
1.648     raeburn  7447: Inputs:
                   7448: 
                   7449: =over 4
                   7450: 
                   7451: $title - optional title for the page
                   7452: 
                   7453: $head_extra - optional extra HTML to incude inside the <head>
                   7454: 
                   7455: $args - additional optional args supported are:
                   7456: 
                   7457: =over 8
                   7458: 
                   7459:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 7460:                                     arg on
1.814     bisitz   7461:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  7462:              add_entries    -> additional attributes to add to the  <body>
                   7463:              domain         -> force to color decorate a page for a 
1.317     albertel 7464:                                     specific domain
1.648     raeburn  7465:              function       -> force usage of a specific rolish color
1.317     albertel 7466:                                     scheme
1.648     raeburn  7467:              redirect       -> see &headtag()
                   7468:              bgcolor        -> override the default page bg color
                   7469:              js_ready       -> return a string ready for being used in 
1.317     albertel 7470:                                     a javascript writeln
1.648     raeburn  7471:              html_encode    -> return a string ready for being used in 
1.320     albertel 7472:                                     a html attribute
1.648     raeburn  7473:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 7474:                                     $forcereg arg
1.648     raeburn  7475:              frameset       -> if true will start with a <frameset>
1.330     albertel 7476:                                     rather than <body>
1.648     raeburn  7477:              skip_phases    -> hash ref of 
1.338     albertel 7478:                                     head -> skip the <html><head> generation
                   7479:                                     body -> skip all <body> generation
1.648     raeburn  7480:              no_auto_mt_title -> prevent &mt()ing the title arg
                   7481:              inherit_jsmath -> when creating popup window in a page,
                   7482:                                     should it have jsmath forced on by the
                   7483:                                     current page
1.867     kalberla 7484:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  7485:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1096    raeburn  7486:              group          -> includes the current group, if page is for a 
                   7487:                                specific group  
1.361     albertel 7488: 
1.648     raeburn  7489: =back
1.460     albertel 7490: 
1.648     raeburn  7491: =back
1.562     albertel 7492: 
1.306     albertel 7493: =cut
                   7494: 
                   7495: sub start_page {
1.309     albertel 7496:     my ($title,$head_extra,$args) = @_;
1.318     albertel 7497:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 7498: 
1.315     albertel 7499:     $env{'internal.start_page'}++;
1.1096    raeburn  7500:     my ($result,@advtools);
1.964     droeschl 7501: 
1.338     albertel 7502:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1030    www      7503:         $result .= &xml_begin() . &headtag($title, $head_extra, $args);
1.338     albertel 7504:     }
                   7505:     
                   7506:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   7507: 	if ($args->{'frameset'}) {
                   7508: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   7509: 						$args->{'add_entries'});
                   7510: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   7511:         } else {
                   7512:             $result .=
                   7513:                 &bodytag($title, 
                   7514:                          $args->{'function'},       $args->{'add_entries'},
                   7515:                          $args->{'only_body'},      $args->{'domain'},
                   7516:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  7517:                          $args->{'bgcolor'},        $args,
                   7518:                          \@advtools);
1.831     bisitz   7519:         }
1.330     albertel 7520:     }
1.338     albertel 7521: 
1.315     albertel 7522:     if ($args->{'js_ready'}) {
1.713     kaisler  7523: 		$result = &js_ready($result);
1.315     albertel 7524:     }
1.320     albertel 7525:     if ($args->{'html_encode'}) {
1.713     kaisler  7526: 		$result = &html_encode($result);
                   7527:     }
                   7528: 
1.813     bisitz   7529:     # Preparation for new and consistent functionlist at top of screen
                   7530:     # if ($args->{'functionlist'}) {
                   7531:     #            $result .= &build_functionlist();
                   7532:     #}
                   7533: 
1.964     droeschl 7534:     # Don't add anything more if only_body wanted or in const space
                   7535:     return $result if    $args->{'only_body'} 
                   7536:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   7537: 
                   7538:     #Breadcrumbs
1.758     kaisler  7539:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   7540: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   7541: 		#if any br links exists, add them to the breadcrumbs
                   7542: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   7543: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   7544: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   7545: 			}
                   7546: 		}
1.1096    raeburn  7547:                 # if @advtools array contains items add then to the breadcrumbs
                   7548:                 if (@advtools > 0) {
                   7549:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   7550:                 }
1.758     kaisler  7551: 
                   7552: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   7553: 		if(exists($args->{'bread_crumbs_component'})){
                   7554: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   7555: 		}else{
                   7556: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   7557: 		}
1.320     albertel 7558:     }
1.315     albertel 7559:     return $result;
1.306     albertel 7560: }
                   7561: 
                   7562: sub end_page {
1.315     albertel 7563:     my ($args) = @_;
                   7564:     $env{'internal.end_page'}++;
1.330     albertel 7565:     my $result;
1.335     albertel 7566:     if ($args->{'discussion'}) {
                   7567: 	my ($target,$parser);
                   7568: 	if (ref($args->{'discussion'})) {
                   7569: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   7570: 				$args->{'discussion'}{'parser'});
                   7571: 	}
                   7572: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   7573:     }
1.330     albertel 7574:     if ($args->{'frameset'}) {
                   7575: 	$result .= '</frameset>';
                   7576:     } else {
1.635     raeburn  7577: 	$result .= &endbodytag($args);
1.330     albertel 7578:     }
1.1080    raeburn  7579:     unless ($args->{'notbody'}) {
                   7580:         $result .= "\n</html>";
                   7581:     }
1.330     albertel 7582: 
1.315     albertel 7583:     if ($args->{'js_ready'}) {
1.317     albertel 7584: 	$result = &js_ready($result);
1.315     albertel 7585:     }
1.335     albertel 7586: 
1.320     albertel 7587:     if ($args->{'html_encode'}) {
                   7588: 	$result = &html_encode($result);
                   7589:     }
1.335     albertel 7590: 
1.315     albertel 7591:     return $result;
                   7592: }
                   7593: 
1.1034    www      7594: sub wishlist_window {
                   7595:     return(<<'ENDWISHLIST');
1.1046    raeburn  7596: <script type="text/javascript">
1.1034    www      7597: // <![CDATA[
                   7598: // <!-- BEGIN LON-CAPA Internal
                   7599: function set_wishlistlink(title, path) {
                   7600:     if (!title) {
                   7601:         title = document.title;
                   7602:         title = title.replace(/^LON-CAPA /,'');
                   7603:     }
                   7604:     if (!path) {
                   7605:         path = location.pathname;
                   7606:     }
                   7607:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   7608:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   7609: }
                   7610: // END LON-CAPA Internal -->
                   7611: // ]]>
                   7612: </script>
                   7613: ENDWISHLIST
                   7614: }
                   7615: 
1.1030    www      7616: sub modal_window {
                   7617:     return(<<'ENDMODAL');
1.1046    raeburn  7618: <script type="text/javascript">
1.1030    www      7619: // <![CDATA[
                   7620: // <!-- BEGIN LON-CAPA Internal
                   7621: var modalWindow = {
                   7622: 	parent:"body",
                   7623: 	windowId:null,
                   7624: 	content:null,
                   7625: 	width:null,
                   7626: 	height:null,
                   7627: 	close:function()
                   7628: 	{
                   7629: 	        $(".LCmodal-window").remove();
                   7630: 	        $(".LCmodal-overlay").remove();
                   7631: 	},
                   7632: 	open:function()
                   7633: 	{
                   7634: 		var modal = "";
                   7635: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   7636: 		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;\">";
                   7637: 		modal += this.content;
                   7638: 		modal += "</div>";	
                   7639: 
                   7640: 		$(this.parent).append(modal);
                   7641: 
                   7642: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   7643: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   7644: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   7645: 	}
                   7646: };
1.1031    www      7647: 	var openMyModal = function(source,width,height,scrolling)
1.1030    www      7648: 	{
                   7649: 		modalWindow.windowId = "myModal";
                   7650: 		modalWindow.width = width;
                   7651: 		modalWindow.height = height;
1.1031    www      7652: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='true' src='" + source + "'>&lt/iframe>";
1.1030    www      7653: 		modalWindow.open();
                   7654: 	};	
                   7655: // END LON-CAPA Internal -->
                   7656: // ]]>
                   7657: </script>
                   7658: ENDMODAL
                   7659: }
                   7660: 
                   7661: sub modal_link {
1.1052    www      7662:     my ($link,$linktext,$width,$height,$target,$scrolling,$title)=@_;
1.1030    www      7663:     unless ($width) { $width=480; }
                   7664:     unless ($height) { $height=400; }
1.1031    www      7665:     unless ($scrolling) { $scrolling='yes'; }
1.1074    raeburn  7666:     my $target_attr;
                   7667:     if (defined($target)) {
                   7668:         $target_attr = 'target="'.$target.'"';
                   7669:     }
                   7670:     return <<"ENDLINK";
                   7671: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling'); return false;">
                   7672:            $linktext</a>
                   7673: ENDLINK
1.1030    www      7674: }
                   7675: 
1.1032    www      7676: sub modal_adhoc_script {
                   7677:     my ($funcname,$width,$height,$content)=@_;
                   7678:     return (<<ENDADHOC);
1.1046    raeburn  7679: <script type="text/javascript">
1.1032    www      7680: // <![CDATA[
                   7681:         var $funcname = function()
                   7682:         {
                   7683:                 modalWindow.windowId = "myModal";
                   7684:                 modalWindow.width = $width;
                   7685:                 modalWindow.height = $height;
                   7686:                 modalWindow.content = '$content';
                   7687:                 modalWindow.open();
                   7688:         };  
                   7689: // ]]>
                   7690: </script>
                   7691: ENDADHOC
                   7692: }
                   7693: 
1.1041    www      7694: sub modal_adhoc_inner {
                   7695:     my ($funcname,$width,$height,$content)=@_;
                   7696:     my $innerwidth=$width-20;
                   7697:     $content=&js_ready(
1.1042    www      7698:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1041    www      7699:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px').
                   7700:                     $content.
                   7701:                  &end_scrollbox().
                   7702:                &end_page()
                   7703:              );
                   7704:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   7705: }
                   7706: 
                   7707: sub modal_adhoc_window {
                   7708:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   7709:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   7710:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   7711: }
                   7712: 
                   7713: sub modal_adhoc_launch {
                   7714:     my ($funcname,$width,$height,$content)=@_;
                   7715:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   7716: <script type="text/javascript">
                   7717: // <![CDATA[
                   7718: $funcname();
                   7719: // ]]>
                   7720: </script>
                   7721: ENDLAUNCH
                   7722: }
                   7723: 
                   7724: sub modal_adhoc_close {
                   7725:     return (<<ENDCLOSE);
                   7726: <script type="text/javascript">
                   7727: // <![CDATA[
                   7728: modalWindow.close();
                   7729: // ]]>
                   7730: </script>
                   7731: ENDCLOSE
                   7732: }
                   7733: 
1.1038    www      7734: sub togglebox_script {
                   7735:    return(<<ENDTOGGLE);
                   7736: <script type="text/javascript"> 
                   7737: // <![CDATA[
                   7738: function LCtoggleDisplay(id,hidetext,showtext) {
                   7739:    link = document.getElementById(id + "link").childNodes[0];
                   7740:    with (document.getElementById(id).style) {
                   7741:       if (display == "none" ) {
                   7742:           display = "inline";
                   7743:           link.nodeValue = hidetext;
                   7744:         } else {
                   7745:           display = "none";
                   7746:           link.nodeValue = showtext;
                   7747:        }
                   7748:    }
                   7749: }
                   7750: // ]]>
                   7751: </script>
                   7752: ENDTOGGLE
                   7753: }
                   7754: 
1.1039    www      7755: sub start_togglebox {
                   7756:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   7757:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   7758:     unless ($showtext) { $showtext=&mt('show'); }
                   7759:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   7760:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   7761:     return &start_data_table().
                   7762:            &start_data_table_header_row().
                   7763:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   7764:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   7765:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   7766:            &end_data_table_header_row().
                   7767:            '<tr id="'.$id.'" style="display:none""><td>';
                   7768: }
                   7769: 
                   7770: sub end_togglebox {
                   7771:     return '</td></tr>'.&end_data_table();
                   7772: }
                   7773: 
1.1041    www      7774: sub LCprogressbar_script {
1.1045    www      7775:    my ($id)=@_;
1.1041    www      7776:    return(<<ENDPROGRESS);
                   7777: <script type="text/javascript">
                   7778: // <![CDATA[
1.1045    www      7779: \$('#progressbar$id').progressbar({
1.1041    www      7780:   value: 0,
                   7781:   change: function(event, ui) {
                   7782:     var newVal = \$(this).progressbar('option', 'value');
                   7783:     \$('.pblabel', this).text(LCprogressTxt);
                   7784:   }
                   7785: });
                   7786: // ]]>
                   7787: </script>
                   7788: ENDPROGRESS
                   7789: }
                   7790: 
                   7791: sub LCprogressbarUpdate_script {
                   7792:    return(<<ENDPROGRESSUPDATE);
                   7793: <style type="text/css">
                   7794: .ui-progressbar { position:relative; }
                   7795: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   7796: </style>
                   7797: <script type="text/javascript">
                   7798: // <![CDATA[
1.1045    www      7799: var LCprogressTxt='---';
                   7800: 
                   7801: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      7802:    LCprogressTxt=progresstext;
1.1045    www      7803:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      7804: }
                   7805: // ]]>
                   7806: </script>
                   7807: ENDPROGRESSUPDATE
                   7808: }
                   7809: 
1.1042    www      7810: my $LClastpercent;
1.1045    www      7811: my $LCidcnt;
                   7812: my $LCcurrentid;
1.1042    www      7813: 
1.1041    www      7814: sub LCprogressbar {
1.1042    www      7815:     my ($r)=(@_);
                   7816:     $LClastpercent=0;
1.1045    www      7817:     $LCidcnt++;
                   7818:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      7819:     my $starting=&mt('Starting');
                   7820:     my $content=(<<ENDPROGBAR);
1.1123    raeburn  7821: <p>
1.1045    www      7822:   <div id="progressbar$LCcurrentid">
1.1041    www      7823:     <span class="pblabel">$starting</span>
                   7824:   </div>
1.1123    raeburn  7825: </p>
1.1041    www      7826: ENDPROGBAR
1.1045    www      7827:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      7828: }
                   7829: 
                   7830: sub LCprogressbarUpdate {
1.1042    www      7831:     my ($r,$val,$text)=@_;
                   7832:     unless ($val) { 
                   7833:        if ($LClastpercent) {
                   7834:            $val=$LClastpercent;
                   7835:        } else {
                   7836:            $val=0;
                   7837:        }
                   7838:     }
1.1041    www      7839:     if ($val<0) { $val=0; }
                   7840:     if ($val>100) { $val=0; }
1.1042    www      7841:     $LClastpercent=$val;
1.1041    www      7842:     unless ($text) { $text=$val.'%'; }
                   7843:     $text=&js_ready($text);
1.1044    www      7844:     &r_print($r,<<ENDUPDATE);
1.1041    www      7845: <script type="text/javascript">
                   7846: // <![CDATA[
1.1045    www      7847: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      7848: // ]]>
                   7849: </script>
                   7850: ENDUPDATE
1.1035    www      7851: }
                   7852: 
1.1042    www      7853: sub LCprogressbarClose {
                   7854:     my ($r)=@_;
                   7855:     $LClastpercent=0;
1.1044    www      7856:     &r_print($r,<<ENDCLOSE);
1.1042    www      7857: <script type="text/javascript">
                   7858: // <![CDATA[
1.1045    www      7859: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      7860: // ]]>
                   7861: </script>
                   7862: ENDCLOSE
1.1044    www      7863: }
                   7864: 
                   7865: sub r_print {
                   7866:     my ($r,$to_print)=@_;
                   7867:     if ($r) {
                   7868:       $r->print($to_print);
                   7869:       $r->rflush();
                   7870:     } else {
                   7871:       print($to_print);
                   7872:     }
1.1042    www      7873: }
                   7874: 
1.320     albertel 7875: sub html_encode {
                   7876:     my ($result) = @_;
                   7877: 
1.322     albertel 7878:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 7879:     
                   7880:     return $result;
                   7881: }
1.1044    www      7882: 
1.317     albertel 7883: sub js_ready {
                   7884:     my ($result) = @_;
                   7885: 
1.323     albertel 7886:     $result =~ s/[\n\r]/ /xmsg;
                   7887:     $result =~ s/\\/\\\\/xmsg;
                   7888:     $result =~ s/'/\\'/xmsg;
1.372     albertel 7889:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 7890:     
                   7891:     return $result;
                   7892: }
                   7893: 
1.315     albertel 7894: sub validate_page {
                   7895:     if (  exists($env{'internal.start_page'})
1.316     albertel 7896: 	  &&     $env{'internal.start_page'} > 1) {
                   7897: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 7898: 				 $env{'internal.start_page'}.' '.
1.316     albertel 7899: 				 $ENV{'request.filename'});
1.315     albertel 7900:     }
                   7901:     if (  exists($env{'internal.end_page'})
1.316     albertel 7902: 	  &&     $env{'internal.end_page'} > 1) {
                   7903: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 7904: 				 $env{'internal.end_page'}.' '.
1.316     albertel 7905: 				 $env{'request.filename'});
1.315     albertel 7906:     }
                   7907:     if (     exists($env{'internal.start_page'})
                   7908: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 7909: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   7910: 				 $env{'request.filename'});
1.315     albertel 7911:     }
                   7912:     if (   ! exists($env{'internal.start_page'})
                   7913: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 7914: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   7915: 				 $env{'request.filename'});
1.315     albertel 7916:     }
1.306     albertel 7917: }
1.315     albertel 7918: 
1.996     www      7919: 
                   7920: sub start_scrollbox {
1.1075    raeburn  7921:     my ($outerwidth,$width,$height,$id,$bgcolor)=@_;
1.998     raeburn  7922:     unless ($outerwidth) { $outerwidth='520px'; }
                   7923:     unless ($width) { $width='500px'; }
                   7924:     unless ($height) { $height='200px'; }
1.1075    raeburn  7925:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  7926:     if ($id ne '') {
1.1020    raeburn  7927:         $table_id = " id='table_$id'";
                   7928:         $div_id = " id='div_$id'";
1.1018    raeburn  7929:     }
1.1075    raeburn  7930:     if ($bgcolor ne '') {
                   7931:         $tdcol = "background-color: $bgcolor;";
                   7932:     }
                   7933:     return <<"END";
                   7934: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol"><div style="overflow:auto; width:$width; height: $height;"$div_id>
                   7935: END
1.996     www      7936: }
                   7937: 
                   7938: sub end_scrollbox {
1.1036    www      7939:     return '</div></td></tr></table>';
1.996     www      7940: }
                   7941: 
1.318     albertel 7942: sub simple_error_page {
                   7943:     my ($r,$title,$msg) = @_;
                   7944:     my $page =
                   7945: 	&Apache::loncommon::start_page($title).
1.1097    bisitz   7946: 	'<p class="LC_error">'.&mt($msg).'</p>'.
1.318     albertel 7947: 	&Apache::loncommon::end_page();
                   7948:     if (ref($r)) {
                   7949: 	$r->print($page);
1.327     albertel 7950: 	return;
1.318     albertel 7951:     }
                   7952:     return $page;
                   7953: }
1.347     albertel 7954: 
                   7955: {
1.610     albertel 7956:     my @row_count;
1.961     onken    7957: 
                   7958:     sub start_data_table_count {
                   7959:         unshift(@row_count, 0);
                   7960:         return;
                   7961:     }
                   7962: 
                   7963:     sub end_data_table_count {
                   7964:         shift(@row_count);
                   7965:         return;
                   7966:     }
                   7967: 
1.347     albertel 7968:     sub start_data_table {
1.1018    raeburn  7969: 	my ($add_class,$id) = @_;
1.422     albertel 7970: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  7971:         my $table_id;
                   7972:         if (defined($id)) {
                   7973:             $table_id = ' id="'.$id.'"';
                   7974:         }
1.961     onken    7975: 	&start_data_table_count();
1.1018    raeburn  7976: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 7977:     }
                   7978: 
                   7979:     sub end_data_table {
1.961     onken    7980: 	&end_data_table_count();
1.389     albertel 7981: 	return '</table>'."\n";;
1.347     albertel 7982:     }
                   7983: 
                   7984:     sub start_data_table_row {
1.974     wenzelju 7985: 	my ($add_class, $id) = @_;
1.610     albertel 7986: 	$row_count[0]++;
                   7987: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   7988: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 7989:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7990:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 7991:     }
1.471     banghart 7992:     
                   7993:     sub continue_data_table_row {
1.974     wenzelju 7994: 	my ($add_class, $id) = @_;
1.610     albertel 7995: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 7996: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   7997:         $id = (' id="'.$id.'"') unless ($id eq '');
                   7998:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 7999:     }
1.347     albertel 8000: 
                   8001:     sub end_data_table_row {
1.389     albertel 8002: 	return '</tr>'."\n";;
1.347     albertel 8003:     }
1.367     www      8004: 
1.421     albertel 8005:     sub start_data_table_empty_row {
1.707     bisitz   8006: #	$row_count[0]++;
1.421     albertel 8007: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8008:     }
                   8009: 
                   8010:     sub end_data_table_empty_row {
                   8011: 	return '</tr>'."\n";;
                   8012:     }
                   8013: 
1.367     www      8014:     sub start_data_table_header_row {
1.389     albertel 8015: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      8016:     }
                   8017: 
                   8018:     sub end_data_table_header_row {
1.389     albertel 8019: 	return '</tr>'."\n";;
1.367     www      8020:     }
1.890     droeschl 8021: 
                   8022:     sub data_table_caption {
                   8023:         my $caption = shift;
                   8024:         return "<caption class=\"LC_caption\">$caption</caption>";
                   8025:     }
1.347     albertel 8026: }
                   8027: 
1.548     albertel 8028: =pod
                   8029: 
                   8030: =item * &inhibit_menu_check($arg)
                   8031: 
                   8032: Checks for a inhibitmenu state and generates output to preserve it
                   8033: 
                   8034: Inputs:         $arg - can be any of
                   8035:                      - undef - in which case the return value is a string 
                   8036:                                to add  into arguments list of a uri
                   8037:                      - 'input' - in which case the return value is a HTML
                   8038:                                  <form> <input> field of type hidden to
                   8039:                                  preserve the value
                   8040:                      - a url - in which case the return value is the url with
                   8041:                                the neccesary cgi args added to preserve the
                   8042:                                inhibitmenu state
                   8043:                      - a ref to a url - no return value, but the string is
                   8044:                                         updated to include the neccessary cgi
                   8045:                                         args to preserve the inhibitmenu state
                   8046: 
                   8047: =cut
                   8048: 
                   8049: sub inhibit_menu_check {
                   8050:     my ($arg) = @_;
                   8051:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   8052:     if ($arg eq 'input') {
                   8053: 	if ($env{'form.inhibitmenu'}) {
                   8054: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   8055: 	} else {
                   8056: 	    return
                   8057: 	}
                   8058:     }
                   8059:     if ($env{'form.inhibitmenu'}) {
                   8060: 	if (ref($arg)) {
                   8061: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8062: 	} elsif ($arg eq '') {
                   8063: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   8064: 	} else {
                   8065: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8066: 	}
                   8067:     }
                   8068:     if (!ref($arg)) {
                   8069: 	return $arg;
                   8070:     }
                   8071: }
                   8072: 
1.251     albertel 8073: ###############################################
1.182     matthew  8074: 
                   8075: =pod
                   8076: 
1.549     albertel 8077: =back
                   8078: 
                   8079: =head1 User Information Routines
                   8080: 
                   8081: =over 4
                   8082: 
1.405     albertel 8083: =item * &get_users_function()
1.182     matthew  8084: 
                   8085: Used by &bodytag to determine the current users primary role.
                   8086: Returns either 'student','coordinator','admin', or 'author'.
                   8087: 
                   8088: =cut
                   8089: 
                   8090: ###############################################
                   8091: sub get_users_function {
1.815     tempelho 8092:     my $function = 'norole';
1.818     tempelho 8093:     if ($env{'request.role'}=~/^(st)/) {
                   8094:         $function='student';
                   8095:     }
1.907     raeburn  8096:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  8097:         $function='coordinator';
                   8098:     }
1.258     albertel 8099:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  8100:         $function='admin';
                   8101:     }
1.826     bisitz   8102:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  8103:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  8104:         $function='author';
                   8105:     }
                   8106:     return $function;
1.54      www      8107: }
1.99      www      8108: 
                   8109: ###############################################
                   8110: 
1.233     raeburn  8111: =pod
                   8112: 
1.821     raeburn  8113: =item * &show_course()
                   8114: 
                   8115: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   8116: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   8117: 
                   8118: Inputs:
                   8119: None
                   8120: 
                   8121: Outputs:
                   8122: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   8123: 
                   8124: =cut
                   8125: 
                   8126: ###############################################
                   8127: sub show_course {
                   8128:     my $course = !$env{'user.adv'};
                   8129:     if (!$env{'user.adv'}) {
                   8130:         foreach my $env (keys(%env)) {
                   8131:             next if ($env !~ m/^user\.priv\./);
                   8132:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   8133:                 $course = 0;
                   8134:                 last;
                   8135:             }
                   8136:         }
                   8137:     }
                   8138:     return $course;
                   8139: }
                   8140: 
                   8141: ###############################################
                   8142: 
                   8143: =pod
                   8144: 
1.542     raeburn  8145: =item * &check_user_status()
1.274     raeburn  8146: 
                   8147: Determines current status of supplied role for a
                   8148: specific user. Roles can be active, previous or future.
                   8149: 
                   8150: Inputs: 
                   8151: user's domain, user's username, course's domain,
1.375     raeburn  8152: course's number, optional section ID.
1.274     raeburn  8153: 
                   8154: Outputs:
                   8155: role status: active, previous or future. 
                   8156: 
                   8157: =cut
                   8158: 
                   8159: sub check_user_status {
1.412     raeburn  8160:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  8161:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.274     raeburn  8162:     my @uroles = keys %userinfo;
                   8163:     my $srchstr;
                   8164:     my $active_chk = 'none';
1.412     raeburn  8165:     my $now = time;
1.274     raeburn  8166:     if (@uroles > 0) {
1.908     raeburn  8167:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  8168:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   8169:         } else {
1.412     raeburn  8170:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   8171:         }
                   8172:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  8173:             my $role_end = 0;
                   8174:             my $role_start = 0;
                   8175:             $active_chk = 'active';
1.412     raeburn  8176:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   8177:                 $role_end = $1;
                   8178:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   8179:                     $role_start = $1;
1.274     raeburn  8180:                 }
                   8181:             }
                   8182:             if ($role_start > 0) {
1.412     raeburn  8183:                 if ($now < $role_start) {
1.274     raeburn  8184:                     $active_chk = 'future';
                   8185:                 }
                   8186:             }
                   8187:             if ($role_end > 0) {
1.412     raeburn  8188:                 if ($now > $role_end) {
1.274     raeburn  8189:                     $active_chk = 'previous';
                   8190:                 }
                   8191:             }
                   8192:         }
                   8193:     }
                   8194:     return $active_chk;
                   8195: }
                   8196: 
                   8197: ###############################################
                   8198: 
                   8199: =pod
                   8200: 
1.405     albertel 8201: =item * &get_sections()
1.233     raeburn  8202: 
                   8203: Determines all the sections for a course including
                   8204: sections with students and sections containing other roles.
1.419     raeburn  8205: Incoming parameters: 
                   8206: 
                   8207: 1. domain
                   8208: 2. course number 
                   8209: 3. reference to array containing roles for which sections should 
                   8210: be gathered (optional).
                   8211: 4. reference to array containing status types for which sections 
                   8212: should be gathered (optional).
                   8213: 
                   8214: If the third argument is undefined, sections are gathered for any role. 
                   8215: If the fourth argument is undefined, sections are gathered for any status.
                   8216: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  8217:  
1.374     raeburn  8218: Returns section hash (keys are section IDs, values are
                   8219: number of users in each section), subject to the
1.419     raeburn  8220: optional roles filter, optional status filter 
1.233     raeburn  8221: 
                   8222: =cut
                   8223: 
                   8224: ###############################################
                   8225: sub get_sections {
1.419     raeburn  8226:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 8227:     if (!defined($cdom) || !defined($cnum)) {
                   8228:         my $cid =  $env{'request.course.id'};
                   8229: 
                   8230: 	return if (!defined($cid));
                   8231: 
                   8232:         $cdom = $env{'course.'.$cid.'.domain'};
                   8233:         $cnum = $env{'course.'.$cid.'.num'};
                   8234:     }
                   8235: 
                   8236:     my %sectioncount;
1.419     raeburn  8237:     my $now = time;
1.240     albertel 8238: 
1.1118    raeburn  8239:     my $check_students = 1;
                   8240:     my $only_students = 0;
                   8241:     if (ref($possible_roles) eq 'ARRAY') {
                   8242:         if (grep(/^st$/,@{$possible_roles})) {
                   8243:             if (@{$possible_roles} == 1) {
                   8244:                 $only_students = 1;
                   8245:             }
                   8246:         } else {
                   8247:             $check_students = 0;
                   8248:         }
                   8249:     }
                   8250: 
                   8251:     if ($check_students) { 
1.276     albertel 8252: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 8253: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   8254: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  8255:         my $start_index = &Apache::loncoursedata::CL_START();
                   8256:         my $end_index = &Apache::loncoursedata::CL_END();
                   8257:         my $status;
1.366     albertel 8258: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  8259: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   8260: 				                     $data->[$status_index],
                   8261:                                                      $data->[$start_index],
                   8262:                                                      $data->[$end_index]);
                   8263:             if ($stu_status eq 'Active') {
                   8264:                 $status = 'active';
                   8265:             } elsif ($end < $now) {
                   8266:                 $status = 'previous';
                   8267:             } elsif ($start > $now) {
                   8268:                 $status = 'future';
                   8269:             } 
                   8270: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   8271:                 if ((!defined($possible_status)) || (($status ne '') && 
                   8272:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   8273: 		    $sectioncount{$section}++;
                   8274:                 }
1.240     albertel 8275: 	    }
                   8276: 	}
                   8277:     }
1.1118    raeburn  8278:     if ($only_students) {
                   8279:         return %sectioncount;
                   8280:     }
1.240     albertel 8281:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8282:     foreach my $user (sort(keys(%courseroles))) {
                   8283: 	if ($user !~ /^(\w{2})/) { next; }
                   8284: 	my ($role) = ($user =~ /^(\w{2})/);
                   8285: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  8286: 	my ($section,$status);
1.240     albertel 8287: 	if ($role eq 'cr' &&
                   8288: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   8289: 	    $section=$1;
                   8290: 	}
                   8291: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   8292: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  8293:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   8294:         if ($end == -1 && $start == -1) {
                   8295:             next; #deleted role
                   8296:         }
                   8297:         if (!defined($possible_status)) { 
                   8298:             $sectioncount{$section}++;
                   8299:         } else {
                   8300:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   8301:                 $status = 'active';
                   8302:             } elsif ($end < $now) {
                   8303:                 $status = 'future';
                   8304:             } elsif ($start > $now) {
                   8305:                 $status = 'previous';
                   8306:             }
                   8307:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   8308:                 $sectioncount{$section}++;
                   8309:             }
                   8310:         }
1.233     raeburn  8311:     }
1.366     albertel 8312:     return %sectioncount;
1.233     raeburn  8313: }
                   8314: 
1.274     raeburn  8315: ###############################################
1.294     raeburn  8316: 
                   8317: =pod
1.405     albertel 8318: 
                   8319: =item * &get_course_users()
                   8320: 
1.275     raeburn  8321: Retrieves usernames:domains for users in the specified course
                   8322: with specific role(s), and access status. 
                   8323: 
                   8324: Incoming parameters:
1.277     albertel 8325: 1. course domain
                   8326: 2. course number
                   8327: 3. access status: users must have - either active, 
1.275     raeburn  8328: previous, future, or all.
1.277     albertel 8329: 4. reference to array of permissible roles
1.288     raeburn  8330: 5. reference to array of section restrictions (optional)
                   8331: 6. reference to results object (hash of hashes).
                   8332: 7. reference to optional userdata hash
1.609     raeburn  8333: 8. reference to optional statushash
1.630     raeburn  8334: 9. flag if privileged users (except those set to unhide in
                   8335:    course settings) should be excluded    
1.609     raeburn  8336: Keys of top level results hash are roles.
1.275     raeburn  8337: Keys of inner hashes are username:domain, with 
                   8338: values set to access type.
1.288     raeburn  8339: Optional userdata hash returns an array with arguments in the 
                   8340: same order as loncoursedata::get_classlist() for student data.
                   8341: 
1.609     raeburn  8342: Optional statushash returns
                   8343: 
1.288     raeburn  8344: Entries for end, start, section and status are blank because
                   8345: of the possibility of multiple values for non-student roles.
                   8346: 
1.275     raeburn  8347: =cut
1.405     albertel 8348: 
1.275     raeburn  8349: ###############################################
1.405     albertel 8350: 
1.275     raeburn  8351: sub get_course_users {
1.630     raeburn  8352:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  8353:     my %idx = ();
1.419     raeburn  8354:     my %seclists;
1.288     raeburn  8355: 
                   8356:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   8357:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   8358:     $idx{end} = &Apache::loncoursedata::CL_END();
                   8359:     $idx{start} = &Apache::loncoursedata::CL_START();
                   8360:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   8361:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   8362:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   8363:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   8364: 
1.290     albertel 8365:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 8366:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  8367:         my $now = time;
1.277     albertel 8368:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  8369:             my $match = 0;
1.412     raeburn  8370:             my $secmatch = 0;
1.419     raeburn  8371:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  8372:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  8373:             if ($section eq '') {
                   8374:                 $section = 'none';
                   8375:             }
1.291     albertel 8376:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8377:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8378:                     $secmatch = 1;
                   8379:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 8380:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8381:                         $secmatch = 1;
                   8382:                     }
                   8383:                 } else {  
1.419     raeburn  8384: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  8385: 		        $secmatch = 1;
                   8386:                     }
1.290     albertel 8387: 		}
1.412     raeburn  8388:                 if (!$secmatch) {
                   8389:                     next;
                   8390:                 }
1.419     raeburn  8391:             }
1.275     raeburn  8392:             if (defined($$types{'active'})) {
1.288     raeburn  8393:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  8394:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  8395:                     $match = 1;
1.275     raeburn  8396:                 }
                   8397:             }
                   8398:             if (defined($$types{'previous'})) {
1.609     raeburn  8399:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  8400:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  8401:                     $match = 1;
1.275     raeburn  8402:                 }
                   8403:             }
                   8404:             if (defined($$types{'future'})) {
1.609     raeburn  8405:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  8406:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  8407:                     $match = 1;
1.275     raeburn  8408:                 }
                   8409:             }
1.609     raeburn  8410:             if ($match) {
                   8411:                 push(@{$seclists{$student}},$section);
                   8412:                 if (ref($userdata) eq 'HASH') {
                   8413:                     $$userdata{$student} = $$classlist{$student};
                   8414:                 }
                   8415:                 if (ref($statushash) eq 'HASH') {
                   8416:                     $statushash->{$student}{'st'}{$section} = $status;
                   8417:                 }
1.288     raeburn  8418:             }
1.275     raeburn  8419:         }
                   8420:     }
1.412     raeburn  8421:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  8422:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8423:         my $now = time;
1.609     raeburn  8424:         my %displaystatus = ( previous => 'Expired',
                   8425:                               active   => 'Active',
                   8426:                               future   => 'Future',
                   8427:                             );
1.1121    raeburn  8428:         my (%nothide,@possdoms);
1.630     raeburn  8429:         if ($hidepriv) {
                   8430:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   8431:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   8432:                 if ($user !~ /:/) {
                   8433:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   8434:                 } else {
                   8435:                     $nothide{$user} = 1;
                   8436:                 }
                   8437:             }
1.1121    raeburn  8438:             my @possdoms = ($cdom);
                   8439:             if ($coursehash{'checkforpriv'}) {
                   8440:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   8441:             }
1.630     raeburn  8442:         }
1.439     raeburn  8443:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  8444:             my $match = 0;
1.412     raeburn  8445:             my $secmatch = 0;
1.439     raeburn  8446:             my $status;
1.412     raeburn  8447:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  8448:             $user =~ s/:$//;
1.439     raeburn  8449:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   8450:             if ($end == -1 || $start == -1) {
                   8451:                 next;
                   8452:             }
                   8453:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   8454:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  8455:                 my ($uname,$udom) = split(/:/,$user);
                   8456:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 8457:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  8458:                         $secmatch = 1;
                   8459:                     } elsif ($usec eq '') {
1.420     albertel 8460:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  8461:                             $secmatch = 1;
                   8462:                         }
                   8463:                     } else {
                   8464:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   8465:                             $secmatch = 1;
                   8466:                         }
                   8467:                     }
                   8468:                     if (!$secmatch) {
                   8469:                         next;
                   8470:                     }
1.288     raeburn  8471:                 }
1.419     raeburn  8472:                 if ($usec eq '') {
                   8473:                     $usec = 'none';
                   8474:                 }
1.275     raeburn  8475:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  8476:                     if ($hidepriv) {
1.1121    raeburn  8477:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  8478:                             (!$nothide{$uname.':'.$udom})) {
                   8479:                             next;
                   8480:                         }
                   8481:                     }
1.503     raeburn  8482:                     if ($end > 0 && $end < $now) {
1.439     raeburn  8483:                         $status = 'previous';
                   8484:                     } elsif ($start > $now) {
                   8485:                         $status = 'future';
                   8486:                     } else {
                   8487:                         $status = 'active';
                   8488:                     }
1.277     albertel 8489:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  8490:                         if ($status eq $type) {
1.420     albertel 8491:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  8492:                                 push(@{$$users{$role}{$user}},$type);
                   8493:                             }
1.288     raeburn  8494:                             $match = 1;
                   8495:                         }
                   8496:                     }
1.419     raeburn  8497:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   8498:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   8499: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   8500:                         }
1.420     albertel 8501:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  8502:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   8503:                         }
1.609     raeburn  8504:                         if (ref($statushash) eq 'HASH') {
                   8505:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   8506:                         }
1.275     raeburn  8507:                     }
                   8508:                 }
                   8509:             }
                   8510:         }
1.290     albertel 8511:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  8512:             if ((defined($cdom)) && (defined($cnum))) {
                   8513:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   8514:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   8515:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  8516:                     next if ($owner eq '');
                   8517:                     my ($ownername,$ownerdom);
                   8518:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   8519:                         $ownername = $1;
                   8520:                         $ownerdom = $2;
                   8521:                     } else {
                   8522:                         $ownername = $owner;
                   8523:                         $ownerdom = $cdom;
                   8524:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  8525:                     }
                   8526:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 8527:                     if (defined($userdata) && 
1.609     raeburn  8528: 			!exists($$userdata{$owner})) {
                   8529: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   8530:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   8531:                             push(@{$seclists{$owner}},'none');
                   8532:                         }
                   8533:                         if (ref($statushash) eq 'HASH') {
                   8534:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  8535:                         }
1.290     albertel 8536: 		    }
1.279     raeburn  8537:                 }
                   8538:             }
                   8539:         }
1.419     raeburn  8540:         foreach my $user (keys(%seclists)) {
                   8541:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   8542:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   8543:         }
1.275     raeburn  8544:     }
                   8545:     return;
                   8546: }
                   8547: 
1.288     raeburn  8548: sub get_user_info {
                   8549:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 8550:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   8551: 	&plainname($uname,$udom,'lastname');
1.291     albertel 8552:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  8553:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  8554:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   8555:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  8556:     return;
                   8557: }
1.275     raeburn  8558: 
1.472     raeburn  8559: ###############################################
                   8560: 
                   8561: =pod
                   8562: 
                   8563: =item * &get_user_quota()
                   8564: 
                   8565: Retrieves quota assigned for storage of portfolio files for a user  
                   8566: 
                   8567: Incoming parameters:
                   8568: 1. user's username
                   8569: 2. user's domain
                   8570: 
                   8571: Returns:
1.536     raeburn  8572: 1. Disk quota (in Mb) assigned to student.
                   8573: 2. (Optional) Type of setting: custom or default
                   8574:    (individually assigned or default for user's 
                   8575:    institutional status).
                   8576: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   8577:    or student - types as defined in localenroll::inst_usertypes 
                   8578:    for user's domain, which determines default quota for user.
                   8579: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  8580: 
                   8581: If a value has been stored in the user's environment, 
1.536     raeburn  8582: it will return that, otherwise it returns the maximal default
                   8583: defined for the user's instituional status(es) in the domain.
1.472     raeburn  8584: 
                   8585: =cut
                   8586: 
                   8587: ###############################################
                   8588: 
                   8589: 
                   8590: sub get_user_quota {
                   8591:     my ($uname,$udom) = @_;
1.536     raeburn  8592:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  8593:     if (!defined($udom)) {
                   8594:         $udom = $env{'user.domain'};
                   8595:     }
                   8596:     if (!defined($uname)) {
                   8597:         $uname = $env{'user.name'};
                   8598:     }
                   8599:     if (($udom eq '' || $uname eq '') ||
                   8600:         ($udom eq 'public') && ($uname eq 'public')) {
                   8601:         $quota = 0;
1.536     raeburn  8602:         $quotatype = 'default';
                   8603:         $defquota = 0; 
1.472     raeburn  8604:     } else {
1.536     raeburn  8605:         my $inststatus;
1.472     raeburn  8606:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   8607:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  8608:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  8609:         } else {
1.536     raeburn  8610:             my %userenv = 
                   8611:                 &Apache::lonnet::get('environment',['portfolioquota',
                   8612:                                      'inststatus'],$udom,$uname);
1.472     raeburn  8613:             my ($tmp) = keys(%userenv);
                   8614:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   8615:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  8616:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  8617:             } else {
                   8618:                 undef(%userenv);
                   8619:             }
                   8620:         }
1.536     raeburn  8621:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  8622:         if ($quota eq '') {
1.536     raeburn  8623:             $quota = $defquota;
                   8624:             $quotatype = 'default';
                   8625:         } else {
                   8626:             $quotatype = 'custom';
1.472     raeburn  8627:         }
                   8628:     }
1.536     raeburn  8629:     if (wantarray) {
                   8630:         return ($quota,$quotatype,$settingstatus,$defquota);
                   8631:     } else {
                   8632:         return $quota;
                   8633:     }
1.472     raeburn  8634: }
                   8635: 
                   8636: ###############################################
                   8637: 
                   8638: =pod
                   8639: 
                   8640: =item * &default_quota()
                   8641: 
1.536     raeburn  8642: Retrieves default quota assigned for storage of user portfolio files,
                   8643: given an (optional) user's institutional status.
1.472     raeburn  8644: 
                   8645: Incoming parameters:
                   8646: 1. domain
1.536     raeburn  8647: 2. (Optional) institutional status(es).  This is a : separated list of 
                   8648:    status types (e.g., faculty, staff, student etc.)
                   8649:    which apply to the user for whom the default is being retrieved.
                   8650:    If the institutional status string in undefined, the domain
                   8651:    default quota will be returned. 
1.472     raeburn  8652: 
                   8653: Returns:
                   8654: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  8655: 2. (Optional) institutional type which determined the value of the
                   8656:    default quota.
1.472     raeburn  8657: 
                   8658: If a value has been stored in the domain's configuration db,
                   8659: it will return that, otherwise it returns 20 (for backwards 
                   8660: compatibility with domains which have not set up a configuration
                   8661: db file; the original statically defined portfolio quota was 20 Mb). 
                   8662: 
1.536     raeburn  8663: If the user's status includes multiple types (e.g., staff and student),
                   8664: the largest default quota which applies to the user determines the
                   8665: default quota returned.
                   8666: 
1.780     raeburn  8667: =back
                   8668: 
1.472     raeburn  8669: =cut
                   8670: 
                   8671: ###############################################
                   8672: 
                   8673: 
                   8674: sub default_quota {
1.536     raeburn  8675:     my ($udom,$inststatus) = @_;
                   8676:     my ($defquota,$settingstatus);
                   8677:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  8678:                                             ['quotas'],$udom);
                   8679:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  8680:         if ($inststatus ne '') {
1.765     raeburn  8681:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  8682:             foreach my $item (@statuses) {
1.711     raeburn  8683:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8684:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   8685:                         if ($defquota eq '') {
                   8686:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8687:                             $settingstatus = $item;
                   8688:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   8689:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   8690:                             $settingstatus = $item;
                   8691:                         }
                   8692:                     }
                   8693:                 } else {
                   8694:                     if ($quotahash{'quotas'}{$item} ne '') {
                   8695:                         if ($defquota eq '') {
                   8696:                             $defquota = $quotahash{'quotas'}{$item};
                   8697:                             $settingstatus = $item;
                   8698:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   8699:                             $defquota = $quotahash{'quotas'}{$item};
                   8700:                             $settingstatus = $item;
                   8701:                         }
1.536     raeburn  8702:                     }
                   8703:                 }
                   8704:             }
                   8705:         }
                   8706:         if ($defquota eq '') {
1.711     raeburn  8707:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   8708:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   8709:             } else {
                   8710:                 $defquota = $quotahash{'quotas'}{'default'};
                   8711:             }
1.536     raeburn  8712:             $settingstatus = 'default';
                   8713:         }
                   8714:     } else {
                   8715:         $settingstatus = 'default';
                   8716:         $defquota = 20;
                   8717:     }
                   8718:     if (wantarray) {
                   8719:         return ($defquota,$settingstatus);
1.472     raeburn  8720:     } else {
1.536     raeburn  8721:         return $defquota;
1.472     raeburn  8722:     }
                   8723: }
                   8724: 
1.384     raeburn  8725: sub get_secgrprole_info {
                   8726:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   8727:     my %sections_count = &get_sections($cdom,$cnum);
                   8728:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   8729:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   8730:     my @groups = sort(keys(%curr_groups));
                   8731:     my $allroles = [];
                   8732:     my $rolehash;
                   8733:     my $accesshash = {
                   8734:                      active => 'Currently has access',
                   8735:                      future => 'Will have future access',
                   8736:                      previous => 'Previously had access',
                   8737:                   };
                   8738:     if ($needroles) {
                   8739:         $rolehash = {'all' => 'all'};
1.385     albertel 8740:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8741: 	if (&Apache::lonnet::error(%user_roles)) {
                   8742: 	    undef(%user_roles);
                   8743: 	}
                   8744:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  8745:             my ($role)=split(/\:/,$item,2);
                   8746:             if ($role eq 'cr') { next; }
                   8747:             if ($role =~ /^cr/) {
                   8748:                 $$rolehash{$role} = (split('/',$role))[3];
                   8749:             } else {
                   8750:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   8751:             }
                   8752:         }
                   8753:         foreach my $key (sort(keys(%{$rolehash}))) {
                   8754:             push(@{$allroles},$key);
                   8755:         }
                   8756:         push (@{$allroles},'st');
                   8757:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   8758:     }
                   8759:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   8760: }
                   8761: 
1.555     raeburn  8762: sub user_picker {
1.994     raeburn  8763:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_;
1.555     raeburn  8764:     my $currdom = $dom;
                   8765:     my %curr_selected = (
                   8766:                         srchin => 'dom',
1.580     raeburn  8767:                         srchby => 'lastname',
1.555     raeburn  8768:                       );
                   8769:     my $srchterm;
1.625     raeburn  8770:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  8771:         if ($srch->{'srchby'} ne '') {
                   8772:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   8773:         }
                   8774:         if ($srch->{'srchin'} ne '') {
                   8775:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   8776:         }
                   8777:         if ($srch->{'srchtype'} ne '') {
                   8778:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   8779:         }
                   8780:         if ($srch->{'srchdomain'} ne '') {
                   8781:             $currdom = $srch->{'srchdomain'};
                   8782:         }
                   8783:         $srchterm = $srch->{'srchterm'};
                   8784:     }
                   8785:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  8786:                     'usr'       => 'Search criteria',
1.563     raeburn  8787:                     'doma'      => 'Domain/institution to search',
1.558     albertel 8788:                     'uname'     => 'username',
                   8789:                     'lastname'  => 'last name',
1.555     raeburn  8790:                     'lastfirst' => 'last name, first name',
1.558     albertel 8791:                     'crs'       => 'in this course',
1.576     raeburn  8792:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 8793:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  8794:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 8795:                     'exact'     => 'is',
                   8796:                     'contains'  => 'contains',
1.569     raeburn  8797:                     'begins'    => 'begins with',
1.571     raeburn  8798:                     'youm'      => "You must include some text to search for.",
                   8799:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   8800:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   8801:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   8802:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   8803:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   8804:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   8805:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  8806:                                        );
1.563     raeburn  8807:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   8808:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  8809: 
                   8810:     my @srchins = ('crs','dom','alc','instd');
                   8811: 
                   8812:     foreach my $option (@srchins) {
                   8813:         # FIXME 'alc' option unavailable until 
                   8814:         #       loncreateuser::print_user_query_page()
                   8815:         #       has been completed.
                   8816:         next if ($option eq 'alc');
1.880     raeburn  8817:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  8818:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  8819:         if ($curr_selected{'srchin'} eq $option) {
                   8820:             $srchinsel .= ' 
                   8821:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8822:         } else {
                   8823:             $srchinsel .= '
                   8824:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8825:         }
1.555     raeburn  8826:     }
1.563     raeburn  8827:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  8828: 
                   8829:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  8830:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  8831:         if ($curr_selected{'srchby'} eq $option) {
                   8832:             $srchbysel .= '
                   8833:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8834:         } else {
                   8835:             $srchbysel .= '
                   8836:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8837:          }
                   8838:     }
                   8839:     $srchbysel .= "\n  </select>\n";
                   8840: 
                   8841:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  8842:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  8843:         if ($curr_selected{'srchtype'} eq $option) {
                   8844:             $srchtypesel .= '
                   8845:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   8846:         } else {
                   8847:             $srchtypesel .= '
                   8848:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   8849:         }
                   8850:     }
                   8851:     $srchtypesel .= "\n  </select>\n";
                   8852: 
1.558     albertel 8853:     my ($newuserscript,$new_user_create);
1.994     raeburn  8854:     my $context_dom = $env{'request.role.domain'};
                   8855:     if ($context eq 'requestcrs') {
                   8856:         if ($env{'form.coursedom'} ne '') { 
                   8857:             $context_dom = $env{'form.coursedom'};
                   8858:         }
                   8859:     }
1.556     raeburn  8860:     if ($forcenewuser) {
1.576     raeburn  8861:         if (ref($srch) eq 'HASH') {
1.994     raeburn  8862:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  8863:                 if ($cancreate) {
                   8864:                     $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>';
                   8865:                 } else {
1.799     bisitz   8866:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  8867:                     my %usertypetext = (
                   8868:                         official   => 'institutional',
                   8869:                         unofficial => 'non-institutional',
                   8870:                     );
1.799     bisitz   8871:                     $new_user_create = '<p class="LC_warning">'
                   8872:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   8873:                                       .' '
                   8874:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   8875:                                           ,'<a href="'.$helplink.'">','</a>')
                   8876:                                       .'</p><br />';
1.627     raeburn  8877:                 }
1.576     raeburn  8878:             }
                   8879:         }
                   8880: 
1.556     raeburn  8881:         $newuserscript = <<"ENDSCRIPT";
                   8882: 
1.570     raeburn  8883: function setSearch(createnew,callingForm) {
1.556     raeburn  8884:     if (createnew == 1) {
1.570     raeburn  8885:         for (var i=0; i<callingForm.srchby.length; i++) {
                   8886:             if (callingForm.srchby.options[i].value == 'uname') {
                   8887:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  8888:             }
                   8889:         }
1.570     raeburn  8890:         for (var i=0; i<callingForm.srchin.length; i++) {
                   8891:             if ( callingForm.srchin.options[i].value == 'dom') {
                   8892: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  8893:             }
                   8894:         }
1.570     raeburn  8895:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   8896:             if (callingForm.srchtype.options[i].value == 'exact') {
                   8897:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  8898:             }
                   8899:         }
1.570     raeburn  8900:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  8901:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  8902:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  8903:             }
                   8904:         }
                   8905:     }
                   8906: }
                   8907: ENDSCRIPT
1.558     albertel 8908: 
1.556     raeburn  8909:     }
                   8910: 
1.555     raeburn  8911:     my $output = <<"END_BLOCK";
1.556     raeburn  8912: <script type="text/javascript">
1.824     bisitz   8913: // <![CDATA[
1.570     raeburn  8914: function validateEntry(callingForm) {
1.558     albertel 8915: 
1.556     raeburn  8916:     var checkok = 1;
1.558     albertel 8917:     var srchin;
1.570     raeburn  8918:     for (var i=0; i<callingForm.srchin.length; i++) {
                   8919: 	if ( callingForm.srchin[i].checked ) {
                   8920: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 8921: 	}
                   8922:     }
                   8923: 
1.570     raeburn  8924:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   8925:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   8926:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   8927:     var srchterm =  callingForm.srchterm.value;
                   8928:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  8929:     var msg = "";
                   8930: 
                   8931:     if (srchterm == "") {
                   8932:         checkok = 0;
1.571     raeburn  8933:         msg += "$lt{'youm'}\\n";
1.556     raeburn  8934:     }
                   8935: 
1.569     raeburn  8936:     if (srchtype== 'begins') {
                   8937:         if (srchterm.length < 2) {
                   8938:             checkok = 0;
1.571     raeburn  8939:             msg += "$lt{'thte'}\\n";
1.569     raeburn  8940:         }
                   8941:     }
                   8942: 
1.556     raeburn  8943:     if (srchtype== 'contains') {
                   8944:         if (srchterm.length < 3) {
                   8945:             checkok = 0;
1.571     raeburn  8946:             msg += "$lt{'thet'}\\n";
1.556     raeburn  8947:         }
                   8948:     }
                   8949:     if (srchin == 'instd') {
                   8950:         if (srchdomain == '') {
                   8951:             checkok = 0;
1.571     raeburn  8952:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  8953:         }
                   8954:     }
                   8955:     if (srchin == 'dom') {
                   8956:         if (srchdomain == '') {
                   8957:             checkok = 0;
1.571     raeburn  8958:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  8959:         }
                   8960:     }
                   8961:     if (srchby == 'lastfirst') {
                   8962:         if (srchterm.indexOf(",") == -1) {
                   8963:             checkok = 0;
1.571     raeburn  8964:             msg += "$lt{'whus'}\\n";
1.556     raeburn  8965:         }
                   8966:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   8967:             checkok = 0;
1.571     raeburn  8968:             msg += "$lt{'whse'}\\n";
1.556     raeburn  8969:         }
                   8970:     }
                   8971:     if (checkok == 0) {
1.571     raeburn  8972:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  8973:         return;
                   8974:     }
                   8975:     if (checkok == 1) {
1.570     raeburn  8976:         callingForm.submit();
1.556     raeburn  8977:     }
                   8978: }
                   8979: 
                   8980: $newuserscript
                   8981: 
1.824     bisitz   8982: // ]]>
1.556     raeburn  8983: </script>
1.558     albertel 8984: 
                   8985: $new_user_create
                   8986: 
1.555     raeburn  8987: END_BLOCK
1.558     albertel 8988: 
1.876     raeburn  8989:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   8990:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   8991:                $domform.
                   8992:                &Apache::lonhtmlcommon::row_closure().
                   8993:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   8994:                $srchbysel.
                   8995:                $srchtypesel. 
                   8996:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   8997:                $srchinsel.
                   8998:                &Apache::lonhtmlcommon::row_closure(1). 
                   8999:                &Apache::lonhtmlcommon::end_pick_box().
                   9000:                '<br />';
1.555     raeburn  9001:     return $output;
                   9002: }
                   9003: 
1.612     raeburn  9004: sub user_rule_check {
1.615     raeburn  9005:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  9006:     my $response;
                   9007:     if (ref($usershash) eq 'HASH') {
                   9008:         foreach my $user (keys(%{$usershash})) {
                   9009:             my ($uname,$udom) = split(/:/,$user);
                   9010:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  9011:             my ($id,$newuser);
1.612     raeburn  9012:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  9013:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  9014:                 $id = $usershash->{$user}->{'id'};
                   9015:             }
                   9016:             my $inst_response;
                   9017:             if (ref($checks) eq 'HASH') {
                   9018:                 if (defined($checks->{'username'})) {
1.615     raeburn  9019:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  9020:                         &Apache::lonnet::get_instuser($udom,$uname);
                   9021:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  9022:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  9023:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   9024:                 }
1.615     raeburn  9025:             } else {
                   9026:                 ($inst_response,%{$inst_results->{$user}}) =
                   9027:                     &Apache::lonnet::get_instuser($udom,$uname);
                   9028:                 return;
1.612     raeburn  9029:             }
1.615     raeburn  9030:             if (!$got_rules->{$udom}) {
1.612     raeburn  9031:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   9032:                                                   ['usercreation'],$udom);
                   9033:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  9034:                     foreach my $item ('username','id') {
1.612     raeburn  9035:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   9036:                             $$curr_rules{$udom}{$item} = 
                   9037:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  9038:                         }
                   9039:                     }
                   9040:                 }
1.615     raeburn  9041:                 $got_rules->{$udom} = 1;  
1.585     raeburn  9042:             }
1.612     raeburn  9043:             foreach my $item (keys(%{$checks})) {
                   9044:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   9045:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   9046:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   9047:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   9048:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   9049:                                 if ($rule_check{$rule}) {
                   9050:                                     $$rulematch{$user}{$item} = $rule;
                   9051:                                     if ($inst_response eq 'ok') {
1.615     raeburn  9052:                                         if (ref($inst_results) eq 'HASH') {
                   9053:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   9054:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   9055:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   9056:                                                 }
1.612     raeburn  9057:                                             }
                   9058:                                         }
1.615     raeburn  9059:                                     }
                   9060:                                     last;
1.585     raeburn  9061:                                 }
                   9062:                             }
                   9063:                         }
                   9064:                     }
                   9065:                 }
                   9066:             }
                   9067:         }
                   9068:     }
1.612     raeburn  9069:     return;
                   9070: }
                   9071: 
                   9072: sub user_rule_formats {
                   9073:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   9074:     my %text = ( 
                   9075:                  'username' => 'Usernames',
                   9076:                  'id'       => 'IDs',
                   9077:                );
                   9078:     my $output;
                   9079:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   9080:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   9081:         if (@{$ruleorder} > 0) {
1.1102    raeburn  9082:             $output = '<br />'.
                   9083:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   9084:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   9085:                       ' <ul>';
1.612     raeburn  9086:             foreach my $rule (@{$ruleorder}) {
                   9087:                 if (ref($curr_rules) eq 'ARRAY') {
                   9088:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   9089:                         if (ref($rules->{$rule}) eq 'HASH') {
                   9090:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   9091:                                         $rules->{$rule}{'desc'}.'</li>';
                   9092:                         }
                   9093:                     }
                   9094:                 }
                   9095:             }
                   9096:             $output .= '</ul>';
                   9097:         }
                   9098:     }
                   9099:     return $output;
                   9100: }
                   9101: 
                   9102: sub instrule_disallow_msg {
1.615     raeburn  9103:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  9104:     my $response;
                   9105:     my %text = (
                   9106:                   item   => 'username',
                   9107:                   items  => 'usernames',
                   9108:                   match  => 'matches',
                   9109:                   do     => 'does',
                   9110:                   action => 'a username',
                   9111:                   one    => 'one',
                   9112:                );
                   9113:     if ($count > 1) {
                   9114:         $text{'item'} = 'usernames';
                   9115:         $text{'match'} ='match';
                   9116:         $text{'do'} = 'do';
                   9117:         $text{'action'} = 'usernames',
                   9118:         $text{'one'} = 'ones';
                   9119:     }
                   9120:     if ($checkitem eq 'id') {
                   9121:         $text{'items'} = 'IDs';
                   9122:         $text{'item'} = 'ID';
                   9123:         $text{'action'} = 'an ID';
1.615     raeburn  9124:         if ($count > 1) {
                   9125:             $text{'item'} = 'IDs';
                   9126:             $text{'action'} = 'IDs';
                   9127:         }
1.612     raeburn  9128:     }
1.674     bisitz   9129:     $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  9130:     if ($mode eq 'upload') {
                   9131:         if ($checkitem eq 'username') {
                   9132:             $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'}.");
                   9133:         } elsif ($checkitem eq 'id') {
1.674     bisitz   9134:             $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  9135:         }
1.669     raeburn  9136:     } elsif ($mode eq 'selfcreate') {
                   9137:         if ($checkitem eq 'id') {
                   9138:             $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.");
                   9139:         }
1.615     raeburn  9140:     } else {
                   9141:         if ($checkitem eq 'username') {
                   9142:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   9143:         } elsif ($checkitem eq 'id') {
                   9144:             $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.");
                   9145:         }
1.612     raeburn  9146:     }
                   9147:     return $response;
1.585     raeburn  9148: }
                   9149: 
1.624     raeburn  9150: sub personal_data_fieldtitles {
                   9151:     my %fieldtitles = &Apache::lonlocal::texthash (
                   9152:                         id => 'Student/Employee ID',
                   9153:                         permanentemail => 'E-mail address',
                   9154:                         lastname => 'Last Name',
                   9155:                         firstname => 'First Name',
                   9156:                         middlename => 'Middle Name',
                   9157:                         generation => 'Generation',
                   9158:                         gen => 'Generation',
1.765     raeburn  9159:                         inststatus => 'Affiliation',
1.624     raeburn  9160:                    );
                   9161:     return %fieldtitles;
                   9162: }
                   9163: 
1.642     raeburn  9164: sub sorted_inst_types {
                   9165:     my ($dom) = @_;
                   9166:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   9167:     my $othertitle = &mt('All users');
                   9168:     if ($env{'request.course.id'}) {
1.668     raeburn  9169:         $othertitle  = &mt('Any users');
1.642     raeburn  9170:     }
                   9171:     my @types;
                   9172:     if (ref($order) eq 'ARRAY') {
                   9173:         @types = @{$order};
                   9174:     }
                   9175:     if (@types == 0) {
                   9176:         if (ref($usertypes) eq 'HASH') {
                   9177:             @types = sort(keys(%{$usertypes}));
                   9178:         }
                   9179:     }
                   9180:     if (keys(%{$usertypes}) > 0) {
                   9181:         $othertitle = &mt('Other users');
                   9182:     }
                   9183:     return ($othertitle,$usertypes,\@types);
                   9184: }
                   9185: 
1.645     raeburn  9186: sub get_institutional_codes {
                   9187:     my ($settings,$allcourses,$LC_code) = @_;
                   9188: # Get complete list of course sections to update
                   9189:     my @currsections = ();
                   9190:     my @currxlists = ();
                   9191:     my $coursecode = $$settings{'internal.coursecode'};
                   9192: 
                   9193:     if ($$settings{'internal.sectionnums'} ne '') {
                   9194:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   9195:     }
                   9196: 
                   9197:     if ($$settings{'internal.crosslistings'} ne '') {
                   9198:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   9199:     }
                   9200: 
                   9201:     if (@currxlists > 0) {
                   9202:         foreach (@currxlists) {
                   9203:             if (m/^([^:]+):(\w*)$/) {
                   9204:                 unless (grep/^$1$/,@{$allcourses}) {
                   9205:                     push @{$allcourses},$1;
                   9206:                     $$LC_code{$1} = $2;
                   9207:                 }
                   9208:             }
                   9209:         }
                   9210:     }
                   9211:  
                   9212:     if (@currsections > 0) {
                   9213:         foreach (@currsections) {
                   9214:             if (m/^(\w+):(\w*)$/) {
                   9215:                 my $sec = $coursecode.$1;
                   9216:                 my $lc_sec = $2;
                   9217:                 unless (grep/^$sec$/,@{$allcourses}) {
                   9218:                     push @{$allcourses},$sec;
                   9219:                     $$LC_code{$sec} = $lc_sec;
                   9220:                 }
                   9221:             }
                   9222:         }
                   9223:     }
                   9224:     return;
                   9225: }
                   9226: 
1.971     raeburn  9227: sub get_standard_codeitems {
                   9228:     return ('Year','Semester','Department','Number','Section');
                   9229: }
                   9230: 
1.112     bowersj2 9231: =pod
                   9232: 
1.780     raeburn  9233: =head1 Slot Helpers
                   9234: 
                   9235: =over 4
                   9236: 
                   9237: =item * sorted_slots()
                   9238: 
1.1040    raeburn  9239: Sorts an array of slot names in order of an optional sort key,
                   9240: default sort is by slot start time (earliest first). 
1.780     raeburn  9241: 
                   9242: Inputs:
                   9243: 
                   9244: =over 4
                   9245: 
                   9246: slotsarr  - Reference to array of unsorted slot names.
                   9247: 
                   9248: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   9249: 
1.1040    raeburn  9250: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   9251: 
1.549     albertel 9252: =back
                   9253: 
1.780     raeburn  9254: Returns:
                   9255: 
                   9256: =over 4
                   9257: 
1.1040    raeburn  9258: sorted   - An array of slot names sorted by a specified sort key 
                   9259:            (default sort key is start time of the slot).
1.780     raeburn  9260: 
                   9261: =back
                   9262: 
                   9263: =cut
                   9264: 
                   9265: 
                   9266: sub sorted_slots {
1.1040    raeburn  9267:     my ($slotsarr,$slots,$sortkey) = @_;
                   9268:     if ($sortkey eq '') {
                   9269:         $sortkey = 'starttime';
                   9270:     }
1.780     raeburn  9271:     my @sorted;
                   9272:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   9273:         @sorted =
                   9274:             sort {
                   9275:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  9276:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  9277:                      }
                   9278:                      if (ref($slots->{$a})) { return -1;}
                   9279:                      if (ref($slots->{$b})) { return 1;}
                   9280:                      return 0;
                   9281:                  } @{$slotsarr};
                   9282:     }
                   9283:     return @sorted;
                   9284: }
                   9285: 
1.1040    raeburn  9286: =pod
                   9287: 
                   9288: =item * get_future_slots()
                   9289: 
                   9290: Inputs:
                   9291: 
                   9292: =over 4
                   9293: 
                   9294: cnum - course number
                   9295: 
                   9296: cdom - course domain
                   9297: 
                   9298: now - current UNIX time
                   9299: 
                   9300: symb - optional symb
                   9301: 
                   9302: =back
                   9303: 
                   9304: Returns:
                   9305: 
                   9306: =over 4
                   9307: 
                   9308: sorted_reservable - ref to array of student_schedulable slots currently 
                   9309:                     reservable, ordered by end date of reservation period.
                   9310: 
                   9311: reservable_now - ref to hash of student_schedulable slots currently
                   9312:                  reservable.
                   9313: 
                   9314:     Keys in inner hash are:
                   9315:     (a) symb: either blank or symb to which slot use is restricted.
                   9316:     (b) endreserve: end date of reservation period. 
                   9317: 
                   9318: sorted_future - ref to array of student_schedulable slots reservable in
                   9319:                 the future, ordered by start date of reservation period.
                   9320: 
                   9321: future_reservable - ref to hash of student_schedulable slots reservable
                   9322:                     in the future.
                   9323: 
                   9324:     Keys in inner hash are:
                   9325:     (a) symb: either blank or symb to which slot use is restricted.
                   9326:     (b) startreserve:  start date of reservation period.
                   9327: 
                   9328: =back
                   9329: 
                   9330: =cut
                   9331: 
                   9332: sub get_future_slots {
                   9333:     my ($cnum,$cdom,$now,$symb) = @_;
                   9334:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   9335:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   9336:     foreach my $slot (keys(%slots)) {
                   9337:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   9338:         if ($symb) {
                   9339:             next if (($slots{$slot}->{'symb'} ne '') && 
                   9340:                      ($slots{$slot}->{'symb'} ne $symb));
                   9341:         }
                   9342:         if (($slots{$slot}->{'starttime'} > $now) &&
                   9343:             ($slots{$slot}->{'endtime'} > $now)) {
                   9344:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   9345:                 my $userallowed = 0;
                   9346:                 if ($slots{$slot}->{'allowedsections'}) {
                   9347:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   9348:                     if (!defined($env{'request.role.sec'})
                   9349:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   9350:                         $userallowed=1;
                   9351:                     } else {
                   9352:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   9353:                             $userallowed=1;
                   9354:                         }
                   9355:                     }
                   9356:                     unless ($userallowed) {
                   9357:                         if (defined($env{'request.course.groups'})) {
                   9358:                             my @groups = split(/:/,$env{'request.course.groups'});
                   9359:                             foreach my $group (@groups) {
                   9360:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   9361:                                     $userallowed=1;
                   9362:                                     last;
                   9363:                                 }
                   9364:                             }
                   9365:                         }
                   9366:                     }
                   9367:                 }
                   9368:                 if ($slots{$slot}->{'allowedusers'}) {
                   9369:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   9370:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   9371:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   9372:                         $userallowed = 1;
                   9373:                     }
                   9374:                 }
                   9375:                 next unless($userallowed);
                   9376:             }
                   9377:             my $startreserve = $slots{$slot}->{'startreserve'};
                   9378:             my $endreserve = $slots{$slot}->{'endreserve'};
                   9379:             my $symb = $slots{$slot}->{'symb'};
                   9380:             if (($startreserve < $now) &&
                   9381:                 (!$endreserve || $endreserve > $now)) {
                   9382:                 my $lastres = $endreserve;
                   9383:                 if (!$lastres) {
                   9384:                     $lastres = $slots{$slot}->{'starttime'};
                   9385:                 }
                   9386:                 $reservable_now{$slot} = {
                   9387:                                            symb       => $symb,
                   9388:                                            endreserve => $lastres
                   9389:                                          };
                   9390:             } elsif (($startreserve > $now) &&
                   9391:                      (!$endreserve || $endreserve > $startreserve)) {
                   9392:                 $future_reservable{$slot} = {
                   9393:                                               symb         => $symb,
                   9394:                                               startreserve => $startreserve
                   9395:                                             };
                   9396:             }
                   9397:         }
                   9398:     }
                   9399:     my @unsorted_reservable = keys(%reservable_now);
                   9400:     if (@unsorted_reservable > 0) {
                   9401:         @sorted_reservable = 
                   9402:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   9403:     }
                   9404:     my @unsorted_future = keys(%future_reservable);
                   9405:     if (@unsorted_future > 0) {
                   9406:         @sorted_future =
                   9407:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   9408:     }
                   9409:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   9410: }
1.780     raeburn  9411: 
                   9412: =pod
                   9413: 
1.1057    foxr     9414: =back
                   9415: 
1.549     albertel 9416: =head1 HTTP Helpers
                   9417: 
                   9418: =over 4
                   9419: 
1.648     raeburn  9420: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 9421: 
1.258     albertel 9422: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 9423: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 9424: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 9425: 
                   9426: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   9427: $possible_names is an ref to an array of form element names.  As an example:
                   9428: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 9429: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 9430: 
                   9431: =cut
1.1       albertel 9432: 
1.6       albertel 9433: sub get_unprocessed_cgi {
1.25      albertel 9434:   my ($query,$possible_names)= @_;
1.26      matthew  9435:   # $Apache::lonxml::debug=1;
1.356     albertel 9436:   foreach my $pair (split(/&/,$query)) {
                   9437:     my ($name, $value) = split(/=/,$pair);
1.369     www      9438:     $name = &unescape($name);
1.25      albertel 9439:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   9440:       $value =~ tr/+/ /;
                   9441:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 9442:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 9443:     }
1.16      harris41 9444:   }
1.6       albertel 9445: }
                   9446: 
1.112     bowersj2 9447: =pod
                   9448: 
1.648     raeburn  9449: =item * &cacheheader() 
1.112     bowersj2 9450: 
                   9451: returns cache-controlling header code
                   9452: 
                   9453: =cut
                   9454: 
1.7       albertel 9455: sub cacheheader {
1.258     albertel 9456:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 9457:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   9458:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 9459:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   9460:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 9461:     return $output;
1.7       albertel 9462: }
                   9463: 
1.112     bowersj2 9464: =pod
                   9465: 
1.648     raeburn  9466: =item * &no_cache($r) 
1.112     bowersj2 9467: 
                   9468: specifies header code to not have cache
                   9469: 
                   9470: =cut
                   9471: 
1.9       albertel 9472: sub no_cache {
1.216     albertel 9473:     my ($r) = @_;
                   9474:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 9475: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 9476:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   9477:     $r->no_cache(1);
                   9478:     $r->header_out("Expires" => $date);
                   9479:     $r->header_out("Pragma" => "no-cache");
1.123     www      9480: }
                   9481: 
                   9482: sub content_type {
1.181     albertel 9483:     my ($r,$type,$charset) = @_;
1.299     foxr     9484:     if ($r) {
                   9485: 	#  Note that printout.pl calls this with undef for $r.
                   9486: 	&no_cache($r);
                   9487:     }
1.258     albertel 9488:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 9489:     unless ($charset) {
                   9490: 	$charset=&Apache::lonlocal::current_encoding;
                   9491:     }
                   9492:     if ($charset) { $type.='; charset='.$charset; }
                   9493:     if ($r) {
                   9494: 	$r->content_type($type);
                   9495:     } else {
                   9496: 	print("Content-type: $type\n\n");
                   9497:     }
1.9       albertel 9498: }
1.25      albertel 9499: 
1.112     bowersj2 9500: =pod
                   9501: 
1.648     raeburn  9502: =item * &add_to_env($name,$value) 
1.112     bowersj2 9503: 
1.258     albertel 9504: adds $name to the %env hash with value
1.112     bowersj2 9505: $value, if $name already exists, the entry is converted to an array
                   9506: reference and $value is added to the array.
                   9507: 
                   9508: =cut
                   9509: 
1.25      albertel 9510: sub add_to_env {
                   9511:   my ($name,$value)=@_;
1.258     albertel 9512:   if (defined($env{$name})) {
                   9513:     if (ref($env{$name})) {
1.25      albertel 9514:       #already have multiple values
1.258     albertel 9515:       push(@{ $env{$name} },$value);
1.25      albertel 9516:     } else {
                   9517:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 9518:       my $first=$env{$name};
                   9519:       undef($env{$name});
                   9520:       push(@{ $env{$name} },$first,$value);
1.25      albertel 9521:     }
                   9522:   } else {
1.258     albertel 9523:     $env{$name}=$value;
1.25      albertel 9524:   }
1.31      albertel 9525: }
1.149     albertel 9526: 
                   9527: =pod
                   9528: 
1.648     raeburn  9529: =item * &get_env_multiple($name) 
1.149     albertel 9530: 
1.258     albertel 9531: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 9532: values may be defined and end up as an array ref.
                   9533: 
                   9534: returns an array of values
                   9535: 
                   9536: =cut
                   9537: 
                   9538: sub get_env_multiple {
                   9539:     my ($name) = @_;
                   9540:     my @values;
1.258     albertel 9541:     if (defined($env{$name})) {
1.149     albertel 9542:         # exists is it an array
1.258     albertel 9543:         if (ref($env{$name})) {
                   9544:             @values=@{ $env{$name} };
1.149     albertel 9545:         } else {
1.258     albertel 9546:             $values[0]=$env{$name};
1.149     albertel 9547:         }
                   9548:     }
                   9549:     return(@values);
                   9550: }
                   9551: 
1.660     raeburn  9552: sub ask_for_embedded_content {
                   9553:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  9554:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  9555:         %currsubfile,%unused,$rem);
1.1071    raeburn  9556:     my $counter = 0;
                   9557:     my $numnew = 0;
1.987     raeburn  9558:     my $numremref = 0;
                   9559:     my $numinvalid = 0;
                   9560:     my $numpathchg = 0;
                   9561:     my $numexisting = 0;
1.1071    raeburn  9562:     my $numunused = 0;
                   9563:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
                   9564:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path);
                   9565:     my $heading = &mt('Upload embedded files');
                   9566:     my $buttontext = &mt('Upload');
                   9567: 
1.1123    raeburn  9568:     my ($navmap,$cdom,$cnum);
1.1085    raeburn  9569:     if ($env{'request.course.id'}) {
1.1123    raeburn  9570:         if ($actionurl eq '/adm/dependencies') {
                   9571:             $navmap = Apache::lonnavmaps::navmap->new();
                   9572:         }
                   9573:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9574:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  9575:     }
1.1123    raeburn  9576:     if (($actionurl eq '/adm/portfolio') || 
                   9577:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  9578:         my $current_path='/';
                   9579:         if ($env{'form.currentpath'}) {
                   9580:             $current_path = $env{'form.currentpath'};
                   9581:         }
                   9582:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  9583:             $udom = $cdom;
                   9584:             $uname = $cnum;
1.984     raeburn  9585:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   9586:         } else {
                   9587:             $udom = $env{'user.domain'};
                   9588:             $uname = $env{'user.name'};
                   9589:             $url = '/userfiles/portfolio';
                   9590:         }
1.987     raeburn  9591:         $toplevel = $url.'/';
1.984     raeburn  9592:         $url .= $current_path;
                   9593:         $getpropath = 1;
1.987     raeburn  9594:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   9595:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      9596:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  9597:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  9598:         $toplevel = $url;
1.984     raeburn  9599:         if ($rest ne '') {
1.987     raeburn  9600:             $url .= $rest;
                   9601:         }
                   9602:     } elsif ($actionurl eq '/adm/coursedocs') {
                   9603:         if (ref($args) eq 'HASH') {
1.1071    raeburn  9604:             $url = $args->{'docs_url'};
                   9605:             $toplevel = $url;
1.1084    raeburn  9606:             if ($args->{'context'} eq 'paste') {
                   9607:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   9608:                 ($path) = 
                   9609:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   9610:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   9611:                 $fileloc =~ s{^/}{};
                   9612:             }
1.1071    raeburn  9613:         }
1.1084    raeburn  9614:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  9615:         if ($env{'request.course.id'} ne '') {
                   9616:             if (ref($args) eq 'HASH') {
                   9617:                 $url = $args->{'docs_url'};
                   9618:                 $title = $args->{'docs_title'};
1.1126  ! raeburn  9619:                 $toplevel = $url; 
        !          9620:                 unless ($toplevel =~ m{^/}) {
        !          9621:                     $toplevel = "/$url";
        !          9622:                 }
1.1085    raeburn  9623:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126  ! raeburn  9624:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
        !          9625:                     $path = $1;
        !          9626:                 } else {
        !          9627:                     ($path) =
        !          9628:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
        !          9629:                 }
1.1071    raeburn  9630:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   9631:                 $fileloc =~ s{^/}{};
                   9632:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   9633:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   9634:             }
1.987     raeburn  9635:         }
1.1123    raeburn  9636:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   9637:         $udom = $cdom;
                   9638:         $uname = $cnum;
                   9639:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   9640:         $toplevel = $url;
                   9641:         $path = $url;
                   9642:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   9643:         $fileloc =~ s{^/}{};
1.987     raeburn  9644:     }
1.1126  ! raeburn  9645:     foreach my $file (keys(%{$allfiles})) {
        !          9646:         my $embed_file;
        !          9647:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
        !          9648:             $embed_file = $1;
        !          9649:         } else {
        !          9650:             $embed_file = $file;
        !          9651:         }
1.987     raeburn  9652:         my $absolutepath;
                   9653:         if ($embed_file =~ m{^\w+://}) {
                   9654:             $newfiles{$embed_file} = 1;
                   9655:             $mapping{$embed_file} = $embed_file;
                   9656:         } else {
                   9657:             if ($embed_file =~ m{^/}) {
                   9658:                 $absolutepath = $embed_file;
                   9659:                 $embed_file =~ s{^(/+)}{};
                   9660:             }
                   9661:             if ($embed_file =~ m{/}) {
                   9662:                 my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$});
                   9663:                 $path = &check_for_traversal($path,$url,$toplevel);
                   9664:                 my $item = $fname;
                   9665:                 if ($path ne '') {
                   9666:                     $item = $path.'/'.$fname;
                   9667:                     $subdependencies{$path}{$fname} = 1;
                   9668:                 } else {
                   9669:                     $dependencies{$item} = 1;
                   9670:                 }
                   9671:                 if ($absolutepath) {
                   9672:                     $mapping{$item} = $absolutepath;
                   9673:                 } else {
                   9674:                     $mapping{$item} = $embed_file;
                   9675:                 }
                   9676:             } else {
                   9677:                 $dependencies{$embed_file} = 1;
                   9678:                 if ($absolutepath) {
                   9679:                     $mapping{$embed_file} = $absolutepath;
                   9680:                 } else {
                   9681:                     $mapping{$embed_file} = $embed_file;
                   9682:                 }
                   9683:             }
1.984     raeburn  9684:         }
                   9685:     }
1.1071    raeburn  9686:     my $dirptr = 16384;
1.984     raeburn  9687:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  9688:         $currsubfile{$path} = {};
1.1123    raeburn  9689:         if (($actionurl eq '/adm/portfolio') || 
                   9690:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9691:             my ($sublistref,$listerror) =
                   9692:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   9693:             if (ref($sublistref) eq 'ARRAY') {
                   9694:                 foreach my $line (@{$sublistref}) {
                   9695:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  9696:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  9697:                 }
1.984     raeburn  9698:             }
1.987     raeburn  9699:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9700:             if (opendir(my $dir,$url.'/'.$path)) {
                   9701:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  9702:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   9703:             }
1.1084    raeburn  9704:         } elsif (($actionurl eq '/adm/dependencies') ||
                   9705:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  9706:                   ($args->{'context'} eq 'paste')) ||
                   9707:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  9708:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  9709:                 my $dir;
                   9710:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   9711:                     $dir = $fileloc;
                   9712:                 } else {
                   9713:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9714:                 }
1.1071    raeburn  9715:                 if ($dir ne '') {
                   9716:                     my ($sublistref,$listerror) =
                   9717:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   9718:                     if (ref($sublistref) eq 'ARRAY') {
                   9719:                         foreach my $line (@{$sublistref}) {
                   9720:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   9721:                                 undef,$mtime)=split(/\&/,$line,12);
                   9722:                             unless (($testdir&$dirptr) ||
                   9723:                                     ($file_name =~ /^\.\.?$/)) {
                   9724:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   9725:                             }
                   9726:                         }
                   9727:                     }
                   9728:                 }
1.984     raeburn  9729:             }
                   9730:         }
                   9731:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  9732:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  9733:                 my $item = $path.'/'.$file;
                   9734:                 unless ($mapping{$item} eq $item) {
                   9735:                     $pathchanges{$item} = 1;
                   9736:                 }
                   9737:                 $existing{$item} = 1;
                   9738:                 $numexisting ++;
                   9739:             } else {
                   9740:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  9741:             }
                   9742:         }
1.1071    raeburn  9743:         if ($actionurl eq '/adm/dependencies') {
                   9744:             foreach my $path (keys(%currsubfile)) {
                   9745:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   9746:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   9747:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  9748:                              next if (($rem ne '') &&
                   9749:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   9750:                                        (ref($navmap) &&
                   9751:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   9752:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   9753:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  9754:                              $unused{$path.'/'.$file} = 1; 
                   9755:                          }
                   9756:                     }
                   9757:                 }
                   9758:             }
                   9759:         }
1.984     raeburn  9760:     }
1.987     raeburn  9761:     my %currfile;
1.1123    raeburn  9762:     if (($actionurl eq '/adm/portfolio') ||
                   9763:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  9764:         my ($dirlistref,$listerror) =
                   9765:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   9766:         if (ref($dirlistref) eq 'ARRAY') {
                   9767:             foreach my $line (@{$dirlistref}) {
                   9768:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   9769:                 $currfile{$file_name} = 1;
                   9770:             }
1.984     raeburn  9771:         }
1.987     raeburn  9772:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  9773:         if (opendir(my $dir,$url)) {
1.987     raeburn  9774:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  9775:             map {$currfile{$_} = 1;} @dir_list;
                   9776:         }
1.1084    raeburn  9777:     } elsif (($actionurl eq '/adm/dependencies') ||
                   9778:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  9779:               ($args->{'context'} eq 'paste')) ||
                   9780:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  9781:         if ($env{'request.course.id'} ne '') {
                   9782:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   9783:             if ($dir ne '') {
                   9784:                 my ($dirlistref,$listerror) =
                   9785:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   9786:                 if (ref($dirlistref) eq 'ARRAY') {
                   9787:                     foreach my $line (@{$dirlistref}) {
                   9788:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   9789:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   9790:                         unless (($testdir&$dirptr) ||
                   9791:                                 ($file_name =~ /^\.\.?$/)) {
                   9792:                             $currfile{$file_name} = [$size,$mtime];
                   9793:                         }
                   9794:                     }
                   9795:                 }
                   9796:             }
                   9797:         }
1.984     raeburn  9798:     }
                   9799:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  9800:         if (exists($currfile{$file})) {
1.987     raeburn  9801:             unless ($mapping{$file} eq $file) {
                   9802:                 $pathchanges{$file} = 1;
                   9803:             }
                   9804:             $existing{$file} = 1;
                   9805:             $numexisting ++;
                   9806:         } else {
1.984     raeburn  9807:             $newfiles{$file} = 1;
                   9808:         }
                   9809:     }
1.1071    raeburn  9810:     foreach my $file (keys(%currfile)) {
                   9811:         unless (($file eq $filename) ||
                   9812:                 ($file eq $filename.'.bak') ||
                   9813:                 ($dependencies{$file})) {
1.1085    raeburn  9814:             if ($actionurl eq '/adm/dependencies') {
1.1126  ! raeburn  9815:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
        !          9816:                     next if (($rem ne '') &&
        !          9817:                              (($env{"httpref.$rem".$file} ne '') ||
        !          9818:                               (ref($navmap) &&
        !          9819:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
        !          9820:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
        !          9821:                                 ($navmap->getResourceByUrl($rem.$1)))))));
        !          9822:                 }
1.1085    raeburn  9823:             }
1.1071    raeburn  9824:             $unused{$file} = 1;
                   9825:         }
                   9826:     }
1.1084    raeburn  9827:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   9828:         ($args->{'context'} eq 'paste')) {
                   9829:         $counter = scalar(keys(%existing));
                   9830:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  9831:         return ($output,$counter,$numpathchg,\%existing);
                   9832:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   9833:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   9834:         $counter = scalar(keys(%existing));
                   9835:         $numpathchg = scalar(keys(%pathchanges));
                   9836:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  9837:     }
1.984     raeburn  9838:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  9839:         if ($actionurl eq '/adm/dependencies') {
                   9840:             next if ($embed_file =~ m{^\w+://});
                   9841:         }
1.660     raeburn  9842:         $upload_output .= &start_data_table_row().
1.1123    raeburn  9843:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  9844:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  9845:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  9846:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   9847:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  9848:         }
1.1123    raeburn  9849:         $upload_output .= '</td>';
1.1071    raeburn  9850:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  9851:             $upload_output.='<td align="right">'.
                   9852:                             '<span class="LC_info LC_fontsize_medium">'.
                   9853:                             &mt("URL points to web address").'</span>';
1.987     raeburn  9854:             $numremref++;
1.660     raeburn  9855:         } elsif ($args->{'error_on_invalid_names'}
                   9856:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  9857:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   9858:                             &mt('Invalid characters').'</span>';
1.987     raeburn  9859:             $numinvalid++;
1.660     raeburn  9860:         } else {
1.1123    raeburn  9861:             $upload_output .= '<td>'.
                   9862:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  9863:                                                      $embed_file,\%mapping,
1.1071    raeburn  9864:                                                      $allfiles,$codebase,'upload');
                   9865:             $counter ++;
                   9866:             $numnew ++;
1.987     raeburn  9867:         }
                   9868:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   9869:     }
                   9870:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  9871:         if ($actionurl eq '/adm/dependencies') {
                   9872:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   9873:             $modify_output .= &start_data_table_row().
                   9874:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   9875:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   9876:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   9877:                               '<td>'.$size.'</td>'.
                   9878:                               '<td>'.$mtime.'</td>'.
                   9879:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   9880:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   9881:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   9882:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   9883:                               &embedded_file_element('upload_embedded',$counter,
                   9884:                                                      $embed_file,\%mapping,
                   9885:                                                      $allfiles,$codebase,'modify').
                   9886:                               '</div></td>'.
                   9887:                               &end_data_table_row()."\n";
                   9888:             $counter ++;
                   9889:         } else {
                   9890:             $upload_output .= &start_data_table_row().
1.1123    raeburn  9891:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   9892:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   9893:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  9894:                               &Apache::loncommon::end_data_table_row()."\n";
                   9895:         }
                   9896:     }
                   9897:     my $delidx = $counter;
                   9898:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   9899:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   9900:         $delete_output .= &start_data_table_row().
                   9901:                           '<td><img src="'.&icon($oldfile).'" />'.
                   9902:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   9903:                           '<td>'.$size.'</td>'.
                   9904:                           '<td>'.$mtime.'</td>'.
                   9905:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   9906:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   9907:                           &embedded_file_element('upload_embedded',$delidx,
                   9908:                                                  $oldfile,\%mapping,$allfiles,
                   9909:                                                  $codebase,'delete').'</td>'.
                   9910:                           &end_data_table_row()."\n"; 
                   9911:         $numunused ++;
                   9912:         $delidx ++;
1.987     raeburn  9913:     }
                   9914:     if ($upload_output) {
                   9915:         $upload_output = &start_data_table().
                   9916:                          $upload_output.
                   9917:                          &end_data_table()."\n";
                   9918:     }
1.1071    raeburn  9919:     if ($modify_output) {
                   9920:         $modify_output = &start_data_table().
                   9921:                          &start_data_table_header_row().
                   9922:                          '<th>'.&mt('File').'</th>'.
                   9923:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9924:                          '<th>'.&mt('Modified').'</th>'.
                   9925:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   9926:                          &end_data_table_header_row().
                   9927:                          $modify_output.
                   9928:                          &end_data_table()."\n";
                   9929:     }
                   9930:     if ($delete_output) {
                   9931:         $delete_output = &start_data_table().
                   9932:                          &start_data_table_header_row().
                   9933:                          '<th>'.&mt('File').'</th>'.
                   9934:                          '<th>'.&mt('Size (KB)').'</th>'.
                   9935:                          '<th>'.&mt('Modified').'</th>'.
                   9936:                          '<th>'.&mt('Delete?').'</th>'.
                   9937:                          &end_data_table_header_row().
                   9938:                          $delete_output.
                   9939:                          &end_data_table()."\n";
                   9940:     }
1.987     raeburn  9941:     my $applies = 0;
                   9942:     if ($numremref) {
                   9943:         $applies ++;
                   9944:     }
                   9945:     if ($numinvalid) {
                   9946:         $applies ++;
                   9947:     }
                   9948:     if ($numexisting) {
                   9949:         $applies ++;
                   9950:     }
1.1071    raeburn  9951:     if ($counter || $numunused) {
1.987     raeburn  9952:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   9953:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  9954:                   $state.'<h3>'.$heading.'</h3>'; 
                   9955:         if ($actionurl eq '/adm/dependencies') {
                   9956:             if ($numnew) {
                   9957:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   9958:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   9959:                            $upload_output.'<br />'."\n";
                   9960:             }
                   9961:             if ($numexisting) {
                   9962:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   9963:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   9964:                            $modify_output.'<br />'."\n";
                   9965:                            $buttontext = &mt('Save changes');
                   9966:             }
                   9967:             if ($numunused) {
                   9968:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   9969:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   9970:                            $delete_output.'<br />'."\n";
                   9971:                            $buttontext = &mt('Save changes');
                   9972:             }
                   9973:         } else {
                   9974:             $output .= $upload_output.'<br />'."\n";
                   9975:         }
                   9976:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   9977:                    $counter.'" />'."\n";
                   9978:         if ($actionurl eq '/adm/dependencies') { 
                   9979:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   9980:                        $numnew.'" />'."\n";
                   9981:         } elsif ($actionurl eq '') {
1.987     raeburn  9982:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   9983:         }
                   9984:     } elsif ($applies) {
                   9985:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   9986:         if ($applies > 1) {
                   9987:             $output .=  
1.1123    raeburn  9988:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  9989:             if ($numremref) {
                   9990:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   9991:             }
                   9992:             if ($numinvalid) {
                   9993:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   9994:             }
                   9995:             if ($numexisting) {
                   9996:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   9997:             }
                   9998:             $output .= '</ul><br />';
                   9999:         } elsif ($numremref) {
                   10000:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   10001:         } elsif ($numinvalid) {
                   10002:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   10003:         } elsif ($numexisting) {
                   10004:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   10005:         }
                   10006:         $output .= $upload_output.'<br />';
                   10007:     }
                   10008:     my ($pathchange_output,$chgcount);
1.1071    raeburn  10009:     $chgcount = $counter;
1.987     raeburn  10010:     if (keys(%pathchanges) > 0) {
                   10011:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  10012:             if ($counter) {
1.987     raeburn  10013:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   10014:                                                   $embed_file,\%mapping,
1.1071    raeburn  10015:                                                   $allfiles,$codebase,'change');
1.987     raeburn  10016:             } else {
                   10017:                 $pathchange_output .= 
                   10018:                     &start_data_table_row().
                   10019:                     '<td><input type ="checkbox" name="namechange" value="'.
                   10020:                     $chgcount.'" checked="checked" /></td>'.
                   10021:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   10022:                     '<td>'.$embed_file.
                   10023:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  10024:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  10025:                     '</td>'.&end_data_table_row();
1.660     raeburn  10026:             }
1.987     raeburn  10027:             $numpathchg ++;
                   10028:             $chgcount ++;
1.660     raeburn  10029:         }
                   10030:     }
1.1071    raeburn  10031:     if ($counter) {
1.987     raeburn  10032:         if ($numpathchg) {
                   10033:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   10034:                        $numpathchg.'" />'."\n";
                   10035:         }
                   10036:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   10037:             ($actionurl eq '/adm/imsimport')) {
                   10038:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   10039:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   10040:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  10041:         } elsif ($actionurl eq '/adm/dependencies') {
                   10042:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  10043:         }
1.1123    raeburn  10044:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  10045:     } elsif ($numpathchg) {
                   10046:         my %pathchange = ();
                   10047:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   10048:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   10049:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  10050:         }
1.987     raeburn  10051:     }
1.1071    raeburn  10052:     return ($output,$counter,$numpathchg);
1.987     raeburn  10053: }
                   10054: 
                   10055: sub embedded_file_element {
1.1071    raeburn  10056:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  10057:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   10058:                    (ref($codebase) eq 'HASH'));
                   10059:     my $output;
1.1071    raeburn  10060:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  10061:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   10062:     }
                   10063:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   10064:                &escape($embed_file).'" />';
                   10065:     unless (($context eq 'upload_embedded') && 
                   10066:             ($mapping->{$embed_file} eq $embed_file)) {
                   10067:         $output .='
                   10068:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   10069:     }
                   10070:     my $attrib;
                   10071:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   10072:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   10073:     }
                   10074:     $output .=
                   10075:         "\n\t\t".
                   10076:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   10077:         $attrib.'" />';
                   10078:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   10079:         $output .=
                   10080:             "\n\t\t".
                   10081:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   10082:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  10083:     }
1.987     raeburn  10084:     return $output;
1.660     raeburn  10085: }
                   10086: 
1.1071    raeburn  10087: sub get_dependency_details {
                   10088:     my ($currfile,$currsubfile,$embed_file) = @_;
                   10089:     my ($size,$mtime,$showsize,$showmtime);
                   10090:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   10091:         if ($embed_file =~ m{/}) {
                   10092:             my ($path,$fname) = split(/\//,$embed_file);
                   10093:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   10094:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   10095:             }
                   10096:         } else {
                   10097:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   10098:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   10099:             }
                   10100:         }
                   10101:         $showsize = $size/1024.0;
                   10102:         $showsize = sprintf("%.1f",$showsize);
                   10103:         if ($mtime > 0) {
                   10104:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   10105:         }
                   10106:     }
                   10107:     return ($showsize,$showmtime);
                   10108: }
                   10109: 
                   10110: sub ask_embedded_js {
                   10111:     return <<"END";
                   10112: <script type="text/javascript"">
                   10113: // <![CDATA[
                   10114: function toggleBrowse(counter) {
                   10115:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   10116:     var fileid = document.getElementById('embedded_item_'+counter);
                   10117:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   10118:     if (chkboxid.checked == true) {
                   10119:         uploaddivid.style.display='block';
                   10120:     } else {
                   10121:         uploaddivid.style.display='none';
                   10122:         fileid.value = '';
                   10123:     }
                   10124: }
                   10125: // ]]>
                   10126: </script>
                   10127: 
                   10128: END
                   10129: }
                   10130: 
1.661     raeburn  10131: sub upload_embedded {
                   10132:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  10133:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   10134:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  10135:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   10136:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   10137:         my $orig_uploaded_filename =
                   10138:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  10139:         foreach my $type ('orig','ref','attrib','codebase') {
                   10140:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   10141:                 $env{'form.embedded_'.$type.'_'.$i} =
                   10142:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   10143:             }
                   10144:         }
1.661     raeburn  10145:         my ($path,$fname) =
                   10146:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   10147:         # no path, whole string is fname
                   10148:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   10149:         $fname = &Apache::lonnet::clean_filename($fname);
                   10150:         # See if there is anything left
                   10151:         next if ($fname eq '');
                   10152: 
                   10153:         # Check if file already exists as a file or directory.
                   10154:         my ($state,$msg);
                   10155:         if ($context eq 'portfolio') {
                   10156:             my $port_path = $dirpath;
                   10157:             if ($group ne '') {
                   10158:                 $port_path = "groups/$group/$port_path";
                   10159:             }
1.987     raeburn  10160:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   10161:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  10162:                                               $dir_root,$port_path,$disk_quota,
                   10163:                                               $current_disk_usage,$uname,$udom);
                   10164:             if ($state eq 'will_exceed_quota'
1.984     raeburn  10165:                 || $state eq 'file_locked') {
1.661     raeburn  10166:                 $output .= $msg;
                   10167:                 next;
                   10168:             }
                   10169:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   10170:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   10171:             if ($state eq 'exists') {
                   10172:                 $output .= $msg;
                   10173:                 next;
                   10174:             }
                   10175:         }
                   10176:         # Check if extension is valid
                   10177:         if (($fname =~ /\.(\w+)$/) &&
                   10178:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.987     raeburn  10179:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />';
1.661     raeburn  10180:             next;
                   10181:         } elsif (($fname =~ /\.(\w+)$/) &&
                   10182:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  10183:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  10184:             next;
                   10185:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   10186:             $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  10187:             next;
                   10188:         }
                   10189:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  10190:         my $subdir = $path;
                   10191:         $subdir =~ s{/+$}{};
1.661     raeburn  10192:         if ($context eq 'portfolio') {
1.984     raeburn  10193:             my $result;
                   10194:             if ($state eq 'existingfile') {
                   10195:                 $result=
                   10196:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  10197:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  10198:             } else {
1.984     raeburn  10199:                 $result=
                   10200:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  10201:                                                     $dirpath.
1.1123    raeburn  10202:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  10203:                 if ($result !~ m|^/uploaded/|) {
                   10204:                     $output .= '<span class="LC_error">'
                   10205:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   10206:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   10207:                                .'</span><br />';
                   10208:                     next;
                   10209:                 } else {
1.987     raeburn  10210:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   10211:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  10212:                 }
1.661     raeburn  10213:             }
1.1123    raeburn  10214:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126  ! raeburn  10215:             my $extendedsubdir = $dirpath.'/'.$subdir;
        !          10216:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  10217:             my $result =
1.1126  ! raeburn  10218:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  10219:             if ($result !~ m|^/uploaded/|) {
                   10220:                 $output .= '<span class="LC_error">'
                   10221:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   10222:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   10223:                            .'</span><br />';
                   10224:                     next;
                   10225:             } else {
                   10226:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   10227:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  10228:                 if ($context eq 'syllabus') {
                   10229:                     &Apache::lonnet::make_public_indefinitely($result);
                   10230:                 }
1.987     raeburn  10231:             }
1.661     raeburn  10232:         } else {
                   10233: # Save the file
                   10234:             my $target = $env{'form.embedded_item_'.$i};
                   10235:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   10236:             my $dest = $fullpath.$fname;
                   10237:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  10238:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  10239:             my $count;
                   10240:             my $filepath = $dir_root;
1.1027    raeburn  10241:             foreach my $subdir (@parts) {
                   10242:                 $filepath .= "/$subdir";
                   10243:                 if (!-e $filepath) {
1.661     raeburn  10244:                     mkdir($filepath,0770);
                   10245:                 }
                   10246:             }
                   10247:             my $fh;
                   10248:             if (!open($fh,'>'.$dest)) {
                   10249:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   10250:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  10251:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   10252:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  10253:                            '</span><br />';
                   10254:             } else {
                   10255:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   10256:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   10257:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  10258:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   10259:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  10260:                               '</span><br />';
                   10261:                 } else {
1.987     raeburn  10262:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   10263:                                $url.'</span>').'<br />';
                   10264:                     unless ($context eq 'testbank') {
                   10265:                         $footer .= &mt('View embedded file: [_1]',
                   10266:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   10267:                     }
                   10268:                 }
                   10269:                 close($fh);
                   10270:             }
                   10271:         }
                   10272:         if ($env{'form.embedded_ref_'.$i}) {
                   10273:             $pathchange{$i} = 1;
                   10274:         }
                   10275:     }
                   10276:     if ($output) {
                   10277:         $output = '<p>'.$output.'</p>';
                   10278:     }
                   10279:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   10280:     $returnflag = 'ok';
1.1071    raeburn  10281:     my $numpathchgs = scalar(keys(%pathchange));
                   10282:     if ($numpathchgs > 0) {
1.987     raeburn  10283:         if ($context eq 'portfolio') {
                   10284:             $output .= '<p>'.&mt('or').'</p>';
                   10285:         } elsif ($context eq 'testbank') {
1.1071    raeburn  10286:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   10287:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  10288:             $returnflag = 'modify_orightml';
                   10289:         }
                   10290:     }
1.1071    raeburn  10291:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  10292: }
                   10293: 
                   10294: sub modify_html_form {
                   10295:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   10296:     my $end = 0;
                   10297:     my $modifyform;
                   10298:     if ($context eq 'upload_embedded') {
                   10299:         return unless (ref($pathchange) eq 'HASH');
                   10300:         if ($env{'form.number_embedded_items'}) {
                   10301:             $end += $env{'form.number_embedded_items'};
                   10302:         }
                   10303:         if ($env{'form.number_pathchange_items'}) {
                   10304:             $end += $env{'form.number_pathchange_items'};
                   10305:         }
                   10306:         if ($end) {
                   10307:             for (my $i=0; $i<$end; $i++) {
                   10308:                 if ($i < $env{'form.number_embedded_items'}) {
                   10309:                     next unless($pathchange->{$i});
                   10310:                 }
                   10311:                 $modifyform .=
                   10312:                     &start_data_table_row().
                   10313:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   10314:                     'checked="checked" /></td>'.
                   10315:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   10316:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   10317:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   10318:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   10319:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   10320:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   10321:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   10322:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   10323:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   10324:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   10325:                     &end_data_table_row();
1.1071    raeburn  10326:             }
1.987     raeburn  10327:         }
                   10328:     } else {
                   10329:         $modifyform = $pathchgtable;
                   10330:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   10331:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   10332:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   10333:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   10334:         }
                   10335:     }
                   10336:     if ($modifyform) {
1.1071    raeburn  10337:         if ($actionurl eq '/adm/dependencies') {
                   10338:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   10339:         }
1.987     raeburn  10340:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   10341:                '<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".
                   10342:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   10343:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   10344:                '</ol></p>'."\n".'<p>'.
                   10345:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   10346:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   10347:                &start_data_table()."\n".
                   10348:                &start_data_table_header_row().
                   10349:                '<th>'.&mt('Change?').'</th>'.
                   10350:                '<th>'.&mt('Current reference').'</th>'.
                   10351:                '<th>'.&mt('Required reference').'</th>'.
                   10352:                &end_data_table_header_row()."\n".
                   10353:                $modifyform.
                   10354:                &end_data_table().'<br />'."\n".$hiddenstate.
                   10355:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   10356:                '</form>'."\n";
                   10357:     }
                   10358:     return;
                   10359: }
                   10360: 
                   10361: sub modify_html_refs {
1.1123    raeburn  10362:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  10363:     my $container;
                   10364:     if ($context eq 'portfolio') {
                   10365:         $container = $env{'form.container'};
                   10366:     } elsif ($context eq 'coursedoc') {
                   10367:         $container = $env{'form.primaryurl'};
1.1071    raeburn  10368:     } elsif ($context eq 'manage_dependencies') {
                   10369:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   10370:         $container = "/$container";
1.1123    raeburn  10371:     } elsif ($context eq 'syllabus') {
                   10372:         $container = $url;
1.987     raeburn  10373:     } else {
1.1027    raeburn  10374:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  10375:     }
                   10376:     my (%allfiles,%codebase,$output,$content);
                   10377:     my @changes = &get_env_multiple('form.namechange');
1.1126  ! raeburn  10378:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  10379:         if (wantarray) {
                   10380:             return ('',0,0); 
                   10381:         } else {
                   10382:             return;
                   10383:         }
                   10384:     }
                   10385:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  10386:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  10387:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   10388:             if (wantarray) {
                   10389:                 return ('',0,0);
                   10390:             } else {
                   10391:                 return;
                   10392:             }
                   10393:         } 
1.987     raeburn  10394:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  10395:         if ($content eq '-1') {
                   10396:             if (wantarray) {
                   10397:                 return ('',0,0);
                   10398:             } else {
                   10399:                 return;
                   10400:             }
                   10401:         }
1.987     raeburn  10402:     } else {
1.1071    raeburn  10403:         unless ($container =~ /^\Q$dir_root\E/) {
                   10404:             if (wantarray) {
                   10405:                 return ('',0,0);
                   10406:             } else {
                   10407:                 return;
                   10408:             }
                   10409:         } 
1.987     raeburn  10410:         if (open(my $fh,"<$container")) {
                   10411:             $content = join('', <$fh>);
                   10412:             close($fh);
                   10413:         } else {
1.1071    raeburn  10414:             if (wantarray) {
                   10415:                 return ('',0,0);
                   10416:             } else {
                   10417:                 return;
                   10418:             }
1.987     raeburn  10419:         }
                   10420:     }
                   10421:     my ($count,$codebasecount) = (0,0);
                   10422:     my $mm = new File::MMagic;
                   10423:     my $mime_type = $mm->checktype_contents($content);
                   10424:     if ($mime_type eq 'text/html') {
                   10425:         my $parse_result = 
                   10426:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   10427:                                                     \%codebase,\$content);
                   10428:         if ($parse_result eq 'ok') {
                   10429:             foreach my $i (@changes) {
                   10430:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   10431:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   10432:                 if ($allfiles{$ref}) {
                   10433:                     my $newname =  $orig;
                   10434:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  10435:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  10436:                     if ($attrib_regexp =~ /:/) {
                   10437:                         $attrib_regexp =~ s/\:/|/g;
                   10438:                     }
                   10439:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   10440:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   10441:                         $count += $numchg;
1.1123    raeburn  10442:                         $allfiles{$newname} = $allfiles{$ref};
1.987     raeburn  10443:                     }
                   10444:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  10445:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  10446:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   10447:                         $codebasecount ++;
                   10448:                     }
                   10449:                 }
                   10450:             }
1.1123    raeburn  10451:             my $skiprewrites;
1.987     raeburn  10452:             if ($count || $codebasecount) {
                   10453:                 my $saveresult;
1.1071    raeburn  10454:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  10455:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  10456:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   10457:                     if ($url eq $container) {
                   10458:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   10459:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10460:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  10461:                                             $fname.'</span>').'</p>';
1.987     raeburn  10462:                     } else {
                   10463:                          $output = '<p class="LC_error">'.
                   10464:                                    &mt('Error: update failed for: [_1].',
                   10465:                                    '<span class="LC_filename">'.
                   10466:                                    $container.'</span>').'</p>';
                   10467:                     }
1.1123    raeburn  10468:                     if ($context eq 'syllabus') {
                   10469:                         unless ($saveresult eq 'ok') {
                   10470:                             $skiprewrites = 1;
                   10471:                         }
                   10472:                     }
1.987     raeburn  10473:                 } else {
                   10474:                     if (open(my $fh,">$container")) {
                   10475:                         print $fh $content;
                   10476:                         close($fh);
                   10477:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   10478:                                   $count,'<span class="LC_filename">'.
                   10479:                                   $container.'</span>').'</p>';
1.661     raeburn  10480:                     } else {
1.987     raeburn  10481:                          $output = '<p class="LC_error">'.
                   10482:                                    &mt('Error: could not update [_1].',
                   10483:                                    '<span class="LC_filename">'.
                   10484:                                    $container.'</span>').'</p>';
1.661     raeburn  10485:                     }
                   10486:                 }
                   10487:             }
1.1123    raeburn  10488:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   10489:                 my ($actionurl,$state);
                   10490:                 $actionurl = "/public/$udom/$uname/syllabus";
                   10491:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   10492:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   10493:                                               \%codebase,
                   10494:                                               {'context' => 'rewrites',
                   10495:                                                'ignore_remote_references' => 1,});
                   10496:                 if (ref($mapping) eq 'HASH') {
                   10497:                     my $rewrites = 0;
                   10498:                     foreach my $key (keys(%{$mapping})) {
                   10499:                         next if ($key =~ m{^https?://});
                   10500:                         my $ref = $mapping->{$key};
                   10501:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   10502:                         my $attrib;
                   10503:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   10504:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   10505:                         }
                   10506:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   10507:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   10508:                             $rewrites += $numchg;
                   10509:                         }
                   10510:                     }
                   10511:                     if ($rewrites) {
                   10512:                         my $saveresult; 
                   10513:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   10514:                         if ($url eq $container) {
                   10515:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   10516:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   10517:                                             $count,'<span class="LC_filename">'.
                   10518:                                             $fname.'</span>').'</p>';
                   10519:                         } else {
                   10520:                             $output .= '<p class="LC_error">'.
                   10521:                                        &mt('Error: could not update links in [_1].',
                   10522:                                        '<span class="LC_filename">'.
                   10523:                                        $container.'</span>').'</p>';
                   10524: 
                   10525:                         }
                   10526:                     }
                   10527:                 }
                   10528:             }
1.987     raeburn  10529:         } else {
                   10530:             &logthis('Failed to parse '.$container.
                   10531:                      ' to modify references: '.$parse_result);
1.661     raeburn  10532:         }
                   10533:     }
1.1071    raeburn  10534:     if (wantarray) {
                   10535:         return ($output,$count,$codebasecount);
                   10536:     } else {
                   10537:         return $output;
                   10538:     }
1.661     raeburn  10539: }
                   10540: 
                   10541: sub check_for_existing {
                   10542:     my ($path,$fname,$element) = @_;
                   10543:     my ($state,$msg);
                   10544:     if (-d $path.'/'.$fname) {
                   10545:         $state = 'exists';
                   10546:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10547:     } elsif (-e $path.'/'.$fname) {
                   10548:         $state = 'exists';
                   10549:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   10550:     }
                   10551:     if ($state eq 'exists') {
                   10552:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   10553:     }
                   10554:     return ($state,$msg);
                   10555: }
                   10556: 
                   10557: sub check_for_upload {
                   10558:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   10559:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  10560:     my $filesize = length($env{'form.'.$element});
                   10561:     if (!$filesize) {
                   10562:         my $msg = '<span class="LC_error">'.
                   10563:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   10564:                       '<span class="LC_filename">'.$fname.'</span>',
                   10565:                       $filesize).'<br />'.
1.1007    raeburn  10566:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  10567:                   '</span>';
                   10568:         return ('zero_bytes',$msg);
                   10569:     }
                   10570:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  10571:     my $getpropath = 1;
1.1021    raeburn  10572:     my ($dirlistref,$listerror) =
                   10573:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  10574:     my $found_file = 0;
                   10575:     my $locked_file = 0;
1.991     raeburn  10576:     my @lockers;
                   10577:     my $navmap;
                   10578:     if ($env{'request.course.id'}) {
                   10579:         $navmap = Apache::lonnavmaps::navmap->new();
                   10580:     }
1.1021    raeburn  10581:     if (ref($dirlistref) eq 'ARRAY') {
                   10582:         foreach my $line (@{$dirlistref}) {
                   10583:             my ($file_name,$rest)=split(/\&/,$line,2);
                   10584:             if ($file_name eq $fname){
                   10585:                 $file_name = $path.$file_name;
                   10586:                 if ($group ne '') {
                   10587:                     $file_name = $group.$file_name;
                   10588:                 }
                   10589:                 $found_file = 1;
                   10590:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   10591:                     foreach my $lock (@lockers) {
                   10592:                         if (ref($lock) eq 'ARRAY') {
                   10593:                             my ($symb,$crsid) = @{$lock};
                   10594:                             if ($crsid eq $env{'request.course.id'}) {
                   10595:                                 if (ref($navmap)) {
                   10596:                                     my $res = $navmap->getBySymb($symb);
                   10597:                                     foreach my $part (@{$res->parts()}) { 
                   10598:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   10599:                                         unless (($slot_status == $res->RESERVED) ||
                   10600:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   10601:                                             $locked_file = 1;
                   10602:                                         }
1.991     raeburn  10603:                                     }
1.1021    raeburn  10604:                                 } else {
                   10605:                                     $locked_file = 1;
1.991     raeburn  10606:                                 }
                   10607:                             } else {
                   10608:                                 $locked_file = 1;
                   10609:                             }
                   10610:                         }
1.1021    raeburn  10611:                    }
                   10612:                 } else {
                   10613:                     my @info = split(/\&/,$rest);
                   10614:                     my $currsize = $info[6]/1000;
                   10615:                     if ($currsize < $filesize) {
                   10616:                         my $extra = $filesize - $currsize;
                   10617:                         if (($current_disk_usage + $extra) > $disk_quota) {
                   10618:                             my $msg = '<span class="LC_error">'.
                   10619:                                       &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.',
                   10620:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'.
                   10621:                                       '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   10622:                                                    $disk_quota,$current_disk_usage);
                   10623:                             return ('will_exceed_quota',$msg);
                   10624:                         }
1.984     raeburn  10625:                     }
                   10626:                 }
1.661     raeburn  10627:             }
                   10628:         }
                   10629:     }
                   10630:     if (($current_disk_usage + $filesize) > $disk_quota){
                   10631:         my $msg = '<span class="LC_error">'.
                   10632:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   10633:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   10634:         return ('will_exceed_quota',$msg);
                   10635:     } elsif ($found_file) {
                   10636:         if ($locked_file) {
                   10637:             my $msg = '<span class="LC_error">';
                   10638:             $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>');
                   10639:             $msg .= '</span><br />';
                   10640:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   10641:             return ('file_locked',$msg);
                   10642:         } else {
                   10643:             my $msg = '<span class="LC_error">';
1.984     raeburn  10644:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.661     raeburn  10645:             $msg .= '</span>';
1.984     raeburn  10646:             return ('existingfile',$msg);
1.661     raeburn  10647:         }
                   10648:     }
                   10649: }
                   10650: 
1.987     raeburn  10651: sub check_for_traversal {
                   10652:     my ($path,$url,$toplevel) = @_;
                   10653:     my @parts=split(/\//,$path);
                   10654:     my $cleanpath;
                   10655:     my $fullpath = $url;
                   10656:     for (my $i=0;$i<@parts;$i++) {
                   10657:         next if ($parts[$i] eq '.');
                   10658:         if ($parts[$i] eq '..') {
                   10659:             $fullpath =~ s{([^/]+/)$}{};
                   10660:         } else {
                   10661:             $fullpath .= $parts[$i].'/';
                   10662:         }
                   10663:     }
                   10664:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   10665:         $cleanpath = $1;
                   10666:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   10667:         my $curr_toprel = $1;
                   10668:         my @parts = split(/\//,$curr_toprel);
                   10669:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   10670:         my @urlparts = split(/\//,$url_toprel);
                   10671:         my $doubledots;
                   10672:         my $startdiff = -1;
                   10673:         for (my $i=0; $i<@urlparts; $i++) {
                   10674:             if ($startdiff == -1) {
                   10675:                 unless ($urlparts[$i] eq $parts[$i]) {
                   10676:                     $startdiff = $i;
                   10677:                     $doubledots .= '../';
                   10678:                 }
                   10679:             } else {
                   10680:                 $doubledots .= '../';
                   10681:             }
                   10682:         }
                   10683:         if ($startdiff > -1) {
                   10684:             $cleanpath = $doubledots;
                   10685:             for (my $i=$startdiff; $i<@parts; $i++) {
                   10686:                 $cleanpath .= $parts[$i].'/';
                   10687:             }
                   10688:         }
                   10689:     }
                   10690:     $cleanpath =~ s{(/)$}{};
                   10691:     return $cleanpath;
                   10692: }
1.31      albertel 10693: 
1.1053    raeburn  10694: sub is_archive_file {
                   10695:     my ($mimetype) = @_;
                   10696:     if (($mimetype eq 'application/octet-stream') ||
                   10697:         ($mimetype eq 'application/x-stuffit') ||
                   10698:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   10699:         return 1;
                   10700:     }
                   10701:     return;
                   10702: }
                   10703: 
                   10704: sub decompress_form {
1.1065    raeburn  10705:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  10706:     my %lt = &Apache::lonlocal::texthash (
                   10707:         this => 'This file is an archive file.',
1.1067    raeburn  10708:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  10709:         itsc => 'Its contents are as follows:',
1.1053    raeburn  10710:         youm => 'You may wish to extract its contents.',
                   10711:         extr => 'Extract contents',
1.1067    raeburn  10712:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   10713:         proa => 'Process automatically?',
1.1053    raeburn  10714:         yes  => 'Yes',
                   10715:         no   => 'No',
1.1067    raeburn  10716:         fold => 'Title for folder containing movie',
                   10717:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  10718:     );
1.1065    raeburn  10719:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  10720:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  10721:     my $info = &list_archive_contents($fileloc,\@paths);
                   10722:     if (@paths) {
                   10723:         foreach my $path (@paths) {
                   10724:             $path =~ s{^/}{};
1.1067    raeburn  10725:             if ($path =~ m{^([^/]+)/$}) {
                   10726:                 $topdir = $1;
                   10727:             }
1.1065    raeburn  10728:             if ($path =~ m{^([^/]+)/}) {
                   10729:                 $toplevel{$1} = $path;
                   10730:             } else {
                   10731:                 $toplevel{$path} = $path;
                   10732:             }
                   10733:         }
                   10734:     }
1.1067    raeburn  10735:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
                   10736:         my @camtasia = ("$topdir/","$topdir/index.html",
                   10737:                         "$topdir/media/",
                   10738:                         "$topdir/media/$topdir.mp4",
                   10739:                         "$topdir/media/FirstFrame.png",
                   10740:                         "$topdir/media/player.swf",
                   10741:                         "$topdir/media/swfobject.js",
                   10742:                         "$topdir/media/expressInstall.swf");
                   10743:         my @diffs = &compare_arrays(\@paths,\@camtasia);
                   10744:         if (@diffs == 0) {
                   10745:             $is_camtasia = 1;
                   10746:         }
                   10747:     }
                   10748:     my $output;
                   10749:     if ($is_camtasia) {
                   10750:         $output = <<"ENDCAM";
                   10751: <script type="text/javascript" language="Javascript">
                   10752: // <![CDATA[
                   10753: 
                   10754: function camtasiaToggle() {
                   10755:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   10756:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
                   10757:             if (document.uploaded_decompress.autoextract_camtasia[i].value == 1) {
                   10758: 
                   10759:                 document.getElementById('camtasia_titles').style.display='block';
                   10760:             } else {
                   10761:                 document.getElementById('camtasia_titles').style.display='none';
                   10762:             }
                   10763:         }
                   10764:     }
                   10765:     return;
                   10766: }
                   10767: 
                   10768: // ]]>
                   10769: </script>
                   10770: <p>$lt{'camt'}</p>
                   10771: ENDCAM
1.1065    raeburn  10772:     } else {
1.1067    raeburn  10773:         $output = '<p>'.$lt{'this'};
                   10774:         if ($info eq '') {
                   10775:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   10776:         } else {
                   10777:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   10778:                        '<div><pre>'.$info.'</pre></div>';
                   10779:         }
1.1065    raeburn  10780:     }
1.1067    raeburn  10781:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  10782:     my $duplicates;
                   10783:     my $num = 0;
                   10784:     if (ref($dirlist) eq 'ARRAY') {
                   10785:         foreach my $item (@{$dirlist}) {
                   10786:             if (ref($item) eq 'ARRAY') {
                   10787:                 if (exists($toplevel{$item->[0]})) {
                   10788:                     $duplicates .= 
                   10789:                         &start_data_table_row().
                   10790:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10791:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   10792:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   10793:                         'value="1" />'.&mt('Yes').'</label>'.
                   10794:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   10795:                         '<td>'.$item->[0].'</td>';
                   10796:                     if ($item->[2]) {
                   10797:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   10798:                     } else {
                   10799:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   10800:                     }
                   10801:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   10802:                                    '<td>'.
                   10803:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   10804:                                    '</td>'.
                   10805:                                    &end_data_table_row();
                   10806:                     $num ++;
                   10807:                 }
                   10808:             }
                   10809:         }
                   10810:     }
                   10811:     my $itemcount;
                   10812:     if (@paths > 0) {
                   10813:         $itemcount = scalar(@paths);
                   10814:     } else {
                   10815:         $itemcount = 1;
                   10816:     }
1.1067    raeburn  10817:     if ($is_camtasia) {
                   10818:         $output .= $lt{'auto'}.'<br />'.
                   10819:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
                   10820:                    '<input type="radio" name="autoextract_camtasia" value="1" onclick="javascript:camtasiaToggle();" checked="checked" />'.
                   10821:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   10822:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   10823:                    $lt{'no'}.'</label></span><br />'.
                   10824:                    '<div id="camtasia_titles" style="display:block">'.
                   10825:                    &Apache::lonhtmlcommon::start_pick_box().
                   10826:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   10827:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   10828:                    &Apache::lonhtmlcommon::row_closure().
                   10829:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   10830:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   10831:                    &Apache::lonhtmlcommon::row_closure(1).
                   10832:                    &Apache::lonhtmlcommon::end_pick_box().
                   10833:                    '</div>';
                   10834:     }
1.1065    raeburn  10835:     $output .= 
                   10836:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  10837:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   10838:         "\n";
1.1065    raeburn  10839:     if ($duplicates ne '') {
                   10840:         $output .= '<p><span class="LC_warning">'.
                   10841:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   10842:                    &start_data_table().
                   10843:                    &start_data_table_header_row().
                   10844:                    '<th>'.&mt('Overwrite?').'</th>'.
                   10845:                    '<th>'.&mt('Name').'</th>'.
                   10846:                    '<th>'.&mt('Type').'</th>'.
                   10847:                    '<th>'.&mt('Size').'</th>'.
                   10848:                    '<th>'.&mt('Last modified').'</th>'.
                   10849:                    &end_data_table_header_row().
                   10850:                    $duplicates.
                   10851:                    &end_data_table().
                   10852:                    '</p>';
                   10853:     }
1.1067    raeburn  10854:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  10855:     if (ref($hiddenelements) eq 'HASH') {
                   10856:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   10857:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   10858:         }
                   10859:     }
                   10860:     $output .= <<"END";
1.1067    raeburn  10861: <br />
1.1053    raeburn  10862: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   10863: </form>
                   10864: $noextract
                   10865: END
                   10866:     return $output;
                   10867: }
                   10868: 
1.1065    raeburn  10869: sub decompression_utility {
                   10870:     my ($program) = @_;
                   10871:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   10872:     my $location;
                   10873:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   10874:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   10875:                          '/usr/sbin/') {
                   10876:             if (-x $dir.$program) {
                   10877:                 $location = $dir.$program;
                   10878:                 last;
                   10879:             }
                   10880:         }
                   10881:     }
                   10882:     return $location;
                   10883: }
                   10884: 
                   10885: sub list_archive_contents {
                   10886:     my ($file,$pathsref) = @_;
                   10887:     my (@cmd,$output);
                   10888:     my $needsregexp;
                   10889:     if ($file =~ /\.zip$/) {
                   10890:         @cmd = (&decompression_utility('unzip'),"-l");
                   10891:         $needsregexp = 1;
                   10892:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   10893:              ($file =~ /\.tgz$/)) {
                   10894:         @cmd = (&decompression_utility('tar'),"-ztf");
                   10895:     } elsif ($file =~ /\.tar\.bz2$/) {
                   10896:         @cmd = (&decompression_utility('tar'),"-jtf");
                   10897:     } elsif ($file =~ m|\.tar$|) {
                   10898:         @cmd = (&decompression_utility('tar'),"-tf");
                   10899:     }
                   10900:     if (@cmd) {
                   10901:         undef($!);
                   10902:         undef($@);
                   10903:         if (open(my $fh,"-|", @cmd, $file)) {
                   10904:             while (my $line = <$fh>) {
                   10905:                 $output .= $line;
                   10906:                 chomp($line);
                   10907:                 my $item;
                   10908:                 if ($needsregexp) {
                   10909:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   10910:                 } else {
                   10911:                     $item = $line;
                   10912:                 }
                   10913:                 if ($item ne '') {
                   10914:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   10915:                         push(@{$pathsref},$item);
                   10916:                     } 
                   10917:                 }
                   10918:             }
                   10919:             close($fh);
                   10920:         }
                   10921:     }
                   10922:     return $output;
                   10923: }
                   10924: 
1.1053    raeburn  10925: sub decompress_uploaded_file {
                   10926:     my ($file,$dir) = @_;
                   10927:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   10928:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   10929:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   10930:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   10931:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   10932:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   10933:     my $decompressed = $env{'cgi.decompressed'};
                   10934:     &Apache::lonnet::delenv('cgi.file');
                   10935:     &Apache::lonnet::delenv('cgi.dir');
                   10936:     &Apache::lonnet::delenv('cgi.decompressed');
                   10937:     return ($decompressed,$result);
                   10938: }
                   10939: 
1.1055    raeburn  10940: sub process_decompression {
                   10941:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
                   10942:     my ($dir,$error,$warning,$output);
                   10943:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/) {
1.1120    bisitz   10944:         $error = &mt('Filename not a supported archive file type.').
                   10945:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  10946:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   10947:     } else {
                   10948:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   10949:         if ($docuhome eq 'no_host') {
                   10950:             $error = &mt('Could not determine home server for course.');
                   10951:         } else {
                   10952:             my @ids=&Apache::lonnet::current_machine_ids();
                   10953:             my $currdir = "$dir_root/$destination";
                   10954:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   10955:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   10956:                        "$dir_root/$destination";
                   10957:             } else {
                   10958:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   10959:                        "$dir_root/$docudom/$docuname/$destination";
                   10960:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   10961:                     $error = &mt('Archive file not found.');
                   10962:                 }
                   10963:             }
1.1065    raeburn  10964:             my (@to_overwrite,@to_skip);
                   10965:             if ($env{'form.archive_overwrite_total'} > 0) {
                   10966:                 my $total = $env{'form.archive_overwrite_total'};
                   10967:                 for (my $i=0; $i<$total; $i++) {
                   10968:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   10969:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   10970:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   10971:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   10972:                     }
                   10973:                 }
                   10974:             }
                   10975:             my $numskip = scalar(@to_skip);
                   10976:             if (($numskip > 0) && 
                   10977:                 ($numskip == $env{'form.archive_itemcount'})) {
                   10978:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   10979:             } elsif ($dir eq '') {
1.1055    raeburn  10980:                 $error = &mt('Directory containing archive file unavailable.');
                   10981:             } elsif (!$error) {
1.1065    raeburn  10982:                 my ($decompressed,$display);
                   10983:                 if ($numskip > 0) {
                   10984:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   10985:                     mkdir("$dir/$tempdir",0755);
                   10986:                     system("mv $dir/$file $dir/$tempdir/$file");
                   10987:                     ($decompressed,$display) = 
                   10988:                         &decompress_uploaded_file($file,"$dir/$tempdir");
                   10989:                     foreach my $item (@to_skip) {
                   10990:                         if (($item ne '') && ($item !~ /\.\./)) {
                   10991:                             if (-f "$dir/$tempdir/$item") { 
                   10992:                                 unlink("$dir/$tempdir/$item");
                   10993:                             } elsif (-d "$dir/$tempdir/$item") {
                   10994:                                 system("rm -rf $dir/$tempdir/$item");
                   10995:                             }
                   10996:                         }
                   10997:                     }
                   10998:                     system("mv $dir/$tempdir/* $dir");
                   10999:                     rmdir("$dir/$tempdir");   
                   11000:                 } else {
                   11001:                     ($decompressed,$display) = 
                   11002:                         &decompress_uploaded_file($file,$dir);
                   11003:                 }
1.1055    raeburn  11004:                 if ($decompressed eq 'ok') {
1.1065    raeburn  11005:                     $output = '<p class="LC_info">'.
                   11006:                               &mt('Files extracted successfully from archive.').
                   11007:                               '</p>'."\n";
1.1055    raeburn  11008:                     my ($warning,$result,@contents);
                   11009:                     my ($newdirlistref,$newlisterror) =
                   11010:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   11011:                                                  $docuname,1);
                   11012:                     my (%is_dir,%changes,@newitems);
                   11013:                     my $dirptr = 16384;
1.1065    raeburn  11014:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  11015:                         foreach my $dir_line (@{$newdirlistref}) {
                   11016:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1065    raeburn  11017:                             unless (($item =~ /^\.+$/) || ($item eq $file) || 
                   11018:                                     ((@to_skip > 0) && (grep(/^\Q$item\E$/,@to_skip)))) {
1.1055    raeburn  11019:                                 push(@newitems,$item);
                   11020:                                 if ($dirptr&$testdir) {
                   11021:                                     $is_dir{$item} = 1;
                   11022:                                 }
                   11023:                                 $changes{$item} = 1;
                   11024:                             }
                   11025:                         }
                   11026:                     }
                   11027:                     if (keys(%changes) > 0) {
                   11028:                         foreach my $item (sort(@newitems)) {
                   11029:                             if ($changes{$item}) {
                   11030:                                 push(@contents,$item);
                   11031:                             }
                   11032:                         }
                   11033:                     }
                   11034:                     if (@contents > 0) {
1.1067    raeburn  11035:                         my $wantform;
                   11036:                         unless ($env{'form.autoextract_camtasia'}) {
                   11037:                             $wantform = 1;
                   11038:                         }
1.1056    raeburn  11039:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  11040:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   11041:                                                                 $currdir,\%is_dir,
                   11042:                                                                 \%children,\%parent,
1.1056    raeburn  11043:                                                                 \@contents,\%dirorder,
                   11044:                                                                 \%titles,$wantform);
1.1055    raeburn  11045:                         if ($datatable ne '') {
                   11046:                             $output .= &archive_options_form('decompressed',$datatable,
                   11047:                                                              $count,$hiddenelem);
1.1065    raeburn  11048:                             my $startcount = 6;
1.1055    raeburn  11049:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  11050:                                                            \%titles,\%children);
1.1055    raeburn  11051:                         }
1.1067    raeburn  11052:                         if ($env{'form.autoextract_camtasia'}) {
                   11053:                             my %displayed;
                   11054:                             my $total = 1;
                   11055:                             $env{'form.archive_directory'} = [];
                   11056:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   11057:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   11058:                                 $path =~ s{/$}{};
                   11059:                                 my $item;
                   11060:                                 if ($path ne '') {
                   11061:                                     $item = "$path/$titles{$i}";
                   11062:                                 } else {
                   11063:                                     $item = $titles{$i};
                   11064:                                 }
                   11065:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   11066:                                 if ($item eq $contents[0]) {
                   11067:                                     push(@{$env{'form.archive_directory'}},$i);
                   11068:                                     $env{'form.archive_'.$i} = 'display';
                   11069:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   11070:                                     $displayed{'folder'} = $i;
                   11071:                                 } elsif ($item eq "$contents[0]/index.html") {
                   11072:                                     $env{'form.archive_'.$i} = 'display';
                   11073:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   11074:                                     $displayed{'web'} = $i;
                   11075:                                 } else {
                   11076:                                     if ($item eq "$contents[0]/media") {
                   11077:                                         push(@{$env{'form.archive_directory'}},$i);
                   11078:                                     }
                   11079:                                     $env{'form.archive_'.$i} = 'dependency';
                   11080:                                 }
                   11081:                                 $total ++;
                   11082:                             }
                   11083:                             for (my $i=1; $i<$total; $i++) {
                   11084:                                 next if ($i == $displayed{'web'});
                   11085:                                 next if ($i == $displayed{'folder'});
                   11086:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   11087:                             }
                   11088:                             $env{'form.phase'} = 'decompress_cleanup';
                   11089:                             $env{'form.archivedelete'} = 1;
                   11090:                             $env{'form.archive_count'} = $total-1;
                   11091:                             $output .=
                   11092:                                 &process_extracted_files('coursedocs',$docudom,
                   11093:                                                          $docuname,$destination,
                   11094:                                                          $dir_root,$hiddenelem);
                   11095:                         }
1.1055    raeburn  11096:                     } else {
                   11097:                         $warning = &mt('No new items extracted from archive file.');
                   11098:                     }
                   11099:                 } else {
                   11100:                     $output = $display;
                   11101:                     $error = &mt('An error occurred during extraction from the archive file.');
                   11102:                 }
                   11103:             }
                   11104:         }
                   11105:     }
                   11106:     if ($error) {
                   11107:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   11108:                    $error.'</p>'."\n";
                   11109:     }
                   11110:     if ($warning) {
                   11111:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   11112:     }
                   11113:     return $output;
                   11114: }
                   11115: 
                   11116: sub get_extracted {
1.1056    raeburn  11117:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   11118:         $titles,$wantform) = @_;
1.1055    raeburn  11119:     my $count = 0;
                   11120:     my $depth = 0;
                   11121:     my $datatable;
1.1056    raeburn  11122:     my @hierarchy;
1.1055    raeburn  11123:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  11124:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   11125:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  11126:     foreach my $item (@{$contents}) {
                   11127:         $count ++;
1.1056    raeburn  11128:         @{$dirorder->{$count}} = @hierarchy;
                   11129:         $titles->{$count} = $item;
1.1055    raeburn  11130:         &archive_hierarchy($depth,$count,$parent,$children);
                   11131:         if ($wantform) {
                   11132:             $datatable .= &archive_row($is_dir->{$item},$item,
                   11133:                                        $currdir,$depth,$count);
                   11134:         }
                   11135:         if ($is_dir->{$item}) {
                   11136:             $depth ++;
1.1056    raeburn  11137:             push(@hierarchy,$count);
                   11138:             $parent->{$depth} = $count;
1.1055    raeburn  11139:             $datatable .=
                   11140:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  11141:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   11142:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  11143:             $depth --;
1.1056    raeburn  11144:             pop(@hierarchy);
1.1055    raeburn  11145:         }
                   11146:     }
                   11147:     return ($count,$datatable);
                   11148: }
                   11149: 
                   11150: sub recurse_extracted_archive {
1.1056    raeburn  11151:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   11152:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  11153:     my $result='';
1.1056    raeburn  11154:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   11155:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   11156:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  11157:         return $result;
                   11158:     }
                   11159:     my $dirptr = 16384;
                   11160:     my ($newdirlistref,$newlisterror) =
                   11161:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   11162:     if (ref($newdirlistref) eq 'ARRAY') {
                   11163:         foreach my $dir_line (@{$newdirlistref}) {
                   11164:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   11165:             unless ($item =~ /^\.+$/) {
                   11166:                 $$count ++;
1.1056    raeburn  11167:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   11168:                 $titles->{$$count} = $item;
1.1055    raeburn  11169:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  11170: 
1.1055    raeburn  11171:                 my $is_dir;
                   11172:                 if ($dirptr&$testdir) {
                   11173:                     $is_dir = 1;
                   11174:                 }
                   11175:                 if ($wantform) {
                   11176:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   11177:                 }
                   11178:                 if ($is_dir) {
                   11179:                     $$depth ++;
1.1056    raeburn  11180:                     push(@{$hierarchy},$$count);
                   11181:                     $parent->{$$depth} = $$count;
1.1055    raeburn  11182:                     $result .=
                   11183:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   11184:                                                    $docuname,$depth,$count,
1.1056    raeburn  11185:                                                    $hierarchy,$dirorder,$children,
                   11186:                                                    $parent,$titles,$wantform);
1.1055    raeburn  11187:                     $$depth --;
1.1056    raeburn  11188:                     pop(@{$hierarchy});
1.1055    raeburn  11189:                 }
                   11190:             }
                   11191:         }
                   11192:     }
                   11193:     return $result;
                   11194: }
                   11195: 
                   11196: sub archive_hierarchy {
                   11197:     my ($depth,$count,$parent,$children) =@_;
                   11198:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   11199:         if (exists($parent->{$depth})) {
                   11200:              $children->{$parent->{$depth}} .= $count.':';
                   11201:         }
                   11202:     }
                   11203:     return;
                   11204: }
                   11205: 
                   11206: sub archive_row {
                   11207:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   11208:     my ($name) = ($item =~ m{([^/]+)$});
                   11209:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  11210:                                        'display'    => 'Add as file',
1.1055    raeburn  11211:                                        'dependency' => 'Include as dependency',
                   11212:                                        'discard'    => 'Discard',
                   11213:                                       );
                   11214:     if ($is_dir) {
1.1059    raeburn  11215:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  11216:     }
1.1056    raeburn  11217:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   11218:     my $offset = 0;
1.1055    raeburn  11219:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  11220:         $offset ++;
1.1065    raeburn  11221:         if ($action ne 'display') {
                   11222:             $offset ++;
                   11223:         }  
1.1055    raeburn  11224:         $output .= '<td><span class="LC_nobreak">'.
                   11225:                    '<label><input type="radio" name="archive_'.$count.
                   11226:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   11227:         my $text = $choices{$action};
                   11228:         if ($is_dir) {
                   11229:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   11230:             if ($action eq 'display') {
1.1059    raeburn  11231:                 $text = &mt('Add as folder');
1.1055    raeburn  11232:             }
1.1056    raeburn  11233:         } else {
                   11234:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   11235: 
                   11236:         }
                   11237:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   11238:         if ($action eq 'dependency') {
                   11239:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   11240:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   11241:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   11242:                        '<option value=""></option>'."\n".
                   11243:                        '</select>'."\n".
                   11244:                        '</div>';
1.1059    raeburn  11245:         } elsif ($action eq 'display') {
                   11246:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   11247:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   11248:                        '</div>';
1.1055    raeburn  11249:         }
1.1056    raeburn  11250:         $output .= '</td>';
1.1055    raeburn  11251:     }
                   11252:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   11253:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   11254:     for (my $i=0; $i<$depth; $i++) {
                   11255:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   11256:     }
                   11257:     if ($is_dir) {
                   11258:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   11259:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   11260:     } else {
                   11261:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   11262:     }
                   11263:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   11264:                &end_data_table_row();
                   11265:     return $output;
                   11266: }
                   11267: 
                   11268: sub archive_options_form {
1.1065    raeburn  11269:     my ($form,$display,$count,$hiddenelem) = @_;
                   11270:     my %lt = &Apache::lonlocal::texthash(
                   11271:                perm => 'Permanently remove archive file?',
                   11272:                hows => 'How should each extracted item be incorporated in the course?',
                   11273:                cont => 'Content actions for all',
                   11274:                addf => 'Add as folder/file',
                   11275:                incd => 'Include as dependency for a displayed file',
                   11276:                disc => 'Discard',
                   11277:                no   => 'No',
                   11278:                yes  => 'Yes',
                   11279:                save => 'Save',
                   11280:     );
                   11281:     my $output = <<"END";
                   11282: <form name="$form" method="post" action="">
                   11283: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   11284: <label>
                   11285:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   11286: </label>
                   11287: &nbsp;
                   11288: <label>
                   11289:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   11290: </span>
                   11291: </p>
                   11292: <input type="hidden" name="phase" value="decompress_cleanup" />
                   11293: <br />$lt{'hows'}
                   11294: <div class="LC_columnSection">
                   11295:   <fieldset>
                   11296:     <legend>$lt{'cont'}</legend>
                   11297:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   11298:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   11299:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   11300:   </fieldset>
                   11301: </div>
                   11302: END
                   11303:     return $output.
1.1055    raeburn  11304:            &start_data_table()."\n".
1.1065    raeburn  11305:            $display."\n".
1.1055    raeburn  11306:            &end_data_table()."\n".
                   11307:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   11308:            $hiddenelem.
1.1065    raeburn  11309:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  11310:            '</form>';
                   11311: }
                   11312: 
                   11313: sub archive_javascript {
1.1056    raeburn  11314:     my ($startcount,$numitems,$titles,$children) = @_;
                   11315:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  11316:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  11317:     my $scripttag = <<START;
                   11318: <script type="text/javascript">
                   11319: // <![CDATA[
                   11320: 
                   11321: function checkAll(form,prefix) {
                   11322:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   11323:     for (var i=0; i < form.elements.length; i++) {
                   11324:         var id = form.elements[i].id;
                   11325:         if ((id != '') && (id != undefined)) {
                   11326:             if (idstr.test(id)) {
                   11327:                 if (form.elements[i].type == 'radio') {
                   11328:                     form.elements[i].checked = true;
1.1056    raeburn  11329:                     var nostart = i-$startcount;
1.1059    raeburn  11330:                     var offset = nostart%7;
                   11331:                     var count = (nostart-offset)/7;    
1.1056    raeburn  11332:                     dependencyCheck(form,count,offset);
1.1055    raeburn  11333:                 }
                   11334:             }
                   11335:         }
                   11336:     }
                   11337: }
                   11338: 
                   11339: function propagateCheck(form,count) {
                   11340:     if (count > 0) {
1.1059    raeburn  11341:         var startelement = $startcount + ((count-1) * 7);
                   11342:         for (var j=1; j<6; j++) {
                   11343:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  11344:                 var item = startelement + j; 
                   11345:                 if (form.elements[item].type == 'radio') {
                   11346:                     if (form.elements[item].checked) {
                   11347:                         containerCheck(form,count,j);
                   11348:                         break;
                   11349:                     }
1.1055    raeburn  11350:                 }
                   11351:             }
                   11352:         }
                   11353:     }
                   11354: }
                   11355: 
                   11356: numitems = $numitems
1.1056    raeburn  11357: var titles = new Array(numitems);
                   11358: var parents = new Array(numitems);
1.1055    raeburn  11359: for (var i=0; i<numitems; i++) {
1.1056    raeburn  11360:     parents[i] = new Array;
1.1055    raeburn  11361: }
1.1059    raeburn  11362: var maintitle = '$maintitle';
1.1055    raeburn  11363: 
                   11364: START
                   11365: 
1.1056    raeburn  11366:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   11367:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  11368:         for (my $i=0; $i<@contents; $i ++) {
                   11369:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   11370:         }
                   11371:     }
                   11372: 
1.1056    raeburn  11373:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   11374:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   11375:     }
                   11376: 
1.1055    raeburn  11377:     $scripttag .= <<END;
                   11378: 
                   11379: function containerCheck(form,count,offset) {
                   11380:     if (count > 0) {
1.1056    raeburn  11381:         dependencyCheck(form,count,offset);
1.1059    raeburn  11382:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  11383:         form.elements[item].checked = true;
                   11384:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11385:             if (parents[count].length > 0) {
                   11386:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  11387:                     containerCheck(form,parents[count][j],offset);
                   11388:                 }
                   11389:             }
                   11390:         }
                   11391:     }
                   11392: }
                   11393: 
                   11394: function dependencyCheck(form,count,offset) {
                   11395:     if (count > 0) {
1.1059    raeburn  11396:         var chosen = (offset+$startcount)+7*(count-1);
                   11397:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  11398:         var currtype = form.elements[depitem].type;
                   11399:         if (form.elements[chosen].value == 'dependency') {
                   11400:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   11401:             form.elements[depitem].options.length = 0;
                   11402:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  11403:             for (var i=1; i<=numitems; i++) {
                   11404:                 if (i == count) {
                   11405:                     continue;
                   11406:                 }
1.1059    raeburn  11407:                 var startelement = $startcount + (i-1) * 7;
                   11408:                 for (var j=1; j<6; j++) {
                   11409:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  11410:                         var item = startelement + j;
                   11411:                         if (form.elements[item].type == 'radio') {
                   11412:                             if (form.elements[item].checked) {
                   11413:                                 if (form.elements[item].value == 'display') {
                   11414:                                     var n = form.elements[depitem].options.length;
                   11415:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   11416:                                 }
                   11417:                             }
                   11418:                         }
                   11419:                     }
                   11420:                 }
                   11421:             }
                   11422:         } else {
                   11423:             document.getElementById('arc_depon_'+count).style.display='none';
                   11424:             form.elements[depitem].options.length = 0;
                   11425:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   11426:         }
1.1059    raeburn  11427:         titleCheck(form,count,offset);
1.1056    raeburn  11428:     }
                   11429: }
                   11430: 
                   11431: function propagateSelect(form,count,offset) {
                   11432:     if (count > 0) {
1.1065    raeburn  11433:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  11434:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   11435:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11436:             if (parents[count].length > 0) {
                   11437:                 for (var j=0; j<parents[count].length; j++) {
                   11438:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  11439:                 }
                   11440:             }
                   11441:         }
                   11442:     }
                   11443: }
1.1056    raeburn  11444: 
                   11445: function containerSelect(form,count,offset,picked) {
                   11446:     if (count > 0) {
1.1065    raeburn  11447:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  11448:         if (form.elements[item].type == 'radio') {
                   11449:             if (form.elements[item].value == 'dependency') {
                   11450:                 if (form.elements[item+1].type == 'select-one') {
                   11451:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   11452:                         if (form.elements[item+1].options[i].value == picked) {
                   11453:                             form.elements[item+1].selectedIndex = i;
                   11454:                             break;
                   11455:                         }
                   11456:                     }
                   11457:                 }
                   11458:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   11459:                     if (parents[count].length > 0) {
                   11460:                         for (var j=0; j<parents[count].length; j++) {
                   11461:                             containerSelect(form,parents[count][j],offset,picked);
                   11462:                         }
                   11463:                     }
                   11464:                 }
                   11465:             }
                   11466:         }
                   11467:     }
                   11468: }
                   11469: 
1.1059    raeburn  11470: function titleCheck(form,count,offset) {
                   11471:     if (count > 0) {
                   11472:         var chosen = (offset+$startcount)+7*(count-1);
                   11473:         var depitem = $startcount + ((count-1) * 7) + 2;
                   11474:         var currtype = form.elements[depitem].type;
                   11475:         if (form.elements[chosen].value == 'display') {
                   11476:             document.getElementById('arc_title_'+count).style.display='block';
                   11477:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   11478:                 document.getElementById('archive_title_'+count).value=maintitle;
                   11479:             }
                   11480:         } else {
                   11481:             document.getElementById('arc_title_'+count).style.display='none';
                   11482:             if (currtype == 'text') { 
                   11483:                 document.getElementById('archive_title_'+count).value='';
                   11484:             }
                   11485:         }
                   11486:     }
                   11487:     return;
                   11488: }
                   11489: 
1.1055    raeburn  11490: // ]]>
                   11491: </script>
                   11492: END
                   11493:     return $scripttag;
                   11494: }
                   11495: 
                   11496: sub process_extracted_files {
1.1067    raeburn  11497:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  11498:     my $numitems = $env{'form.archive_count'};
                   11499:     return unless ($numitems);
                   11500:     my @ids=&Apache::lonnet::current_machine_ids();
                   11501:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  11502:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  11503:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   11504:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   11505:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   11506:         $pathtocheck = "$dir_root/$destination";
                   11507:         $dir = $dir_root;
                   11508:         $ishome = 1;
                   11509:     } else {
                   11510:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   11511:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
                   11512:         $dir = "$dir_root/$docudom/$docuname";    
                   11513:     }
                   11514:     my $currdir = "$dir_root/$destination";
                   11515:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   11516:     if ($env{'form.folderpath'}) {
                   11517:         my @items = split('&',$env{'form.folderpath'});
                   11518:         $folders{'0'} = $items[-2];
1.1099    raeburn  11519:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   11520:             $containers{'0'}='page';
                   11521:         } else {  
                   11522:             $containers{'0'}='sequence';
                   11523:         }
1.1055    raeburn  11524:     }
                   11525:     my @archdirs = &get_env_multiple('form.archive_directory');
                   11526:     if ($numitems) {
                   11527:         for (my $i=1; $i<=$numitems; $i++) {
                   11528:             my $path = $env{'form.archive_content_'.$i};
                   11529:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   11530:                 my $item = $1;
                   11531:                 $toplevelitems{$item} = $i;
                   11532:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   11533:                     $is_dir{$item} = 1;
                   11534:                 }
                   11535:             }
                   11536:         }
                   11537:     }
1.1067    raeburn  11538:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  11539:     if (keys(%toplevelitems) > 0) {
                   11540:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  11541:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   11542:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  11543:     }
1.1066    raeburn  11544:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  11545:     if ($numitems) {
                   11546:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  11547:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  11548:             my $path = $env{'form.archive_content_'.$i};
                   11549:             if ($path =~ /^\Q$pathtocheck\E/) {
                   11550:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   11551:                     if ($prefix ne '' && $path ne '') {
                   11552:                         if (-e $prefix.$path) {
1.1066    raeburn  11553:                             if ((@archdirs > 0) && 
                   11554:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   11555:                                 $todeletedir{$prefix.$path} = 1;
                   11556:                             } else {
                   11557:                                 $todelete{$prefix.$path} = 1;
                   11558:                             }
1.1055    raeburn  11559:                         }
                   11560:                     }
                   11561:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  11562:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  11563:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  11564:                     $docstitle = $env{'form.archive_title_'.$i};
                   11565:                     if ($docstitle eq '') {
                   11566:                         $docstitle = $title;
                   11567:                     }
1.1055    raeburn  11568:                     $outer = 0;
1.1056    raeburn  11569:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   11570:                         if (@{$dirorder{$i}} > 0) {
                   11571:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  11572:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   11573:                                     $outer = $item;
                   11574:                                     last;
                   11575:                                 }
                   11576:                             }
                   11577:                         }
                   11578:                     }
                   11579:                     my ($errtext,$fatal) = 
                   11580:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   11581:                                                '/'.$folders{$outer}.'.'.
                   11582:                                                $containers{$outer});
                   11583:                     next if ($fatal);
                   11584:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   11585:                         if ($context eq 'coursedocs') {
1.1056    raeburn  11586:                             $mapinner{$i} = time;
1.1055    raeburn  11587:                             $folders{$i} = 'default_'.$mapinner{$i};
                   11588:                             $containers{$i} = 'sequence';
                   11589:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11590:                                       $folders{$i}.'.'.$containers{$i};
                   11591:                             my $newidx = &LONCAPA::map::getresidx();
                   11592:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11593:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11594:                             push(@LONCAPA::map::order,$newidx);
                   11595:                             my ($outtext,$errtext) =
                   11596:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11597:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  11598:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  11599:                             $newseqid{$i} = $newidx;
1.1067    raeburn  11600:                             unless ($errtext) {
                   11601:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',$docstitle).'</li>'."\n";
                   11602:                             }
1.1055    raeburn  11603:                         }
                   11604:                     } else {
                   11605:                         if ($context eq 'coursedocs') {
                   11606:                             my $newidx=&LONCAPA::map::getresidx();
                   11607:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   11608:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   11609:                                       $title;
                   11610:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   11611:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   11612:                             }
                   11613:                             if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11614:                                 mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   11615:                             }
                   11616:                             if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   11617:                                 system("mv $prefix$path $prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title");
1.1056    raeburn  11618:                                 $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
1.1067    raeburn  11619:                                 unless ($ishome) {
                   11620:                                     my $fetch = "$newdest{$i}/$title";
                   11621:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   11622:                                     $prompttofetch{$fetch} = 1;
                   11623:                                 }
1.1055    raeburn  11624:                             }
                   11625:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  11626:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  11627:                             push(@LONCAPA::map::order, $newidx);
                   11628:                             my ($outtext,$errtext)=
                   11629:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   11630:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  11631:                                                         '.'.$containers{$outer},1,1);
1.1067    raeburn  11632:                             unless ($errtext) {
                   11633:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   11634:                                     $result .= '<li>'.&mt('File: [_1] added to course',$docstitle).'</li>'."\n";
                   11635:                                 }
                   11636:                             }
1.1055    raeburn  11637:                         }
                   11638:                     }
1.1086    raeburn  11639:                 }
                   11640:             } else {
                   11641:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   11642:             }
                   11643:         }
                   11644:         for (my $i=1; $i<=$numitems; $i++) {
                   11645:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   11646:             my $path = $env{'form.archive_content_'.$i};
                   11647:             if ($path =~ /^\Q$pathtocheck\E/) {
                   11648:                 my ($title) = ($path =~ m{/([^/]+)$});
                   11649:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   11650:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   11651:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   11652:                         my ($itemidx,$fullpath,$relpath);
                   11653:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   11654:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  11655:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  11656:                                 if ($dirorder{$i}->[$j] eq $container) {
                   11657:                                     $itemidx = $j;
1.1056    raeburn  11658:                                 }
                   11659:                             }
1.1086    raeburn  11660:                         }
                   11661:                         if ($itemidx eq '') {
                   11662:                             $itemidx =  0;
                   11663:                         } 
                   11664:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   11665:                             if ($mapinner{$referrer{$i}}) {
                   11666:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   11667:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11668:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11669:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11670:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   11671:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   11672:                                             if (!-e $fullpath) {
                   11673:                                                 mkdir($fullpath,0755);
1.1056    raeburn  11674:                                             }
                   11675:                                         }
1.1086    raeburn  11676:                                     } else {
                   11677:                                         last;
1.1056    raeburn  11678:                                     }
1.1086    raeburn  11679:                                 }
                   11680:                             }
                   11681:                         } elsif ($newdest{$referrer{$i}}) {
                   11682:                             $fullpath = $newdest{$referrer{$i}};
                   11683:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   11684:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   11685:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   11686:                                     last;
                   11687:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   11688:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   11689:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   11690:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   11691:                                         if (!-e $fullpath) {
                   11692:                                             mkdir($fullpath,0755);
1.1056    raeburn  11693:                                         }
                   11694:                                     }
1.1086    raeburn  11695:                                 } else {
                   11696:                                     last;
1.1056    raeburn  11697:                                 }
1.1055    raeburn  11698:                             }
                   11699:                         }
1.1086    raeburn  11700:                         if ($fullpath ne '') {
                   11701:                             if (-e "$prefix$path") {
                   11702:                                 system("mv $prefix$path $fullpath/$title");
                   11703:                             }
                   11704:                             if (-e "$fullpath/$title") {
                   11705:                                 my $showpath;
                   11706:                                 if ($relpath ne '') {
                   11707:                                     $showpath = "$relpath/$title";
                   11708:                                 } else {
                   11709:                                     $showpath = "/$title";
                   11710:                                 } 
                   11711:                                 $result .= '<li>'.&mt('[_1] included as a dependency',$showpath).'</li>'."\n";
                   11712:                             } 
                   11713:                             unless ($ishome) {
                   11714:                                 my $fetch = "$fullpath/$title";
                   11715:                                 $fetch =~ s/^\Q$prefix$dir\E//; 
                   11716:                                 $prompttofetch{$fetch} = 1;
                   11717:                             }
                   11718:                         }
1.1055    raeburn  11719:                     }
1.1086    raeburn  11720:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   11721:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
                   11722:                                     $path,$env{'form.archive_content_'.$referrer{$i}}).'<br />';
1.1055    raeburn  11723:                 }
                   11724:             } else {
                   11725:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',$path).'<br />'; 
                   11726:             }
                   11727:         }
                   11728:         if (keys(%todelete)) {
                   11729:             foreach my $key (keys(%todelete)) {
                   11730:                 unlink($key);
1.1066    raeburn  11731:             }
                   11732:         }
                   11733:         if (keys(%todeletedir)) {
                   11734:             foreach my $key (keys(%todeletedir)) {
                   11735:                 rmdir($key);
                   11736:             }
                   11737:         }
                   11738:         foreach my $dir (sort(keys(%is_dir))) {
                   11739:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   11740:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  11741:             }
                   11742:         }
1.1067    raeburn  11743:         if ($result ne '') {
                   11744:             $output .= '<ul>'."\n".
                   11745:                        $result."\n".
                   11746:                        '</ul>';
                   11747:         }
                   11748:         unless ($ishome) {
                   11749:             my $replicationfail;
                   11750:             foreach my $item (keys(%prompttofetch)) {
                   11751:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   11752:                 unless ($fetchresult eq 'ok') {
                   11753:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   11754:                 }
                   11755:             }
                   11756:             if ($replicationfail) {
                   11757:                 $output .= '<p class="LC_error">'.
                   11758:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   11759:                            $replicationfail.
                   11760:                            '</ul></p>';
                   11761:             }
                   11762:         }
1.1055    raeburn  11763:     } else {
                   11764:         $warning = &mt('No items found in archive.');
                   11765:     }
                   11766:     if ($error) {
                   11767:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   11768:                    $error.'</p>'."\n";
                   11769:     }
                   11770:     if ($warning) {
                   11771:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   11772:     }
                   11773:     return $output;
                   11774: }
                   11775: 
1.1066    raeburn  11776: sub cleanup_empty_dirs {
                   11777:     my ($path) = @_;
                   11778:     if (($path ne '') && (-d $path)) {
                   11779:         if (opendir(my $dirh,$path)) {
                   11780:             my @dircontents = grep(!/^\./,readdir($dirh));
                   11781:             my $numitems = 0;
                   11782:             foreach my $item (@dircontents) {
                   11783:                 if (-d "$path/$item") {
1.1111    raeburn  11784:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  11785:                     if (-e "$path/$item") {
                   11786:                         $numitems ++;
                   11787:                     }
                   11788:                 } else {
                   11789:                     $numitems ++;
                   11790:                 }
                   11791:             }
                   11792:             if ($numitems == 0) {
                   11793:                 rmdir($path);
                   11794:             }
                   11795:             closedir($dirh);
                   11796:         }
                   11797:     }
                   11798:     return;
                   11799: }
                   11800: 
1.41      ng       11801: =pod
1.45      matthew  11802: 
1.1068    raeburn  11803: =item &get_folder_hierarchy()
                   11804: 
                   11805: Provides hierarchy of names of folders/sub-folders containing the current
                   11806: item,
                   11807: 
                   11808: Inputs: 3
                   11809:      - $navmap - navmaps object
                   11810: 
                   11811:      - $map - url for map (either the trigger itself, or map containing
                   11812:                            the resource, which is the trigger).
                   11813: 
                   11814:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   11815: 
                   11816: Outputs: 1 @pathitems - array of folder/subfolder names.
                   11817: 
                   11818: =cut
                   11819: 
                   11820: sub get_folder_hierarchy {
                   11821:     my ($navmap,$map,$showitem) = @_;
                   11822:     my @pathitems;
                   11823:     if (ref($navmap)) {
                   11824:         my $mapres = $navmap->getResourceByUrl($map);
                   11825:         if (ref($mapres)) {
                   11826:             my $pcslist = $mapres->map_hierarchy();
                   11827:             if ($pcslist ne '') {
                   11828:                 my @pcs = split(/,/,$pcslist);
                   11829:                 foreach my $pc (@pcs) {
                   11830:                     if ($pc == 1) {
                   11831:                         push(@pathitems,&mt('Main Course Documents'));
                   11832:                     } else {
                   11833:                         my $res = $navmap->getByMapPc($pc);
                   11834:                         if (ref($res)) {
                   11835:                             my $title = $res->compTitle();
                   11836:                             $title =~ s/\W+/_/g;
                   11837:                             if ($title ne '') {
                   11838:                                 push(@pathitems,$title);
                   11839:                             }
                   11840:                         }
                   11841:                     }
                   11842:                 }
                   11843:             }
1.1071    raeburn  11844:             if ($showitem) {
                   11845:                 if ($mapres->{ID} eq '0.0') {
                   11846:                     push(@pathitems,&mt('Main Course Documents'));
                   11847:                 } else {
                   11848:                     my $maptitle = $mapres->compTitle();
                   11849:                     $maptitle =~ s/\W+/_/g;
                   11850:                     if ($maptitle ne '') {
                   11851:                         push(@pathitems,$maptitle);
                   11852:                     }
1.1068    raeburn  11853:                 }
                   11854:             }
                   11855:         }
                   11856:     }
                   11857:     return @pathitems;
                   11858: }
                   11859: 
                   11860: =pod
                   11861: 
1.1015    raeburn  11862: =item * &get_turnedin_filepath()
                   11863: 
                   11864: Determines path in a user's portfolio file for storage of files uploaded
                   11865: to a specific essayresponse or dropbox item.
                   11866: 
                   11867: Inputs: 3 required + 1 optional.
                   11868: $symb is symb for resource, $uname and $udom are for current user (required).
                   11869: $caller is optional (can be "submission", if routine is called when storing
                   11870: an upoaded file when "Submit Answer" button was pressed).
                   11871: 
                   11872: Returns array containing $path and $multiresp. 
                   11873: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   11874: than one file upload item.  Callers of routine should append partid as a 
                   11875: subdirectory to $path in cases where $multiresp is 1.
                   11876: 
                   11877: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   11878: 
                   11879: =cut
                   11880: 
                   11881: sub get_turnedin_filepath {
                   11882:     my ($symb,$uname,$udom,$caller) = @_;
                   11883:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   11884:     my $turnindir;
                   11885:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   11886:     $turnindir = $userhash{'turnindir'};
                   11887:     my ($path,$multiresp);
                   11888:     if ($turnindir eq '') {
                   11889:         if ($caller eq 'submission') {
                   11890:             $turnindir = &mt('turned in');
                   11891:             $turnindir =~ s/\W+/_/g;
                   11892:             my %newhash = (
                   11893:                             'turnindir' => $turnindir,
                   11894:                           );
                   11895:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   11896:         }
                   11897:     }
                   11898:     if ($turnindir ne '') {
                   11899:         $path = '/'.$turnindir.'/';
                   11900:         my ($multipart,$turnin,@pathitems);
                   11901:         my $navmap = Apache::lonnavmaps::navmap->new();
                   11902:         if (defined($navmap)) {
                   11903:             my $mapres = $navmap->getResourceByUrl($map);
                   11904:             if (ref($mapres)) {
                   11905:                 my $pcslist = $mapres->map_hierarchy();
                   11906:                 if ($pcslist ne '') {
                   11907:                     foreach my $pc (split(/,/,$pcslist)) {
                   11908:                         my $res = $navmap->getByMapPc($pc);
                   11909:                         if (ref($res)) {
                   11910:                             my $title = $res->compTitle();
                   11911:                             $title =~ s/\W+/_/g;
                   11912:                             if ($title ne '') {
                   11913:                                 push(@pathitems,$title);
                   11914:                             }
                   11915:                         }
                   11916:                     }
                   11917:                 }
                   11918:                 my $maptitle = $mapres->compTitle();
                   11919:                 $maptitle =~ s/\W+/_/g;
                   11920:                 if ($maptitle ne '') {
                   11921:                     push(@pathitems,$maptitle);
                   11922:                 }
                   11923:                 unless ($env{'request.state'} eq 'construct') {
                   11924:                     my $res = $navmap->getBySymb($symb);
                   11925:                     if (ref($res)) {
                   11926:                         my $partlist = $res->parts();
                   11927:                         my $totaluploads = 0;
                   11928:                         if (ref($partlist) eq 'ARRAY') {
                   11929:                             foreach my $part (@{$partlist}) {
                   11930:                                 my @types = $res->responseType($part);
                   11931:                                 my @ids = $res->responseIds($part);
                   11932:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   11933:                                     if ($types[$i] eq 'essay') {
                   11934:                                         my $partid = $part.'_'.$ids[$i];
                   11935:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   11936:                                             $totaluploads ++;
                   11937:                                         }
                   11938:                                     }
                   11939:                                 }
                   11940:                             }
                   11941:                             if ($totaluploads > 1) {
                   11942:                                 $multiresp = 1;
                   11943:                             }
                   11944:                         }
                   11945:                     }
                   11946:                 }
                   11947:             } else {
                   11948:                 return;
                   11949:             }
                   11950:         } else {
                   11951:             return;
                   11952:         }
                   11953:         my $restitle=&Apache::lonnet::gettitle($symb);
                   11954:         $restitle =~ s/\W+/_/g;
                   11955:         if ($restitle eq '') {
                   11956:             $restitle = ($resurl =~ m{/[^/]+$});
                   11957:             if ($restitle eq '') {
                   11958:                 $restitle = time;
                   11959:             }
                   11960:         }
                   11961:         push(@pathitems,$restitle);
                   11962:         $path .= join('/',@pathitems);
                   11963:     }
                   11964:     return ($path,$multiresp);
                   11965: }
                   11966: 
                   11967: =pod
                   11968: 
1.464     albertel 11969: =back
1.41      ng       11970: 
1.112     bowersj2 11971: =head1 CSV Upload/Handling functions
1.38      albertel 11972: 
1.41      ng       11973: =over 4
                   11974: 
1.648     raeburn  11975: =item * &upfile_store($r)
1.41      ng       11976: 
                   11977: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 11978: needs $env{'form.upfile'}
1.41      ng       11979: returns $datatoken to be put into hidden field
                   11980: 
                   11981: =cut
1.31      albertel 11982: 
                   11983: sub upfile_store {
                   11984:     my $r=shift;
1.258     albertel 11985:     $env{'form.upfile'}=~s/\r/\n/gs;
                   11986:     $env{'form.upfile'}=~s/\f/\n/gs;
                   11987:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   11988:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 11989: 
1.258     albertel 11990:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   11991: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 11992:     {
1.158     raeburn  11993:         my $datafile = $r->dir_config('lonDaemons').
                   11994:                            '/tmp/'.$datatoken.'.tmp';
                   11995:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 11996:             print $fh $env{'form.upfile'};
1.158     raeburn  11997:             close($fh);
                   11998:         }
1.31      albertel 11999:     }
                   12000:     return $datatoken;
                   12001: }
                   12002: 
1.56      matthew  12003: =pod
                   12004: 
1.648     raeburn  12005: =item * &load_tmp_file($r)
1.41      ng       12006: 
                   12007: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 12008: needs $env{'form.datatoken'},
                   12009: sets $env{'form.upfile'} to the contents of the file
1.41      ng       12010: 
                   12011: =cut
1.31      albertel 12012: 
                   12013: sub load_tmp_file {
                   12014:     my $r=shift;
                   12015:     my @studentdata=();
                   12016:     {
1.158     raeburn  12017:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 12018:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  12019:         if ( open(my $fh,"<$studentfile") ) {
                   12020:             @studentdata=<$fh>;
                   12021:             close($fh);
                   12022:         }
1.31      albertel 12023:     }
1.258     albertel 12024:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 12025: }
                   12026: 
1.56      matthew  12027: =pod
                   12028: 
1.648     raeburn  12029: =item * &upfile_record_sep()
1.41      ng       12030: 
                   12031: Separate uploaded file into records
                   12032: returns array of records,
1.258     albertel 12033: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       12034: 
                   12035: =cut
1.31      albertel 12036: 
                   12037: sub upfile_record_sep {
1.258     albertel 12038:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 12039:     } else {
1.248     albertel 12040: 	my @records;
1.258     albertel 12041: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 12042: 	    if ($line=~/^\s*$/) { next; }
                   12043: 	    push(@records,$line);
                   12044: 	}
                   12045: 	return @records;
1.31      albertel 12046:     }
                   12047: }
                   12048: 
1.56      matthew  12049: =pod
                   12050: 
1.648     raeburn  12051: =item * &record_sep($record)
1.41      ng       12052: 
1.258     albertel 12053: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       12054: 
                   12055: =cut
                   12056: 
1.263     www      12057: sub takeleft {
                   12058:     my $index=shift;
                   12059:     return substr('0000'.$index,-4,4);
                   12060: }
                   12061: 
1.31      albertel 12062: sub record_sep {
                   12063:     my $record=shift;
                   12064:     my %components=();
1.258     albertel 12065:     if ($env{'form.upfiletype'} eq 'xml') {
                   12066:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 12067:         my $i=0;
1.356     albertel 12068:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 12069:             $field=~s/^(\"|\')//;
                   12070:             $field=~s/(\"|\')$//;
1.263     www      12071:             $components{&takeleft($i)}=$field;
1.31      albertel 12072:             $i++;
                   12073:         }
1.258     albertel 12074:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 12075:         my $i=0;
1.356     albertel 12076:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 12077:             $field=~s/^(\"|\')//;
                   12078:             $field=~s/(\"|\')$//;
1.263     www      12079:             $components{&takeleft($i)}=$field;
1.31      albertel 12080:             $i++;
                   12081:         }
                   12082:     } else {
1.561     www      12083:         my $separator=',';
1.480     banghart 12084:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      12085:             $separator=';';
1.480     banghart 12086:         }
1.31      albertel 12087:         my $i=0;
1.561     www      12088: # the character we are looking for to indicate the end of a quote or a record 
                   12089:         my $looking_for=$separator;
                   12090: # do not add the characters to the fields
                   12091:         my $ignore=0;
                   12092: # we just encountered a separator (or the beginning of the record)
                   12093:         my $just_found_separator=1;
                   12094: # store the field we are working on here
                   12095:         my $field='';
                   12096: # work our way through all characters in record
                   12097:         foreach my $character ($record=~/(.)/g) {
                   12098:             if ($character eq $looking_for) {
                   12099:                if ($character ne $separator) {
                   12100: # Found the end of a quote, again looking for separator
                   12101:                   $looking_for=$separator;
                   12102:                   $ignore=1;
                   12103:                } else {
                   12104: # Found a separator, store away what we got
                   12105:                   $components{&takeleft($i)}=$field;
                   12106: 	          $i++;
                   12107:                   $just_found_separator=1;
                   12108:                   $ignore=0;
                   12109:                   $field='';
                   12110:                }
                   12111:                next;
                   12112:             }
                   12113: # single or double quotation marks after a separator indicate beginning of a quote
                   12114: # we are now looking for the end of the quote and need to ignore separators
                   12115:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   12116:                $looking_for=$character;
                   12117:                next;
                   12118:             }
                   12119: # ignore would be true after we reached the end of a quote
                   12120:             if ($ignore) { next; }
                   12121:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   12122:             $field.=$character;
                   12123:             $just_found_separator=0; 
1.31      albertel 12124:         }
1.561     www      12125: # catch the very last entry, since we never encountered the separator
                   12126:         $components{&takeleft($i)}=$field;
1.31      albertel 12127:     }
                   12128:     return %components;
                   12129: }
                   12130: 
1.144     matthew  12131: ######################################################
                   12132: ######################################################
                   12133: 
1.56      matthew  12134: =pod
                   12135: 
1.648     raeburn  12136: =item * &upfile_select_html()
1.41      ng       12137: 
1.144     matthew  12138: Return HTML code to select a file from the users machine and specify 
                   12139: the file type.
1.41      ng       12140: 
                   12141: =cut
                   12142: 
1.144     matthew  12143: ######################################################
                   12144: ######################################################
1.31      albertel 12145: sub upfile_select_html {
1.144     matthew  12146:     my %Types = (
                   12147:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 12148:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  12149:                  space => &mt('Space separated'),
                   12150:                  tab   => &mt('Tabulator separated'),
                   12151: #                 xml   => &mt('HTML/XML'),
                   12152:                  );
                   12153:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  12154:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  12155:     foreach my $type (sort(keys(%Types))) {
                   12156:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   12157:     }
                   12158:     $Str .= "</select>\n";
                   12159:     return $Str;
1.31      albertel 12160: }
                   12161: 
1.301     albertel 12162: sub get_samples {
                   12163:     my ($records,$toget) = @_;
                   12164:     my @samples=({});
                   12165:     my $got=0;
                   12166:     foreach my $rec (@$records) {
                   12167: 	my %temp = &record_sep($rec);
                   12168: 	if (! grep(/\S/, values(%temp))) { next; }
                   12169: 	if (%temp) {
                   12170: 	    $samples[$got]=\%temp;
                   12171: 	    $got++;
                   12172: 	    if ($got == $toget) { last; }
                   12173: 	}
                   12174:     }
                   12175:     return \@samples;
                   12176: }
                   12177: 
1.144     matthew  12178: ######################################################
                   12179: ######################################################
                   12180: 
1.56      matthew  12181: =pod
                   12182: 
1.648     raeburn  12183: =item * &csv_print_samples($r,$records)
1.41      ng       12184: 
                   12185: Prints a table of sample values from each column uploaded $r is an
                   12186: Apache Request ref, $records is an arrayref from
                   12187: &Apache::loncommon::upfile_record_sep
                   12188: 
                   12189: =cut
                   12190: 
1.144     matthew  12191: ######################################################
                   12192: ######################################################
1.31      albertel 12193: sub csv_print_samples {
                   12194:     my ($r,$records) = @_;
1.662     bisitz   12195:     my $samples = &get_samples($records,5);
1.301     albertel 12196: 
1.594     raeburn  12197:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   12198:               &start_data_table_header_row());
1.356     albertel 12199:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   12200:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  12201:     $r->print(&end_data_table_header_row());
1.301     albertel 12202:     foreach my $hash (@$samples) {
1.594     raeburn  12203: 	$r->print(&start_data_table_row());
1.356     albertel 12204: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 12205: 	    $r->print('<td>');
1.356     albertel 12206: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 12207: 	    $r->print('</td>');
                   12208: 	}
1.594     raeburn  12209: 	$r->print(&end_data_table_row());
1.31      albertel 12210:     }
1.594     raeburn  12211:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 12212: }
                   12213: 
1.144     matthew  12214: ######################################################
                   12215: ######################################################
                   12216: 
1.56      matthew  12217: =pod
                   12218: 
1.648     raeburn  12219: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       12220: 
                   12221: Prints a table to create associations between values and table columns.
1.144     matthew  12222: 
1.41      ng       12223: $r is an Apache Request ref,
                   12224: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  12225: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       12226: 
                   12227: =cut
                   12228: 
1.144     matthew  12229: ######################################################
                   12230: ######################################################
1.31      albertel 12231: sub csv_print_select_table {
                   12232:     my ($r,$records,$d) = @_;
1.301     albertel 12233:     my $i=0;
                   12234:     my $samples = &get_samples($records,1);
1.144     matthew  12235:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  12236: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  12237:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  12238:               '<th>'.&mt('Column').'</th>'.
                   12239:               &end_data_table_header_row()."\n");
1.356     albertel 12240:     foreach my $array_ref (@$d) {
                   12241: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  12242: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 12243: 
1.875     bisitz   12244: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  12245: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 12246: 	$r->print('<option value="none"></option>');
1.356     albertel 12247: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   12248: 	    $r->print('<option value="'.$sample.'"'.
                   12249:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   12250:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 12251: 	}
1.594     raeburn  12252: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 12253: 	$i++;
                   12254:     }
1.594     raeburn  12255:     $r->print(&end_data_table());
1.31      albertel 12256:     $i--;
                   12257:     return $i;
                   12258: }
1.56      matthew  12259: 
1.144     matthew  12260: ######################################################
                   12261: ######################################################
                   12262: 
1.56      matthew  12263: =pod
1.31      albertel 12264: 
1.648     raeburn  12265: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       12266: 
                   12267: Prints a table of sample values from the upload and can make associate samples to internal names.
                   12268: 
                   12269: $r is an Apache Request ref,
                   12270: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   12271: $d is an array of 2 element arrays (internal name, displayed name)
                   12272: 
                   12273: =cut
                   12274: 
1.144     matthew  12275: ######################################################
                   12276: ######################################################
1.31      albertel 12277: sub csv_samples_select_table {
                   12278:     my ($r,$records,$d) = @_;
                   12279:     my $i=0;
1.144     matthew  12280:     #
1.662     bisitz   12281:     my $max_samples = 5;
                   12282:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  12283:     $r->print(&start_data_table().
                   12284:               &start_data_table_header_row().'<th>'.
                   12285:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   12286:               &end_data_table_header_row());
1.301     albertel 12287: 
                   12288:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  12289: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  12290: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 12291: 	foreach my $option (@$d) {
                   12292: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  12293: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 12294:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  12295:                       $display.'</option>');
1.31      albertel 12296: 	}
                   12297: 	$r->print('</select></td><td>');
1.662     bisitz   12298: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 12299: 	    if (defined($samples->[$line]{$key})) { 
                   12300: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   12301: 	    }
                   12302: 	}
1.594     raeburn  12303: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 12304: 	$i++;
                   12305:     }
1.594     raeburn  12306:     $r->print(&end_data_table());
1.31      albertel 12307:     $i--;
                   12308:     return($i);
1.115     matthew  12309: }
                   12310: 
1.144     matthew  12311: ######################################################
                   12312: ######################################################
                   12313: 
1.115     matthew  12314: =pod
                   12315: 
1.648     raeburn  12316: =item * &clean_excel_name($name)
1.115     matthew  12317: 
                   12318: Returns a replacement for $name which does not contain any illegal characters.
                   12319: 
                   12320: =cut
                   12321: 
1.144     matthew  12322: ######################################################
                   12323: ######################################################
1.115     matthew  12324: sub clean_excel_name {
                   12325:     my ($name) = @_;
                   12326:     $name =~ s/[:\*\?\/\\]//g;
                   12327:     if (length($name) > 31) {
                   12328:         $name = substr($name,0,31);
                   12329:     }
                   12330:     return $name;
1.25      albertel 12331: }
1.84      albertel 12332: 
1.85      albertel 12333: =pod
                   12334: 
1.648     raeburn  12335: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 12336: 
                   12337: Returns either 1 or undef
                   12338: 
                   12339: 1 if the part is to be hidden, undef if it is to be shown
                   12340: 
                   12341: Arguments are:
                   12342: 
                   12343: $id the id of the part to be checked
                   12344: $symb, optional the symb of the resource to check
                   12345: $udom, optional the domain of the user to check for
                   12346: $uname, optional the username of the user to check for
                   12347: 
                   12348: =cut
1.84      albertel 12349: 
                   12350: sub check_if_partid_hidden {
                   12351:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 12352:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 12353: 					 $symb,$udom,$uname);
1.141     albertel 12354:     my $truth=1;
                   12355:     #if the string starts with !, then the list is the list to show not hide
                   12356:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 12357:     my @hiddenlist=split(/,/,$hiddenparts);
                   12358:     foreach my $checkid (@hiddenlist) {
1.141     albertel 12359: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 12360:     }
1.141     albertel 12361:     return !$truth;
1.84      albertel 12362: }
1.127     matthew  12363: 
1.138     matthew  12364: 
                   12365: ############################################################
                   12366: ############################################################
                   12367: 
                   12368: =pod
                   12369: 
1.157     matthew  12370: =back 
                   12371: 
1.138     matthew  12372: =head1 cgi-bin script and graphing routines
                   12373: 
1.157     matthew  12374: =over 4
                   12375: 
1.648     raeburn  12376: =item * &get_cgi_id()
1.138     matthew  12377: 
                   12378: Inputs: none
                   12379: 
                   12380: Returns an id which can be used to pass environment variables
                   12381: to various cgi-bin scripts.  These environment variables will
                   12382: be removed from the users environment after a given time by
                   12383: the routine &Apache::lonnet::transfer_profile_to_env.
                   12384: 
                   12385: =cut
                   12386: 
                   12387: ############################################################
                   12388: ############################################################
1.152     albertel 12389: my $uniq=0;
1.136     matthew  12390: sub get_cgi_id {
1.154     albertel 12391:     $uniq=($uniq+1)%100000;
1.280     albertel 12392:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  12393: }
                   12394: 
1.127     matthew  12395: ############################################################
                   12396: ############################################################
                   12397: 
                   12398: =pod
                   12399: 
1.648     raeburn  12400: =item * &DrawBarGraph()
1.127     matthew  12401: 
1.138     matthew  12402: Facilitates the plotting of data in a (stacked) bar graph.
                   12403: Puts plot definition data into the users environment in order for 
                   12404: graph.png to plot it.  Returns an <img> tag for the plot.
                   12405: The bars on the plot are labeled '1','2',...,'n'.
                   12406: 
                   12407: Inputs:
                   12408: 
                   12409: =over 4
                   12410: 
                   12411: =item $Title: string, the title of the plot
                   12412: 
                   12413: =item $xlabel: string, text describing the X-axis of the plot
                   12414: 
                   12415: =item $ylabel: string, text describing the Y-axis of the plot
                   12416: 
                   12417: =item $Max: scalar, the maximum Y value to use in the plot
                   12418: If $Max is < any data point, the graph will not be rendered.
                   12419: 
1.140     matthew  12420: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  12421: they are plotted.  If undefined, default values will be used.
                   12422: 
1.178     matthew  12423: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   12424: 
1.138     matthew  12425: =item @Values: An array of array references.  Each array reference holds data
                   12426: to be plotted in a stacked bar chart.
                   12427: 
1.239     matthew  12428: =item If the final element of @Values is a hash reference the key/value
                   12429: pairs will be added to the graph definition.
                   12430: 
1.138     matthew  12431: =back
                   12432: 
                   12433: Returns:
                   12434: 
                   12435: An <img> tag which references graph.png and the appropriate identifying
                   12436: information for the plot.
                   12437: 
1.127     matthew  12438: =cut
                   12439: 
                   12440: ############################################################
                   12441: ############################################################
1.134     matthew  12442: sub DrawBarGraph {
1.178     matthew  12443:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  12444:     #
                   12445:     if (! defined($colors)) {
                   12446:         $colors = ['#33ff00', 
                   12447:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   12448:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   12449:                   ]; 
                   12450:     }
1.228     matthew  12451:     my $extra_settings = {};
                   12452:     if (ref($Values[-1]) eq 'HASH') {
                   12453:         $extra_settings = pop(@Values);
                   12454:     }
1.127     matthew  12455:     #
1.136     matthew  12456:     my $identifier = &get_cgi_id();
                   12457:     my $id = 'cgi.'.$identifier;        
1.129     matthew  12458:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  12459:         return '';
                   12460:     }
1.225     matthew  12461:     #
                   12462:     my @Labels;
                   12463:     if (defined($labels)) {
                   12464:         @Labels = @$labels;
                   12465:     } else {
                   12466:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   12467:             push (@Labels,$i+1);
                   12468:         }
                   12469:     }
                   12470:     #
1.129     matthew  12471:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  12472:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  12473:     my %ValuesHash;
                   12474:     my $NumSets=1;
                   12475:     foreach my $array (@Values) {
                   12476:         next if (! ref($array));
1.136     matthew  12477:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  12478:             join(',',@$array);
1.129     matthew  12479:     }
1.127     matthew  12480:     #
1.136     matthew  12481:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  12482:     if ($NumBars < 3) {
                   12483:         $width = 120+$NumBars*32;
1.220     matthew  12484:         $xskip = 1;
1.225     matthew  12485:         $bar_width = 30;
                   12486:     } elsif ($NumBars < 5) {
                   12487:         $width = 120+$NumBars*20;
                   12488:         $xskip = 1;
                   12489:         $bar_width = 20;
1.220     matthew  12490:     } elsif ($NumBars < 10) {
1.136     matthew  12491:         $width = 120+$NumBars*15;
                   12492:         $xskip = 1;
                   12493:         $bar_width = 15;
                   12494:     } elsif ($NumBars <= 25) {
                   12495:         $width = 120+$NumBars*11;
                   12496:         $xskip = 5;
                   12497:         $bar_width = 8;
                   12498:     } elsif ($NumBars <= 50) {
                   12499:         $width = 120+$NumBars*8;
                   12500:         $xskip = 5;
                   12501:         $bar_width = 4;
                   12502:     } else {
                   12503:         $width = 120+$NumBars*8;
                   12504:         $xskip = 5;
                   12505:         $bar_width = 4;
                   12506:     }
                   12507:     #
1.137     matthew  12508:     $Max = 1 if ($Max < 1);
                   12509:     if ( int($Max) < $Max ) {
                   12510:         $Max++;
                   12511:         $Max = int($Max);
                   12512:     }
1.127     matthew  12513:     $Title  = '' if (! defined($Title));
                   12514:     $xlabel = '' if (! defined($xlabel));
                   12515:     $ylabel = '' if (! defined($ylabel));
1.369     www      12516:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   12517:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   12518:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  12519:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  12520:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   12521:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   12522:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   12523:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12524:     $ValuesHash{$id.'.height'}   = $height;
                   12525:     $ValuesHash{$id.'.width'}    = $width;
                   12526:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   12527:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   12528:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  12529:     #
1.228     matthew  12530:     # Deal with other parameters
                   12531:     while (my ($key,$value) = each(%$extra_settings)) {
                   12532:         $ValuesHash{$id.'.'.$key} = $value;
                   12533:     }
                   12534:     #
1.646     raeburn  12535:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  12536:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12537: }
                   12538: 
                   12539: ############################################################
                   12540: ############################################################
                   12541: 
                   12542: =pod
                   12543: 
1.648     raeburn  12544: =item * &DrawXYGraph()
1.137     matthew  12545: 
1.138     matthew  12546: Facilitates the plotting of data in an XY graph.
                   12547: Puts plot definition data into the users environment in order for 
                   12548: graph.png to plot it.  Returns an <img> tag for the plot.
                   12549: 
                   12550: Inputs:
                   12551: 
                   12552: =over 4
                   12553: 
                   12554: =item $Title: string, the title of the plot
                   12555: 
                   12556: =item $xlabel: string, text describing the X-axis of the plot
                   12557: 
                   12558: =item $ylabel: string, text describing the Y-axis of the plot
                   12559: 
                   12560: =item $Max: scalar, the maximum Y value to use in the plot
                   12561: If $Max is < any data point, the graph will not be rendered.
                   12562: 
                   12563: =item $colors: Array ref containing the hex color codes for the data to be 
                   12564: plotted in.  If undefined, default values will be used.
                   12565: 
                   12566: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12567: 
                   12568: =item $Ydata: Array ref containing Array refs.  
1.185     www      12569: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  12570: 
                   12571: =item %Values: hash indicating or overriding any default values which are 
                   12572: passed to graph.png.  
                   12573: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12574: 
                   12575: =back
                   12576: 
                   12577: Returns:
                   12578: 
                   12579: An <img> tag which references graph.png and the appropriate identifying
                   12580: information for the plot.
                   12581: 
1.137     matthew  12582: =cut
                   12583: 
                   12584: ############################################################
                   12585: ############################################################
                   12586: sub DrawXYGraph {
                   12587:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   12588:     #
                   12589:     # Create the identifier for the graph
                   12590:     my $identifier = &get_cgi_id();
                   12591:     my $id = 'cgi.'.$identifier;
                   12592:     #
                   12593:     $Title  = '' if (! defined($Title));
                   12594:     $xlabel = '' if (! defined($xlabel));
                   12595:     $ylabel = '' if (! defined($ylabel));
                   12596:     my %ValuesHash = 
                   12597:         (
1.369     www      12598:          $id.'.title'  => &escape($Title),
                   12599:          $id.'.xlabel' => &escape($xlabel),
                   12600:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  12601:          $id.'.y_max_value'=> $Max,
                   12602:          $id.'.labels'     => join(',',@$Xlabels),
                   12603:          $id.'.PlotType'   => 'XY',
                   12604:          );
                   12605:     #
                   12606:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12607:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12608:     }
                   12609:     #
                   12610:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   12611:         return '';
                   12612:     }
                   12613:     my $NumSets=1;
1.138     matthew  12614:     foreach my $array (@{$Ydata}){
1.137     matthew  12615:         next if (! ref($array));
                   12616:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   12617:     }
1.138     matthew  12618:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  12619:     #
                   12620:     # Deal with other parameters
                   12621:     while (my ($key,$value) = each(%Values)) {
                   12622:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  12623:     }
                   12624:     #
1.646     raeburn  12625:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  12626:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   12627: }
                   12628: 
                   12629: ############################################################
                   12630: ############################################################
                   12631: 
                   12632: =pod
                   12633: 
1.648     raeburn  12634: =item * &DrawXYYGraph()
1.138     matthew  12635: 
                   12636: Facilitates the plotting of data in an XY graph with two Y axes.
                   12637: Puts plot definition data into the users environment in order for 
                   12638: graph.png to plot it.  Returns an <img> tag for the plot.
                   12639: 
                   12640: Inputs:
                   12641: 
                   12642: =over 4
                   12643: 
                   12644: =item $Title: string, the title of the plot
                   12645: 
                   12646: =item $xlabel: string, text describing the X-axis of the plot
                   12647: 
                   12648: =item $ylabel: string, text describing the Y-axis of the plot
                   12649: 
                   12650: =item $colors: Array ref containing the hex color codes for the data to be 
                   12651: plotted in.  If undefined, default values will be used.
                   12652: 
                   12653: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   12654: 
                   12655: =item $Ydata1: The first data set
                   12656: 
                   12657: =item $Min1: The minimum value of the left Y-axis
                   12658: 
                   12659: =item $Max1: The maximum value of the left Y-axis
                   12660: 
                   12661: =item $Ydata2: The second data set
                   12662: 
                   12663: =item $Min2: The minimum value of the right Y-axis
                   12664: 
                   12665: =item $Max2: The maximum value of the left Y-axis
                   12666: 
                   12667: =item %Values: hash indicating or overriding any default values which are 
                   12668: passed to graph.png.  
                   12669: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   12670: 
                   12671: =back
                   12672: 
                   12673: Returns:
                   12674: 
                   12675: An <img> tag which references graph.png and the appropriate identifying
                   12676: information for the plot.
1.136     matthew  12677: 
                   12678: =cut
                   12679: 
                   12680: ############################################################
                   12681: ############################################################
1.137     matthew  12682: sub DrawXYYGraph {
                   12683:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   12684:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  12685:     #
                   12686:     # Create the identifier for the graph
                   12687:     my $identifier = &get_cgi_id();
                   12688:     my $id = 'cgi.'.$identifier;
                   12689:     #
                   12690:     $Title  = '' if (! defined($Title));
                   12691:     $xlabel = '' if (! defined($xlabel));
                   12692:     $ylabel = '' if (! defined($ylabel));
                   12693:     my %ValuesHash = 
                   12694:         (
1.369     www      12695:          $id.'.title'  => &escape($Title),
                   12696:          $id.'.xlabel' => &escape($xlabel),
                   12697:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  12698:          $id.'.labels' => join(',',@$Xlabels),
                   12699:          $id.'.PlotType' => 'XY',
                   12700:          $id.'.NumSets' => 2,
1.137     matthew  12701:          $id.'.two_axes' => 1,
                   12702:          $id.'.y1_max_value' => $Max1,
                   12703:          $id.'.y1_min_value' => $Min1,
                   12704:          $id.'.y2_max_value' => $Max2,
                   12705:          $id.'.y2_min_value' => $Min2,
1.136     matthew  12706:          );
                   12707:     #
1.137     matthew  12708:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   12709:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   12710:     }
                   12711:     #
                   12712:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   12713:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  12714:         return '';
                   12715:     }
                   12716:     my $NumSets=1;
1.137     matthew  12717:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  12718:         next if (! ref($array));
                   12719:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  12720:     }
                   12721:     #
                   12722:     # Deal with other parameters
                   12723:     while (my ($key,$value) = each(%Values)) {
                   12724:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  12725:     }
                   12726:     #
1.646     raeburn  12727:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 12728:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  12729: }
                   12730: 
                   12731: ############################################################
                   12732: ############################################################
                   12733: 
                   12734: =pod
                   12735: 
1.157     matthew  12736: =back 
                   12737: 
1.139     matthew  12738: =head1 Statistics helper routines?  
                   12739: 
                   12740: Bad place for them but what the hell.
                   12741: 
1.157     matthew  12742: =over 4
                   12743: 
1.648     raeburn  12744: =item * &chartlink()
1.139     matthew  12745: 
                   12746: Returns a link to the chart for a specific student.  
                   12747: 
                   12748: Inputs:
                   12749: 
                   12750: =over 4
                   12751: 
                   12752: =item $linktext: The text of the link
                   12753: 
                   12754: =item $sname: The students username
                   12755: 
                   12756: =item $sdomain: The students domain
                   12757: 
                   12758: =back
                   12759: 
1.157     matthew  12760: =back
                   12761: 
1.139     matthew  12762: =cut
                   12763: 
                   12764: ############################################################
                   12765: ############################################################
                   12766: sub chartlink {
                   12767:     my ($linktext, $sname, $sdomain) = @_;
                   12768:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      12769:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 12770:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  12771:        '">'.$linktext.'</a>';
1.153     matthew  12772: }
                   12773: 
                   12774: #######################################################
                   12775: #######################################################
                   12776: 
                   12777: =pod
                   12778: 
                   12779: =head1 Course Environment Routines
1.157     matthew  12780: 
                   12781: =over 4
1.153     matthew  12782: 
1.648     raeburn  12783: =item * &restore_course_settings()
1.153     matthew  12784: 
1.648     raeburn  12785: =item * &store_course_settings()
1.153     matthew  12786: 
                   12787: Restores/Store indicated form parameters from the course environment.
                   12788: Will not overwrite existing values of the form parameters.
                   12789: 
                   12790: Inputs: 
                   12791: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   12792: 
                   12793: a hash ref describing the data to be stored.  For example:
                   12794:    
                   12795: %Save_Parameters = ('Status' => 'scalar',
                   12796:     'chartoutputmode' => 'scalar',
                   12797:     'chartoutputdata' => 'scalar',
                   12798:     'Section' => 'array',
1.373     raeburn  12799:     'Group' => 'array',
1.153     matthew  12800:     'StudentData' => 'array',
                   12801:     'Maps' => 'array');
                   12802: 
                   12803: Returns: both routines return nothing
                   12804: 
1.631     raeburn  12805: =back
                   12806: 
1.153     matthew  12807: =cut
                   12808: 
                   12809: #######################################################
                   12810: #######################################################
                   12811: sub store_course_settings {
1.496     albertel 12812:     return &store_settings($env{'request.course.id'},@_);
                   12813: }
                   12814: 
                   12815: sub store_settings {
1.153     matthew  12816:     # save to the environment
                   12817:     # appenv the same items, just to be safe
1.300     albertel 12818:     my $udom  = $env{'user.domain'};
                   12819:     my $uname = $env{'user.name'};
1.496     albertel 12820:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12821:     my %SaveHash;
                   12822:     my %AppHash;
                   12823:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 12824:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 12825:         my $envname = 'environment.'.$basename;
1.258     albertel 12826:         if (exists($env{'form.'.$setting})) {
1.153     matthew  12827:             # Save this value away
                   12828:             if ($type eq 'scalar' &&
1.258     albertel 12829:                 (! exists($env{$envname}) || 
                   12830:                  $env{$envname} ne $env{'form.'.$setting})) {
                   12831:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   12832:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  12833:             } elsif ($type eq 'array') {
                   12834:                 my $stored_form;
1.258     albertel 12835:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  12836:                     $stored_form = join(',',
                   12837:                                         map {
1.369     www      12838:                                             &escape($_);
1.258     albertel 12839:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  12840:                 } else {
                   12841:                     $stored_form = 
1.369     www      12842:                         &escape($env{'form.'.$setting});
1.153     matthew  12843:                 }
                   12844:                 # Determine if the array contents are the same.
1.258     albertel 12845:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  12846:                     $SaveHash{$basename} = $stored_form;
                   12847:                     $AppHash{$envname}   = $stored_form;
                   12848:                 }
                   12849:             }
                   12850:         }
                   12851:     }
                   12852:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 12853:                                           $udom,$uname);
1.153     matthew  12854:     if ($put_result !~ /^(ok|delayed)/) {
                   12855:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   12856:                                  'got error:'.$put_result);
                   12857:     }
                   12858:     # Make sure these settings stick around in this session, too
1.646     raeburn  12859:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  12860:     return;
                   12861: }
                   12862: 
                   12863: sub restore_course_settings {
1.499     albertel 12864:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 12865: }
                   12866: 
                   12867: sub restore_settings {
                   12868:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  12869:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 12870:         next if (exists($env{'form.'.$setting}));
1.496     albertel 12871:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  12872:             '.'.$setting;
1.258     albertel 12873:         if (exists($env{$envname})) {
1.153     matthew  12874:             if ($type eq 'scalar') {
1.258     albertel 12875:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  12876:             } elsif ($type eq 'array') {
1.258     albertel 12877:                 $env{'form.'.$setting} = [ 
1.153     matthew  12878:                                            map { 
1.369     www      12879:                                                &unescape($_); 
1.258     albertel 12880:                                            } split(',',$env{$envname})
1.153     matthew  12881:                                            ];
                   12882:             }
                   12883:         }
                   12884:     }
1.127     matthew  12885: }
                   12886: 
1.618     raeburn  12887: #######################################################
                   12888: #######################################################
                   12889: 
                   12890: =pod
                   12891: 
                   12892: =head1 Domain E-mail Routines  
                   12893: 
                   12894: =over 4
                   12895: 
1.648     raeburn  12896: =item * &build_recipient_list()
1.618     raeburn  12897: 
1.884     raeburn  12898: Build recipient lists for five types of e-mail:
1.766     raeburn  12899: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  12900: (d) Help requests, (e) Course requests needing approval,  generated by
                   12901: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   12902: loncoursequeueadmin.pm respectively.
1.618     raeburn  12903: 
                   12904: Inputs:
1.619     raeburn  12905: defmail (scalar - email address of default recipient), 
1.618     raeburn  12906: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  12907: defdom (domain for which to retrieve configuration settings),
                   12908: origmail (scalar - email address of recipient from loncapa.conf, 
                   12909: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  12910: 
1.655     raeburn  12911: Returns: comma separated list of addresses to which to send e-mail.
                   12912: 
                   12913: =back
1.618     raeburn  12914: 
                   12915: =cut
                   12916: 
                   12917: ############################################################
                   12918: ############################################################
                   12919: sub build_recipient_list {
1.619     raeburn  12920:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  12921:     my @recipients;
                   12922:     my $otheremails;
                   12923:     my %domconfig =
                   12924:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   12925:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  12926:         if (exists($domconfig{'contacts'}{$mailing})) {
                   12927:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   12928:                 my @contacts = ('adminemail','supportemail');
                   12929:                 foreach my $item (@contacts) {
                   12930:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   12931:                         my $addr = $domconfig{'contacts'}{$item}; 
                   12932:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12933:                             push(@recipients,$addr);
                   12934:                         }
1.619     raeburn  12935:                     }
1.766     raeburn  12936:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  12937:                 }
                   12938:             }
1.766     raeburn  12939:         } elsif ($origmail ne '') {
                   12940:             push(@recipients,$origmail);
1.618     raeburn  12941:         }
1.619     raeburn  12942:     } elsif ($origmail ne '') {
                   12943:         push(@recipients,$origmail);
1.618     raeburn  12944:     }
1.688     raeburn  12945:     if (defined($defmail)) {
                   12946:         if ($defmail ne '') {
                   12947:             push(@recipients,$defmail);
                   12948:         }
1.618     raeburn  12949:     }
                   12950:     if ($otheremails) {
1.619     raeburn  12951:         my @others;
                   12952:         if ($otheremails =~ /,/) {
                   12953:             @others = split(/,/,$otheremails);
1.618     raeburn  12954:         } else {
1.619     raeburn  12955:             push(@others,$otheremails);
                   12956:         }
                   12957:         foreach my $addr (@others) {
                   12958:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   12959:                 push(@recipients,$addr);
                   12960:             }
1.618     raeburn  12961:         }
                   12962:     }
1.619     raeburn  12963:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  12964:     return $recipientlist;
                   12965: }
                   12966: 
1.127     matthew  12967: ############################################################
                   12968: ############################################################
1.154     albertel 12969: 
1.655     raeburn  12970: =pod
                   12971: 
                   12972: =head1 Course Catalog Routines
                   12973: 
                   12974: =over 4
                   12975: 
                   12976: =item * &gather_categories()
                   12977: 
                   12978: Converts category definitions - keys of categories hash stored in  
                   12979: coursecategories in configuration.db on the primary library server in a 
                   12980: domain - to an array.  Also generates javascript and idx hash used to 
                   12981: generate Domain Coordinator interface for editing Course Categories.
                   12982: 
                   12983: Inputs:
1.663     raeburn  12984: 
1.655     raeburn  12985: categories (reference to hash of category definitions).
1.663     raeburn  12986: 
1.655     raeburn  12987: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   12988:       categories and subcategories).
1.663     raeburn  12989: 
1.655     raeburn  12990: idx (reference to hash of counters used in Domain Coordinator interface for 
                   12991:       editing Course Categories).
1.663     raeburn  12992: 
1.655     raeburn  12993: jsarray (reference to array of categories used to create Javascript arrays for
                   12994:          Domain Coordinator interface for editing Course Categories).
                   12995: 
                   12996: Returns: nothing
                   12997: 
                   12998: Side effects: populates cats, idx and jsarray. 
                   12999: 
                   13000: =cut
                   13001: 
                   13002: sub gather_categories {
                   13003:     my ($categories,$cats,$idx,$jsarray) = @_;
                   13004:     my %counters;
                   13005:     my $num = 0;
                   13006:     foreach my $item (keys(%{$categories})) {
                   13007:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   13008:         if ($container eq '' && $depth == 0) {
                   13009:             $cats->[$depth][$categories->{$item}] = $cat;
                   13010:         } else {
                   13011:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   13012:         }
                   13013:         my ($escitem,$tail) = split(/:/,$item,2);
                   13014:         if ($counters{$tail} eq '') {
                   13015:             $counters{$tail} = $num;
                   13016:             $num ++;
                   13017:         }
                   13018:         if (ref($idx) eq 'HASH') {
                   13019:             $idx->{$item} = $counters{$tail};
                   13020:         }
                   13021:         if (ref($jsarray) eq 'ARRAY') {
                   13022:             push(@{$jsarray->[$counters{$tail}]},$item);
                   13023:         }
                   13024:     }
                   13025:     return;
                   13026: }
                   13027: 
                   13028: =pod
                   13029: 
                   13030: =item * &extract_categories()
                   13031: 
                   13032: Used to generate breadcrumb trails for course categories.
                   13033: 
                   13034: Inputs:
1.663     raeburn  13035: 
1.655     raeburn  13036: categories (reference to hash of category definitions).
1.663     raeburn  13037: 
1.655     raeburn  13038: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   13039:       categories and subcategories).
1.663     raeburn  13040: 
1.655     raeburn  13041: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  13042: 
1.655     raeburn  13043: allitems (reference to hash - key is category key 
                   13044:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  13045: 
1.655     raeburn  13046: idx (reference to hash of counters used in Domain Coordinator interface for
                   13047:       editing Course Categories).
1.663     raeburn  13048: 
1.655     raeburn  13049: jsarray (reference to array of categories used to create Javascript arrays for
                   13050:          Domain Coordinator interface for editing Course Categories).
                   13051: 
1.665     raeburn  13052: subcats (reference to hash of arrays containing all subcategories within each 
                   13053:          category, -recursive)
                   13054: 
1.655     raeburn  13055: Returns: nothing
                   13056: 
                   13057: Side effects: populates trails and allitems hash references.
                   13058: 
                   13059: =cut
                   13060: 
                   13061: sub extract_categories {
1.665     raeburn  13062:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  13063:     if (ref($categories) eq 'HASH') {
                   13064:         &gather_categories($categories,$cats,$idx,$jsarray);
                   13065:         if (ref($cats->[0]) eq 'ARRAY') {
                   13066:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   13067:                 my $name = $cats->[0][$i];
                   13068:                 my $item = &escape($name).'::0';
                   13069:                 my $trailstr;
                   13070:                 if ($name eq 'instcode') {
                   13071:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  13072:                 } elsif ($name eq 'communities') {
                   13073:                     $trailstr = &mt('Communities');
1.655     raeburn  13074:                 } else {
                   13075:                     $trailstr = $name;
                   13076:                 }
                   13077:                 if ($allitems->{$item} eq '') {
                   13078:                     push(@{$trails},$trailstr);
                   13079:                     $allitems->{$item} = scalar(@{$trails})-1;
                   13080:                 }
                   13081:                 my @parents = ($name);
                   13082:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   13083:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   13084:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  13085:                         if (ref($subcats) eq 'HASH') {
                   13086:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   13087:                         }
                   13088:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   13089:                     }
                   13090:                 } else {
                   13091:                     if (ref($subcats) eq 'HASH') {
                   13092:                         $subcats->{$item} = [];
1.655     raeburn  13093:                     }
                   13094:                 }
                   13095:             }
                   13096:         }
                   13097:     }
                   13098:     return;
                   13099: }
                   13100: 
                   13101: =pod
                   13102: 
                   13103: =item *&recurse_categories()
                   13104: 
                   13105: Recursively used to generate breadcrumb trails for course categories.
                   13106: 
                   13107: Inputs:
1.663     raeburn  13108: 
1.655     raeburn  13109: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   13110:       categories and subcategories).
1.663     raeburn  13111: 
1.655     raeburn  13112: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  13113: 
                   13114: category (current course category, for which breadcrumb trail is being generated).
                   13115: 
                   13116: trails (reference to array of breadcrumb trails for each category).
                   13117: 
1.655     raeburn  13118: allitems (reference to hash - key is category key
                   13119:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  13120: 
1.655     raeburn  13121: parents (array containing containers directories for current category, 
                   13122:          back to top level). 
                   13123: 
                   13124: Returns: nothing
                   13125: 
                   13126: Side effects: populates trails and allitems hash references
                   13127: 
                   13128: =cut
                   13129: 
                   13130: sub recurse_categories {
1.665     raeburn  13131:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  13132:     my $shallower = $depth - 1;
                   13133:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   13134:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   13135:             my $name = $cats->[$depth]{$category}[$k];
                   13136:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   13137:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   13138:             if ($allitems->{$item} eq '') {
                   13139:                 push(@{$trails},$trailstr);
                   13140:                 $allitems->{$item} = scalar(@{$trails})-1;
                   13141:             }
                   13142:             my $deeper = $depth+1;
                   13143:             push(@{$parents},$category);
1.665     raeburn  13144:             if (ref($subcats) eq 'HASH') {
                   13145:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   13146:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   13147:                     my $higher;
                   13148:                     if ($j > 0) {
                   13149:                         $higher = &escape($parents->[$j]).':'.
                   13150:                                   &escape($parents->[$j-1]).':'.$j;
                   13151:                     } else {
                   13152:                         $higher = &escape($parents->[$j]).'::'.$j;
                   13153:                     }
                   13154:                     push(@{$subcats->{$higher}},$subcat);
                   13155:                 }
                   13156:             }
                   13157:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   13158:                                 $subcats);
1.655     raeburn  13159:             pop(@{$parents});
                   13160:         }
                   13161:     } else {
                   13162:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   13163:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   13164:         if ($allitems->{$item} eq '') {
                   13165:             push(@{$trails},$trailstr);
                   13166:             $allitems->{$item} = scalar(@{$trails})-1;
                   13167:         }
                   13168:     }
                   13169:     return;
                   13170: }
                   13171: 
1.663     raeburn  13172: =pod
                   13173: 
                   13174: =item *&assign_categories_table()
                   13175: 
                   13176: Create a datatable for display of hierarchical categories in a domain,
                   13177: with checkboxes to allow a course to be categorized. 
                   13178: 
                   13179: Inputs:
                   13180: 
                   13181: cathash - reference to hash of categories defined for the domain (from
                   13182:           configuration.db)
                   13183: 
                   13184: currcat - scalar with an & separated list of categories assigned to a course. 
                   13185: 
1.919     raeburn  13186: type    - scalar contains course type (Course or Community).
                   13187: 
1.663     raeburn  13188: Returns: $output (markup to be displayed) 
                   13189: 
                   13190: =cut
                   13191: 
                   13192: sub assign_categories_table {
1.919     raeburn  13193:     my ($cathash,$currcat,$type) = @_;
1.663     raeburn  13194:     my $output;
                   13195:     if (ref($cathash) eq 'HASH') {
                   13196:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   13197:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   13198:         $maxdepth = scalar(@cats);
                   13199:         if (@cats > 0) {
                   13200:             my $itemcount = 0;
                   13201:             if (ref($cats[0]) eq 'ARRAY') {
                   13202:                 my @currcategories;
                   13203:                 if ($currcat ne '') {
                   13204:                     @currcategories = split('&',$currcat);
                   13205:                 }
1.919     raeburn  13206:                 my $table;
1.663     raeburn  13207:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   13208:                     my $parent = $cats[0][$i];
1.919     raeburn  13209:                     next if ($parent eq 'instcode');
                   13210:                     if ($type eq 'Community') {
                   13211:                         next unless ($parent eq 'communities');
                   13212:                     } else {
                   13213:                         next if ($parent eq 'communities');
                   13214:                     }
1.663     raeburn  13215:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   13216:                     my $item = &escape($parent).'::0';
                   13217:                     my $checked = '';
                   13218:                     if (@currcategories > 0) {
                   13219:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   13220:                             $checked = ' checked="checked"';
1.663     raeburn  13221:                         }
                   13222:                     }
1.919     raeburn  13223:                     my $parent_title = $parent;
                   13224:                     if ($parent eq 'communities') {
                   13225:                         $parent_title = &mt('Communities');
                   13226:                     }
                   13227:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   13228:                               '<input type="checkbox" name="usecategory" value="'.
                   13229:                               $item.'"'.$checked.' />'.$parent_title.'</span>'.
                   13230:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  13231:                     my $depth = 1;
                   13232:                     push(@path,$parent);
1.919     raeburn  13233:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
1.663     raeburn  13234:                     pop(@path);
1.919     raeburn  13235:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  13236:                     $itemcount ++;
                   13237:                 }
1.919     raeburn  13238:                 if ($itemcount) {
                   13239:                     $output = &Apache::loncommon::start_data_table().
                   13240:                               $table.
                   13241:                               &Apache::loncommon::end_data_table();
                   13242:                 }
1.663     raeburn  13243:             }
                   13244:         }
                   13245:     }
                   13246:     return $output;
                   13247: }
                   13248: 
                   13249: =pod
                   13250: 
                   13251: =item *&assign_category_rows()
                   13252: 
                   13253: Create a datatable row for display of nested categories in a domain,
                   13254: with checkboxes to allow a course to be categorized,called recursively.
                   13255: 
                   13256: Inputs:
                   13257: 
                   13258: itemcount - track row number for alternating colors
                   13259: 
                   13260: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   13261:       categories and subcategories.
                   13262: 
                   13263: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   13264: 
                   13265: parent - parent of current category item
                   13266: 
                   13267: path - Array containing all categories back up through the hierarchy from the
                   13268:        current category to the top level.
                   13269: 
                   13270: currcategories - reference to array of current categories assigned to the course
                   13271: 
                   13272: Returns: $output (markup to be displayed).
                   13273: 
                   13274: =cut
                   13275: 
                   13276: sub assign_category_rows {
                   13277:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   13278:     my ($text,$name,$item,$chgstr);
                   13279:     if (ref($cats) eq 'ARRAY') {
                   13280:         my $maxdepth = scalar(@{$cats});
                   13281:         if (ref($cats->[$depth]) eq 'HASH') {
                   13282:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   13283:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   13284:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   13285:                 $text .= '<td><table class="LC_datatable">';
                   13286:                 for (my $j=0; $j<$numchildren; $j++) {
                   13287:                     $name = $cats->[$depth]{$parent}[$j];
                   13288:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   13289:                     my $deeper = $depth+1;
                   13290:                     my $checked = '';
                   13291:                     if (ref($currcategories) eq 'ARRAY') {
                   13292:                         if (@{$currcategories} > 0) {
                   13293:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   13294:                                 $checked = ' checked="checked"';
1.663     raeburn  13295:                             }
                   13296:                         }
                   13297:                     }
1.664     raeburn  13298:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   13299:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  13300:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   13301:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   13302:                              '</td><td>';
1.663     raeburn  13303:                     if (ref($path) eq 'ARRAY') {
                   13304:                         push(@{$path},$name);
                   13305:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   13306:                         pop(@{$path});
                   13307:                     }
                   13308:                     $text .= '</td></tr>';
                   13309:                 }
                   13310:                 $text .= '</table></td>';
                   13311:             }
                   13312:         }
                   13313:     }
                   13314:     return $text;
                   13315: }
                   13316: 
1.655     raeburn  13317: ############################################################
                   13318: ############################################################
                   13319: 
                   13320: 
1.443     albertel 13321: sub commit_customrole {
1.664     raeburn  13322:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  13323:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 13324:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   13325:                          ($end?', ending '.localtime($end):'').': <b>'.
                   13326:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  13327:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 13328:                  '</b><br />';
                   13329:     return $output;
                   13330: }
                   13331: 
                   13332: sub commit_standardrole {
1.1116    raeburn  13333:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  13334:     my ($output,$logmsg,$linefeed);
                   13335:     if ($context eq 'auto') {
                   13336:         $linefeed = "\n";
                   13337:     } else {
                   13338:         $linefeed = "<br />\n";
                   13339:     }  
1.443     albertel 13340:     if ($three eq 'st') {
1.541     raeburn  13341:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116    raeburn  13342:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  13343:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  13344:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   13345:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 13346:         } else {
1.541     raeburn  13347:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 13348:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  13349:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   13350:             if ($context eq 'auto') {
                   13351:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   13352:             } else {
                   13353:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   13354:                &mt('Add to classlist').': <b>ok</b>';
                   13355:             }
                   13356:             $output .= $linefeed;
1.443     albertel 13357:         }
                   13358:     } else {
                   13359:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   13360:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  13361:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  13362:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  13363:         if ($context eq 'auto') {
                   13364:             $output .= $result.$linefeed;
                   13365:         } else {
                   13366:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   13367:         }
1.443     albertel 13368:     }
                   13369:     return $output;
                   13370: }
                   13371: 
                   13372: sub commit_studentrole {
1.1116    raeburn  13373:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   13374:         $credits) = @_;
1.626     raeburn  13375:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  13376:     if ($context eq 'auto') {
                   13377:         $linefeed = "\n";
                   13378:     } else {
                   13379:         $linefeed = '<br />'."\n";
                   13380:     }
1.443     albertel 13381:     if (defined($one) && defined($two)) {
                   13382:         my $cid=$one.'_'.$two;
                   13383:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   13384:         my $secchange = 0;
                   13385:         my $expire_role_result;
                   13386:         my $modify_section_result;
1.628     raeburn  13387:         if ($oldsec ne '-1') { 
                   13388:             if ($oldsec ne $sec) {
1.443     albertel 13389:                 $secchange = 1;
1.628     raeburn  13390:                 my $now = time;
1.443     albertel 13391:                 my $uurl='/'.$cid;
                   13392:                 $uurl=~s/\_/\//g;
                   13393:                 if ($oldsec) {
                   13394:                     $uurl.='/'.$oldsec;
                   13395:                 }
1.626     raeburn  13396:                 $oldsecurl = $uurl;
1.628     raeburn  13397:                 $expire_role_result = 
1.652     raeburn  13398:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  13399:                 if ($env{'request.course.sec'} ne '') { 
                   13400:                     if ($expire_role_result eq 'refused') {
                   13401:                         my @roles = ('st');
                   13402:                         my @statuses = ('previous');
                   13403:                         my @roledoms = ($one);
                   13404:                         my $withsec = 1;
                   13405:                         my %roleshash = 
                   13406:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   13407:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   13408:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   13409:                             my ($oldstart,$oldend) = 
                   13410:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   13411:                             if ($oldend > 0 && $oldend <= $now) {
                   13412:                                 $expire_role_result = 'ok';
                   13413:                             }
                   13414:                         }
                   13415:                     }
                   13416:                 }
1.443     albertel 13417:                 $result = $expire_role_result;
                   13418:             }
                   13419:         }
                   13420:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  13421:             $modify_section_result = 
                   13422:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   13423:                                                            undef,undef,undef,$sec,
                   13424:                                                            $end,$start,'','',$cid,
                   13425:                                                            '',$context,$credits);
1.443     albertel 13426:             if ($modify_section_result =~ /^ok/) {
                   13427:                 if ($secchange == 1) {
1.628     raeburn  13428:                     if ($sec eq '') {
                   13429:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   13430:                     } else {
                   13431:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   13432:                     }
1.443     albertel 13433:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  13434:                     if ($sec eq '') {
                   13435:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   13436:                     } else {
                   13437:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13438:                     }
1.443     albertel 13439:                 } else {
1.628     raeburn  13440:                     if ($sec eq '') {
                   13441:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   13442:                     } else {
                   13443:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   13444:                     }
1.443     albertel 13445:                 }
                   13446:             } else {
1.1115    raeburn  13447:                 if ($secchange) { 
1.628     raeburn  13448:                     $$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;
                   13449:                 } else {
                   13450:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   13451:                 }
1.443     albertel 13452:             }
                   13453:             $result = $modify_section_result;
                   13454:         } elsif ($secchange == 1) {
1.628     raeburn  13455:             if ($oldsec eq '') {
1.1103    raeburn  13456:                 $$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  13457:             } else {
                   13458:                 $$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;
                   13459:             }
1.626     raeburn  13460:             if ($expire_role_result eq 'refused') {
                   13461:                 my $newsecurl = '/'.$cid;
                   13462:                 $newsecurl =~ s/\_/\//g;
                   13463:                 if ($sec ne '') {
                   13464:                     $newsecurl.='/'.$sec;
                   13465:                 }
                   13466:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   13467:                     if ($sec eq '') {
                   13468:                         $$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;
                   13469:                     } else {
                   13470:                         $$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;
                   13471:                     }
                   13472:                 }
                   13473:             }
1.443     albertel 13474:         }
                   13475:     } else {
1.626     raeburn  13476:         $$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 13477:         $result = "error: incomplete course id\n";
                   13478:     }
                   13479:     return $result;
                   13480: }
                   13481: 
1.1108    raeburn  13482: sub show_role_extent {
                   13483:     my ($scope,$context,$role) = @_;
                   13484:     $scope =~ s{^/}{};
                   13485:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   13486:     push(@courseroles,'co');
                   13487:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   13488:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   13489:         $scope =~ s{/}{_};
                   13490:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   13491:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   13492:         my ($audom,$auname) = split(/\//,$scope);
                   13493:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   13494:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   13495:     } else {
                   13496:         $scope =~ s{/$}{};
                   13497:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   13498:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   13499:     }
                   13500: }
                   13501: 
1.443     albertel 13502: ############################################################
                   13503: ############################################################
                   13504: 
1.566     albertel 13505: sub check_clone {
1.578     raeburn  13506:     my ($args,$linefeed) = @_;
1.566     albertel 13507:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   13508:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   13509:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   13510:     my $clonemsg;
                   13511:     my $can_clone = 0;
1.944     raeburn  13512:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  13513:     if ($lctype ne 'community') {
                   13514:         $lctype = 'course';
                   13515:     }
1.566     albertel 13516:     if ($clonehome eq 'no_host') {
1.944     raeburn  13517:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13518:             $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'});
                   13519:         } else {
                   13520:             $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'});
                   13521:         }     
1.566     albertel 13522:     } else {
                   13523: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  13524:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13525:             if ($clonedesc{'type'} ne 'Community') {
                   13526:                  $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'});
                   13527:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13528:             }
                   13529:         }
1.882     raeburn  13530: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   13531:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 13532: 	    $can_clone = 1;
                   13533: 	} else {
                   13534: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   13535: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   13536: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  13537:             if (grep(/^\*$/,@cloners)) {
                   13538:                 $can_clone = 1;
                   13539:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   13540:                 $can_clone = 1;
                   13541:             } else {
1.908     raeburn  13542:                 my $ccrole = 'cc';
1.944     raeburn  13543:                 if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13544:                     $ccrole = 'co';
                   13545:                 }
1.578     raeburn  13546: 	        my %roleshash =
                   13547: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   13548: 					 $args->{'ccdomain'},
1.908     raeburn  13549:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  13550: 					 [$args->{'clonedomain'}]);
1.908     raeburn  13551: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.942     raeburn  13552:                     $can_clone = 1;
                   13553:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
                   13554:                     $can_clone = 1;
                   13555:                 } else {
1.944     raeburn  13556:                     if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  13557:                         $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'});
                   13558:                     } else {
                   13559:                         $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'});
                   13560:                     }
1.578     raeburn  13561: 	        }
1.566     albertel 13562: 	    }
1.578     raeburn  13563:         }
1.566     albertel 13564:     }
                   13565:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13566: }
                   13567: 
1.444     albertel 13568: sub construct_course {
1.885     raeburn  13569:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 13570:     my $outcome;
1.541     raeburn  13571:     my $linefeed =  '<br />'."\n";
                   13572:     if ($context eq 'auto') {
                   13573:         $linefeed = "\n";
                   13574:     }
1.566     albertel 13575: 
                   13576: #
                   13577: # Are we cloning?
                   13578: #
                   13579:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   13580:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  13581: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 13582: 	if ($context ne 'auto') {
1.578     raeburn  13583:             if ($clonemsg ne '') {
                   13584: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   13585:             }
1.566     albertel 13586: 	}
                   13587: 	$outcome .= $clonemsg.$linefeed;
                   13588: 
                   13589:         if (!$can_clone) {
                   13590: 	    return (0,$outcome);
                   13591: 	}
                   13592:     }
                   13593: 
1.444     albertel 13594: #
                   13595: # Open course
                   13596: #
                   13597:     my $crstype = lc($args->{'crstype'});
                   13598:     my %cenv=();
                   13599:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   13600:                                              $args->{'cdescr'},
                   13601:                                              $args->{'curl'},
                   13602:                                              $args->{'course_home'},
                   13603:                                              $args->{'nonstandard'},
                   13604:                                              $args->{'crscode'},
                   13605:                                              $args->{'ccuname'}.':'.
                   13606:                                              $args->{'ccdomain'},
1.882     raeburn  13607:                                              $args->{'crstype'},
1.885     raeburn  13608:                                              $cnum,$context,$category);
1.444     albertel 13609: 
                   13610:     # Note: The testing routines depend on this being output; see 
                   13611:     # Utils::Course. This needs to at least be output as a comment
                   13612:     # if anyone ever decides to not show this, and Utils::Course::new
                   13613:     # will need to be suitably modified.
1.541     raeburn  13614:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  13615:     if ($$courseid =~ /^error:/) {
                   13616:         return (0,$outcome);
                   13617:     }
                   13618: 
1.444     albertel 13619: #
                   13620: # Check if created correctly
                   13621: #
1.479     albertel 13622:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 13623:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  13624:     if ($crsuhome eq 'no_host') {
                   13625:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   13626:         return (0,$outcome);
                   13627:     }
1.541     raeburn  13628:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 13629: 
1.444     albertel 13630: #
1.566     albertel 13631: # Do the cloning
                   13632: #   
                   13633:     if ($can_clone && $cloneid) {
                   13634: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   13635: 	if ($context ne 'auto') {
                   13636: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   13637: 	}
                   13638: 	$outcome .= $clonemsg.$linefeed;
                   13639: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 13640: # Copy all files
1.637     www      13641: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 13642: # Restore URL
1.566     albertel 13643: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 13644: # Restore title
1.566     albertel 13645: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  13646: # Restore creation date, creator and creation context.
                   13647:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   13648:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   13649:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 13650: # Mark as cloned
1.566     albertel 13651: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      13652: # Need to clone grading mode
                   13653:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   13654:         $cenv{'grading'}=$newenv{'grading'};
                   13655: # Do not clone these environment entries
                   13656:         &Apache::lonnet::del('environment',
                   13657:                   ['default_enrollment_start_date',
                   13658:                    'default_enrollment_end_date',
                   13659:                    'question.email',
                   13660:                    'policy.email',
                   13661:                    'comment.email',
                   13662:                    'pch.users.denied',
1.725     raeburn  13663:                    'plc.users.denied',
                   13664:                    'hidefromcat',
1.1121    raeburn  13665:                    'checkforpriv',
1.725     raeburn  13666:                    'categories'],
1.638     www      13667:                    $$crsudom,$$crsunum);
1.444     albertel 13668:     }
1.566     albertel 13669: 
1.444     albertel 13670: #
                   13671: # Set environment (will override cloned, if existing)
                   13672: #
                   13673:     my @sections = ();
                   13674:     my @xlists = ();
                   13675:     if ($args->{'crstype'}) {
                   13676:         $cenv{'type'}=$args->{'crstype'};
                   13677:     }
                   13678:     if ($args->{'crsid'}) {
                   13679:         $cenv{'courseid'}=$args->{'crsid'};
                   13680:     }
                   13681:     if ($args->{'crscode'}) {
                   13682:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   13683:     }
                   13684:     if ($args->{'crsquota'} ne '') {
                   13685:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   13686:     } else {
                   13687:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   13688:     }
                   13689:     if ($args->{'ccuname'}) {
                   13690:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   13691:                                         ':'.$args->{'ccdomain'};
                   13692:     } else {
                   13693:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   13694:     }
1.1116    raeburn  13695:     if ($args->{'defaultcredits'}) {
                   13696:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   13697:     }
1.444     albertel 13698:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   13699:     if ($args->{'crssections'}) {
                   13700:         $cenv{'internal.sectionnums'} = '';
                   13701:         if ($args->{'crssections'} =~ m/,/) {
                   13702:             @sections = split/,/,$args->{'crssections'};
                   13703:         } else {
                   13704:             $sections[0] = $args->{'crssections'};
                   13705:         }
                   13706:         if (@sections > 0) {
                   13707:             foreach my $item (@sections) {
                   13708:                 my ($sec,$gp) = split/:/,$item;
                   13709:                 my $class = $args->{'crscode'}.$sec;
                   13710:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   13711:                 $cenv{'internal.sectionnums'} .= $item.',';
                   13712:                 unless ($addcheck eq 'ok') {
                   13713:                     push @badclasses, $class;
                   13714:                 }
                   13715:             }
                   13716:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   13717:         }
                   13718:     }
                   13719: # do not hide course coordinator from staff listing, 
                   13720: # even if privileged
                   13721:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  13722: # add course coordinator's domain to domains to check for privileged users
                   13723: # if different to course domain
                   13724:     if ($$crsudom ne $args->{'ccdomain'}) {
                   13725:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   13726:     }
1.444     albertel 13727: # add crosslistings
                   13728:     if ($args->{'crsxlist'}) {
                   13729:         $cenv{'internal.crosslistings'}='';
                   13730:         if ($args->{'crsxlist'} =~ m/,/) {
                   13731:             @xlists = split/,/,$args->{'crsxlist'};
                   13732:         } else {
                   13733:             $xlists[0] = $args->{'crsxlist'};
                   13734:         }
                   13735:         if (@xlists > 0) {
                   13736:             foreach my $item (@xlists) {
                   13737:                 my ($xl,$gp) = split/:/,$item;
                   13738:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   13739:                 $cenv{'internal.crosslistings'} .= $item.',';
                   13740:                 unless ($addcheck eq 'ok') {
                   13741:                     push @badclasses, $xl;
                   13742:                 }
                   13743:             }
                   13744:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   13745:         }
                   13746:     }
                   13747:     if ($args->{'autoadds'}) {
                   13748:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   13749:     }
                   13750:     if ($args->{'autodrops'}) {
                   13751:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   13752:     }
                   13753: # check for notification of enrollment changes
                   13754:     my @notified = ();
                   13755:     if ($args->{'notify_owner'}) {
                   13756:         if ($args->{'ccuname'} ne '') {
                   13757:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   13758:         }
                   13759:     }
                   13760:     if ($args->{'notify_dc'}) {
                   13761:         if ($uname ne '') { 
1.630     raeburn  13762:             push(@notified,$uname.':'.$udom);
1.444     albertel 13763:         }
                   13764:     }
                   13765:     if (@notified > 0) {
                   13766:         my $notifylist;
                   13767:         if (@notified > 1) {
                   13768:             $notifylist = join(',',@notified);
                   13769:         } else {
                   13770:             $notifylist = $notified[0];
                   13771:         }
                   13772:         $cenv{'internal.notifylist'} = $notifylist;
                   13773:     }
                   13774:     if (@badclasses > 0) {
                   13775:         my %lt=&Apache::lonlocal::texthash(
                   13776:                 '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',
                   13777:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   13778:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   13779:         );
1.541     raeburn  13780:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   13781:                            ' ('.$lt{'adby'}.')';
                   13782:         if ($context eq 'auto') {
                   13783:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 13784:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  13785:             foreach my $item (@badclasses) {
                   13786:                 if ($context eq 'auto') {
                   13787:                     $outcome .= " - $item\n";
                   13788:                 } else {
                   13789:                     $outcome .= "<li>$item</li>\n";
                   13790:                 }
                   13791:             }
                   13792:             if ($context eq 'auto') {
                   13793:                 $outcome .= $linefeed;
                   13794:             } else {
1.566     albertel 13795:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  13796:             }
                   13797:         } 
1.444     albertel 13798:     }
                   13799:     if ($args->{'no_end_date'}) {
                   13800:         $args->{'endaccess'} = 0;
                   13801:     }
                   13802:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   13803:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   13804:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   13805:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   13806:     if ($args->{'showphotos'}) {
                   13807:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   13808:     }
                   13809:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   13810:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   13811:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   13812:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  13813:             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'); 
                   13814:             if ($context eq 'auto') {
                   13815:                 $outcome .= $krb_msg;
                   13816:             } else {
1.566     albertel 13817:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  13818:             }
                   13819:             $outcome .= $linefeed;
1.444     albertel 13820:         }
                   13821:     }
                   13822:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   13823:        if ($args->{'setpolicy'}) {
                   13824:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13825:        }
                   13826:        if ($args->{'setcontent'}) {
                   13827:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   13828:        }
                   13829:     }
                   13830:     if ($args->{'reshome'}) {
                   13831: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   13832: 	$cenv{'reshome'}=~s/\/+$/\//;
                   13833:     }
                   13834: #
                   13835: # course has keyed access
                   13836: #
                   13837:     if ($args->{'setkeys'}) {
                   13838:        $cenv{'keyaccess'}='yes';
                   13839:     }
                   13840: # if specified, key authority is not course, but user
                   13841: # only active if keyaccess is yes
                   13842:     if ($args->{'keyauth'}) {
1.487     albertel 13843: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   13844: 	$user = &LONCAPA::clean_username($user);
                   13845: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     13846: 	if ($user ne '' && $domain ne '') {
1.487     albertel 13847: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 13848: 	}
                   13849:     }
                   13850: 
                   13851:     if ($args->{'disresdis'}) {
                   13852:         $cenv{'pch.roles.denied'}='st';
                   13853:     }
                   13854:     if ($args->{'disablechat'}) {
                   13855:         $cenv{'plc.roles.denied'}='st';
                   13856:     }
                   13857: 
                   13858:     # Record we've not yet viewed the Course Initialization Helper for this 
                   13859:     # course
                   13860:     $cenv{'course.helper.not.run'} = 1;
                   13861:     #
                   13862:     # Use new Randomseed
                   13863:     #
                   13864:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   13865:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   13866:     #
                   13867:     # The encryption code and receipt prefix for this course
                   13868:     #
                   13869:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   13870:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   13871:     #
                   13872:     # By default, use standard grading
                   13873:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   13874: 
1.541     raeburn  13875:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   13876:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13877: #
                   13878: # Open all assignments
                   13879: #
                   13880:     if ($args->{'openall'}) {
                   13881:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   13882:        my %storecontent = ($storeunder         => time,
                   13883:                            $storeunder.'.type' => 'date_start');
                   13884:        
                   13885:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  13886:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 13887:    }
                   13888: #
                   13889: # Set first page
                   13890: #
                   13891:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   13892: 	    || ($cloneid)) {
1.445     albertel 13893: 	use LONCAPA::map;
1.444     albertel 13894: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 13895: 
                   13896: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   13897:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   13898: 
1.444     albertel 13899:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   13900:         my $title; my $url;
                   13901:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   13902: 	    $title=&mt('Syllabus');
1.444     albertel 13903:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   13904:         } else {
1.963     raeburn  13905:             $title=&mt('Table of Contents');
1.444     albertel 13906:             $url='/adm/navmaps';
                   13907:         }
1.445     albertel 13908: 
                   13909:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   13910: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   13911: 
                   13912: 	if ($errtext) { $fatal=2; }
1.541     raeburn  13913:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 13914:     }
1.566     albertel 13915: 
                   13916:     return (1,$outcome);
1.444     albertel 13917: }
                   13918: 
                   13919: ############################################################
                   13920: ############################################################
                   13921: 
1.953     droeschl 13922: #SD
                   13923: # only Community and Course, or anything else?
1.378     raeburn  13924: sub course_type {
                   13925:     my ($cid) = @_;
                   13926:     if (!defined($cid)) {
                   13927:         $cid = $env{'request.course.id'};
                   13928:     }
1.404     albertel 13929:     if (defined($env{'course.'.$cid.'.type'})) {
                   13930:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  13931:     } else {
                   13932:         return 'Course';
1.377     raeburn  13933:     }
                   13934: }
1.156     albertel 13935: 
1.406     raeburn  13936: sub group_term {
                   13937:     my $crstype = &course_type();
                   13938:     my %names = (
                   13939:                   'Course' => 'group',
1.865     raeburn  13940:                   'Community' => 'group',
1.406     raeburn  13941:                 );
                   13942:     return $names{$crstype};
                   13943: }
                   13944: 
1.902     raeburn  13945: sub course_types {
                   13946:     my @types = ('official','unofficial','community');
                   13947:     my %typename = (
                   13948:                          official   => 'Official course',
                   13949:                          unofficial => 'Unofficial course',
                   13950:                          community  => 'Community',
                   13951:                    );
                   13952:     return (\@types,\%typename);
                   13953: }
                   13954: 
1.156     albertel 13955: sub icon {
                   13956:     my ($file)=@_;
1.505     albertel 13957:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 13958:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 13959:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 13960:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   13961: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   13962: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13963: 	            $curfext.".gif") {
                   13964: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   13965: 		$curfext.".gif";
                   13966: 	}
                   13967:     }
1.249     albertel 13968:     return &lonhttpdurl($iconname);
1.154     albertel 13969: } 
1.84      albertel 13970: 
1.575     albertel 13971: sub lonhttpdurl {
1.692     www      13972: #
                   13973: # Had been used for "small fry" static images on separate port 8080.
                   13974: # Modify here if lightweight http functionality desired again.
                   13975: # Currently eliminated due to increasing firewall issues.
                   13976: #
1.575     albertel 13977:     my ($url)=@_;
1.692     www      13978:     return $url;
1.215     albertel 13979: }
                   13980: 
1.213     albertel 13981: sub connection_aborted {
                   13982:     my ($r)=@_;
                   13983:     $r->print(" ");$r->rflush();
                   13984:     my $c = $r->connection;
                   13985:     return $c->aborted();
                   13986: }
                   13987: 
1.221     foxr     13988: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     13989: #    strings as 'strings'.
                   13990: sub escape_single {
1.221     foxr     13991:     my ($input) = @_;
1.223     albertel 13992:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     13993:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   13994:     return $input;
                   13995: }
1.223     albertel 13996: 
1.222     foxr     13997: #  Same as escape_single, but escape's "'s  This 
                   13998: #  can be used for  "strings"
                   13999: sub escape_double {
                   14000:     my ($input) = @_;
                   14001:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   14002:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   14003:     return $input;
                   14004: }
1.223     albertel 14005:  
1.222     foxr     14006: #   Escapes the last element of a full URL.
                   14007: sub escape_url {
                   14008:     my ($url)   = @_;
1.238     raeburn  14009:     my @urlslices = split(/\//, $url,-1);
1.369     www      14010:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 14011:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     14012: }
1.462     albertel 14013: 
1.820     raeburn  14014: sub compare_arrays {
                   14015:     my ($arrayref1,$arrayref2) = @_;
                   14016:     my (@difference,%count);
                   14017:     @difference = ();
                   14018:     %count = ();
                   14019:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   14020:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   14021:         foreach my $element (keys(%count)) {
                   14022:             if ($count{$element} == 1) {
                   14023:                 push(@difference,$element);
                   14024:             }
                   14025:         }
                   14026:     }
                   14027:     return @difference;
                   14028: }
                   14029: 
1.817     bisitz   14030: # -------------------------------------------------------- Initialize user login
1.462     albertel 14031: sub init_user_environment {
1.463     albertel 14032:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 14033:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   14034: 
                   14035:     my $public=($username eq 'public' && $domain eq 'public');
                   14036: 
                   14037: # See if old ID present, if so, remove
                   14038: 
1.1062    raeburn  14039:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 14040:     my $now=time;
                   14041: 
                   14042:     if ($public) {
                   14043: 	my $max_public=100;
                   14044: 	my $oldest;
                   14045: 	my $oldest_time=0;
                   14046: 	for(my $next=1;$next<=$max_public;$next++) {
                   14047: 	    if (-e $lonids."/publicuser_$next.id") {
                   14048: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   14049: 		if ($mtime<$oldest_time || !$oldest_time) {
                   14050: 		    $oldest_time=$mtime;
                   14051: 		    $oldest=$next;
                   14052: 		}
                   14053: 	    } else {
                   14054: 		$cookie="publicuser_$next";
                   14055: 		last;
                   14056: 	    }
                   14057: 	}
                   14058: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   14059:     } else {
1.463     albertel 14060: 	# if this isn't a robot, kill any existing non-robot sessions
                   14061: 	if (!$args->{'robot'}) {
                   14062: 	    opendir(DIR,$lonids);
                   14063: 	    while ($filename=readdir(DIR)) {
                   14064: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   14065: 		    unlink($lonids.'/'.$filename);
                   14066: 		}
1.462     albertel 14067: 	    }
1.463     albertel 14068: 	    closedir(DIR);
1.462     albertel 14069: 	}
                   14070: # Give them a new cookie
1.463     albertel 14071: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      14072: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 14073: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 14074:     
                   14075: # Initialize roles
                   14076: 
1.1062    raeburn  14077: 	($userroles,$firstaccenv,$timerintenv) = 
                   14078:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 14079:     }
                   14080: # ------------------------------------ Check browser type and MathML capability
                   14081: 
                   14082:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   14083:         $clientunicode,$clientos) = &decode_user_agent($r);
                   14084: 
                   14085: # ------------------------------------------------------------- Get environment
                   14086: 
                   14087:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   14088:     my ($tmp) = keys(%userenv);
                   14089:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   14090:     } else {
                   14091: 	undef(%userenv);
                   14092:     }
                   14093:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   14094: 	$form->{'interface'}=$userenv{'interface'};
                   14095:     }
                   14096:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   14097: 
                   14098: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   14099:     foreach my $option ('interface','localpath','localres') {
                   14100:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 14101:     }
                   14102: # --------------------------------------------------------- Write first profile
                   14103: 
                   14104:     {
                   14105: 	my %initial_env = 
                   14106: 	    ("user.name"          => $username,
                   14107: 	     "user.domain"        => $domain,
                   14108: 	     "user.home"          => $authhost,
                   14109: 	     "browser.type"       => $clientbrowser,
                   14110: 	     "browser.version"    => $clientversion,
                   14111: 	     "browser.mathml"     => $clientmathml,
                   14112: 	     "browser.unicode"    => $clientunicode,
                   14113: 	     "browser.os"         => $clientos,
                   14114: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   14115: 	     "request.course.fn"  => '',
                   14116: 	     "request.course.uri" => '',
                   14117: 	     "request.course.sec" => '',
                   14118: 	     "request.role"       => 'cm',
                   14119: 	     "request.role.adv"   => $env{'user.adv'},
                   14120: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   14121: 
                   14122:         if ($form->{'localpath'}) {
                   14123: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   14124: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   14125:         }
                   14126: 	
                   14127: 	if ($form->{'interface'}) {
                   14128: 	    $form->{'interface'}=~s/\W//gs;
                   14129: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   14130: 	    $env{'browser.interface'}=$form->{'interface'};
                   14131: 	}
                   14132: 
1.981     raeburn  14133:         my %is_adv = ( is_adv => $env{'user.adv'} );
1.1016    raeburn  14134:         my %domdef;
                   14135:         unless ($domain eq 'public') {
                   14136:             %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   14137:         }
1.980     raeburn  14138: 
1.1081    raeburn  14139:         foreach my $tool ('aboutme','blog','webdav','portfolio') {
1.724     raeburn  14140:             $userenv{'availabletools.'.$tool} = 
1.980     raeburn  14141:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   14142:                                                   undef,\%userenv,\%domdef,\%is_adv);
1.724     raeburn  14143:         }
                   14144: 
1.864     raeburn  14145:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  14146:             $userenv{'canrequest.'.$crstype} =
                   14147:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
1.980     raeburn  14148:                                                   'reload','requestcourses',
                   14149:                                                   \%userenv,\%domdef,\%is_adv);
1.765     raeburn  14150:         }
                   14151: 
1.1092    raeburn  14152:         $userenv{'canrequest.author'} =
                   14153:             &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   14154:                                         'reload','requestauthor',
                   14155:                                         \%userenv,\%domdef,\%is_adv);
                   14156:         my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   14157:                                              $domain,$username);
                   14158:         my $reqstatus = $reqauthor{'author_status'};
                   14159:         if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   14160:             if (ref($reqauthor{'author'}) eq 'HASH') {
                   14161:                 $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   14162:                                                   $reqauthor{'author'}{'timestamp'};
                   14163:             }
                   14164:         }
                   14165: 
1.462     albertel 14166: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  14167: 
1.462     albertel 14168: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   14169: 		 &GDBM_WRCREAT(),0640)) {
                   14170: 	    &_add_to_env(\%disk_env,\%initial_env);
                   14171: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   14172: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  14173:             if (ref($firstaccenv) eq 'HASH') {
                   14174:                 &_add_to_env(\%disk_env,$firstaccenv);
                   14175:             }
                   14176:             if (ref($timerintenv) eq 'HASH') {
                   14177:                 &_add_to_env(\%disk_env,$timerintenv);
                   14178:             }
1.463     albertel 14179: 	    if (ref($args->{'extra_env'})) {
                   14180: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   14181: 	    }
1.462     albertel 14182: 	    untie(%disk_env);
                   14183: 	} else {
1.705     tempelho 14184: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   14185: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 14186: 	    return 'error: '.$!;
                   14187: 	}
                   14188:     }
                   14189:     $env{'request.role'}='cm';
                   14190:     $env{'request.role.adv'}=$env{'user.adv'};
                   14191:     $env{'browser.type'}=$clientbrowser;
                   14192: 
                   14193:     return $cookie;
                   14194: 
                   14195: }
                   14196: 
                   14197: sub _add_to_env {
                   14198:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  14199:     if (ref($env_data) eq 'HASH') {
                   14200:         while (my ($key,$value) = each(%$env_data)) {
                   14201: 	    $idf->{$prefix.$key} = $value;
                   14202: 	    $env{$prefix.$key}   = $value;
                   14203:         }
1.462     albertel 14204:     }
                   14205: }
                   14206: 
1.685     tempelho 14207: # --- Get the symbolic name of a problem and the url
                   14208: sub get_symb {
                   14209:     my ($request,$silent) = @_;
1.726     raeburn  14210:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 14211:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   14212:     if ($symb eq '') {
                   14213:         if (!$silent) {
1.1071    raeburn  14214:             if (ref($request)) { 
                   14215:                 $request->print("Unable to handle ambiguous references:$url:.");
                   14216:             }
1.685     tempelho 14217:             return ();
                   14218:         }
                   14219:     }
                   14220:     &Apache::lonenc::check_decrypt(\$symb);
                   14221:     return ($symb);
                   14222: }
                   14223: 
                   14224: # --------------------------------------------------------------Get annotation
                   14225: 
                   14226: sub get_annotation {
                   14227:     my ($symb,$enc) = @_;
                   14228: 
                   14229:     my $key = $symb;
                   14230:     if (!$enc) {
                   14231:         $key =
                   14232:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   14233:     }
                   14234:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   14235:     return $annotation{$key};
                   14236: }
                   14237: 
                   14238: sub clean_symb {
1.731     raeburn  14239:     my ($symb,$delete_enc) = @_;
1.685     tempelho 14240: 
                   14241:     &Apache::lonenc::check_decrypt(\$symb);
                   14242:     my $enc = $env{'request.enc'};
1.731     raeburn  14243:     if ($delete_enc) {
1.730     raeburn  14244:         delete($env{'request.enc'});
                   14245:     }
1.685     tempelho 14246: 
                   14247:     return ($symb,$enc);
                   14248: }
1.462     albertel 14249: 
1.990     raeburn  14250: sub build_release_hashes {
                   14251:     my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
                   14252:     return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
                   14253:                   (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
                   14254:                   (ref($randomizetry) eq 'HASH'));
                   14255:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   14256:         my ($item,$name,$value) = split(/:/,$key);
                   14257:         if ($item eq 'parameter') {
                   14258:             if (ref($checkparms->{$name}) eq 'ARRAY') {
                   14259:                 unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
                   14260:                     push(@{$checkparms->{$name}},$value);
                   14261:                 }
                   14262:             } else {
                   14263:                 push(@{$checkparms->{$name}},$value);
                   14264:             }
                   14265:         } elsif ($item eq 'resourcetag') {
                   14266:             if ($name eq 'responsetype') {
                   14267:                 $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
                   14268:             }
                   14269:         } elsif ($item eq 'course') {
                   14270:             if ($name eq 'crstype') {
                   14271:                 $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
                   14272:             }
                   14273:         }
                   14274:     }
                   14275:     ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
                   14276:     ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
                   14277:     return;
                   14278: }
                   14279: 
1.1083    raeburn  14280: sub update_content_constraints {
                   14281:     my ($cdom,$cnum,$chome,$cid) = @_;
                   14282:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   14283:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   14284:     my %checkresponsetypes;
                   14285:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   14286:         my ($item,$name,$value) = split(/:/,$key);
                   14287:         if ($item eq 'resourcetag') {
                   14288:             if ($name eq 'responsetype') {
                   14289:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   14290:             }
                   14291:         }
                   14292:     }
                   14293:     my $navmap = Apache::lonnavmaps::navmap->new();
                   14294:     if (defined($navmap)) {
                   14295:         my %allresponses;
                   14296:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   14297:             my %responses = $res->responseTypes();
                   14298:             foreach my $key (keys(%responses)) {
                   14299:                 next unless(exists($checkresponsetypes{$key}));
                   14300:                 $allresponses{$key} += $responses{$key};
                   14301:             }
                   14302:         }
                   14303:         foreach my $key (keys(%allresponses)) {
                   14304:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   14305:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   14306:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   14307:             }
                   14308:         }
                   14309:         undef($navmap);
                   14310:     }
                   14311:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   14312:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   14313:     }
                   14314:     return;
                   14315: }
                   14316: 
1.1110    raeburn  14317: sub allmaps_incourse {
                   14318:     my ($cdom,$cnum,$chome,$cid) = @_;
                   14319:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   14320:         $cid = $env{'request.course.id'};
                   14321:         $cdom = $env{'course.'.$cid.'.domain'};
                   14322:         $cnum = $env{'course.'.$cid.'.num'};
                   14323:         $chome = $env{'course.'.$cid.'.home'};
                   14324:     }
                   14325:     my %allmaps = ();
                   14326:     my $lastchange =
                   14327:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   14328:     if ($lastchange > $env{'request.course.tied'}) {
                   14329:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   14330:         unless ($ferr) {
                   14331:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   14332:         }
                   14333:     }
                   14334:     my $navmap = Apache::lonnavmaps::navmap->new();
                   14335:     if (defined($navmap)) {
                   14336:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   14337:             $allmaps{$res->src()} = 1;
                   14338:         }
                   14339:     }
                   14340:     return \%allmaps;
                   14341: }
                   14342: 
1.1083    raeburn  14343: sub parse_supplemental_title {
                   14344:     my ($title) = @_;
                   14345: 
                   14346:     my ($foldertitle,$renametitle);
                   14347:     if ($title =~ /&amp;&amp;&amp;/) {
                   14348:         $title = &HTML::Entites::decode($title);
                   14349:     }
                   14350:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   14351:         $renametitle=$4;
                   14352:         my ($time,$uname,$udom) = ($1,$2,$3);
                   14353:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   14354:         my $name =  &plainname($uname,$udom);
                   14355:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   14356:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   14357:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   14358:             $name.': <br />'.$foldertitle;
                   14359:     }
                   14360:     if (wantarray) {
                   14361:         return ($title,$foldertitle,$renametitle);
                   14362:     }
                   14363:     return $title;
                   14364: }
                   14365: 
1.1101    raeburn  14366: sub symb_to_docspath {
                   14367:     my ($symb) = @_;
                   14368:     return unless ($symb);
                   14369:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   14370:     if ($resurl=~/\.(sequence|page)$/) {
                   14371:         $mapurl=$resurl;
                   14372:     } elsif ($resurl eq 'adm/navmaps') {
                   14373:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   14374:     }
                   14375:     my $mapresobj;
                   14376:     my $navmap = Apache::lonnavmaps::navmap->new();
                   14377:     if (ref($navmap)) {
                   14378:         $mapresobj = $navmap->getResourceByUrl($mapurl);
                   14379:     }
                   14380:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   14381:     my $type=$2;
                   14382:     my $path;
                   14383:     if (ref($mapresobj)) {
                   14384:         my $pcslist = $mapresobj->map_hierarchy();
                   14385:         if ($pcslist ne '') {
                   14386:             foreach my $pc (split(/,/,$pcslist)) {
                   14387:                 next if ($pc <= 1);
                   14388:                 my $res = $navmap->getByMapPc($pc);
                   14389:                 if (ref($res)) {
                   14390:                     my $thisurl = $res->src();
                   14391:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   14392:                     my $thistitle = $res->title();
                   14393:                     $path .= '&'.
                   14394:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
                   14395:                              &Apache::lonhtmlcommon::entity_encode($thistitle).
                   14396:                              ':'.$res->randompick().
                   14397:                              ':'.$res->randomout().
                   14398:                              ':'.$res->encrypted().
                   14399:                              ':'.$res->randomorder().
                   14400:                              ':'.$res->is_page();
                   14401:                 }
                   14402:             }
                   14403:         }
                   14404:         $path =~ s/^\&//;
                   14405:         my $maptitle = $mapresobj->title();
                   14406:         if ($mapurl eq 'default') {
                   14407:             $maptitle = 'Main Course Documents';
                   14408:         }
                   14409:         $path .= (($path ne '')? '&' : '').
                   14410:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
                   14411:                  &Apache::lonhtmlcommon::entity_encode($maptitle).
                   14412:                  ':'.$mapresobj->randompick().
                   14413:                  ':'.$mapresobj->randomout().
                   14414:                  ':'.$mapresobj->encrypted().
                   14415:                  ':'.$mapresobj->randomorder().
                   14416:                  ':'.$mapresobj->is_page();
                   14417:     } else {
                   14418:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   14419:         my $ispage = (($type eq 'page')? 1 : '');
                   14420:         if ($mapurl eq 'default') {
                   14421:             $maptitle = 'Main Course Documents';
                   14422:         }
                   14423:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
                   14424:                 &Apache::lonhtmlcommon::entity_encode($maptitle).':::::'.$ispage;
                   14425:     }
                   14426:     unless ($mapurl eq 'default') {
                   14427:         $path = 'default&'.
                   14428:                 &Apache::lonhtmlcommon::entity_encode('Main Course Documents').
                   14429:                 ':::::&'.$path;
                   14430:     }
                   14431:     return $path;
                   14432: }
                   14433: 
1.1094    raeburn  14434: sub captcha_display {
                   14435:     my ($context,$lonhost) = @_;
                   14436:     my ($output,$error);
                   14437:     my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095    raeburn  14438:     if ($captcha eq 'original') {
1.1094    raeburn  14439:         $output = &create_captcha();
                   14440:         unless ($output) {
                   14441:             $error = 'captcha'; 
                   14442:         }
                   14443:     } elsif ($captcha eq 'recaptcha') {
                   14444:         $output = &create_recaptcha($pubkey);
                   14445:         unless ($output) {
1.1095    raeburn  14446:             $error = 'recaptcha'; 
1.1094    raeburn  14447:         }
                   14448:     }
                   14449:     return ($output,$error);
                   14450: }
                   14451: 
                   14452: sub captcha_response {
                   14453:     my ($context,$lonhost) = @_;
                   14454:     my ($captcha_chk,$captcha_error);
                   14455:     my ($captcha,$pubkey,$privkey) = &get_captcha_config($context,$lonhost);
1.1095    raeburn  14456:     if ($captcha eq 'original') {
1.1094    raeburn  14457:         ($captcha_chk,$captcha_error) = &check_captcha();
                   14458:     } elsif ($captcha eq 'recaptcha') {
                   14459:         $captcha_chk = &check_recaptcha($privkey);
                   14460:     } else {
                   14461:         $captcha_chk = 1;
                   14462:     }
                   14463:     return ($captcha_chk,$captcha_error);
                   14464: }
                   14465: 
                   14466: sub get_captcha_config {
                   14467:     my ($context,$lonhost) = @_;
1.1095    raeburn  14468:     my ($captcha,$pubkey,$privkey,$hashtocheck);
1.1094    raeburn  14469:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   14470:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   14471:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  14472:     if ($context eq 'usercreation') {
                   14473:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   14474:         if (ref($domconfig{$context}) eq 'HASH') {
                   14475:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   14476:             if (ref($hashtocheck) eq 'HASH') {
                   14477:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   14478:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   14479:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   14480:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   14481:                     }
                   14482:                     if ($privkey && $pubkey) {
                   14483:                         $captcha = 'recaptcha';
                   14484:                     } else {
                   14485:                         $captcha = 'original';
                   14486:                     }
                   14487:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   14488:                     $captcha = 'original';
                   14489:                 }
1.1094    raeburn  14490:             }
1.1095    raeburn  14491:         } else {
                   14492:             $captcha = 'captcha';
                   14493:         }
                   14494:     } elsif ($context eq 'login') {
                   14495:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   14496:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   14497:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   14498:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  14499:             if ($privkey && $pubkey) {
                   14500:                 $captcha = 'recaptcha';
1.1095    raeburn  14501:             } else {
                   14502:                 $captcha = 'original';
1.1094    raeburn  14503:             }
1.1095    raeburn  14504:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   14505:             $captcha = 'original';
1.1094    raeburn  14506:         }
                   14507:     }
                   14508:     return ($captcha,$pubkey,$privkey);
                   14509: }
                   14510: 
                   14511: sub create_captcha {
                   14512:     my %captcha_params = &captcha_settings();
                   14513:     my ($output,$maxtries,$tries) = ('',10,0);
                   14514:     while ($tries < $maxtries) {
                   14515:         $tries ++;
                   14516:         my $captcha = Authen::Captcha->new (
                   14517:                                            output_folder => $captcha_params{'output_dir'},
                   14518:                                            data_folder   => $captcha_params{'db_dir'},
                   14519:                                           );
                   14520:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   14521: 
                   14522:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   14523:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   14524:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
                   14525:                      '<input type="text" size="5" name="code" value="" /><br />'.
                   14526:                      '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
                   14527:             last;
                   14528:         }
                   14529:     }
                   14530:     return $output;
                   14531: }
                   14532: 
                   14533: sub captcha_settings {
                   14534:     my %captcha_params = (
                   14535:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   14536:                            www_output_dir => "/captchaspool",
                   14537:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   14538:                            numchars       => '5',
                   14539:                          );
                   14540:     return %captcha_params;
                   14541: }
                   14542: 
                   14543: sub check_captcha {
                   14544:     my ($captcha_chk,$captcha_error);
                   14545:     my $code = $env{'form.code'};
                   14546:     my $md5sum = $env{'form.crypt'};
                   14547:     my %captcha_params = &captcha_settings();
                   14548:     my $captcha = Authen::Captcha->new(
                   14549:                       output_folder => $captcha_params{'output_dir'},
                   14550:                       data_folder   => $captcha_params{'db_dir'},
                   14551:                   );
1.1109    raeburn  14552:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  14553:     my %captcha_hash = (
                   14554:                         0       => 'Code not checked (file error)',
                   14555:                        -1      => 'Failed: code expired',
                   14556:                        -2      => 'Failed: invalid code (not in database)',
                   14557:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   14558:     );
                   14559:     if ($captcha_chk != 1) {
                   14560:         $captcha_error = $captcha_hash{$captcha_chk}
                   14561:     }
                   14562:     return ($captcha_chk,$captcha_error);
                   14563: }
                   14564: 
                   14565: sub create_recaptcha {
                   14566:     my ($pubkey) = @_;
                   14567:     my $captcha = Captcha::reCAPTCHA->new;
                   14568:     return $captcha->get_options_setter({theme => 'white'})."\n".
                   14569:            $captcha->get_html($pubkey).
                   14570:            &mt('If either word is hard to read, [_1] will replace them.',
                   14571:                '<image src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   14572:            '<br /><br />';
                   14573: }
                   14574: 
                   14575: sub check_recaptcha {
                   14576:     my ($privkey) = @_;
                   14577:     my $captcha_chk;
                   14578:     my $captcha = Captcha::reCAPTCHA->new;
                   14579:     my $captcha_result =
                   14580:         $captcha->check_answer(
                   14581:                                 $privkey,
                   14582:                                 $ENV{'REMOTE_ADDR'},
                   14583:                                 $env{'form.recaptcha_challenge_field'},
                   14584:                                 $env{'form.recaptcha_response_field'},
                   14585:                               );
                   14586:     if ($captcha_result->{is_valid}) {
                   14587:         $captcha_chk = 1;
                   14588:     }
                   14589:     return $captcha_chk;
                   14590: }
                   14591: 
1.41      ng       14592: =pod
                   14593: 
                   14594: =back
                   14595: 
1.112     bowersj2 14596: =cut
1.41      ng       14597: 
1.112     bowersj2 14598: 1;
                   14599: __END__;
1.41      ng       14600: 

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