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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1075.2.129! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.128 2018/09/02 21:21:17 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.1075.2.25  raeburn    70: use Apache::lonuserutils();
1.1075.2.27  raeburn    71: use Apache::lonuserstate();
1.1075.2.69  raeburn    72: use Apache::courseclassifier();
1.479     albertel   73: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    74: use DateTime::TimeZone;
1.1075.2.102  raeburn    75: use DateTime::Locale;
1.1075.2.94  raeburn    76: use Encode();
1.1075.2.14  raeburn    77: use Authen::Captcha;
                     78: use Captcha::reCAPTCHA;
1.1075.2.107  raeburn    79: use JSON::DWIW;
                     80: use LWP::UserAgent;
1.1075.2.64  raeburn    81: use Crypt::DES;
                     82: use DynaLoader; # for Crypt::DES version
1.1075.2.128  raeburn    83: use File::Copy();
                     84: use File::Path();
1.117     www        85: 
1.517     raeburn    86: # ---------------------------------------------- Designs
                     87: use vars qw(%defaultdesign);
                     88: 
1.22      www        89: my $readit;
                     90: 
1.517     raeburn    91: 
1.157     matthew    92: ##
                     93: ## Global Variables
                     94: ##
1.46      matthew    95: 
1.643     foxr       96: 
                     97: # ----------------------------------------------- SSI with retries:
                     98: #
                     99: 
                    100: =pod
                    101: 
1.648     raeburn   102: =head1 Server Side include with retries:
1.643     foxr      103: 
                    104: =over 4
                    105: 
1.648     raeburn   106: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      107: 
                    108: Performs an ssi with some number of retries.  Retries continue either
                    109: until the result is ok or until the retry count supplied by the
                    110: caller is exhausted.  
                    111: 
                    112: Inputs:
1.648     raeburn   113: 
                    114: =over 4
                    115: 
1.643     foxr      116: resource   - Identifies the resource to insert.
1.648     raeburn   117: 
1.643     foxr      118: retries    - Count of the number of retries allowed.
1.648     raeburn   119: 
1.643     foxr      120: form       - Hash that identifies the rendering options.
                    121: 
1.648     raeburn   122: =back
                    123: 
                    124: Returns:
                    125: 
                    126: =over 4
                    127: 
1.643     foxr      128: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   129: 
1.643     foxr      130: response   - The response from the last attempt (which may or may not have been successful.
                    131: 
1.648     raeburn   132: =back
                    133: 
                    134: =back
                    135: 
1.643     foxr      136: =cut
                    137: 
                    138: sub ssi_with_retries {
                    139:     my ($resource, $retries, %form) = @_;
                    140: 
                    141: 
                    142:     my $ok = 0;			# True if we got a good response.
                    143:     my $content;
                    144:     my $response;
                    145: 
                    146:     # Try to get the ssi done. within the retries count:
                    147: 
                    148:     do {
                    149: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    150: 	$ok      = $response->is_success;
1.650     www       151:         if (!$ok) {
                    152:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    153:         }
1.643     foxr      154: 	$retries--;
                    155:     } while (!$ok && ($retries > 0));
                    156: 
                    157:     if (!$ok) {
                    158: 	$content = '';		# On error return an empty content.
                    159:     }
                    160:     return ($content, $response);
                    161: 
                    162: }
                    163: 
                    164: 
                    165: 
1.20      www       166: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  167: my %language;
1.124     www       168: my %supported_language;
1.1048    foxr      169: my %latex_language;		# For choosing hyphenation in <transl..>
                    170: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  171: my %cprtag;
1.192     taceyjo1  172: my %scprtag;
1.351     www       173: my %fe; my %fd; my %fm;
1.41      ng        174: my %category_extensions;
1.12      harris41  175: 
1.46      matthew   176: # ---------------------------------------------- Thesaurus variables
1.144     matthew   177: #
                    178: # %Keywords:
                    179: #      A hash used by &keyword to determine if a word is considered a keyword.
                    180: # $thesaurus_db_file 
                    181: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   182: 
                    183: my %Keywords;
                    184: my $thesaurus_db_file;
                    185: 
1.144     matthew   186: #
                    187: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    188: # thesaurus.tab, and filecategories.tab.
                    189: #
1.18      www       190: BEGIN {
1.46      matthew   191:     # Variable initialization
                    192:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    193:     #
1.22      www       194:     unless ($readit) {
1.12      harris41  195: # ------------------------------------------------------------------- languages
                    196:     {
1.158     raeburn   197:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    198:                                    '/language.tab';
1.1075.2.128  raeburn   199:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  200:             while (my $line = <$fh>) {
                    201:                 next if ($line=~/^\#/);
                    202:                 chomp($line);
1.1048    foxr      203:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   204:                 $language{$key}=$val.' - '.$enc;
                    205:                 if ($sup) {
                    206:                     $supported_language{$key}=$sup;
                    207:                 }
1.1048    foxr      208: 		if ($latex) {
                    209: 		    $latex_language_bykey{$key} = $latex;
                    210: 		    $latex_language{$two} = $latex;
                    211: 		}
1.158     raeburn   212:             }
                    213:             close($fh);
                    214:         }
1.12      harris41  215:     }
                    216: # ------------------------------------------------------------------ copyrights
                    217:     {
1.158     raeburn   218:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    219:                                   '/copyright.tab';
1.1075.2.128  raeburn   220:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  221:             while (my $line = <$fh>) {
                    222:                 next if ($line=~/^\#/);
                    223:                 chomp($line);
                    224:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   225:                 $cprtag{$key}=$val;
                    226:             }
                    227:             close($fh);
                    228:         }
1.12      harris41  229:     }
1.351     www       230: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  231:     {
                    232:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    233:                                   '/source_copyright.tab';
1.1075.2.128  raeburn   234:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  235:             while (my $line = <$fh>) {
                    236:                 next if ($line =~ /^\#/);
                    237:                 chomp($line);
                    238:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  239:                 $scprtag{$key}=$val;
                    240:             }
                    241:             close($fh);
                    242:         }
                    243:     }
1.63      www       244: 
1.517     raeburn   245: # -------------------------------------------------------------- default domain designs
1.63      www       246:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   247:     my $designfile = $designdir.'/default.tab';
1.1075.2.128  raeburn   248:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   249:         while (my $line = <$fh>) {
                    250:             next if ($line =~ /^\#/);
                    251:             chomp($line);
                    252:             my ($key,$val)=(split(/\=/,$line));
                    253:             if ($val) { $defaultdesign{$key}=$val; }
                    254:         }
                    255:         close($fh);
1.63      www       256:     }
                    257: 
1.15      harris41  258: # ------------------------------------------------------------- file categories
                    259:     {
1.158     raeburn   260:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    261:                                   '/filecategories.tab';
1.1075.2.128  raeburn   262:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  263: 	    while (my $line = <$fh>) {
                    264: 		next if ($line =~ /^\#/);
                    265: 		chomp($line);
                    266:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119  raeburn   267:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   268:             }
                    269:             close($fh);
                    270:         }
                    271: 
1.15      harris41  272:     }
1.12      harris41  273: # ------------------------------------------------------------------ file types
                    274:     {
1.158     raeburn   275:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    276:                '/filetypes.tab';
1.1075.2.128  raeburn   277:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  278:             while (my $line = <$fh>) {
                    279: 		next if ($line =~ /^\#/);
                    280: 		chomp($line);
                    281:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   282:                 if ($descr ne '') {
                    283:                     $fe{$ending}=lc($emb);
                    284:                     $fd{$ending}=$descr;
1.351     www       285:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   286:                 }
                    287:             }
                    288:             close($fh);
                    289:         }
1.12      harris41  290:     }
1.22      www       291:     &Apache::lonnet::logthis(
1.705     tempelho  292:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       293:     $readit=1;
1.46      matthew   294:     }  # end of unless($readit) 
1.32      matthew   295:     
                    296: }
1.112     bowersj2  297: 
1.42      matthew   298: ###############################################################
                    299: ##           HTML and Javascript Helper Functions            ##
                    300: ###############################################################
                    301: 
                    302: =pod 
                    303: 
1.112     bowersj2  304: =head1 HTML and Javascript Functions
1.42      matthew   305: 
1.112     bowersj2  306: =over 4
                    307: 
1.648     raeburn   308: =item * &browser_and_searcher_javascript()
1.112     bowersj2  309: 
                    310: X<browsing, javascript>X<searching, javascript>Returns a string
                    311: containing javascript with two functions, C<openbrowser> and
                    312: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    313: tags.
1.42      matthew   314: 
1.648     raeburn   315: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   316: 
                    317: inputs: formname, elementname, only, omit
                    318: 
                    319: formname and elementname indicate the name of the html form and name of
                    320: the element that the results of the browsing selection are to be placed in. 
                    321: 
                    322: Specifying 'only' will restrict the browser to displaying only files
1.185     www       323: with the given extension.  Can be a comma separated list.
1.42      matthew   324: 
                    325: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       326: with the given extension.  Can be a comma separated list.
1.42      matthew   327: 
1.648     raeburn   328: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   329: 
                    330: Inputs: formname, elementname
                    331: 
                    332: formname and elementname specify the name of the html form and the name
                    333: of the element the selection from the search results will be placed in.
1.542     raeburn   334: 
1.42      matthew   335: =cut
                    336: 
                    337: sub browser_and_searcher_javascript {
1.199     albertel  338:     my ($mode)=@_;
                    339:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  340:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   341:     return <<END;
1.219     albertel  342: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   343:     var editbrowser = null;
1.135     albertel  344:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       345:         var url = '$resurl/?';
1.42      matthew   346:         if (editbrowser == null) {
                    347:             url += 'launch=1&';
                    348:         }
                    349:         url += 'catalogmode=interactive&';
1.199     albertel  350:         url += 'mode=$mode&';
1.611     albertel  351:         url += 'inhibitmenu=yes&';
1.42      matthew   352:         url += 'form=' + formname + '&';
                    353:         if (only != null) {
                    354:             url += 'only=' + only + '&';
1.217     albertel  355:         } else {
                    356:             url += 'only=&';
                    357: 	}
1.42      matthew   358:         if (omit != null) {
                    359:             url += 'omit=' + omit + '&';
1.217     albertel  360:         } else {
                    361:             url += 'omit=&';
                    362: 	}
1.135     albertel  363:         if (titleelement != null) {
                    364:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  365:         } else {
                    366: 	    url += 'titleelement=&';
                    367: 	}
1.42      matthew   368:         url += 'element=' + elementname + '';
                    369:         var title = 'Browser';
1.435     albertel  370:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   371:         options += ',width=700,height=600';
                    372:         editbrowser = open(url,title,options,'1');
                    373:         editbrowser.focus();
                    374:     }
                    375:     var editsearcher;
1.135     albertel  376:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   377:         var url = '/adm/searchcat?';
                    378:         if (editsearcher == null) {
                    379:             url += 'launch=1&';
                    380:         }
                    381:         url += 'catalogmode=interactive&';
1.199     albertel  382:         url += 'mode=$mode&';
1.42      matthew   383:         url += 'form=' + formname + '&';
1.135     albertel  384:         if (titleelement != null) {
                    385:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  386:         } else {
                    387: 	    url += 'titleelement=&';
                    388: 	}
1.42      matthew   389:         url += 'element=' + elementname + '';
                    390:         var title = 'Search';
1.435     albertel  391:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   392:         options += ',width=700,height=600';
                    393:         editsearcher = open(url,title,options,'1');
                    394:         editsearcher.focus();
                    395:     }
1.219     albertel  396: // END LON-CAPA Internal -->
1.42      matthew   397: END
1.170     www       398: }
                    399: 
                    400: sub lastresurl {
1.258     albertel  401:     if ($env{'environment.lastresurl'}) {
                    402: 	return $env{'environment.lastresurl'}
1.170     www       403:     } else {
                    404: 	return '/res';
                    405:     }
                    406: }
                    407: 
                    408: sub storeresurl {
                    409:     my $resurl=&Apache::lonnet::clutter(shift);
                    410:     unless ($resurl=~/^\/res/) { return 0; }
                    411:     $resurl=~s/\/$//;
                    412:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   413:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       414:     return 1;
1.42      matthew   415: }
                    416: 
1.74      www       417: sub studentbrowser_javascript {
1.111     www       418:    unless (
1.258     albertel  419:             (($env{'request.course.id'}) && 
1.302     albertel  420:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    421: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    422: 					  '/'.$env{'request.course.sec'})
                    423: 	      ))
1.258     albertel  424:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       425:           ) { return ''; }  
1.74      www       426:    return (<<'ENDSTDBRW');
1.776     bisitz    427: <script type="text/javascript" language="Javascript">
1.824     bisitz    428: // <![CDATA[
1.74      www       429:     var stdeditbrowser;
1.999     www       430:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74      www       431:         var url = '/adm/pickstudent?';
                    432:         var filter;
1.558     albertel  433: 	if (!ignorefilter) {
                    434: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    435: 	}
1.74      www       436:         if (filter != null) {
                    437:            if (filter != '') {
                    438:                url += 'filter='+filter+'&';
                    439: 	   }
                    440:         }
                    441:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       442:                                     '&udomelement='+udom+
                    443:                                     '&clicker='+clicker;
1.111     www       444: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   445:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       446:         var title = 'Student_Browser';
1.74      www       447:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    448:         options += ',width=700,height=600';
                    449:         stdeditbrowser = open(url,title,options,'1');
                    450:         stdeditbrowser.focus();
                    451:     }
1.824     bisitz    452: // ]]>
1.74      www       453: </script>
                    454: ENDSTDBRW
                    455: }
1.42      matthew   456: 
1.1003    www       457: sub resourcebrowser_javascript {
                    458:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       459:    return (<<'ENDRESBRW');
1.1003    www       460: <script type="text/javascript" language="Javascript">
                    461: // <![CDATA[
                    462:     var reseditbrowser;
1.1004    www       463:     function openresbrowser(formname,reslink) {
1.1005    www       464:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       465:         var title = 'Resource_Browser';
                    466:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       467:         options += ',width=700,height=500';
1.1004    www       468:         reseditbrowser = open(url,title,options,'1');
                    469:         reseditbrowser.focus();
1.1003    www       470:     }
                    471: // ]]>
                    472: </script>
1.1004    www       473: ENDRESBRW
1.1003    www       474: }
                    475: 
1.74      www       476: sub selectstudent_link {
1.999     www       477:    my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
                    478:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    479:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    480:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  481:    if ($env{'request.course.id'}) {  
1.302     albertel  482:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    483: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    484: 					'/'.$env{'request.course.sec'})) {
1.111     www       485: 	   return '';
                    486:        }
1.999     www       487:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793     raeburn   488:        if ($courseadvonly)  {
                    489:            $callargs .= ",'',1,1";
                    490:        }
                    491:        return '<span class="LC_nobreak">'.
                    492:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    493:               &mt('Select User').'</a></span>';
1.74      www       494:    }
1.258     albertel  495:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       496:        $callargs .= ",'',1"; 
1.793     raeburn   497:        return '<span class="LC_nobreak">'.
                    498:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    499:               &mt('Select User').'</a></span>';
1.111     www       500:    }
                    501:    return '';
1.91      www       502: }
                    503: 
1.1004    www       504: sub selectresource_link {
                    505:    my ($form,$reslink,$arg)=@_;
                    506:    
                    507:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    508:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    509:    unless ($env{'request.course.id'}) { return $arg; }
                    510:    return '<span class="LC_nobreak">'.
                    511:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    512:               $arg.'</a></span>';
                    513: }
                    514: 
                    515: 
                    516: 
1.653     raeburn   517: sub authorbrowser_javascript {
                    518:     return <<"ENDAUTHORBRW";
1.776     bisitz    519: <script type="text/javascript" language="JavaScript">
1.824     bisitz    520: // <![CDATA[
1.653     raeburn   521: var stdeditbrowser;
                    522: 
                    523: function openauthorbrowser(formname,udom) {
                    524:     var url = '/adm/pickauthor?';
                    525:     url += 'form='+formname+'&roledom='+udom;
                    526:     var title = 'Author_Browser';
                    527:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    528:     options += ',width=700,height=600';
                    529:     stdeditbrowser = open(url,title,options,'1');
                    530:     stdeditbrowser.focus();
                    531: }
                    532: 
1.824     bisitz    533: // ]]>
1.653     raeburn   534: </script>
                    535: ENDAUTHORBRW
                    536: }
                    537: 
1.91      www       538: sub coursebrowser_javascript {
1.1075.2.31  raeburn   539:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95  raeburn   540:         $credits_element,$instcode) = @_;
1.932     raeburn   541:     my $wintitle = 'Course_Browser';
1.931     raeburn   542:     if ($crstype eq 'Community') {
1.932     raeburn   543:         $wintitle = 'Community_Browser';
1.909     raeburn   544:     }
1.876     raeburn   545:     my $id_functions = &javascript_index_functions();
                    546:     my $output = '
1.776     bisitz    547: <script type="text/javascript" language="JavaScript">
1.824     bisitz    548: // <![CDATA[
1.468     raeburn   549:     var stdeditbrowser;'."\n";
1.876     raeburn   550: 
                    551:     $output .= <<"ENDSTDBRW";
1.909     raeburn   552:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       553:         var url = '/adm/pickcourse?';
1.895     raeburn   554:         var formid = getFormIdByName(formname);
1.876     raeburn   555:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  556:         if (domainfilter != null) {
                    557:            if (domainfilter != '') {
                    558:                url += 'domainfilter='+domainfilter+'&';
                    559: 	   }
                    560:         }
1.91      www       561:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  562: 	                            '&cdomelement='+udom+
                    563:                                     '&cnameelement='+desc;
1.468     raeburn   564:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   565:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   566:                 url += '&roleelement='+extra_element;
                    567:                 if (domainfilter == null || domainfilter == '') {
                    568:                     url += '&domainfilter='+extra_element;
                    569:                 }
1.234     raeburn   570:             }
1.468     raeburn   571:             else {
                    572:                 if (formname == 'portform') {
                    573:                     url += '&setroles='+extra_element;
1.800     raeburn   574:                 } else {
                    575:                     if (formname == 'rules') {
                    576:                         url += '&fixeddom='+extra_element; 
                    577:                     }
1.468     raeburn   578:                 }
                    579:             }     
1.230     raeburn   580:         }
1.909     raeburn   581:         if (type != null && type != '') {
                    582:             url += '&type='+type;
                    583:         }
                    584:         if (type_elem != null && type_elem != '') {
                    585:             url += '&typeelement='+type_elem;
                    586:         }
1.872     raeburn   587:         if (formname == 'ccrs') {
                    588:             var ownername = document.forms[formid].ccuname.value;
                    589:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101  raeburn   590:             url += '&cloner='+ownername+':'+ownerdom;
                    591:             if (type == 'Course') {
                    592:                 url += '&crscode='+document.forms[formid].crscode.value;
                    593:             }
1.1075.2.95  raeburn   594:         }
                    595:         if (formname == 'requestcrs') {
                    596:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   597:         }
1.293     raeburn   598:         if (multflag !=null && multflag != '') {
                    599:             url += '&multiple='+multflag;
                    600:         }
1.909     raeburn   601:         var title = '$wintitle';
1.91      www       602:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    603:         options += ',width=700,height=600';
                    604:         stdeditbrowser = open(url,title,options,'1');
                    605:         stdeditbrowser.focus();
                    606:     }
1.876     raeburn   607: $id_functions
                    608: ENDSTDBRW
1.1075.2.31  raeburn   609:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    610:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    611:                                       $credits_element);
1.876     raeburn   612:     }
                    613:     $output .= '
                    614: // ]]>
                    615: </script>';
                    616:     return $output;
                    617: }
                    618: 
                    619: sub javascript_index_functions {
                    620:     return <<"ENDJS";
                    621: 
                    622: function getFormIdByName(formname) {
                    623:     for (var i=0;i<document.forms.length;i++) {
                    624:         if (document.forms[i].name == formname) {
                    625:             return i;
                    626:         }
                    627:     }
                    628:     return -1;
                    629: }
                    630: 
                    631: function getIndexByName(formid,item) {
                    632:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    633:         if (document.forms[formid].elements[i].name == item) {
                    634:             return i;
                    635:         }
                    636:     }
                    637:     return -1;
                    638: }
1.468     raeburn   639: 
1.876     raeburn   640: function getDomainFromSelectbox(formname,udom) {
                    641:     var userdom;
                    642:     var formid = getFormIdByName(formname);
                    643:     if (formid > -1) {
                    644:         var domid = getIndexByName(formid,udom);
                    645:         if (domid > -1) {
                    646:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    647:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    648:             }
                    649:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    650:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   651:             }
                    652:         }
                    653:     }
1.876     raeburn   654:     return userdom;
                    655: }
                    656: 
                    657: ENDJS
1.468     raeburn   658: 
1.876     raeburn   659: }
                    660: 
1.1017    raeburn   661: sub javascript_array_indexof {
1.1018    raeburn   662:     return <<ENDJS;
1.1017    raeburn   663: <script type="text/javascript" language="JavaScript">
                    664: // <![CDATA[
                    665: 
                    666: if (!Array.prototype.indexOf) {
                    667:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    668:         "use strict";
                    669:         if (this === void 0 || this === null) {
                    670:             throw new TypeError();
                    671:         }
                    672:         var t = Object(this);
                    673:         var len = t.length >>> 0;
                    674:         if (len === 0) {
                    675:             return -1;
                    676:         }
                    677:         var n = 0;
                    678:         if (arguments.length > 0) {
                    679:             n = Number(arguments[1]);
                    680:             if (n !== n) { // shortcut for verifying if it's NaN
                    681:                 n = 0;
                    682:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    683:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    684:             }
                    685:         }
                    686:         if (n >= len) {
                    687:             return -1;
                    688:         }
                    689:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    690:         for (; k < len; k++) {
                    691:             if (k in t && t[k] === searchElement) {
                    692:                 return k;
                    693:             }
                    694:         }
                    695:         return -1;
                    696:     }
                    697: }
                    698: 
                    699: // ]]>
                    700: </script>
                    701: 
                    702: ENDJS
                    703: 
                    704: }
                    705: 
1.876     raeburn   706: sub userbrowser_javascript {
                    707:     my $id_functions = &javascript_index_functions();
                    708:     return <<"ENDUSERBRW";
                    709: 
1.888     raeburn   710: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   711:     var url = '/adm/pickuser?';
                    712:     var userdom = getDomainFromSelectbox(formname,udom);
                    713:     if (userdom != null) {
                    714:        if (userdom != '') {
                    715:            url += 'srchdom='+userdom+'&';
                    716:        }
                    717:     }
                    718:     url += 'form=' + formname + '&unameelement='+uname+
                    719:                                 '&udomelement='+udom+
                    720:                                 '&ulastelement='+ulast+
                    721:                                 '&ufirstelement='+ufirst+
                    722:                                 '&uemailelement='+uemail+
1.881     raeburn   723:                                 '&hideudomelement='+hideudom+
                    724:                                 '&coursedom='+crsdom;
1.888     raeburn   725:     if ((caller != null) && (caller != undefined)) {
                    726:         url += '&caller='+caller;
                    727:     }
1.876     raeburn   728:     var title = 'User_Browser';
                    729:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    730:     options += ',width=700,height=600';
                    731:     var stdeditbrowser = open(url,title,options,'1');
                    732:     stdeditbrowser.focus();
                    733: }
                    734: 
1.888     raeburn   735: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   736:     var formid = getFormIdByName(formname);
                    737:     if (formid > -1) {
1.888     raeburn   738:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   739:         var domid = getIndexByName(formid,udom);
                    740:         var hidedomid = getIndexByName(formid,origdom);
                    741:         if (hidedomid > -1) {
                    742:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   743:             var unameval = document.forms[formid].elements[unameid].value;
                    744:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    745:                 if (domid > -1) {
                    746:                     var slct = document.forms[formid].elements[domid];
                    747:                     if (slct.type == 'select-one') {
                    748:                         var i;
                    749:                         for (i=0;i<slct.length;i++) {
                    750:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    751:                         }
                    752:                     }
                    753:                     if (slct.type == 'hidden') {
                    754:                         slct.value = fixeddom;
1.876     raeburn   755:                     }
                    756:                 }
1.468     raeburn   757:             }
                    758:         }
                    759:     }
1.876     raeburn   760:     return;
                    761: }
                    762: 
                    763: $id_functions
                    764: ENDUSERBRW
1.468     raeburn   765: }
                    766: 
                    767: sub setsec_javascript {
1.1075.2.31  raeburn   768:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   769:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    770:         $communityrolestr);
                    771:     if ($role_element ne '') {
                    772:         my @allroles = ('st','ta','ep','in','ad');
                    773:         foreach my $crstype ('Course','Community') {
                    774:             if ($crstype eq 'Community') {
                    775:                 foreach my $role (@allroles) {
                    776:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    777:                 }
                    778:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    779:             } else {
                    780:                 foreach my $role (@allroles) {
                    781:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    782:                 }
                    783:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    784:             }
                    785:         }
                    786:         $rolestr = '"'.join('","',@allroles).'"';
                    787:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    788:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    789:     }
1.468     raeburn   790:     my $setsections = qq|
                    791: function setSect(sectionlist) {
1.629     raeburn   792:     var sectionsArray = new Array();
                    793:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    794:         sectionsArray = sectionlist.split(",");
                    795:     }
1.468     raeburn   796:     var numSections = sectionsArray.length;
                    797:     document.$formname.$sec_element.length = 0;
                    798:     if (numSections == 0) {
                    799:         document.$formname.$sec_element.multiple=false;
                    800:         document.$formname.$sec_element.size=1;
                    801:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    802:     } else {
                    803:         if (numSections == 1) {
                    804:             document.$formname.$sec_element.multiple=false;
                    805:             document.$formname.$sec_element.size=1;
                    806:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    807:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    808:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    809:         } else {
                    810:             for (var i=0; i<numSections; i++) {
                    811:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    812:             }
                    813:             document.$formname.$sec_element.multiple=true
                    814:             if (numSections < 3) {
                    815:                 document.$formname.$sec_element.size=numSections;
                    816:             } else {
                    817:                 document.$formname.$sec_element.size=3;
                    818:             }
                    819:             document.$formname.$sec_element.options[0].selected = false
                    820:         }
                    821:     }
1.91      www       822: }
1.905     raeburn   823: 
                    824: function setRole(crstype) {
1.468     raeburn   825: |;
1.905     raeburn   826:     if ($role_element eq '') {
                    827:         $setsections .= '    return;
                    828: }
                    829: ';
                    830:     } else {
                    831:         $setsections .= qq|
                    832:     var elementLength = document.$formname.$role_element.length;
                    833:     var allroles = Array($rolestr);
                    834:     var courserolenames = Array($courserolestr);
                    835:     var communityrolenames = Array($communityrolestr);
                    836:     if (elementLength != undefined) {
                    837:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    838:             if (crstype == 'Course') {
                    839:                 return;
                    840:             } else {
                    841:                 allroles[5] = 'co';
                    842:                 for (var i=0; i<6; i++) {
                    843:                     document.$formname.$role_element.options[i].value = allroles[i];
                    844:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    845:                 }
                    846:             }
                    847:         } else {
                    848:             if (crstype == 'Community') {
                    849:                 return;
                    850:             } else {
                    851:                 allroles[5] = 'cc';
                    852:                 for (var i=0; i<6; i++) {
                    853:                     document.$formname.$role_element.options[i].value = allroles[i];
                    854:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    855:                 }
                    856:             }
                    857:         }
                    858:     }
                    859:     return;
                    860: }
                    861: |;
                    862:     }
1.1075.2.31  raeburn   863:     if ($credits_element) {
                    864:         $setsections .= qq|
                    865: function setCredits(defaultcredits) {
                    866:     document.$formname.$credits_element.value = defaultcredits;
                    867:     return;
                    868: }
                    869: |;
                    870:     }
1.468     raeburn   871:     return $setsections;
                    872: }
                    873: 
1.91      www       874: sub selectcourse_link {
1.909     raeburn   875:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    876:        $typeelement) = @_;
                    877:    my $type = $selecttype;
1.871     raeburn   878:    my $linktext = &mt('Select Course');
                    879:    if ($selecttype eq 'Community') {
1.909     raeburn   880:        $linktext = &mt('Select Community');
1.906     raeburn   881:    } elsif ($selecttype eq 'Course/Community') {
                    882:        $linktext = &mt('Select Course/Community');
1.909     raeburn   883:        $type = '';
1.1019    raeburn   884:    } elsif ($selecttype eq 'Select') {
                    885:        $linktext = &mt('Select');
                    886:        $type = '';
1.871     raeburn   887:    }
1.787     bisitz    888:    return '<span class="LC_nobreak">'
                    889:          ."<a href='"
                    890:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    891:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   892:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   893:          ."'>".$linktext.'</a>'
1.787     bisitz    894:          .'</span>';
1.74      www       895: }
1.42      matthew   896: 
1.653     raeburn   897: sub selectauthor_link {
                    898:    my ($form,$udom)=@_;
                    899:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    900:           &mt('Select Author').'</a>';
                    901: }
                    902: 
1.876     raeburn   903: sub selectuser_link {
1.881     raeburn   904:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   905:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   906:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   907:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   908:            ');">'.$linktext.'</a>';
1.876     raeburn   909: }
                    910: 
1.273     raeburn   911: sub check_uncheck_jscript {
                    912:     my $jscript = <<"ENDSCRT";
                    913: function checkAll(field) {
                    914:     if (field.length > 0) {
                    915:         for (i = 0; i < field.length; i++) {
1.1075.2.14  raeburn   916:             if (!field[i].disabled) {
                    917:                 field[i].checked = true;
                    918:             }
1.273     raeburn   919:         }
                    920:     } else {
1.1075.2.14  raeburn   921:         if (!field.disabled) {
                    922:             field.checked = true;
                    923:         }
1.273     raeburn   924:     }
                    925: }
                    926:  
                    927: function uncheckAll(field) {
                    928:     if (field.length > 0) {
                    929:         for (i = 0; i < field.length; i++) {
                    930:             field[i].checked = false ;
1.543     albertel  931:         }
                    932:     } else {
1.273     raeburn   933:         field.checked = false ;
                    934:     }
                    935: }
                    936: ENDSCRT
                    937:     return $jscript;
                    938: }
                    939: 
1.656     www       940: sub select_timezone {
1.1075.2.115  raeburn   941:    my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    942:    my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659     raeburn   943:    if ($includeempty) {
                    944:        $output .= '<option value=""';
                    945:        if (($selected eq '') || ($selected eq 'local')) {
                    946:            $output .= ' selected="selected" ';
                    947:        }
                    948:        $output .= '> </option>';
                    949:    }
1.657     raeburn   950:    my @timezones = DateTime::TimeZone->all_names;
                    951:    foreach my $tzone (@timezones) {
                    952:        $output.= '<option value="'.$tzone.'"';
                    953:        if ($tzone eq $selected) {
                    954:            $output.=' selected="selected"';
                    955:        }
                    956:        $output.=">$tzone</option>\n";
1.656     www       957:    }
                    958:    $output.="</select>";
                    959:    return $output;
                    960: }
1.273     raeburn   961: 
1.687     raeburn   962: sub select_datelocale {
1.1075.2.115  raeburn   963:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    964:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   965:     if ($includeempty) {
                    966:         $output .= '<option value=""';
                    967:         if ($selected eq '') {
                    968:             $output .= ' selected="selected" ';
                    969:         }
                    970:         $output .= '> </option>';
                    971:     }
1.1075.2.102  raeburn   972:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   973:     my (@possibles,%locale_names);
1.1075.2.102  raeburn   974:     my @locales = DateTime::Locale->ids();
                    975:     foreach my $id (@locales) {
                    976:         if ($id ne '') {
                    977:             my ($en_terr,$native_terr);
                    978:             my $loc = DateTime::Locale->load($id);
                    979:             if (ref($loc)) {
                    980:                 $en_terr = $loc->name();
                    981:                 $native_terr = $loc->native_name();
1.687     raeburn   982:                 if (grep(/^en$/,@languages) || !@languages) {
                    983:                     if ($en_terr ne '') {
                    984:                         $locale_names{$id} = '('.$en_terr.')';
                    985:                     } elsif ($native_terr ne '') {
                    986:                         $locale_names{$id} = $native_terr;
                    987:                     }
                    988:                 } else {
                    989:                     if ($native_terr ne '') {
                    990:                         $locale_names{$id} = $native_terr.' ';
                    991:                     } elsif ($en_terr ne '') {
                    992:                         $locale_names{$id} = '('.$en_terr.')';
                    993:                     }
                    994:                 }
1.1075.2.94  raeburn   995:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102  raeburn   996:                 push(@possibles,$id);
1.687     raeburn   997:             }
                    998:         }
                    999:     }
                   1000:     foreach my $item (sort(@possibles)) {
                   1001:         $output.= '<option value="'.$item.'"';
                   1002:         if ($item eq $selected) {
                   1003:             $output.=' selected="selected"';
                   1004:         }
                   1005:         $output.=">$item";
                   1006:         if ($locale_names{$item} ne '') {
1.1075.2.94  raeburn  1007:             $output.='  '.$locale_names{$item};
1.687     raeburn  1008:         }
                   1009:         $output.="</option>\n";
                   1010:     }
                   1011:     $output.="</select>";
                   1012:     return $output;
                   1013: }
                   1014: 
1.792     raeburn  1015: sub select_language {
1.1075.2.115  raeburn  1016:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1017:     my %langchoices;
                   1018:     if ($includeempty) {
1.1075.2.32  raeburn  1019:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1020:     }
                   1021:     foreach my $id (&languageids()) {
                   1022:         my $code = &supportedlanguagecode($id);
                   1023:         if ($code) {
                   1024:             $langchoices{$code} = &plainlanguagedescription($id);
                   1025:         }
                   1026:     }
1.1075.2.32  raeburn  1027:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115  raeburn  1028:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1029: }
                   1030: 
1.42      matthew  1031: =pod
1.36      matthew  1032: 
1.648     raeburn  1033: =item * &linked_select_forms(...)
1.36      matthew  1034: 
                   1035: linked_select_forms returns a string containing a <script></script> block
                   1036: and html for two <select> menus.  The select menus will be linked in that
                   1037: changing the value of the first menu will result in new values being placed
                   1038: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1039: order unless a defined order is provided.
1.36      matthew  1040: 
                   1041: linked_select_forms takes the following ordered inputs:
                   1042: 
                   1043: =over 4
                   1044: 
1.112     bowersj2 1045: =item * $formname, the name of the <form> tag
1.36      matthew  1046: 
1.112     bowersj2 1047: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1048: 
1.112     bowersj2 1049: =item * $firstdefault, the default value for the first menu
1.36      matthew  1050: 
1.112     bowersj2 1051: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1052: 
1.112     bowersj2 1053: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1054: 
1.112     bowersj2 1055: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1056: 
1.609     raeburn  1057: =item * $menuorder, the order of values in the first menu
                   1058: 
1.1075.2.31  raeburn  1059: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1060:         event for the first <select> tag
                   1061: 
                   1062: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1063:         event for the second <select> tag
                   1064: 
1.41      ng       1065: =back 
                   1066: 
1.36      matthew  1067: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1068: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1069: values for the first select menu.  The text that coincides with the 
1.41      ng       1070: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1071: and text for the second menu are given in the hash pointed to by 
                   1072: $menu{$choice1}->{'select2'}.  
                   1073: 
1.112     bowersj2 1074:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1075:                        default => "B3",
                   1076:                        select2 => { 
                   1077:                            B1 => "Choice B1",
                   1078:                            B2 => "Choice B2",
                   1079:                            B3 => "Choice B3",
                   1080:                            B4 => "Choice B4"
1.609     raeburn  1081:                            },
                   1082:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1083:                    },
                   1084:                A2 => { text =>"Choice A2" ,
                   1085:                        default => "C2",
                   1086:                        select2 => { 
                   1087:                            C1 => "Choice C1",
                   1088:                            C2 => "Choice C2",
                   1089:                            C3 => "Choice C3"
1.609     raeburn  1090:                            },
                   1091:                        order => ['C2','C1','C3'],
1.112     bowersj2 1092:                    },
                   1093:                A3 => { text =>"Choice A3" ,
                   1094:                        default => "D6",
                   1095:                        select2 => { 
                   1096:                            D1 => "Choice D1",
                   1097:                            D2 => "Choice D2",
                   1098:                            D3 => "Choice D3",
                   1099:                            D4 => "Choice D4",
                   1100:                            D5 => "Choice D5",
                   1101:                            D6 => "Choice D6",
                   1102:                            D7 => "Choice D7"
1.609     raeburn  1103:                            },
                   1104:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1105:                    }
                   1106:                );
1.36      matthew  1107: 
                   1108: =cut
                   1109: 
                   1110: sub linked_select_forms {
                   1111:     my ($formname,
                   1112:         $middletext,
                   1113:         $firstdefault,
                   1114:         $firstselectname,
                   1115:         $secondselectname, 
1.609     raeburn  1116:         $hashref,
                   1117:         $menuorder,
1.1075.2.31  raeburn  1118:         $onchangefirst,
                   1119:         $onchangesecond
1.36      matthew  1120:         ) = @_;
                   1121:     my $second = "document.$formname.$secondselectname";
                   1122:     my $first = "document.$formname.$firstselectname";
                   1123:     # output the javascript to do the changing
                   1124:     my $result = '';
1.776     bisitz   1125:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1126:     $result.="// <![CDATA[\n";
1.36      matthew  1127:     $result.="var select2data = new Object();\n";
                   1128:     $" = '","';
                   1129:     my $debug = '';
                   1130:     foreach my $s1 (sort(keys(%$hashref))) {
                   1131:         $result.="select2data.d_$s1 = new Object();\n";        
                   1132:         $result.="select2data.d_$s1.def = new String('".
                   1133:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1134:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1135:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1136:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1137:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1138:         }
1.36      matthew  1139:         $result.="\"@s2values\");\n";
                   1140:         $result.="select2data.d_$s1.texts = new Array(";        
                   1141:         my @s2texts;
                   1142:         foreach my $value (@s2values) {
1.1075.2.119  raeburn  1143:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1144:         }
                   1145:         $result.="\"@s2texts\");\n";
                   1146:     }
                   1147:     $"=' ';
                   1148:     $result.= <<"END";
                   1149: 
                   1150: function select1_changed() {
                   1151:     // Determine new choice
                   1152:     var newvalue = "d_" + $first.value;
                   1153:     // update select2
                   1154:     var values     = select2data[newvalue].values;
                   1155:     var texts      = select2data[newvalue].texts;
                   1156:     var select2def = select2data[newvalue].def;
                   1157:     var i;
                   1158:     // out with the old
                   1159:     for (i = 0; i < $second.options.length; i++) {
                   1160:         $second.options[i] = null;
                   1161:     }
                   1162:     // in with the nuclear
                   1163:     for (i=0;i<values.length; i++) {
                   1164:         $second.options[i] = new Option(values[i]);
1.143     matthew  1165:         $second.options[i].value = values[i];
1.36      matthew  1166:         $second.options[i].text = texts[i];
                   1167:         if (values[i] == select2def) {
                   1168:             $second.options[i].selected = true;
                   1169:         }
                   1170:     }
                   1171: }
1.824     bisitz   1172: // ]]>
1.36      matthew  1173: </script>
                   1174: END
                   1175:     # output the initial values for the selection lists
1.1075.2.31  raeburn  1176:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1177:     my @order = sort(keys(%{$hashref}));
                   1178:     if (ref($menuorder) eq 'ARRAY') {
                   1179:         @order = @{$menuorder};
                   1180:     }
                   1181:     foreach my $value (@order) {
1.36      matthew  1182:         $result.="    <option value=\"$value\" ";
1.253     albertel 1183:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1184:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1185:     }
                   1186:     $result .= "</select>\n";
                   1187:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1188:     $result .= $middletext;
1.1075.2.31  raeburn  1189:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1190:     if ($onchangesecond) {
                   1191:         $result .= ' onchange="'.$onchangesecond.'"';
                   1192:     }
                   1193:     $result .= ">\n";
1.36      matthew  1194:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1195:     
                   1196:     my @secondorder = sort(keys(%select2));
                   1197:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1198:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1199:     }
                   1200:     foreach my $value (@secondorder) {
1.36      matthew  1201:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1202:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1203:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1204:     }
                   1205:     $result .= "</select>\n";
                   1206:     #    return $debug;
                   1207:     return $result;
                   1208: }   #  end of sub linked_select_forms {
                   1209: 
1.45      matthew  1210: =pod
1.44      bowersj2 1211: 
1.973     raeburn  1212: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1213: 
1.112     bowersj2 1214: Returns a string corresponding to an HTML link to the given help
                   1215: $topic, where $topic corresponds to the name of a .tex file in
                   1216: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1217: spaces. 
                   1218: 
                   1219: $text will optionally be linked to the same topic, allowing you to
                   1220: link text in addition to the graphic. If you do not want to link
                   1221: text, but wish to specify one of the later parameters, pass an
                   1222: empty string. 
                   1223: 
                   1224: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1225: the link will not open a new window. If false, the link will open
                   1226: a new window using Javascript. (Default is false.) 
                   1227: 
                   1228: $width and $height are optional numerical parameters that will
                   1229: override the width and height of the popped up window, which may
1.973     raeburn  1230: be useful for certain help topics with big pictures included.
                   1231: 
                   1232: $imgid is the id of the img tag used for the help icon. This may be
                   1233: used in a javascript call to switch the image src.  See 
                   1234: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1235: 
                   1236: =cut
                   1237: 
                   1238: sub help_open_topic {
1.973     raeburn  1239:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1240:     $text = "" if (not defined $text);
1.44      bowersj2 1241:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1242:     $width = 500 if (not defined $width);
1.44      bowersj2 1243:     $height = 400 if (not defined $height);
                   1244:     my $filename = $topic;
                   1245:     $filename =~ s/ /_/g;
                   1246: 
1.48      bowersj2 1247:     my $template = "";
                   1248:     my $link;
1.572     banghart 1249:     
1.159     www      1250:     $topic=~s/\W/\_/g;
1.44      bowersj2 1251: 
1.572     banghart 1252:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1253:         if ($env{'browser.mobile'}) {
                   1254: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1255:         } else {
                   1256:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1257:         }
1.1037    www      1258:     } elsif ($stayOnPage eq 'popup') {
                   1259:         $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 1260:     } else {
1.48      bowersj2 1261: 	$link = "/adm/help/${filename}.hlp";
                   1262:     }
                   1263: 
                   1264:     # Add the text
1.755     neumanie 1265:     if ($text ne "") {	
1.763     bisitz   1266: 	$template.='<span class="LC_help_open_topic">'
                   1267:                   .'<a target="_top" href="'.$link.'">'
                   1268:                   .$text.'</a>';
1.48      bowersj2 1269:     }
                   1270: 
1.763     bisitz   1271:     # (Always) Add the graphic
1.179     matthew  1272:     my $title = &mt('Online Help');
1.667     raeburn  1273:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1274:     if ($imgid ne '') {
                   1275:         $imgid = ' id="'.$imgid.'"';
                   1276:     }
1.763     bisitz   1277:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1278:               .'<img src="'.$helpicon.'" border="0"'
                   1279:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1280:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1281:               .' /></a>';
                   1282:     if ($text ne "") {	
                   1283:         $template.='</span>';
                   1284:     }
1.44      bowersj2 1285:     return $template;
                   1286: 
1.106     bowersj2 1287: }
                   1288: 
                   1289: # This is a quicky function for Latex cheatsheet editing, since it 
                   1290: # appears in at least four places
                   1291: sub helpLatexCheatsheet {
1.1037    www      1292:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1293:     my $out;
1.106     bowersj2 1294:     my $addOther = '';
1.732     raeburn  1295:     if ($topic) {
1.1037    www      1296: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1297:     }
                   1298:     $out = '<span>' # Start cheatsheet
                   1299: 	  .$addOther
                   1300:           .'<span>'
1.1037    www      1301: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1302: 	  .'</span> <span>'
1.1037    www      1303: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1304: 	  .'</span>';
1.732     raeburn  1305:     unless ($not_author) {
1.763     bisitz   1306:         $out .= ' <span>'
1.1037    www      1307: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1308: 	       .'</span> <span>'
1.1075.2.78  raeburn  1309:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1310:                .'</span>';
1.732     raeburn  1311:     }
1.763     bisitz   1312:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1313:     return $out;
1.172     www      1314: }
                   1315: 
1.430     albertel 1316: sub general_help {
                   1317:     my $helptopic='Student_Intro';
                   1318:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1319: 	$helptopic='Authoring_Intro';
1.907     raeburn  1320:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1321: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1322:     } elsif ($env{'request.role'}=~/^dc/) {
                   1323:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1324:     }
                   1325:     return $helptopic;
                   1326: }
                   1327: 
                   1328: sub update_help_link {
                   1329:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1330:     my $origurl = $ENV{'REQUEST_URI'};
                   1331:     $origurl=~s|^/~|/priv/|;
                   1332:     my $timestamp = time;
                   1333:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1334:         $$datum = &escape($$datum);
                   1335:     }
                   1336: 
                   1337:     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";
                   1338:     my $output .= <<"ENDOUTPUT";
                   1339: <script type="text/javascript">
1.824     bisitz   1340: // <![CDATA[
1.430     albertel 1341: banner_link = '$banner_link';
1.824     bisitz   1342: // ]]>
1.430     albertel 1343: </script>
                   1344: ENDOUTPUT
                   1345:     return $output;
                   1346: }
                   1347: 
                   1348: # now just updates the help link and generates a blue icon
1.193     raeburn  1349: sub help_open_menu {
1.430     albertel 1350:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1351: 	= @_;    
1.949     droeschl 1352:     $stayOnPage = 1;
1.430     albertel 1353:     my $output;
                   1354:     if ($component_help) {
                   1355: 	if (!$text) {
                   1356: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1357: 				       $width,$height);
                   1358: 	} else {
                   1359: 	    my $help_text;
                   1360: 	    $help_text=&unescape($topic);
                   1361: 	    $output='<table><tr><td>'.
                   1362: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1363: 				 $width,$height).'</td></tr></table>';
                   1364: 	}
                   1365:     }
                   1366:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1367:     return $output.$banner_link;
                   1368: }
                   1369: 
                   1370: sub top_nav_help {
                   1371:     my ($text) = @_;
1.436     albertel 1372:     $text = &mt($text);
1.1075.2.60  raeburn  1373:     my $stay_on_page;
                   1374:     unless ($env{'environment.remote'} eq 'on') {
                   1375:         $stay_on_page = 1;
                   1376:     }
1.1075.2.61  raeburn  1377:     my ($link,$banner_link);
                   1378:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1379:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1380: 	                         : "javascript:helpMenu('open')";
                   1381:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1382:     }
1.201     raeburn  1383:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1384:     if ($link) {
                   1385:         return <<"END";
1.436     albertel 1386: $banner_link
1.1075.2.56  raeburn  1387: <a href="$link" title="$title">$text</a>
1.436     albertel 1388: END
1.1075.2.61  raeburn  1389:     } else {
                   1390:         return '&nbsp;'.$text.'&nbsp;';
                   1391:     }
1.436     albertel 1392: }
                   1393: 
                   1394: sub help_menu_js {
1.1075.2.52  raeburn  1395:     my ($httphost) = @_;
1.949     droeschl 1396:     my $stayOnPage = 1;
1.436     albertel 1397:     my $width = 620;
                   1398:     my $height = 600;
1.430     albertel 1399:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1400:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1401:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1402:     my $start_page =
                   1403:         &Apache::loncommon::start_page('Help Menu', undef,
                   1404: 				       {'frameset'    => 1,
                   1405: 					'js_ready'    => 1,
1.1075.2.52  raeburn  1406:                                         'use_absolute' => $httphost, 
1.331     albertel 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.1075.2.61  raeburn  1438:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1439:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1440:     caller.document.close();
                   1441:     caller.focus();
1.193     raeburn  1442: }
1.877     bisitz   1443: // END LON-CAPA Internal -->
1.253     albertel 1444: // ]]>
1.436     albertel 1445: </script>
1.193     raeburn  1446: ENDTEMPLATE
                   1447:     return $template;
                   1448: }
                   1449: 
1.172     www      1450: sub help_open_bug {
                   1451:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1452:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1453:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1454:     $text = "" if (not defined $text);
                   1455: 	$stayOnPage=1;
1.184     albertel 1456:     $width = 600 if (not defined $width);
                   1457:     $height = 600 if (not defined $height);
1.172     www      1458: 
                   1459:     $topic=~s/\W+/\+/g;
                   1460:     my $link='';
                   1461:     my $template='';
1.379     albertel 1462:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1463: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1464:     if (!$stayOnPage)
                   1465:     {
                   1466: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1467:     }
                   1468:     else
                   1469:     {
                   1470: 	$link = $url;
                   1471:     }
                   1472:     # Add the text
                   1473:     if ($text ne "")
                   1474:     {
                   1475: 	$template .= 
                   1476:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1477:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1478:     }
                   1479: 
                   1480:     # Add the graphic
1.179     matthew  1481:     my $title = &mt('Report a Bug');
1.215     albertel 1482:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1483:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1484:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1485: ENDTEMPLATE
                   1486:     if ($text ne '') { $template.='</td></tr></table>' };
                   1487:     return $template;
                   1488: 
                   1489: }
                   1490: 
                   1491: sub help_open_faq {
                   1492:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1493:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1494:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1495:     $text = "" if (not defined $text);
                   1496: 	$stayOnPage=1;
                   1497:     $width = 350 if (not defined $width);
                   1498:     $height = 400 if (not defined $height);
                   1499: 
                   1500:     $topic=~s/\W+/\+/g;
                   1501:     my $link='';
                   1502:     my $template='';
                   1503:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1504:     if (!$stayOnPage)
                   1505:     {
                   1506: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1507:     }
                   1508:     else
                   1509:     {
                   1510: 	$link = $url;
                   1511:     }
                   1512: 
                   1513:     # Add the text
                   1514:     if ($text ne "")
                   1515:     {
                   1516: 	$template .= 
1.173     www      1517:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1518:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1519:     }
                   1520: 
                   1521:     # Add the graphic
1.179     matthew  1522:     my $title = &mt('View the FAQ');
1.215     albertel 1523:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1524:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1525:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1526: ENDTEMPLATE
                   1527:     if ($text ne '') { $template.='</td></tr></table>' };
                   1528:     return $template;
                   1529: 
1.44      bowersj2 1530: }
1.37      matthew  1531: 
1.180     matthew  1532: ###############################################################
                   1533: ###############################################################
                   1534: 
1.45      matthew  1535: =pod
                   1536: 
1.648     raeburn  1537: =item * &change_content_javascript():
1.256     matthew  1538: 
                   1539: This and the next function allow you to create small sections of an
                   1540: otherwise static HTML page that you can update on the fly with
                   1541: Javascript, even in Netscape 4.
                   1542: 
                   1543: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1544: must be written to the HTML page once. It will prove the Javascript
                   1545: function "change(name, content)". Calling the change function with the
                   1546: name of the section 
                   1547: you want to update, matching the name passed to C<changable_area>, and
                   1548: the new content you want to put in there, will put the content into
                   1549: that area.
                   1550: 
                   1551: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1552: to contain room for the original contents. You need to "make space"
                   1553: for whatever changes you wish to make, and be B<sure> to check your
                   1554: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1555: it's adequate for updating a one-line status display, but little more.
                   1556: This script will set the space to 100% width, so you only need to
                   1557: worry about height in Netscape 4.
                   1558: 
                   1559: Modern browsers are much less limiting, and if you can commit to the
                   1560: user not using Netscape 4, this feature may be used freely with
                   1561: pretty much any HTML.
                   1562: 
                   1563: =cut
                   1564: 
                   1565: sub change_content_javascript {
                   1566:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1567:     if ($env{'browser.type'} eq 'netscape' &&
                   1568: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1569: 	return (<<NETSCAPE4);
                   1570: 	function change(name, content) {
                   1571: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1572: 	    doc.open();
                   1573: 	    doc.write(content);
                   1574: 	    doc.close();
                   1575: 	}
                   1576: NETSCAPE4
                   1577:     } else {
                   1578: 	# Otherwise, we need to use semi-standards-compliant code
                   1579: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1580: 	# is really scary, and every useful browser supports it
                   1581: 	return (<<DOMBASED);
                   1582: 	function change(name, content) {
                   1583: 	    element = document.getElementById(name);
                   1584: 	    element.innerHTML = content;
                   1585: 	}
                   1586: DOMBASED
                   1587:     }
                   1588: }
                   1589: 
                   1590: =pod
                   1591: 
1.648     raeburn  1592: =item * &changable_area($name,$origContent):
1.256     matthew  1593: 
                   1594: This provides a "changable area" that can be modified on the fly via
                   1595: the Javascript code provided in C<change_content_javascript>. $name is
                   1596: the name you will use to reference the area later; do not repeat the
                   1597: same name on a given HTML page more then once. $origContent is what
                   1598: the area will originally contain, which can be left blank.
                   1599: 
                   1600: =cut
                   1601: 
                   1602: sub changable_area {
                   1603:     my ($name, $origContent) = @_;
                   1604: 
1.258     albertel 1605:     if ($env{'browser.type'} eq 'netscape' &&
                   1606: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1607: 	# If this is netscape 4, we need to use the Layer tag
                   1608: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1609:     } else {
                   1610: 	return "<span id='$name'>$origContent</span>";
                   1611:     }
                   1612: }
                   1613: 
                   1614: =pod
                   1615: 
1.648     raeburn  1616: =item * &viewport_geometry_js 
1.590     raeburn  1617: 
                   1618: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1619: 
                   1620: =cut
                   1621: 
                   1622: 
                   1623: sub viewport_geometry_js { 
                   1624:     return <<"GEOMETRY";
                   1625: var Geometry = {};
                   1626: function init_geometry() {
                   1627:     if (Geometry.init) { return };
                   1628:     Geometry.init=1;
                   1629:     if (window.innerHeight) {
                   1630:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1631:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1632:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1633:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1634:     }
                   1635:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1636:         Geometry.getViewportHeight =
                   1637:             function() { return document.documentElement.clientHeight; };
                   1638:         Geometry.getViewportWidth =
                   1639:             function() { return document.documentElement.clientWidth; };
                   1640: 
                   1641:         Geometry.getHorizontalScroll =
                   1642:             function() { return document.documentElement.scrollLeft; };
                   1643:         Geometry.getVerticalScroll =
                   1644:             function() { return document.documentElement.scrollTop; };
                   1645:     }
                   1646:     else if (document.body.clientHeight) {
                   1647:         Geometry.getViewportHeight =
                   1648:             function() { return document.body.clientHeight; };
                   1649:         Geometry.getViewportWidth =
                   1650:             function() { return document.body.clientWidth; };
                   1651:         Geometry.getHorizontalScroll =
                   1652:             function() { return document.body.scrollLeft; };
                   1653:         Geometry.getVerticalScroll =
                   1654:             function() { return document.body.scrollTop; };
                   1655:     }
                   1656: }
                   1657: 
                   1658: GEOMETRY
                   1659: }
                   1660: 
                   1661: =pod
                   1662: 
1.648     raeburn  1663: =item * &viewport_size_js()
1.590     raeburn  1664: 
                   1665: 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. 
                   1666: 
                   1667: =cut
                   1668: 
                   1669: sub viewport_size_js {
                   1670:     my $geometry = &viewport_geometry_js();
                   1671:     return <<"DIMS";
                   1672: 
                   1673: $geometry
                   1674: 
                   1675: function getViewportDims(width,height) {
                   1676:     init_geometry();
                   1677:     width.value = Geometry.getViewportWidth();
                   1678:     height.value = Geometry.getViewportHeight();
                   1679:     return;
                   1680: }
                   1681: 
                   1682: DIMS
                   1683: }
                   1684: 
                   1685: =pod
                   1686: 
1.648     raeburn  1687: =item * &resize_textarea_js()
1.565     albertel 1688: 
                   1689: emits the needed javascript to resize a textarea to be as big as possible
                   1690: 
                   1691: creates a function resize_textrea that takes two IDs first should be
                   1692: the id of the element to resize, second should be the id of a div that
                   1693: surrounds everything that comes after the textarea, this routine needs
                   1694: to be attached to the <body> for the onload and onresize events.
                   1695: 
1.648     raeburn  1696: =back
1.565     albertel 1697: 
                   1698: =cut
                   1699: 
                   1700: sub resize_textarea_js {
1.590     raeburn  1701:     my $geometry = &viewport_geometry_js();
1.565     albertel 1702:     return <<"RESIZE";
                   1703:     <script type="text/javascript">
1.824     bisitz   1704: // <![CDATA[
1.590     raeburn  1705: $geometry
1.565     albertel 1706: 
1.588     albertel 1707: function getX(element) {
                   1708:     var x = 0;
                   1709:     while (element) {
                   1710: 	x += element.offsetLeft;
                   1711: 	element = element.offsetParent;
                   1712:     }
                   1713:     return x;
                   1714: }
                   1715: function getY(element) {
                   1716:     var y = 0;
                   1717:     while (element) {
                   1718: 	y += element.offsetTop;
                   1719: 	element = element.offsetParent;
                   1720:     }
                   1721:     return y;
                   1722: }
                   1723: 
                   1724: 
1.565     albertel 1725: function resize_textarea(textarea_id,bottom_id) {
                   1726:     init_geometry();
                   1727:     var textarea        = document.getElementById(textarea_id);
                   1728:     //alert(textarea);
                   1729: 
1.588     albertel 1730:     var textarea_top    = getY(textarea);
1.565     albertel 1731:     var textarea_height = textarea.offsetHeight;
                   1732:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1733:     var bottom_top      = getY(bottom);
1.565     albertel 1734:     var bottom_height   = bottom.offsetHeight;
                   1735:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1736:     var fudge           = 23;
1.565     albertel 1737:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1738:     if (new_height < 300) {
                   1739: 	new_height = 300;
                   1740:     }
                   1741:     textarea.style.height=new_height+'px';
                   1742: }
1.824     bisitz   1743: // ]]>
1.565     albertel 1744: </script>
                   1745: RESIZE
                   1746: 
                   1747: }
                   1748: 
1.1075.2.112  raeburn  1749: sub colorfuleditor_js {
                   1750:     return <<"COLORFULEDIT"
                   1751: <script type="text/javascript">
                   1752: // <![CDATA[>
                   1753:     function fold_box(curDepth, lastresource){
                   1754: 
                   1755:     // we need a list because there can be several blocks you need to fold in one tag
                   1756:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1757:     // but there is only one folding button per tag
                   1758:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1759: 
                   1760:         if(block.item(0).style.display == 'none'){
                   1761: 
                   1762:             foldbutton.value = '@{[&mt("Hide")]}';
                   1763:             for (i = 0; i < block.length; i++){
                   1764:                 block.item(i).style.display = '';
                   1765:             }
                   1766:         }else{
                   1767: 
                   1768:             foldbutton.value = '@{[&mt("Show")]}';
                   1769:             for (i = 0; i < block.length; i++){
                   1770:                 // block.item(i).style.visibility = 'collapse';
                   1771:                 block.item(i).style.display = 'none';
                   1772:             }
                   1773:         };
                   1774:         saveState(lastresource);
                   1775:     }
                   1776: 
                   1777:     function saveState (lastresource) {
                   1778: 
                   1779:         var tag_list = getTagList();
                   1780:         if(tag_list != null){
                   1781:             var timestamp = new Date().getTime();
                   1782:             var key = lastresource;
                   1783: 
                   1784:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1785:             // starting with timestamp
                   1786:             var value = timestamp+';';
                   1787: 
                   1788:             // building the list of key-value pairs
                   1789:             for(var i = 0; i < tag_list.length; i++){
                   1790:                 value += tag_list[i]+',';
                   1791:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1792:             }
                   1793: 
                   1794:             // only iterate whole storage if nothing to override
                   1795:             if(localStorage.getItem(key) == null){
                   1796: 
                   1797:                 // prevent storage from growing large
                   1798:                 if(localStorage.length > 50){
                   1799:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1800:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1801:                     var oldest_key;
                   1802: 
                   1803:                     for(var i = 1; i < localStorage.length; i++){
                   1804:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1805:                             oldest_key = localStorage.key(i);
                   1806:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1807:                         }
                   1808:                     }
                   1809:                     localStorage.removeItem(oldest_key);
                   1810:                 }
                   1811:             }
                   1812:             localStorage.setItem(key,value);
                   1813:         }
                   1814:     }
                   1815: 
                   1816:     // restore folding status of blocks (on page load)
                   1817:     function restoreState (lastresource) {
                   1818:         if(localStorage.getItem(lastresource) != null){
                   1819:             var key = lastresource;
                   1820:             var value = localStorage.getItem(key);
                   1821:             var regex_delTimestamp = /^\d+;/;
                   1822: 
                   1823:             value.replace(regex_delTimestamp, '');
                   1824: 
                   1825:             var valueArr = value.split(';');
                   1826:             var pairs;
                   1827:             var elements;
                   1828:             for (var i = 0; i < valueArr.length; i++){
                   1829:                 pairs = valueArr[i].split(',');
                   1830:                 elements = document.getElementsByName(pairs[0]);
                   1831: 
                   1832:                 for (var j = 0; j < elements.length; j++){
                   1833:                     elements[j].style.display = pairs[1];
                   1834:                     if (pairs[1] == "none"){
                   1835:                         var regex_id = /([_\\d]+)\$/;
                   1836:                         regex_id.exec(pairs[0]);
                   1837:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1838:                     }
                   1839:                 }
                   1840:             }
                   1841:         }
                   1842:     }
                   1843: 
                   1844:     function getTagList () {
                   1845: 
                   1846:         var stringToSearch = document.lonhomework.innerHTML;
                   1847: 
                   1848:         var ret = new Array();
                   1849:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1850:         var tag_list = stringToSearch.match(regex_findBlock);
                   1851: 
                   1852:         if(tag_list != null){
                   1853:             for(var i = 0; i < tag_list.length; i++){
                   1854:                 ret.push(tag_list[i].replace(/"/, ''));
                   1855:             }
                   1856:         }
                   1857:         return ret;
                   1858:     }
                   1859: 
                   1860:     function saveScrollPosition (resource) {
                   1861:         var tag_list = getTagList();
                   1862: 
                   1863:         // we dont always want to jump to the first block
                   1864:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1865:         if(\$(window).scrollTop() > 170){
                   1866:             if(tag_list != null){
                   1867:                 var result;
                   1868:                 for(var i = 0; i < tag_list.length; i++){
                   1869:                     if(isElementInViewport(tag_list[i])){
                   1870:                         result += tag_list[i]+';';
                   1871:                     }
                   1872:                 }
                   1873:                 sessionStorage.setItem('anchor_'+resource, result);
                   1874:             }
                   1875:         } else {
                   1876:             // we dont need to save zero, just delete the item to leave everything tidy
                   1877:             sessionStorage.removeItem('anchor_'+resource);
                   1878:         }
                   1879:     }
                   1880: 
                   1881:     function restoreScrollPosition(resource){
                   1882: 
                   1883:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1884:         if(elem != null){
                   1885:             var tag_list = elem.split(';');
                   1886:             var elem_list;
                   1887: 
                   1888:             for(var i = 0; i < tag_list.length; i++){
                   1889:                 elem_list = document.getElementsByName(tag_list[i]);
                   1890: 
                   1891:                 if(elem_list.length > 0){
                   1892:                     elem = elem_list[0];
                   1893:                     break;
                   1894:                 }
                   1895:             }
                   1896:             elem.scrollIntoView();
                   1897:         }
                   1898:     }
                   1899: 
                   1900:     function isElementInViewport(el) {
                   1901: 
                   1902:         // change to last element instead of first
                   1903:         var elem = document.getElementsByName(el);
                   1904:         var rect = elem[0].getBoundingClientRect();
                   1905: 
                   1906:         return (
                   1907:             rect.top >= 0 &&
                   1908:             rect.left >= 0 &&
                   1909:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1910:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1911:         );
                   1912:     }
                   1913: 
                   1914:     function autosize(depth){
                   1915:         var cmInst = window['cm'+depth];
                   1916:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1917: 
                   1918:         // is fixed size, switching to dynamic
                   1919:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1920:             cmInst.setSize("","auto");
                   1921:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1922:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1923: 
                   1924:         // is dynamic size, switching to fixed
                   1925:         } else {
                   1926:             cmInst.setSize("","300px");
                   1927:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1928:             sessionStorage.removeItem("autosized_"+depth);
                   1929:         }
                   1930:     }
                   1931: 
                   1932: 
                   1933: 
                   1934: // ]]>
                   1935: </script>
                   1936: COLORFULEDIT
                   1937: }
                   1938: 
                   1939: sub xmleditor_js {
                   1940:     return <<XMLEDIT
                   1941: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1942: <script type="text/javascript">
                   1943: // <![CDATA[>
                   1944: 
                   1945:     function saveScrollPosition (resource) {
                   1946: 
                   1947:         var scrollPos = \$(window).scrollTop();
                   1948:         sessionStorage.setItem(resource,scrollPos);
                   1949:     }
                   1950: 
                   1951:     function restoreScrollPosition(resource){
                   1952: 
                   1953:         var scrollPos = sessionStorage.getItem(resource);
                   1954:         \$(window).scrollTop(scrollPos);
                   1955:     }
                   1956: 
                   1957:     // unless internet explorer
                   1958:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1959: 
                   1960:         \$(document).ready(function() {
                   1961:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1962:         });
                   1963:     }
                   1964: 
                   1965:     // inserts text at cursor position into codemirror (xml editor only)
                   1966:     function insertText(text){
                   1967:         cm.focus();
                   1968:         var curPos = cm.getCursor();
                   1969:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1970:     }
                   1971: // ]]>
                   1972: </script>
                   1973: XMLEDIT
                   1974: }
                   1975: 
                   1976: sub insert_folding_button {
                   1977:     my $curDepth = $Apache::lonxml::curdepth;
                   1978:     my $lastresource = $env{'request.ambiguous'};
                   1979: 
                   1980:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   1981:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1982: }
                   1983: 
                   1984: 
1.565     albertel 1985: =pod
                   1986: 
1.256     matthew  1987: =head1 Excel and CSV file utility routines
                   1988: 
                   1989: =cut
                   1990: 
                   1991: ###############################################################
                   1992: ###############################################################
                   1993: 
                   1994: =pod
                   1995: 
1.1075.2.56  raeburn  1996: =over 4
                   1997: 
1.648     raeburn  1998: =item * &csv_translate($text) 
1.37      matthew  1999: 
1.185     www      2000: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2001: format.
                   2002: 
                   2003: =cut
                   2004: 
1.180     matthew  2005: ###############################################################
                   2006: ###############################################################
1.37      matthew  2007: sub csv_translate {
                   2008:     my $text = shift;
                   2009:     $text =~ s/\"/\"\"/g;
1.209     albertel 2010:     $text =~ s/\n/ /g;
1.37      matthew  2011:     return $text;
                   2012: }
1.180     matthew  2013: 
                   2014: ###############################################################
                   2015: ###############################################################
                   2016: 
                   2017: =pod
                   2018: 
1.648     raeburn  2019: =item * &define_excel_formats()
1.180     matthew  2020: 
                   2021: Define some commonly used Excel cell formats.
                   2022: 
                   2023: Currently supported formats:
                   2024: 
                   2025: =over 4
                   2026: 
                   2027: =item header
                   2028: 
                   2029: =item bold
                   2030: 
                   2031: =item h1
                   2032: 
                   2033: =item h2
                   2034: 
                   2035: =item h3
                   2036: 
1.256     matthew  2037: =item h4
                   2038: 
                   2039: =item i
                   2040: 
1.180     matthew  2041: =item date
                   2042: 
                   2043: =back
                   2044: 
                   2045: Inputs: $workbook
                   2046: 
                   2047: Returns: $format, a hash reference.
                   2048: 
1.1057    foxr     2049: 
1.180     matthew  2050: =cut
                   2051: 
                   2052: ###############################################################
                   2053: ###############################################################
                   2054: sub define_excel_formats {
                   2055:     my ($workbook) = @_;
                   2056:     my $format;
                   2057:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2058:                                                 bottom    => 1,
                   2059:                                                 align     => 'center');
                   2060:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2061:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2062:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2063:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2064:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2065:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2066:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2067:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2068:     return $format;
                   2069: }
                   2070: 
                   2071: ###############################################################
                   2072: ###############################################################
1.113     bowersj2 2073: 
                   2074: =pod
                   2075: 
1.648     raeburn  2076: =item * &create_workbook()
1.255     matthew  2077: 
                   2078: Create an Excel worksheet.  If it fails, output message on the
                   2079: request object and return undefs.
                   2080: 
                   2081: Inputs: Apache request object
                   2082: 
                   2083: Returns (undef) on failure, 
                   2084:     Excel worksheet object, scalar with filename, and formats 
                   2085:     from &Apache::loncommon::define_excel_formats on success
                   2086: 
                   2087: =cut
                   2088: 
                   2089: ###############################################################
                   2090: ###############################################################
                   2091: sub create_workbook {
                   2092:     my ($r) = @_;
                   2093:         #
                   2094:     # Create the excel spreadsheet
                   2095:     my $filename = '/prtspool/'.
1.258     albertel 2096:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2097:         time.'_'.rand(1000000000).'.xls';
                   2098:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2099:     if (! defined($workbook)) {
                   2100:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2101:         $r->print(
                   2102:             '<p class="LC_error">'
                   2103:            .&mt('Problems occurred in creating the new Excel file.')
                   2104:            .' '.&mt('This error has been logged.')
                   2105:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2106:            .'</p>'
                   2107:         );
1.255     matthew  2108:         return (undef);
                   2109:     }
                   2110:     #
1.1014    foxr     2111:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2112:     #
                   2113:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2114:     return ($workbook,$filename,$format);
                   2115: }
                   2116: 
                   2117: ###############################################################
                   2118: ###############################################################
                   2119: 
                   2120: =pod
                   2121: 
1.648     raeburn  2122: =item * &create_text_file()
1.113     bowersj2 2123: 
1.542     raeburn  2124: Create a file to write to and eventually make available to the user.
1.256     matthew  2125: If file creation fails, outputs an error message on the request object and 
                   2126: return undefs.
1.113     bowersj2 2127: 
1.256     matthew  2128: Inputs: Apache request object, and file suffix
1.113     bowersj2 2129: 
1.256     matthew  2130: Returns (undef) on failure, 
                   2131:     Filehandle and filename on success.
1.113     bowersj2 2132: 
                   2133: =cut
                   2134: 
1.256     matthew  2135: ###############################################################
                   2136: ###############################################################
                   2137: sub create_text_file {
                   2138:     my ($r,$suffix) = @_;
                   2139:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2140:     my $fh;
                   2141:     my $filename = '/prtspool/'.
1.258     albertel 2142:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2143:         time.'_'.rand(1000000000).'.'.$suffix;
                   2144:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2145:     if (! defined($fh)) {
                   2146:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2147:         $r->print(
                   2148:             '<p class="LC_error">'
                   2149:            .&mt('Problems occurred in creating the output file.')
                   2150:            .' '.&mt('This error has been logged.')
                   2151:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2152:            .'</p>'
                   2153:         );
1.113     bowersj2 2154:     }
1.256     matthew  2155:     return ($fh,$filename)
1.113     bowersj2 2156: }
                   2157: 
                   2158: 
1.256     matthew  2159: =pod 
1.113     bowersj2 2160: 
                   2161: =back
                   2162: 
                   2163: =cut
1.37      matthew  2164: 
                   2165: ###############################################################
1.33      matthew  2166: ##        Home server <option> list generating code          ##
                   2167: ###############################################################
1.35      matthew  2168: 
1.169     www      2169: # ------------------------------------------
                   2170: 
                   2171: sub domain_select {
                   2172:     my ($name,$value,$multiple)=@_;
                   2173:     my %domains=map { 
1.514     albertel 2174: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2175:     } &Apache::lonnet::all_domains();
1.169     www      2176:     if ($multiple) {
                   2177: 	$domains{''}=&mt('Any domain');
1.550     albertel 2178: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2179: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2180:     } else {
1.550     albertel 2181: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2182: 	return &select_form($name,$value,\%domains);
1.169     www      2183:     }
                   2184: }
                   2185: 
1.282     albertel 2186: #-------------------------------------------
                   2187: 
                   2188: =pod
                   2189: 
1.519     raeburn  2190: =head1 Routines for form select boxes
                   2191: 
                   2192: =over 4
                   2193: 
1.648     raeburn  2194: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2195: 
                   2196: Returns a string containing a <select> element int multiple mode
                   2197: 
                   2198: 
                   2199: Args:
                   2200:   $name - name of the <select> element
1.506     raeburn  2201:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2202:   $size - number of rows long the select element is
1.283     albertel 2203:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2204:           (shown text should already have been &mt())
1.506     raeburn  2205:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2206: 
1.282     albertel 2207: =cut
                   2208: 
                   2209: #-------------------------------------------
1.169     www      2210: sub multiple_select_form {
1.284     albertel 2211:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2212:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2213:     my $output='';
1.191     matthew  2214:     if (! defined($size)) {
                   2215:         $size = 4;
1.283     albertel 2216:         if (scalar(keys(%$hash))<4) {
                   2217:             $size = scalar(keys(%$hash));
1.191     matthew  2218:         }
                   2219:     }
1.734     bisitz   2220:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2221:     my @order;
1.506     raeburn  2222:     if (ref($order) eq 'ARRAY')  {
                   2223:         @order = @{$order};
                   2224:     } else {
                   2225:         @order = sort(keys(%$hash));
1.501     banghart 2226:     }
                   2227:     if (exists($$hash{'select_form_order'})) {
                   2228:         @order = @{$$hash{'select_form_order'}};
                   2229:     }
                   2230:         
1.284     albertel 2231:     foreach my $key (@order) {
1.356     albertel 2232:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2233:         $output.='selected="selected" ' if ($selected{$key});
                   2234:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2235:     }
                   2236:     $output.="</select>\n";
                   2237:     return $output;
                   2238: }
                   2239: 
1.88      www      2240: #-------------------------------------------
                   2241: 
                   2242: =pod
                   2243: 
1.1075.2.115  raeburn  2244: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2245: 
                   2246: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2247: allow a user to select options from a ref to a hash containing:
                   2248: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2249: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2250: An optional arg -- $readonly -- if true will cause the select form
                   2251: to be disabled, e.g., for the case where an instructor has a section-
                   2252: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2253: 
1.88      www      2254: See lonrights.pm for an example invocation and use.
                   2255: 
                   2256: =cut
                   2257: 
                   2258: #-------------------------------------------
                   2259: sub select_form {
1.1075.2.115  raeburn  2260:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2261:     return unless (ref($hashref) eq 'HASH');
                   2262:     if ($onchange) {
                   2263:         $onchange = ' onchange="'.$onchange.'"';
                   2264:     }
1.1075.2.129! raeburn  2265:     my $disabled;
        !          2266:     if ($readonly) {
        !          2267:         $disabled = ' disabled="disabled"';
        !          2268:     }
        !          2269:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2270:     my @keys;
1.970     raeburn  2271:     if (exists($hashref->{'select_form_order'})) {
                   2272: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2273:     } else {
1.970     raeburn  2274: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2275:     }
1.356     albertel 2276:     foreach my $key (@keys) {
                   2277:         $selectform.=
                   2278: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2279:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2280:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2281:     }
                   2282:     $selectform.="</select>";
                   2283:     return $selectform;
                   2284: }
                   2285: 
1.475     www      2286: # For display filters
                   2287: 
                   2288: sub display_filter {
1.1074    raeburn  2289:     my ($context) = @_;
1.475     www      2290:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2291:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2292:     my $phraseinput = 'hidden';
                   2293:     my $includeinput = 'hidden';
                   2294:     my ($checked,$includetypestext);
                   2295:     if ($env{'form.displayfilter'} eq 'containing') {
                   2296:         $phraseinput = 'text'; 
                   2297:         if ($context eq 'parmslog') {
                   2298:             $includeinput = 'checkbox';
                   2299:             if ($env{'form.includetypes'}) {
                   2300:                 $checked = ' checked="checked"';
                   2301:             }
                   2302:             $includetypestext = &mt('Include parameter types');
                   2303:         }
                   2304:     } else {
                   2305:         $includetypestext = '&nbsp;';
                   2306:     }
                   2307:     my ($additional,$secondid,$thirdid);
                   2308:     if ($context eq 'parmslog') {
                   2309:         $additional = 
                   2310:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2311:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2312:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2313:             '</label>';
                   2314:         $secondid = 'includetypes';
                   2315:         $thirdid = 'includetypestext';
                   2316:     }
                   2317:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2318:                                                     '$secondid','$thirdid')";
                   2319:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2320: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2321: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2322: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2323:            &mt('Filter: [_1]',
1.477     www      2324: 	   &select_form($env{'form.displayfilter'},
                   2325: 			'displayfilter',
1.970     raeburn  2326: 			{'currentfolder' => 'Current folder/page',
1.477     www      2327: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2328: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2329: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2330:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2331:                          '" />'.$additional;
                   2332: }
                   2333: 
                   2334: sub display_filter_js {
                   2335:     my $includetext = &mt('Include parameter types');
                   2336:     return <<"ENDJS";
                   2337:   
                   2338: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2339:     var firstType = 'hidden';
                   2340:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2341:         firstType = 'text';
                   2342:     }
                   2343:     firstObject = document.getElementById(firstid);
                   2344:     if (typeof(firstObject) == 'object') {
                   2345:         if (firstObject.type != firstType) {
                   2346:             changeInputType(firstObject,firstType);
                   2347:         }
                   2348:     }
                   2349:     if (context == 'parmslog') {
                   2350:         var secondType = 'hidden';
                   2351:         if (firstType == 'text') {
                   2352:             secondType = 'checkbox';
                   2353:         }
                   2354:         secondObject = document.getElementById(secondid);  
                   2355:         if (typeof(secondObject) == 'object') {
                   2356:             if (secondObject.type != secondType) {
                   2357:                 changeInputType(secondObject,secondType);
                   2358:             }
                   2359:         }
                   2360:         var textItem = document.getElementById(thirdid);
                   2361:         var currtext = textItem.innerHTML;
                   2362:         var newtext;
                   2363:         if (firstType == 'text') {
                   2364:             newtext = '$includetext';
                   2365:         } else {
                   2366:             newtext = '&nbsp;';
                   2367:         }
                   2368:         if (currtext != newtext) {
                   2369:             textItem.innerHTML = newtext;
                   2370:         }
                   2371:     }
                   2372:     return;
                   2373: }
                   2374: 
                   2375: function changeInputType(oldObject,newType) {
                   2376:     var newObject = document.createElement('input');
                   2377:     newObject.type = newType;
                   2378:     if (oldObject.size) {
                   2379:         newObject.size = oldObject.size;
                   2380:     }
                   2381:     if (oldObject.value) {
                   2382:         newObject.value = oldObject.value;
                   2383:     }
                   2384:     if (oldObject.name) {
                   2385:         newObject.name = oldObject.name;
                   2386:     }
                   2387:     if (oldObject.id) {
                   2388:         newObject.id = oldObject.id;
                   2389:     }
                   2390:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2391:     return;
                   2392: }
                   2393: 
                   2394: ENDJS
1.475     www      2395: }
                   2396: 
1.167     www      2397: sub gradeleveldescription {
                   2398:     my $gradelevel=shift;
                   2399:     my %gradelevels=(0 => 'Not specified',
                   2400: 		     1 => 'Grade 1',
                   2401: 		     2 => 'Grade 2',
                   2402: 		     3 => 'Grade 3',
                   2403: 		     4 => 'Grade 4',
                   2404: 		     5 => 'Grade 5',
                   2405: 		     6 => 'Grade 6',
                   2406: 		     7 => 'Grade 7',
                   2407: 		     8 => 'Grade 8',
                   2408: 		     9 => 'Grade 9',
                   2409: 		     10 => 'Grade 10',
                   2410: 		     11 => 'Grade 11',
                   2411: 		     12 => 'Grade 12',
                   2412: 		     13 => 'Grade 13',
                   2413: 		     14 => '100 Level',
                   2414: 		     15 => '200 Level',
                   2415: 		     16 => '300 Level',
                   2416: 		     17 => '400 Level',
                   2417: 		     18 => 'Graduate Level');
                   2418:     return &mt($gradelevels{$gradelevel});
                   2419: }
                   2420: 
1.163     www      2421: sub select_level_form {
                   2422:     my ($deflevel,$name)=@_;
                   2423:     unless ($deflevel) { $deflevel=0; }
1.167     www      2424:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2425:     for (my $i=0; $i<=18; $i++) {
                   2426:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2427:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2428:                 ">".&gradeleveldescription($i)."</option>\n";
                   2429:     }
                   2430:     $selectform.="</select>";
                   2431:     return $selectform;
1.163     www      2432: }
1.167     www      2433: 
1.35      matthew  2434: #-------------------------------------------
                   2435: 
1.45      matthew  2436: =pod
                   2437: 
1.1075.2.115  raeburn  2438: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2439: 
                   2440: Returns a string containing a <select name='$name' size='1'> form to 
                   2441: allow a user to select the domain to preform an operation in.  
                   2442: See loncreateuser.pm for an example invocation and use.
                   2443: 
1.90      www      2444: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2445: selected");
                   2446: 
1.743     raeburn  2447: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2448: 
1.910     raeburn  2449: 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.
                   2450: 
1.1075.2.36  raeburn  2451: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2452: 
1.1075.2.115  raeburn  2453: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2454: 
                   2455: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2456: 
1.35      matthew  2457: =cut
                   2458: 
                   2459: #-------------------------------------------
1.34      matthew  2460: sub select_dom_form {
1.1075.2.115  raeburn  2461:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2462:     if ($onchange) {
1.874     raeburn  2463:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2464:     }
1.1075.2.115  raeburn  2465:     if ($disabled) {
                   2466:         $disabled = ' disabled="disabled"';
                   2467:     }
1.1075.2.36  raeburn  2468:     my (@domains,%exclude);
1.910     raeburn  2469:     if (ref($incdoms) eq 'ARRAY') {
                   2470:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2471:     } else {
                   2472:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2473:     }
1.90      www      2474:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2475:     if (ref($excdoms) eq 'ARRAY') {
                   2476:         map { $exclude{$_} = 1; } @{$excdoms};
                   2477:     }
1.1075.2.115  raeburn  2478:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2479:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2480:         next if ($exclude{$dom});
1.356     albertel 2481:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2482:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2483:         if ($showdomdesc) {
                   2484:             if ($dom ne '') {
                   2485:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2486:                 if ($domdesc ne '') {
                   2487:                     $selectdomain .= ' ('.$domdesc.')';
                   2488:                 }
                   2489:             } 
                   2490:         }
                   2491:         $selectdomain .= "</option>\n";
1.34      matthew  2492:     }
                   2493:     $selectdomain.="</select>";
                   2494:     return $selectdomain;
                   2495: }
                   2496: 
1.35      matthew  2497: #-------------------------------------------
                   2498: 
1.45      matthew  2499: =pod
                   2500: 
1.648     raeburn  2501: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2502: 
1.586     raeburn  2503: input: 4 arguments (two required, two optional) - 
                   2504:     $domain - domain of new user
                   2505:     $name - name of form element
                   2506:     $default - Value of 'default' causes a default item to be first 
                   2507:                             option, and selected by default. 
                   2508:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2509:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2510: output: returns 2 items: 
1.586     raeburn  2511: (a) form element which contains either:
                   2512:    (i) <select name="$name">
                   2513:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2514:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2515:        </select>
                   2516:        form item if there are multiple library servers in $domain, or
                   2517:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2518:        if there is only one library server in $domain.
                   2519: 
                   2520: (b) number of library servers found.
                   2521: 
                   2522: See loncreateuser.pm for example of use.
1.35      matthew  2523: 
                   2524: =cut
                   2525: 
                   2526: #-------------------------------------------
1.586     raeburn  2527: sub home_server_form_item {
                   2528:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2529:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2530:     my $result;
                   2531:     my $numlib = keys(%servers);
                   2532:     if ($numlib > 1) {
                   2533:         $result .= '<select name="'.$name.'" />'."\n";
                   2534:         if ($default) {
1.804     bisitz   2535:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2536:                        '</option>'."\n";
                   2537:         }
                   2538:         foreach my $hostid (sort(keys(%servers))) {
                   2539:             $result.= '<option value="'.$hostid.'">'.
                   2540: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2541:         }
                   2542:         $result .= '</select>'."\n";
                   2543:     } elsif ($numlib == 1) {
                   2544:         my $hostid;
                   2545:         foreach my $item (keys(%servers)) {
                   2546:             $hostid = $item;
                   2547:         }
                   2548:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2549:                    $hostid.'" />';
                   2550:                    if (!$hide) {
                   2551:                        $result .= $hostid.' '.$servers{$hostid};
                   2552:                    }
                   2553:                    $result .= "\n";
                   2554:     } elsif ($default) {
                   2555:         $result .= '<input type="hidden" name="'.$name.
                   2556:                    '" value="default" />';
                   2557:                    if (!$hide) {
                   2558:                        $result .= &mt('default');
                   2559:                    }
                   2560:                    $result .= "\n";
1.33      matthew  2561:     }
1.586     raeburn  2562:     return ($result,$numlib);
1.33      matthew  2563: }
1.112     bowersj2 2564: 
                   2565: =pod
                   2566: 
1.534     albertel 2567: =back 
                   2568: 
1.112     bowersj2 2569: =cut
1.87      matthew  2570: 
                   2571: ###############################################################
1.112     bowersj2 2572: ##                  Decoding User Agent                      ##
1.87      matthew  2573: ###############################################################
                   2574: 
                   2575: =pod
                   2576: 
1.112     bowersj2 2577: =head1 Decoding the User Agent
                   2578: 
                   2579: =over 4
                   2580: 
                   2581: =item * &decode_user_agent()
1.87      matthew  2582: 
                   2583: Inputs: $r
                   2584: 
                   2585: Outputs:
                   2586: 
                   2587: =over 4
                   2588: 
1.112     bowersj2 2589: =item * $httpbrowser
1.87      matthew  2590: 
1.112     bowersj2 2591: =item * $clientbrowser
1.87      matthew  2592: 
1.112     bowersj2 2593: =item * $clientversion
1.87      matthew  2594: 
1.112     bowersj2 2595: =item * $clientmathml
1.87      matthew  2596: 
1.112     bowersj2 2597: =item * $clientunicode
1.87      matthew  2598: 
1.112     bowersj2 2599: =item * $clientos
1.87      matthew  2600: 
1.1075.2.42  raeburn  2601: =item * $clientmobile
                   2602: 
                   2603: =item * $clientinfo
                   2604: 
1.1075.2.77  raeburn  2605: =item * $clientosversion
                   2606: 
1.87      matthew  2607: =back
                   2608: 
1.157     matthew  2609: =back 
                   2610: 
1.87      matthew  2611: =cut
                   2612: 
                   2613: ###############################################################
                   2614: ###############################################################
                   2615: sub decode_user_agent {
1.247     albertel 2616:     my ($r)=@_;
1.87      matthew  2617:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2618:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2619:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2620:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2621:     my $clientbrowser='unknown';
                   2622:     my $clientversion='0';
                   2623:     my $clientmathml='';
                   2624:     my $clientunicode='0';
1.1075.2.42  raeburn  2625:     my $clientmobile=0;
1.1075.2.77  raeburn  2626:     my $clientosversion='';
1.87      matthew  2627:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2628:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2629: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2630: 	    $clientbrowser=$bname;
                   2631:             $httpbrowser=~/$vreg/i;
                   2632: 	    $clientversion=$1;
                   2633:             $clientmathml=($clientversion>=$minv);
                   2634:             $clientunicode=($clientversion>=$univ);
                   2635: 	}
                   2636:     }
                   2637:     my $clientos='unknown';
1.1075.2.42  raeburn  2638:     my $clientinfo;
1.87      matthew  2639:     if (($httpbrowser=~/linux/i) ||
                   2640:         ($httpbrowser=~/unix/i) ||
                   2641:         ($httpbrowser=~/ux/i) ||
                   2642:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2643:     if (($httpbrowser=~/vax/i) ||
                   2644:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2645:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2646:     if (($httpbrowser=~/mac/i) ||
                   2647:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2648:     if ($httpbrowser=~/win/i) {
                   2649:         $clientos='win';
                   2650:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2651:             $clientosversion = $1;
                   2652:         }
                   2653:     }
1.87      matthew  2654:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2655:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2656:         $clientmobile=lc($1);
                   2657:     }
                   2658:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2659:         $clientinfo = 'firefox-'.$1;
                   2660:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2661:         $clientinfo = 'chromeframe-'.$1;
                   2662:     }
1.87      matthew  2663:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2664:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2665:             $clientosversion);
1.87      matthew  2666: }
                   2667: 
1.32      matthew  2668: ###############################################################
                   2669: ##    Authentication changing form generation subroutines    ##
                   2670: ###############################################################
                   2671: ##
                   2672: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2673: ## hash, and have reasonable default values.
                   2674: ##
                   2675: ##    formname = the name given in the <form> tag.
1.35      matthew  2676: #-------------------------------------------
                   2677: 
1.45      matthew  2678: =pod
                   2679: 
1.112     bowersj2 2680: =head1 Authentication Routines
                   2681: 
                   2682: =over 4
                   2683: 
1.648     raeburn  2684: =item * &authform_xxxxxx()
1.35      matthew  2685: 
                   2686: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2687: handle some of the conveniences required for authentication forms.  
                   2688: This is not an optimal method, but it works.  
                   2689: 
                   2690: =over 4
                   2691: 
1.112     bowersj2 2692: =item * authform_header
1.35      matthew  2693: 
1.112     bowersj2 2694: =item * authform_authorwarning
1.35      matthew  2695: 
1.112     bowersj2 2696: =item * authform_nochange
1.35      matthew  2697: 
1.112     bowersj2 2698: =item * authform_kerberos
1.35      matthew  2699: 
1.112     bowersj2 2700: =item * authform_internal
1.35      matthew  2701: 
1.112     bowersj2 2702: =item * authform_filesystem
1.35      matthew  2703: 
                   2704: =back
                   2705: 
1.648     raeburn  2706: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2707: 
1.35      matthew  2708: =cut
                   2709: 
                   2710: #-------------------------------------------
1.32      matthew  2711: sub authform_header{  
                   2712:     my %in = (
                   2713:         formname => 'cu',
1.80      albertel 2714:         kerb_def_dom => '',
1.32      matthew  2715:         @_,
                   2716:     );
                   2717:     $in{'formname'} = 'document.' . $in{'formname'};
                   2718:     my $result='';
1.80      albertel 2719: 
                   2720: #---------------------------------------------- Code for upper case translation
                   2721:     my $Javascript_toUpperCase;
                   2722:     unless ($in{kerb_def_dom}) {
                   2723:         $Javascript_toUpperCase =<<"END";
                   2724:         switch (choice) {
                   2725:            case 'krb': currentform.elements[choicearg].value =
                   2726:                currentform.elements[choicearg].value.toUpperCase();
                   2727:                break;
                   2728:            default:
                   2729:         }
                   2730: END
                   2731:     } else {
                   2732:         $Javascript_toUpperCase = "";
                   2733:     }
                   2734: 
1.165     raeburn  2735:     my $radioval = "'nochange'";
1.591     raeburn  2736:     if (defined($in{'curr_authtype'})) {
                   2737:         if ($in{'curr_authtype'} ne '') {
                   2738:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2739:         }
1.174     matthew  2740:     }
1.165     raeburn  2741:     my $argfield = 'null';
1.591     raeburn  2742:     if (defined($in{'mode'})) {
1.165     raeburn  2743:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2744:             if (defined($in{'curr_autharg'})) {
                   2745:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2746:                     $argfield = "'$in{'curr_autharg'}'";
                   2747:                 }
                   2748:             }
                   2749:         }
                   2750:     }
                   2751: 
1.32      matthew  2752:     $result.=<<"END";
                   2753: var current = new Object();
1.165     raeburn  2754: current.radiovalue = $radioval;
                   2755: current.argfield = $argfield;
1.32      matthew  2756: 
                   2757: function changed_radio(choice,currentform) {
                   2758:     var choicearg = choice + 'arg';
                   2759:     // If a radio button in changed, we need to change the argfield
                   2760:     if (current.radiovalue != choice) {
                   2761:         current.radiovalue = choice;
                   2762:         if (current.argfield != null) {
                   2763:             currentform.elements[current.argfield].value = '';
                   2764:         }
                   2765:         if (choice == 'nochange') {
                   2766:             current.argfield = null;
                   2767:         } else {
                   2768:             current.argfield = choicearg;
                   2769:             switch(choice) {
                   2770:                 case 'krb': 
                   2771:                     currentform.elements[current.argfield].value = 
                   2772:                         "$in{'kerb_def_dom'}";
                   2773:                 break;
                   2774:               default:
                   2775:                 break;
                   2776:             }
                   2777:         }
                   2778:     }
                   2779:     return;
                   2780: }
1.22      www      2781: 
1.32      matthew  2782: function changed_text(choice,currentform) {
                   2783:     var choicearg = choice + 'arg';
                   2784:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2785:         $Javascript_toUpperCase
1.32      matthew  2786:         // clear old field
                   2787:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2788:             currentform.elements[current.argfield].value = '';
                   2789:         }
                   2790:         current.argfield = choicearg;
                   2791:     }
                   2792:     set_auth_radio_buttons(choice,currentform);
                   2793:     return;
1.20      www      2794: }
1.32      matthew  2795: 
                   2796: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2797:     var numauthchoices = currentform.login.length;
                   2798:     if (typeof numauthchoices  == "undefined") {
                   2799:         return;
                   2800:     } 
1.32      matthew  2801:     var i=0;
1.986     raeburn  2802:     while (i < numauthchoices) {
1.32      matthew  2803:         if (currentform.login[i].value == newvalue) { break; }
                   2804:         i++;
                   2805:     }
1.986     raeburn  2806:     if (i == numauthchoices) {
1.32      matthew  2807:         return;
                   2808:     }
                   2809:     current.radiovalue = newvalue;
                   2810:     currentform.login[i].checked = true;
                   2811:     return;
                   2812: }
                   2813: END
                   2814:     return $result;
                   2815: }
                   2816: 
1.1075.2.20  raeburn  2817: sub authform_authorwarning {
1.32      matthew  2818:     my $result='';
1.144     matthew  2819:     $result='<i>'.
                   2820:         &mt('As a general rule, only authors or co-authors should be '.
                   2821:             'filesystem authenticated '.
                   2822:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2823:     return $result;
                   2824: }
                   2825: 
1.1075.2.20  raeburn  2826: sub authform_nochange {
1.32      matthew  2827:     my %in = (
                   2828:               formname => 'document.cu',
                   2829:               kerb_def_dom => 'MSU.EDU',
                   2830:               @_,
                   2831:           );
1.1075.2.20  raeburn  2832:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2833:     my $result;
1.1075.2.20  raeburn  2834:     if (!$authnum) {
                   2835:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2836:     } else {
                   2837:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2838:                   '<input type="radio" name="login" value="nochange" '.
                   2839:                   'checked="checked" onclick="'.
1.281     albertel 2840:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2841: 	    '</label>';
1.586     raeburn  2842:     }
1.32      matthew  2843:     return $result;
                   2844: }
                   2845: 
1.591     raeburn  2846: sub authform_kerberos {
1.32      matthew  2847:     my %in = (
                   2848:               formname => 'document.cu',
                   2849:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2850:               kerb_def_auth => 'krb4',
1.32      matthew  2851:               @_,
                   2852:               );
1.586     raeburn  2853:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2854:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2855:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2856:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2857:        $check5 = ' checked="checked"';
1.80      albertel 2858:     } else {
1.772     bisitz   2859:        $check4 = ' checked="checked"';
1.80      albertel 2860:     }
1.1075.2.117  raeburn  2861:     if ($in{'readonly'}) {
                   2862:         $disabled = ' disabled="disabled"';
                   2863:     }
1.165     raeburn  2864:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2865:     if (defined($in{'curr_authtype'})) {
                   2866:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2867:             $krbcheck = ' checked="checked"';
1.623     raeburn  2868:             if (defined($in{'mode'})) {
                   2869:                 if ($in{'mode'} eq 'modifyuser') {
                   2870:                     $krbcheck = '';
                   2871:                 }
                   2872:             }
1.591     raeburn  2873:             if (defined($in{'curr_kerb_ver'})) {
                   2874:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2875:                     $check5 = ' checked="checked"';
1.591     raeburn  2876:                     $check4 = '';
                   2877:                 } else {
1.772     bisitz   2878:                     $check4 = ' checked="checked"';
1.591     raeburn  2879:                     $check5 = '';
                   2880:                 }
1.586     raeburn  2881:             }
1.591     raeburn  2882:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2883:                 $krbarg = $in{'curr_autharg'};
                   2884:             }
1.586     raeburn  2885:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2886:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2887:                     $result = 
                   2888:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2889:         $in{'curr_autharg'},$krbver);
                   2890:                 } else {
                   2891:                     $result =
                   2892:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2893:                 }
                   2894:                 return $result; 
                   2895:             }
                   2896:         }
                   2897:     } else {
                   2898:         if ($authnum == 1) {
1.784     bisitz   2899:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2900:         }
                   2901:     }
1.586     raeburn  2902:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2903:         return;
1.587     raeburn  2904:     } elsif ($authtype eq '') {
1.591     raeburn  2905:         if (defined($in{'mode'})) {
1.587     raeburn  2906:             if ($in{'mode'} eq 'modifycourse') {
                   2907:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2908:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2909:                 }
                   2910:             }
                   2911:         }
1.586     raeburn  2912:     }
                   2913:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2914:     if ($authtype eq '') {
                   2915:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2916:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2917:                     $krbcheck.$disabled.' />';
1.586     raeburn  2918:     }
                   2919:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2920:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2921:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2922:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2923:          $in{'curr_authtype'} eq 'krb4')) {
                   2924:         $result .= &mt
1.144     matthew  2925:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2926:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2927:          '<label>'.$authtype,
1.281     albertel 2928:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2929:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2930:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2931:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2932:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2933: 	 '</label>');
1.586     raeburn  2934:     } elsif ($can_assign{'krb4'}) {
                   2935:         $result .= &mt
                   2936:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2937:          '[_3] Version 4 [_4]',
                   2938:          '<label>'.$authtype,
                   2939:          '</label><input type="text" size="10" name="krbarg" '.
                   2940:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2941:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2942:          '<label><input type="hidden" name="krbver" value="4" />',
                   2943:          '</label>');
                   2944:     } elsif ($can_assign{'krb5'}) {
                   2945:         $result .= &mt
                   2946:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2947:          '[_3] Version 5 [_4]',
                   2948:          '<label>'.$authtype,
                   2949:          '</label><input type="text" size="10" name="krbarg" '.
                   2950:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2951:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2952:          '<label><input type="hidden" name="krbver" value="5" />',
                   2953:          '</label>');
                   2954:     }
1.32      matthew  2955:     return $result;
                   2956: }
                   2957: 
1.1075.2.20  raeburn  2958: sub authform_internal {
1.586     raeburn  2959:     my %in = (
1.32      matthew  2960:                 formname => 'document.cu',
                   2961:                 kerb_def_dom => 'MSU.EDU',
                   2962:                 @_,
                   2963:                 );
1.1075.2.117  raeburn  2964:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2965:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2966:     if ($in{'readonly'}) {
                   2967:         $disabled = ' disabled="disabled"';
                   2968:     }
1.591     raeburn  2969:     if (defined($in{'curr_authtype'})) {
                   2970:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2971:             if ($can_assign{'int'}) {
1.772     bisitz   2972:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2973:                 if (defined($in{'mode'})) {
                   2974:                     if ($in{'mode'} eq 'modifyuser') {
                   2975:                         $intcheck = '';
                   2976:                     }
                   2977:                 }
1.591     raeburn  2978:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2979:                     $intarg = $in{'curr_autharg'};
                   2980:                 }
                   2981:             } else {
                   2982:                 $result = &mt('Currently internally authenticated.');
                   2983:                 return $result;
1.165     raeburn  2984:             }
                   2985:         }
1.586     raeburn  2986:     } else {
                   2987:         if ($authnum == 1) {
1.784     bisitz   2988:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2989:         }
                   2990:     }
                   2991:     if (!$can_assign{'int'}) {
                   2992:         return;
1.587     raeburn  2993:     } elsif ($authtype eq '') {
1.591     raeburn  2994:         if (defined($in{'mode'})) {
1.587     raeburn  2995:             if ($in{'mode'} eq 'modifycourse') {
                   2996:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2997:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  2998:                 }
                   2999:             }
                   3000:         }
1.165     raeburn  3001:     }
1.586     raeburn  3002:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3003:     if ($authtype eq '') {
                   3004:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3005:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3006:     }
1.605     bisitz   3007:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3008:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3009:     $result = &mt
1.144     matthew  3010:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3011:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3012:     $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32      matthew  3013:     return $result;
                   3014: }
                   3015: 
1.1075.2.20  raeburn  3016: sub authform_local {
1.32      matthew  3017:     my %in = (
                   3018:               formname => 'document.cu',
                   3019:               kerb_def_dom => 'MSU.EDU',
                   3020:               @_,
                   3021:               );
1.1075.2.117  raeburn  3022:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3023:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3024:     if ($in{'readonly'}) {
                   3025:         $disabled = ' disabled="disabled"';
                   3026:     }
1.591     raeburn  3027:     if (defined($in{'curr_authtype'})) {
                   3028:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3029:             if ($can_assign{'loc'}) {
1.772     bisitz   3030:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3031:                 if (defined($in{'mode'})) {
                   3032:                     if ($in{'mode'} eq 'modifyuser') {
                   3033:                         $loccheck = '';
                   3034:                     }
                   3035:                 }
1.591     raeburn  3036:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3037:                     $locarg = $in{'curr_autharg'};
                   3038:                 }
                   3039:             } else {
                   3040:                 $result = &mt('Currently using local (institutional) authentication.');
                   3041:                 return $result;
1.165     raeburn  3042:             }
                   3043:         }
1.586     raeburn  3044:     } else {
                   3045:         if ($authnum == 1) {
1.784     bisitz   3046:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3047:         }
                   3048:     }
                   3049:     if (!$can_assign{'loc'}) {
                   3050:         return;
1.587     raeburn  3051:     } elsif ($authtype eq '') {
1.591     raeburn  3052:         if (defined($in{'mode'})) {
1.587     raeburn  3053:             if ($in{'mode'} eq 'modifycourse') {
                   3054:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3055:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3056:                 }
                   3057:             }
                   3058:         }
1.165     raeburn  3059:     }
1.586     raeburn  3060:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3061:     if ($authtype eq '') {
                   3062:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3063:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3064:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3065:     }
                   3066:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3067:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3068:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3069:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3070:     return $result;
                   3071: }
                   3072: 
1.1075.2.20  raeburn  3073: sub authform_filesystem {
1.32      matthew  3074:     my %in = (
                   3075:               formname => 'document.cu',
                   3076:               kerb_def_dom => 'MSU.EDU',
                   3077:               @_,
                   3078:               );
1.1075.2.117  raeburn  3079:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3080:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3081:     if ($in{'readonly'}) {
                   3082:         $disabled = ' disabled="disabled"';
                   3083:     }
1.591     raeburn  3084:     if (defined($in{'curr_authtype'})) {
                   3085:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3086:             if ($can_assign{'fsys'}) {
1.772     bisitz   3087:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3088:                 if (defined($in{'mode'})) {
                   3089:                     if ($in{'mode'} eq 'modifyuser') {
                   3090:                         $fsyscheck = '';
                   3091:                     }
                   3092:                 }
1.586     raeburn  3093:             } else {
                   3094:                 $result = &mt('Currently Filesystem Authenticated.');
                   3095:                 return $result;
                   3096:             }           
                   3097:         }
                   3098:     } else {
                   3099:         if ($authnum == 1) {
1.784     bisitz   3100:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3101:         }
                   3102:     }
                   3103:     if (!$can_assign{'fsys'}) {
                   3104:         return;
1.587     raeburn  3105:     } elsif ($authtype eq '') {
1.591     raeburn  3106:         if (defined($in{'mode'})) {
1.587     raeburn  3107:             if ($in{'mode'} eq 'modifycourse') {
                   3108:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3109:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3110:                 }
                   3111:             }
                   3112:         }
1.586     raeburn  3113:     }
                   3114:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3115:     if ($authtype eq '') {
                   3116:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3117:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3118:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3119:     }
                   3120:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3121:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3122:     $result = &mt
1.144     matthew  3123:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 3124:          '<label><input type="radio" name="login" value="fsys" '.
1.1075.2.117  raeburn  3125:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605     bisitz   3126:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1075.2.117  raeburn  3127:                   'onchange="'.$jscall.'"'.$disabled.' />');
1.32      matthew  3128:     return $result;
                   3129: }
                   3130: 
1.586     raeburn  3131: sub get_assignable_auth {
                   3132:     my ($dom) = @_;
                   3133:     if ($dom eq '') {
                   3134:         $dom = $env{'request.role.domain'};
                   3135:     }
                   3136:     my %can_assign = (
                   3137:                           krb4 => 1,
                   3138:                           krb5 => 1,
                   3139:                           int  => 1,
                   3140:                           loc  => 1,
                   3141:                      );
                   3142:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3143:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3144:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3145:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3146:             my $context;
                   3147:             if ($env{'request.role'} =~ /^au/) {
                   3148:                 $context = 'author';
1.1075.2.117  raeburn  3149:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3150:                 $context = 'domain';
                   3151:             } elsif ($env{'request.course.id'}) {
                   3152:                 $context = 'course';
                   3153:             }
                   3154:             if ($context) {
                   3155:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3156:                    %can_assign = %{$authhash->{$context}}; 
                   3157:                 }
                   3158:             }
                   3159:         }
                   3160:     }
                   3161:     my $authnum = 0;
                   3162:     foreach my $key (keys(%can_assign)) {
                   3163:         if ($can_assign{$key}) {
                   3164:             $authnum ++;
                   3165:         }
                   3166:     }
                   3167:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3168:         $authnum --;
                   3169:     }
                   3170:     return ($authnum,%can_assign);
                   3171: }
                   3172: 
1.80      albertel 3173: ###############################################################
                   3174: ##    Get Kerberos Defaults for Domain                 ##
                   3175: ###############################################################
                   3176: ##
                   3177: ## Returns default kerberos version and an associated argument
                   3178: ## as listed in file domain.tab. If not listed, provides
                   3179: ## appropriate default domain and kerberos version.
                   3180: ##
                   3181: #-------------------------------------------
                   3182: 
                   3183: =pod
                   3184: 
1.648     raeburn  3185: =item * &get_kerberos_defaults()
1.80      albertel 3186: 
                   3187: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3188: version and domain. If not found, it defaults to version 4 and the 
                   3189: domain of the server.
1.80      albertel 3190: 
1.648     raeburn  3191: =over 4
                   3192: 
1.80      albertel 3193: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3194: 
1.648     raeburn  3195: =back
                   3196: 
                   3197: =back
                   3198: 
1.80      albertel 3199: =cut
                   3200: 
                   3201: #-------------------------------------------
                   3202: sub get_kerberos_defaults {
                   3203:     my $domain=shift;
1.641     raeburn  3204:     my ($krbdef,$krbdefdom);
                   3205:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3206:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3207:         $krbdef = $domdefaults{'auth_def'};
                   3208:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3209:     } else {
1.80      albertel 3210:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3211:         my $krbdefdom=$1;
                   3212:         $krbdefdom=~tr/a-z/A-Z/;
                   3213:         $krbdef = "krb4";
                   3214:     }
                   3215:     return ($krbdef,$krbdefdom);
                   3216: }
1.112     bowersj2 3217: 
1.32      matthew  3218: 
1.46      matthew  3219: ###############################################################
                   3220: ##                Thesaurus Functions                        ##
                   3221: ###############################################################
1.20      www      3222: 
1.46      matthew  3223: =pod
1.20      www      3224: 
1.112     bowersj2 3225: =head1 Thesaurus Functions
                   3226: 
                   3227: =over 4
                   3228: 
1.648     raeburn  3229: =item * &initialize_keywords()
1.46      matthew  3230: 
                   3231: Initializes the package variable %Keywords if it is empty.  Uses the
                   3232: package variable $thesaurus_db_file.
                   3233: 
                   3234: =cut
                   3235: 
                   3236: ###################################################
                   3237: 
                   3238: sub initialize_keywords {
                   3239:     return 1 if (scalar keys(%Keywords));
                   3240:     # If we are here, %Keywords is empty, so fill it up
                   3241:     #   Make sure the file we need exists...
                   3242:     if (! -e $thesaurus_db_file) {
                   3243:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3244:                                  " failed because it does not exist");
                   3245:         return 0;
                   3246:     }
                   3247:     #   Set up the hash as a database
                   3248:     my %thesaurus_db;
                   3249:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3250:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3251:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3252:                                  $thesaurus_db_file);
                   3253:         return 0;
                   3254:     } 
                   3255:     #  Get the average number of appearances of a word.
                   3256:     my $avecount = $thesaurus_db{'average.count'};
                   3257:     #  Put keywords (those that appear > average) into %Keywords
                   3258:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3259:         my ($count,undef) = split /:/,$data;
                   3260:         $Keywords{$word}++ if ($count > $avecount);
                   3261:     }
                   3262:     untie %thesaurus_db;
                   3263:     # Remove special values from %Keywords.
1.356     albertel 3264:     foreach my $value ('total.count','average.count') {
                   3265:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3266:   }
1.46      matthew  3267:     return 1;
                   3268: }
                   3269: 
                   3270: ###################################################
                   3271: 
                   3272: =pod
                   3273: 
1.648     raeburn  3274: =item * &keyword($word)
1.46      matthew  3275: 
                   3276: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3277: than the average number of times in the thesaurus database.  Calls 
                   3278: &initialize_keywords
                   3279: 
                   3280: =cut
                   3281: 
                   3282: ###################################################
1.20      www      3283: 
                   3284: sub keyword {
1.46      matthew  3285:     return if (!&initialize_keywords());
                   3286:     my $word=lc(shift());
                   3287:     $word=~s/\W//g;
                   3288:     return exists($Keywords{$word});
1.20      www      3289: }
1.46      matthew  3290: 
                   3291: ###############################################################
                   3292: 
                   3293: =pod 
1.20      www      3294: 
1.648     raeburn  3295: =item * &get_related_words()
1.46      matthew  3296: 
1.160     matthew  3297: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3298: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3299: will be returned.  The order of the words returned is determined by the
                   3300: database which holds them.
                   3301: 
                   3302: Uses global $thesaurus_db_file.
                   3303: 
1.1057    foxr     3304: 
1.46      matthew  3305: =cut
                   3306: 
                   3307: ###############################################################
                   3308: sub get_related_words {
                   3309:     my $keyword = shift;
                   3310:     my %thesaurus_db;
                   3311:     if (! -e $thesaurus_db_file) {
                   3312:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3313:                                  "failed because the file does not exist");
                   3314:         return ();
                   3315:     }
                   3316:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3317:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3318:         return ();
                   3319:     } 
                   3320:     my @Words=();
1.429     www      3321:     my $count=0;
1.46      matthew  3322:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3323: 	# The first element is the number of times
                   3324: 	# the word appears.  We do not need it now.
1.429     www      3325: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3326: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3327: 	my $threshold=$mostfrequentcount/10;
                   3328:         foreach my $possibleword (@RelatedWords) {
                   3329:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3330:             if ($wordcount>$threshold) {
                   3331: 		push(@Words,$word);
                   3332:                 $count++;
                   3333:                 if ($count>10) { last; }
                   3334: 	    }
1.20      www      3335:         }
                   3336:     }
1.46      matthew  3337:     untie %thesaurus_db;
                   3338:     return @Words;
1.14      harris41 3339: }
1.46      matthew  3340: 
1.112     bowersj2 3341: =pod
                   3342: 
                   3343: =back
                   3344: 
                   3345: =cut
1.61      www      3346: 
                   3347: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3348: =pod
                   3349: 
1.112     bowersj2 3350: =head1 User Name Functions
                   3351: 
                   3352: =over 4
                   3353: 
1.648     raeburn  3354: =item * &plainname($uname,$udom,$first)
1.81      albertel 3355: 
1.112     bowersj2 3356: Takes a users logon name and returns it as a string in
1.226     albertel 3357: "first middle last generation" form 
                   3358: if $first is set to 'lastname' then it returns it as
                   3359: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3360: 
                   3361: =cut
1.61      www      3362: 
1.295     www      3363: 
1.81      albertel 3364: ###############################################################
1.61      www      3365: sub plainname {
1.226     albertel 3366:     my ($uname,$udom,$first)=@_;
1.537     albertel 3367:     return if (!defined($uname) || !defined($udom));
1.295     www      3368:     my %names=&getnames($uname,$udom);
1.226     albertel 3369:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3370: 					  $names{'middlename'},
                   3371: 					  $names{'lastname'},
                   3372: 					  $names{'generation'},$first);
                   3373:     $name=~s/^\s+//;
1.62      www      3374:     $name=~s/\s+$//;
                   3375:     $name=~s/\s+/ /g;
1.353     albertel 3376:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3377:     return $name;
1.61      www      3378: }
1.66      www      3379: 
                   3380: # -------------------------------------------------------------------- Nickname
1.81      albertel 3381: =pod
                   3382: 
1.648     raeburn  3383: =item * &nickname($uname,$udom)
1.81      albertel 3384: 
                   3385: Gets a users name and returns it as a string as
                   3386: 
                   3387: "&quot;nickname&quot;"
1.66      www      3388: 
1.81      albertel 3389: if the user has a nickname or
                   3390: 
                   3391: "first middle last generation"
                   3392: 
                   3393: if the user does not
                   3394: 
                   3395: =cut
1.66      www      3396: 
                   3397: sub nickname {
                   3398:     my ($uname,$udom)=@_;
1.537     albertel 3399:     return if (!defined($uname) || !defined($udom));
1.295     www      3400:     my %names=&getnames($uname,$udom);
1.68      albertel 3401:     my $name=$names{'nickname'};
1.66      www      3402:     if ($name) {
                   3403:        $name='&quot;'.$name.'&quot;'; 
                   3404:     } else {
                   3405:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3406: 	     $names{'lastname'}.' '.$names{'generation'};
                   3407:        $name=~s/\s+$//;
                   3408:        $name=~s/\s+/ /g;
                   3409:     }
                   3410:     return $name;
                   3411: }
                   3412: 
1.295     www      3413: sub getnames {
                   3414:     my ($uname,$udom)=@_;
1.537     albertel 3415:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3416:     if ($udom eq 'public' && $uname eq 'public') {
                   3417: 	return ('lastname' => &mt('Public'));
                   3418:     }
1.295     www      3419:     my $id=$uname.':'.$udom;
                   3420:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3421:     if ($cached) {
                   3422: 	return %{$names};
                   3423:     } else {
                   3424: 	my %loadnames=&Apache::lonnet::get('environment',
                   3425:                     ['firstname','middlename','lastname','generation','nickname'],
                   3426: 					 $udom,$uname);
                   3427: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3428: 	return %loadnames;
                   3429:     }
                   3430: }
1.61      www      3431: 
1.542     raeburn  3432: # -------------------------------------------------------------------- getemails
1.648     raeburn  3433: 
1.542     raeburn  3434: =pod
                   3435: 
1.648     raeburn  3436: =item * &getemails($uname,$udom)
1.542     raeburn  3437: 
                   3438: Gets a user's email information and returns it as a hash with keys:
                   3439: notification, critnotification, permanentemail
                   3440: 
                   3441: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3442: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3443:  
1.648     raeburn  3444: 
1.542     raeburn  3445: =cut
                   3446: 
1.648     raeburn  3447: 
1.466     albertel 3448: sub getemails {
                   3449:     my ($uname,$udom)=@_;
                   3450:     if ($udom eq 'public' && $uname eq 'public') {
                   3451: 	return;
                   3452:     }
1.467     www      3453:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3454:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3455:     my $id=$uname.':'.$udom;
                   3456:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3457:     if ($cached) {
                   3458: 	return %{$names};
                   3459:     } else {
                   3460: 	my %loadnames=&Apache::lonnet::get('environment',
                   3461:                     			   ['notification','critnotification',
                   3462: 					    'permanentemail'],
                   3463: 					   $udom,$uname);
                   3464: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3465: 	return %loadnames;
                   3466:     }
                   3467: }
                   3468: 
1.551     albertel 3469: sub flush_email_cache {
                   3470:     my ($uname,$udom)=@_;
                   3471:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3472:     if (!$uname) { $uname=$env{'user.name'};   }
                   3473:     return if ($udom eq 'public' && $uname eq 'public');
                   3474:     my $id=$uname.':'.$udom;
                   3475:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3476: }
                   3477: 
1.728     raeburn  3478: # -------------------------------------------------------------------- getlangs
                   3479: 
                   3480: =pod
                   3481: 
                   3482: =item * &getlangs($uname,$udom)
                   3483: 
                   3484: Gets a user's language preference and returns it as a hash with key:
                   3485: language.
                   3486: 
                   3487: =cut
                   3488: 
                   3489: 
                   3490: sub getlangs {
                   3491:     my ($uname,$udom) = @_;
                   3492:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3493:     if (!$uname) { $uname=$env{'user.name'};   }
                   3494:     my $id=$uname.':'.$udom;
                   3495:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3496:     if ($cached) {
                   3497:         return %{$langs};
                   3498:     } else {
                   3499:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3500:                                            $udom,$uname);
                   3501:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3502:         return %loadlangs;
                   3503:     }
                   3504: }
                   3505: 
                   3506: sub flush_langs_cache {
                   3507:     my ($uname,$udom)=@_;
                   3508:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3509:     if (!$uname) { $uname=$env{'user.name'};   }
                   3510:     return if ($udom eq 'public' && $uname eq 'public');
                   3511:     my $id=$uname.':'.$udom;
                   3512:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3513: }
                   3514: 
1.61      www      3515: # ------------------------------------------------------------------ Screenname
1.81      albertel 3516: 
                   3517: =pod
                   3518: 
1.648     raeburn  3519: =item * &screenname($uname,$udom)
1.81      albertel 3520: 
                   3521: Gets a users screenname and returns it as a string
                   3522: 
                   3523: =cut
1.61      www      3524: 
                   3525: sub screenname {
                   3526:     my ($uname,$udom)=@_;
1.258     albertel 3527:     if ($uname eq $env{'user.name'} &&
                   3528: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3529:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3530:     return $names{'screenname'};
1.62      www      3531: }
                   3532: 
1.212     albertel 3533: 
1.802     bisitz   3534: # ------------------------------------------------------------- Confirm Wrapper
                   3535: =pod
                   3536: 
1.1075.2.42  raeburn  3537: =item * &confirmwrapper($message)
1.802     bisitz   3538: 
                   3539: Wrap messages about completion of operation in box
                   3540: 
                   3541: =cut
                   3542: 
                   3543: sub confirmwrapper {
                   3544:     my ($message)=@_;
                   3545:     if ($message) {
                   3546:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3547:                .$message."\n"
                   3548:                .'</div>'."\n";
                   3549:     } else {
                   3550:         return $message;
                   3551:     }
                   3552: }
                   3553: 
1.62      www      3554: # ------------------------------------------------------------- Message Wrapper
                   3555: 
                   3556: sub messagewrapper {
1.369     www      3557:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3558:     return 
1.441     albertel 3559:         '<a href="/adm/email?compose=individual&amp;'.
                   3560:         'recname='.$username.'&amp;recdom='.$domain.
                   3561: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3562:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3563: }
1.802     bisitz   3564: 
1.74      www      3565: # --------------------------------------------------------------- Notes Wrapper
                   3566: 
                   3567: sub noteswrapper {
                   3568:     my ($link,$un,$do)=@_;
                   3569:     return 
1.896     amueller 3570: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3571: }
1.802     bisitz   3572: 
1.62      www      3573: # ------------------------------------------------------------- Aboutme Wrapper
                   3574: 
                   3575: sub aboutmewrapper {
1.1070    raeburn  3576:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3577:     if (!defined($username)  && !defined($domain)) {
                   3578:         return;
                   3579:     }
1.1075.2.15  raeburn  3580:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3581: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3582: }
                   3583: 
                   3584: # ------------------------------------------------------------ Syllabus Wrapper
                   3585: 
                   3586: sub syllabuswrapper {
1.707     bisitz   3587:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3588:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3589: }
1.14      harris41 3590: 
1.802     bisitz   3591: # -----------------------------------------------------------------------------
                   3592: 
1.208     matthew  3593: sub track_student_link {
1.887     raeburn  3594:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3595:     my $link ="/adm/trackstudent?";
1.208     matthew  3596:     my $title = 'View recent activity';
                   3597:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3598:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3599:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3600:         $title .= ' of this student';
1.268     albertel 3601:     } 
1.208     matthew  3602:     if (defined($target) && $target !~ /^\s*$/) {
                   3603:         $target = qq{target="$target"};
                   3604:     } else {
                   3605:         $target = '';
                   3606:     }
1.268     albertel 3607:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3608:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3609:     $title = &mt($title);
                   3610:     $linktext = &mt($linktext);
1.448     albertel 3611:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3612: 	&help_open_topic('View_recent_activity');
1.208     matthew  3613: }
                   3614: 
1.781     raeburn  3615: sub slot_reservations_link {
                   3616:     my ($linktext,$sname,$sdom,$target) = @_;
                   3617:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3618:     my $title = 'View slot reservation history';
                   3619:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3620:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3621:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3622:         $title .= ' of this student';
                   3623:     }
                   3624:     if (defined($target) && $target !~ /^\s*$/) {
                   3625:         $target = qq{target="$target"};
                   3626:     } else {
                   3627:         $target = '';
                   3628:     }
                   3629:     $title = &mt($title);
                   3630:     $linktext = &mt($linktext);
                   3631:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3632: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3633: 
                   3634: }
                   3635: 
1.508     www      3636: # ===================================================== Display a student photo
                   3637: 
                   3638: 
1.509     albertel 3639: sub student_image_tag {
1.508     www      3640:     my ($domain,$user)=@_;
                   3641:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3642:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3643: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3644:     } else {
                   3645: 	return '';
                   3646:     }
                   3647: }
                   3648: 
1.112     bowersj2 3649: =pod
                   3650: 
                   3651: =back
                   3652: 
                   3653: =head1 Access .tab File Data
                   3654: 
                   3655: =over 4
                   3656: 
1.648     raeburn  3657: =item * &languageids() 
1.112     bowersj2 3658: 
                   3659: returns list of all language ids
                   3660: 
                   3661: =cut
                   3662: 
1.14      harris41 3663: sub languageids {
1.16      harris41 3664:     return sort(keys(%language));
1.14      harris41 3665: }
                   3666: 
1.112     bowersj2 3667: =pod
                   3668: 
1.648     raeburn  3669: =item * &languagedescription() 
1.112     bowersj2 3670: 
                   3671: returns description of a specified language id
                   3672: 
                   3673: =cut
                   3674: 
1.14      harris41 3675: sub languagedescription {
1.125     www      3676:     my $code=shift;
                   3677:     return  ($supported_language{$code}?'* ':'').
                   3678:             $language{$code}.
1.126     www      3679: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3680: }
                   3681: 
1.1048    foxr     3682: =pod
                   3683: 
                   3684: =item * &plainlanguagedescription
                   3685: 
                   3686: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3687: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3688: 
                   3689: =cut
                   3690: 
1.145     www      3691: sub plainlanguagedescription {
                   3692:     my $code=shift;
                   3693:     return $language{$code};
                   3694: }
                   3695: 
1.1048    foxr     3696: =pod
                   3697: 
                   3698: =item * &supportedlanguagecode
                   3699: 
                   3700: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3701: code.
                   3702: 
                   3703: =cut
                   3704: 
1.145     www      3705: sub supportedlanguagecode {
                   3706:     my $code=shift;
                   3707:     return $supported_language{$code};
1.97      www      3708: }
                   3709: 
1.112     bowersj2 3710: =pod
                   3711: 
1.1048    foxr     3712: =item * &latexlanguage()
                   3713: 
                   3714: Given a language key code returns the correspondnig language to use
                   3715: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3716: is no supported hyphenation for the language code.
                   3717: 
                   3718: =cut
                   3719: 
                   3720: sub latexlanguage {
                   3721:     my $code = shift;
                   3722:     return $latex_language{$code};
                   3723: }
                   3724: 
                   3725: =pod
                   3726: 
                   3727: =item * &latexhyphenation()
                   3728: 
                   3729: Same as above but what's supplied is the language as it might be stored
                   3730: in the metadata.
                   3731: 
                   3732: =cut
                   3733: 
                   3734: sub latexhyphenation {
                   3735:     my $key = shift;
                   3736:     return $latex_language_bykey{$key};
                   3737: }
                   3738: 
                   3739: =pod
                   3740: 
1.648     raeburn  3741: =item * &copyrightids() 
1.112     bowersj2 3742: 
                   3743: returns list of all copyrights
                   3744: 
                   3745: =cut
                   3746: 
                   3747: sub copyrightids {
                   3748:     return sort(keys(%cprtag));
                   3749: }
                   3750: 
                   3751: =pod
                   3752: 
1.648     raeburn  3753: =item * &copyrightdescription() 
1.112     bowersj2 3754: 
                   3755: returns description of a specified copyright id
                   3756: 
                   3757: =cut
                   3758: 
                   3759: sub copyrightdescription {
1.166     www      3760:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3761: }
1.197     matthew  3762: 
                   3763: =pod
                   3764: 
1.648     raeburn  3765: =item * &source_copyrightids() 
1.192     taceyjo1 3766: 
                   3767: returns list of all source copyrights
                   3768: 
                   3769: =cut
                   3770: 
                   3771: sub source_copyrightids {
                   3772:     return sort(keys(%scprtag));
                   3773: }
                   3774: 
                   3775: =pod
                   3776: 
1.648     raeburn  3777: =item * &source_copyrightdescription() 
1.192     taceyjo1 3778: 
                   3779: returns description of a specified source copyright id
                   3780: 
                   3781: =cut
                   3782: 
                   3783: sub source_copyrightdescription {
                   3784:     return &mt($scprtag{shift(@_)});
                   3785: }
1.112     bowersj2 3786: 
                   3787: =pod
                   3788: 
1.648     raeburn  3789: =item * &filecategories() 
1.112     bowersj2 3790: 
                   3791: returns list of all file categories
                   3792: 
                   3793: =cut
                   3794: 
                   3795: sub filecategories {
                   3796:     return sort(keys(%category_extensions));
                   3797: }
                   3798: 
                   3799: =pod
                   3800: 
1.648     raeburn  3801: =item * &filecategorytypes() 
1.112     bowersj2 3802: 
                   3803: returns list of file types belonging to a given file
                   3804: category
                   3805: 
                   3806: =cut
                   3807: 
                   3808: sub filecategorytypes {
1.356     albertel 3809:     my ($cat) = @_;
                   3810:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3811: }
                   3812: 
                   3813: =pod
                   3814: 
1.648     raeburn  3815: =item * &fileembstyle() 
1.112     bowersj2 3816: 
                   3817: returns embedding style for a specified file type
                   3818: 
                   3819: =cut
                   3820: 
                   3821: sub fileembstyle {
                   3822:     return $fe{lc(shift(@_))};
1.169     www      3823: }
                   3824: 
1.351     www      3825: sub filemimetype {
                   3826:     return $fm{lc(shift(@_))};
                   3827: }
                   3828: 
1.169     www      3829: 
                   3830: sub filecategoryselect {
                   3831:     my ($name,$value)=@_;
1.189     matthew  3832:     return &select_form($value,$name,
1.970     raeburn  3833:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3834: }
                   3835: 
                   3836: =pod
                   3837: 
1.648     raeburn  3838: =item * &filedescription() 
1.112     bowersj2 3839: 
                   3840: returns description for a specified file type
                   3841: 
                   3842: =cut
                   3843: 
                   3844: sub filedescription {
1.188     matthew  3845:     my $file_description = $fd{lc(shift())};
                   3846:     $file_description =~ s:([\[\]]):~$1:g;
                   3847:     return &mt($file_description);
1.112     bowersj2 3848: }
                   3849: 
                   3850: =pod
                   3851: 
1.648     raeburn  3852: =item * &filedescriptionex() 
1.112     bowersj2 3853: 
                   3854: returns description for a specified file type with
                   3855: extra formatting
                   3856: 
                   3857: =cut
                   3858: 
                   3859: sub filedescriptionex {
                   3860:     my $ex=shift;
1.188     matthew  3861:     my $file_description = $fd{lc($ex)};
                   3862:     $file_description =~ s:([\[\]]):~$1:g;
                   3863:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3864: }
                   3865: 
                   3866: # End of .tab access
                   3867: =pod
                   3868: 
                   3869: =back
                   3870: 
                   3871: =cut
                   3872: 
                   3873: # ------------------------------------------------------------------ File Types
                   3874: sub fileextensions {
                   3875:     return sort(keys(%fe));
                   3876: }
                   3877: 
1.97      www      3878: # ----------------------------------------------------------- Display Languages
                   3879: # returns a hash with all desired display languages
                   3880: #
                   3881: 
                   3882: sub display_languages {
                   3883:     my %languages=();
1.695     raeburn  3884:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3885: 	$languages{$lang}=1;
1.97      www      3886:     }
                   3887:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3888:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3889: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3890: 	    $languages{$lang}=1;
1.97      www      3891:         }
                   3892:     }
                   3893:     return %languages;
1.14      harris41 3894: }
                   3895: 
1.582     albertel 3896: sub languages {
                   3897:     my ($possible_langs) = @_;
1.695     raeburn  3898:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3899:     if (!ref($possible_langs)) {
                   3900: 	if( wantarray ) {
                   3901: 	    return @preferred_langs;
                   3902: 	} else {
                   3903: 	    return $preferred_langs[0];
                   3904: 	}
                   3905:     }
                   3906:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3907:     my @preferred_possibilities;
                   3908:     foreach my $preferred_lang (@preferred_langs) {
                   3909: 	if (exists($possibilities{$preferred_lang})) {
                   3910: 	    push(@preferred_possibilities, $preferred_lang);
                   3911: 	}
                   3912:     }
                   3913:     if( wantarray ) {
                   3914: 	return @preferred_possibilities;
                   3915:     }
                   3916:     return $preferred_possibilities[0];
                   3917: }
                   3918: 
1.742     raeburn  3919: sub user_lang {
                   3920:     my ($touname,$toudom,$fromcid) = @_;
                   3921:     my @userlangs;
                   3922:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3923:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3924:                     $env{'course.'.$fromcid.'.languages'}));
                   3925:     } else {
                   3926:         my %langhash = &getlangs($touname,$toudom);
                   3927:         if ($langhash{'languages'} ne '') {
                   3928:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3929:         } else {
                   3930:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3931:             if ($domdefs{'lang_def'} ne '') {
                   3932:                 @userlangs = ($domdefs{'lang_def'});
                   3933:             }
                   3934:         }
                   3935:     }
                   3936:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3937:     my $user_lh = Apache::localize->get_handle(@languages);
                   3938:     return $user_lh;
                   3939: }
                   3940: 
                   3941: 
1.112     bowersj2 3942: ###############################################################
                   3943: ##               Student Answer Attempts                     ##
                   3944: ###############################################################
                   3945: 
                   3946: =pod
                   3947: 
                   3948: =head1 Alternate Problem Views
                   3949: 
                   3950: =over 4
                   3951: 
1.648     raeburn  3952: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  3953:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 3954: 
                   3955: Return string with previous attempt on problem. Arguments:
                   3956: 
                   3957: =over 4
                   3958: 
                   3959: =item * $symb: Problem, including path
                   3960: 
                   3961: =item * $username: username of the desired student
                   3962: 
                   3963: =item * $domain: domain of the desired student
1.14      harris41 3964: 
1.112     bowersj2 3965: =item * $course: Course ID
1.14      harris41 3966: 
1.112     bowersj2 3967: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3968:     something
1.14      harris41 3969: 
1.112     bowersj2 3970: =item * $regexp: if string matches this regexp, the string will be
                   3971:     sent to $gradesub
1.14      harris41 3972: 
1.112     bowersj2 3973: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3974: 
1.1075.2.86  raeburn  3975: =item * $usec: section of the desired student
                   3976: 
                   3977: =item * $identifier: counter for student (multiple students one problem) or
                   3978:     problem (one student; whole sequence).
                   3979: 
1.112     bowersj2 3980: =back
1.14      harris41 3981: 
1.112     bowersj2 3982: The output string is a table containing all desired attempts, if any.
1.16      harris41 3983: 
1.112     bowersj2 3984: =cut
1.1       albertel 3985: 
                   3986: sub get_previous_attempt {
1.1075.2.86  raeburn  3987:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 3988:   my $prevattempts='';
1.43      ng       3989:   no strict 'refs';
1.1       albertel 3990:   if ($symb) {
1.3       albertel 3991:     my (%returnhash)=
                   3992:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3993:     if ($returnhash{'version'}) {
                   3994:       my %lasthash=();
                   3995:       my $version;
                   3996:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  3997:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   3998:             if ($key =~ /\.rawrndseed$/) {
                   3999:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4000:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4001:             } else {
                   4002:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4003:             }
1.19      harris41 4004:         }
1.1       albertel 4005:       }
1.596     albertel 4006:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4007:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4008:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4009:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4010:       foreach my $key (sort(keys(%lasthash))) {
                   4011: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4012: 	if ($#parts > 0) {
1.31      albertel 4013: 	  my $data=$parts[-1];
1.989     raeburn  4014:           next if ($data eq 'foilorder');
1.31      albertel 4015: 	  pop(@parts);
1.1010    www      4016:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4017:           if ($data eq 'type') {
                   4018:               unless ($showsurv) {
                   4019:                   my $id = join(',',@parts);
                   4020:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4021:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4022:                       $lasthidden{$ign.'.'.$id} = 1;
                   4023:                   }
1.945     raeburn  4024:               }
1.1075.2.86  raeburn  4025:               if ($identifier ne '') {
                   4026:                   my $id = join(',',@parts);
                   4027:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4028:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4029:                       $hidestatus{$ign.'.'.$id} = 1;
                   4030:                   }
                   4031:               }
                   4032:           } elsif ($data eq 'regrader') {
                   4033:               if (($identifier ne '') && (@parts)) {
                   4034:                   my $id = join(',',@parts);
                   4035:                   $regraded{$ign.'.'.$id} = 1;
                   4036:               }
1.1010    www      4037:           } 
1.31      albertel 4038: 	} else {
1.41      ng       4039: 	  if ($#parts == 0) {
                   4040: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4041: 	  } else {
                   4042: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4043: 	  }
1.31      albertel 4044: 	}
1.16      harris41 4045:       }
1.596     albertel 4046:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4047:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4048:         my (%solved,%resets,%probstatus);
                   4049:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4050:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4051:                 foreach my $id (keys(%regraded)) {
                   4052:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4053:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4054:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4055:                         push(@{$resets{$id}},$version);
                   4056:                     }
                   4057:                 }
                   4058:             }
                   4059:         }
1.40      ng       4060: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4061:             my (@hidden,@unsolved);
1.945     raeburn  4062:             if (%typeparts) {
                   4063:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4064:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4065:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4066:                         push(@hidden,$id);
1.1075.2.86  raeburn  4067:                     } elsif ($identifier ne '') {
                   4068:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4069:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4070:                                 ($hidestatus{$id})) {
                   4071:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4072:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4073:                                 push(@{$solved{$id}},$version);
                   4074:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4075:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4076:                                 my $skip;
                   4077:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4078:                                     foreach my $reset (@{$resets{$id}}) {
                   4079:                                         if ($reset > $solved{$id}[-1]) {
                   4080:                                             $skip=1;
                   4081:                                             last;
                   4082:                                         }
                   4083:                                     }
                   4084:                                 }
                   4085:                                 unless ($skip) {
                   4086:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4087:                                     push(@unsolved,$partslist);
                   4088:                                 }
                   4089:                             }
                   4090:                         }
1.945     raeburn  4091:                     }
                   4092:                 }
                   4093:             }
                   4094:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4095:                            '<td>'.&mt('Transaction [_1]',$version);
                   4096:             if (@unsolved) {
                   4097:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4098:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4099:                                  &mt('Hide').'</label></span>';
                   4100:             }
                   4101:             $prevattempts .= '</td>';
1.945     raeburn  4102:             if (@hidden) {
                   4103:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4104:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4105:                     my $hide;
                   4106:                     foreach my $id (@hidden) {
                   4107:                         if ($key =~ /^\Q$id\E/) {
                   4108:                             $hide = 1;
                   4109:                             last;
                   4110:                         }
                   4111:                     }
                   4112:                     if ($hide) {
                   4113:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4114:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4115:                             my $value = &format_previous_attempt_value($key,
                   4116:                                              $returnhash{$version.':'.$key});
                   4117:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4118:                         } else {
                   4119:                             $prevattempts.='<td>&nbsp;</td>';
                   4120:                         }
                   4121:                     } else {
                   4122:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4123:                             my $value = $returnhash{$version.':'.$key};
                   4124:                             if ($key =~ /\.rndseed$/) {
                   4125:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4126:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4127:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4128:                                 }
                   4129:                             }
                   4130:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4131:                                            '&nbsp;</td>';
1.945     raeburn  4132:                         } else {
                   4133:                             $prevattempts.='<td>&nbsp;</td>';
                   4134:                         }
                   4135:                     }
                   4136:                 }
                   4137:             } else {
                   4138: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4139:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4140:                     my $value = $returnhash{$version.':'.$key};
                   4141:                     if ($key =~ /\.rndseed$/) {
                   4142:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4143:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4144:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4145:                         }
                   4146:                     }
                   4147:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4148:                                    '&nbsp;</td>';
1.945     raeburn  4149: 	        }
                   4150:             }
                   4151: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4152: 	 }
1.1       albertel 4153:       }
1.945     raeburn  4154:       my @currhidden = keys(%lasthidden);
1.596     albertel 4155:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4156:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4157:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4158:           if (%typeparts) {
                   4159:               my $hidden;
                   4160:               foreach my $id (@currhidden) {
                   4161:                   if ($key =~ /^\Q$id\E/) {
                   4162:                       $hidden = 1;
                   4163:                       last;
                   4164:                   }
                   4165:               }
                   4166:               if ($hidden) {
                   4167:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4168:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4169:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4170:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4171:                           $value = &$gradesub($value);
                   4172:                       }
                   4173:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4174:                   } else {
                   4175:                       $prevattempts.='<td>&nbsp;</td>';
                   4176:                   }
                   4177:               } else {
                   4178:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4179:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4180:                       $value = &$gradesub($value);
                   4181:                   }
                   4182:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4183:               }
                   4184:           } else {
                   4185: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4186: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4187:                   $value = &$gradesub($value);
                   4188:               }
                   4189: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4190:           }
1.16      harris41 4191:       }
1.596     albertel 4192:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4193:     } else {
1.596     albertel 4194:       $prevattempts=
                   4195: 	  &start_data_table().&start_data_table_row().
                   4196: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4197: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4198:     }
                   4199:   } else {
1.596     albertel 4200:     $prevattempts=
                   4201: 	  &start_data_table().&start_data_table_row().
                   4202: 	  '<td>'.&mt('No data.').'</td>'.
                   4203: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4204:   }
1.10      albertel 4205: }
                   4206: 
1.581     albertel 4207: sub format_previous_attempt_value {
                   4208:     my ($key,$value) = @_;
1.1011    www      4209:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4210: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4211:     } elsif (ref($value) eq 'ARRAY') {
                   4212: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4213:     } elsif ($key =~ /answerstring$/) {
                   4214:         my %answers = &Apache::lonnet::str2hash($value);
                   4215:         my @anskeys = sort(keys(%answers));
                   4216:         if (@anskeys == 1) {
                   4217:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4218:             if ($answer =~ m{\0}) {
                   4219:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4220:             }
                   4221:             my $tag_internal_answer_name = 'INTERNAL';
                   4222:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4223:                 $value = $answer; 
                   4224:             } else {
                   4225:                 $value = $anskeys[0].'='.$answer;
                   4226:             }
                   4227:         } else {
                   4228:             foreach my $ans (@anskeys) {
                   4229:                 my $answer = $answers{$ans};
1.1001    raeburn  4230:                 if ($answer =~ m{\0}) {
                   4231:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4232:                 }
                   4233:                 $value .=  $ans.'='.$answer.'<br />';;
                   4234:             } 
                   4235:         }
1.581     albertel 4236:     } else {
                   4237: 	$value = &unescape($value);
                   4238:     }
                   4239:     return $value;
                   4240: }
                   4241: 
                   4242: 
1.107     albertel 4243: sub relative_to_absolute {
                   4244:     my ($url,$output)=@_;
                   4245:     my $parser=HTML::TokeParser->new(\$output);
                   4246:     my $token;
                   4247:     my $thisdir=$url;
                   4248:     my @rlinks=();
                   4249:     while ($token=$parser->get_token) {
                   4250: 	if ($token->[0] eq 'S') {
                   4251: 	    if ($token->[1] eq 'a') {
                   4252: 		if ($token->[2]->{'href'}) {
                   4253: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4254: 		}
                   4255: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4256: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4257: 	    } elsif ($token->[1] eq 'base') {
                   4258: 		$thisdir=$token->[2]->{'href'};
                   4259: 	    }
                   4260: 	}
                   4261:     }
                   4262:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4263:     foreach my $link (@rlinks) {
1.726     raeburn  4264: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4265: 		($link=~/^\//) ||
                   4266: 		($link=~/^javascript:/i) ||
                   4267: 		($link=~/^mailto:/i) ||
                   4268: 		($link=~/^\#/)) {
                   4269: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4270: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4271: 	}
                   4272:     }
                   4273: # -------------------------------------------------- Deal with Applet codebases
                   4274:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4275:     return $output;
                   4276: }
                   4277: 
1.112     bowersj2 4278: =pod
                   4279: 
1.648     raeburn  4280: =item * &get_student_view()
1.112     bowersj2 4281: 
                   4282: show a snapshot of what student was looking at
                   4283: 
                   4284: =cut
                   4285: 
1.10      albertel 4286: sub get_student_view {
1.186     albertel 4287:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4288:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4289:   my (%form);
1.10      albertel 4290:   my @elements=('symb','courseid','domain','username');
                   4291:   foreach my $element (@elements) {
1.186     albertel 4292:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4293:   }
1.186     albertel 4294:   if (defined($moreenv)) {
                   4295:       %form=(%form,%{$moreenv});
                   4296:   }
1.236     albertel 4297:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4298:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4299:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4300:   $userview=~s/\<body[^\>]*\>//gi;
                   4301:   $userview=~s/\<\/body\>//gi;
                   4302:   $userview=~s/\<html\>//gi;
                   4303:   $userview=~s/\<\/html\>//gi;
                   4304:   $userview=~s/\<head\>//gi;
                   4305:   $userview=~s/\<\/head\>//gi;
                   4306:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4307:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4308:   if (wantarray) {
                   4309:      return ($userview,$response);
                   4310:   } else {
                   4311:      return $userview;
                   4312:   }
                   4313: }
                   4314: 
                   4315: sub get_student_view_with_retries {
                   4316:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4317: 
                   4318:     my $ok = 0;                 # True if we got a good response.
                   4319:     my $content;
                   4320:     my $response;
                   4321: 
                   4322:     # Try to get the student_view done. within the retries count:
                   4323:     
                   4324:     do {
                   4325:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4326:          $ok      = $response->is_success;
                   4327:          if (!$ok) {
                   4328:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4329:          }
                   4330:          $retries--;
                   4331:     } while (!$ok && ($retries > 0));
                   4332:     
                   4333:     if (!$ok) {
                   4334:        $content = '';          # On error return an empty content.
                   4335:     }
1.651     www      4336:     if (wantarray) {
                   4337:        return ($content, $response);
                   4338:     } else {
                   4339:        return $content;
                   4340:     }
1.11      albertel 4341: }
                   4342: 
1.112     bowersj2 4343: =pod
                   4344: 
1.648     raeburn  4345: =item * &get_student_answers() 
1.112     bowersj2 4346: 
                   4347: show a snapshot of how student was answering problem
                   4348: 
                   4349: =cut
                   4350: 
1.11      albertel 4351: sub get_student_answers {
1.100     sakharuk 4352:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4353:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4354:   my (%moreenv);
1.11      albertel 4355:   my @elements=('symb','courseid','domain','username');
                   4356:   foreach my $element (@elements) {
1.186     albertel 4357:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4358:   }
1.186     albertel 4359:   $moreenv{'grade_target'}='answer';
                   4360:   %moreenv=(%form,%moreenv);
1.497     raeburn  4361:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4362:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4363:   return $userview;
1.1       albertel 4364: }
1.116     albertel 4365: 
                   4366: =pod
                   4367: 
                   4368: =item * &submlink()
                   4369: 
1.242     albertel 4370: Inputs: $text $uname $udom $symb $target
1.116     albertel 4371: 
                   4372: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4373: 
                   4374: =cut
                   4375: 
                   4376: ###############################################
                   4377: sub submlink {
1.242     albertel 4378:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4379:     if (!($uname && $udom)) {
                   4380: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4381: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4382: 	if (!$symb) { $symb=$cursymb; }
                   4383:     }
1.254     matthew  4384:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4385:     $symb=&escape($symb);
1.960     bisitz   4386:     if ($target) { $target=" target=\"$target\""; }
                   4387:     return
                   4388:         '<a href="/adm/grades?command=submission'.
                   4389:         '&amp;symb='.$symb.
                   4390:         '&amp;student='.$uname.
                   4391:         '&amp;userdom='.$udom.'"'.
                   4392:         $target.'>'.$text.'</a>';
1.242     albertel 4393: }
                   4394: ##############################################
                   4395: 
                   4396: =pod
                   4397: 
                   4398: =item * &pgrdlink()
                   4399: 
                   4400: Inputs: $text $uname $udom $symb $target
                   4401: 
                   4402: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4403: 
                   4404: =cut
                   4405: 
                   4406: ###############################################
                   4407: sub pgrdlink {
                   4408:     my $link=&submlink(@_);
                   4409:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4410:     return $link;
                   4411: }
                   4412: ##############################################
                   4413: 
                   4414: =pod
                   4415: 
                   4416: =item * &pprmlink()
                   4417: 
                   4418: Inputs: $text $uname $udom $symb $target
                   4419: 
                   4420: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4421: student and a specific resource
1.242     albertel 4422: 
                   4423: =cut
                   4424: 
                   4425: ###############################################
                   4426: sub pprmlink {
                   4427:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4428:     if (!($uname && $udom)) {
                   4429: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4430: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4431: 	if (!$symb) { $symb=$cursymb; }
                   4432:     }
1.254     matthew  4433:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4434:     $symb=&escape($symb);
1.242     albertel 4435:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4436:     return '<a href="/adm/parmset?command=set&amp;'.
                   4437: 	'symb='.$symb.'&amp;uname='.$uname.
                   4438: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4439: }
                   4440: ##############################################
1.37      matthew  4441: 
1.112     bowersj2 4442: =pod
                   4443: 
                   4444: =back
                   4445: 
                   4446: =cut
                   4447: 
1.37      matthew  4448: ###############################################
1.51      www      4449: 
                   4450: 
                   4451: sub timehash {
1.687     raeburn  4452:     my ($thistime) = @_;
                   4453:     my $timezone = &Apache::lonlocal::gettimezone();
                   4454:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4455:                      ->set_time_zone($timezone);
                   4456:     my $wday = $dt->day_of_week();
                   4457:     if ($wday == 7) { $wday = 0; }
                   4458:     return ( 'second' => $dt->second(),
                   4459:              'minute' => $dt->minute(),
                   4460:              'hour'   => $dt->hour(),
                   4461:              'day'     => $dt->day_of_month(),
                   4462:              'month'   => $dt->month(),
                   4463:              'year'    => $dt->year(),
                   4464:              'weekday' => $wday,
                   4465:              'dayyear' => $dt->day_of_year(),
                   4466:              'dlsav'   => $dt->is_dst() );
1.51      www      4467: }
                   4468: 
1.370     www      4469: sub utc_string {
                   4470:     my ($date)=@_;
1.371     www      4471:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4472: }
                   4473: 
1.51      www      4474: sub maketime {
                   4475:     my %th=@_;
1.687     raeburn  4476:     my ($epoch_time,$timezone,$dt);
                   4477:     $timezone = &Apache::lonlocal::gettimezone();
                   4478:     eval {
                   4479:         $dt = DateTime->new( year   => $th{'year'},
                   4480:                              month  => $th{'month'},
                   4481:                              day    => $th{'day'},
                   4482:                              hour   => $th{'hour'},
                   4483:                              minute => $th{'minute'},
                   4484:                              second => $th{'second'},
                   4485:                              time_zone => $timezone,
                   4486:                          );
                   4487:     };
                   4488:     if (!$@) {
                   4489:         $epoch_time = $dt->epoch;
                   4490:         if ($epoch_time) {
                   4491:             return $epoch_time;
                   4492:         }
                   4493:     }
1.51      www      4494:     return POSIX::mktime(
                   4495:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4496:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4497: }
                   4498: 
                   4499: #########################################
1.51      www      4500: 
                   4501: sub findallcourses {
1.482     raeburn  4502:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4503:     my %roles;
                   4504:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4505:     my %courses;
1.51      www      4506:     my $now=time;
1.482     raeburn  4507:     if (!defined($uname)) {
                   4508:         $uname = $env{'user.name'};
                   4509:     }
                   4510:     if (!defined($udom)) {
                   4511:         $udom = $env{'user.domain'};
                   4512:     }
                   4513:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4514:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4515:         if (!%roles) {
                   4516:             %roles = (
                   4517:                        cc => 1,
1.907     raeburn  4518:                        co => 1,
1.482     raeburn  4519:                        in => 1,
                   4520:                        ep => 1,
                   4521:                        ta => 1,
                   4522:                        cr => 1,
                   4523:                        st => 1,
                   4524:              );
                   4525:         }
                   4526:         foreach my $entry (keys(%roleshash)) {
                   4527:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4528:             if ($trole =~ /^cr/) { 
                   4529:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4530:             } else {
                   4531:                 next if (!exists($roles{$trole}));
                   4532:             }
                   4533:             if ($tend) {
                   4534:                 next if ($tend < $now);
                   4535:             }
                   4536:             if ($tstart) {
                   4537:                 next if ($tstart > $now);
                   4538:             }
1.1058    raeburn  4539:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4540:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4541:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4542:             if ($secpart eq '') {
                   4543:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4544:                 $sec = 'none';
1.1058    raeburn  4545:                 $value .= $cnum.'/';
1.482     raeburn  4546:             } else {
                   4547:                 $cnum = $cnumpart;
                   4548:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4549:                 $value .= $cnum.'/'.$sec;
                   4550:             }
                   4551:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4552:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4553:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4554:                 }
                   4555:             } else {
                   4556:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4557:             }
1.482     raeburn  4558:         }
                   4559:     } else {
                   4560:         foreach my $key (keys(%env)) {
1.483     albertel 4561: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4562:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4563: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4564: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4565: 	        next if (%roles && !exists($roles{$role}));
                   4566: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4567:                 my $active=1;
                   4568:                 if ($starttime) {
                   4569: 		    if ($now<$starttime) { $active=0; }
                   4570:                 }
                   4571:                 if ($endtime) {
                   4572:                     if ($now>$endtime) { $active=0; }
                   4573:                 }
                   4574:                 if ($active) {
1.1058    raeburn  4575:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4576:                     if ($sec eq '') {
                   4577:                         $sec = 'none';
1.1058    raeburn  4578:                     } else {
                   4579:                         $value .= $sec;
                   4580:                     }
                   4581:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4582:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4583:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4584:                         }
                   4585:                     } else {
                   4586:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4587:                     }
1.474     raeburn  4588:                 }
                   4589:             }
1.51      www      4590:         }
                   4591:     }
1.474     raeburn  4592:     return %courses;
1.51      www      4593: }
1.37      matthew  4594: 
1.54      www      4595: ###############################################
1.474     raeburn  4596: 
                   4597: sub blockcheck {
1.1075.2.73  raeburn  4598:     my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490     raeburn  4599: 
1.1075.2.73  raeburn  4600:     if (defined($udom) && defined($uname)) {
                   4601:         # If uname and udom are for a course, check for blocks in the course.
                   4602:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4603:             my ($startblock,$endblock,$triggerblock) =
                   4604:                 &get_blocks($setters,$activity,$udom,$uname,$url);
                   4605:             return ($startblock,$endblock,$triggerblock);
                   4606:         }
                   4607:     } else {
1.490     raeburn  4608:         $udom = $env{'user.domain'};
                   4609:         $uname = $env{'user.name'};
                   4610:     }
                   4611: 
1.502     raeburn  4612:     my $startblock = 0;
                   4613:     my $endblock = 0;
1.1062    raeburn  4614:     my $triggerblock = '';
1.482     raeburn  4615:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4616: 
1.490     raeburn  4617:     # If uname is for a user, and activity is course-specific, i.e.,
                   4618:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4619: 
1.490     raeburn  4620:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73  raeburn  4621:          $activity eq 'groups' || $activity eq 'printout') &&
                   4622:         ($env{'request.course.id'})) {
1.490     raeburn  4623:         foreach my $key (keys(%live_courses)) {
                   4624:             if ($key ne $env{'request.course.id'}) {
                   4625:                 delete($live_courses{$key});
                   4626:             }
                   4627:         }
                   4628:     }
                   4629: 
                   4630:     my $otheruser = 0;
                   4631:     my %own_courses;
                   4632:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4633:         # Resource belongs to user other than current user.
                   4634:         $otheruser = 1;
                   4635:         # Gather courses for current user
                   4636:         %own_courses = 
                   4637:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4638:     }
                   4639: 
                   4640:     # Gather active course roles - course coordinator, instructor, 
                   4641:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4642: 
                   4643:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4644:         my ($cdom,$cnum);
                   4645:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4646:             $cdom = $env{'course.'.$course.'.domain'};
                   4647:             $cnum = $env{'course.'.$course.'.num'};
                   4648:         } else {
1.490     raeburn  4649:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4650:         }
                   4651:         my $no_ownblock = 0;
                   4652:         my $no_userblock = 0;
1.533     raeburn  4653:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4654:             # Check if current user has 'evb' priv for this
                   4655:             if (defined($own_courses{$course})) {
                   4656:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4657:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4658:                     if ($sec ne 'none') {
                   4659:                         $checkrole .= '/'.$sec;
                   4660:                     }
                   4661:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4662:                         $no_ownblock = 1;
                   4663:                         last;
                   4664:                     }
                   4665:                 }
                   4666:             }
                   4667:             # if they have 'evb' priv and are currently not playing student
                   4668:             next if (($no_ownblock) &&
                   4669:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4670:         }
1.474     raeburn  4671:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4672:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4673:             if ($sec ne 'none') {
1.482     raeburn  4674:                 $checkrole .= '/'.$sec;
1.474     raeburn  4675:             }
1.490     raeburn  4676:             if ($otheruser) {
                   4677:                 # Resource belongs to user other than current user.
                   4678:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4679:                 my (%allroles,%userroles);
                   4680:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4681:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4682:                         my ($trole,$tdom,$tnum,$tsec);
                   4683:                         if ($entry =~ /^cr/) {
                   4684:                             ($trole,$tdom,$tnum,$tsec) = 
                   4685:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4686:                         } else {
                   4687:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4688:                         }
                   4689:                         my ($spec,$area,$trest);
                   4690:                         $area = '/'.$tdom.'/'.$tnum;
                   4691:                         $trest = $tnum;
                   4692:                         if ($tsec ne '') {
                   4693:                             $area .= '/'.$tsec;
                   4694:                             $trest .= '/'.$tsec;
                   4695:                         }
                   4696:                         $spec = $trole.'.'.$area;
                   4697:                         if ($trole =~ /^cr/) {
                   4698:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4699:                                                               $tdom,$spec,$trest,$area);
                   4700:                         } else {
                   4701:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4702:                                                                 $tdom,$spec,$trest,$area);
                   4703:                         }
                   4704:                     }
1.1075.2.124  raeburn  4705:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4706:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4707:                         if ($1) {
                   4708:                             $no_userblock = 1;
                   4709:                             last;
                   4710:                         }
1.486     raeburn  4711:                     }
                   4712:                 }
1.490     raeburn  4713:             } else {
                   4714:                 # Resource belongs to current user
                   4715:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4716:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4717:                     $no_ownblock = 1;
                   4718:                     last;
                   4719:                 }
1.474     raeburn  4720:             }
                   4721:         }
                   4722:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4723:         next if (($no_ownblock) &&
1.491     albertel 4724:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4725:         next if ($no_userblock);
1.474     raeburn  4726: 
1.1075.2.128  raeburn  4727:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4728:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4729:         
1.1062    raeburn  4730:         my ($start,$end,$trigger) = 
                   4731:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4732:         if (($start != 0) && 
                   4733:             (($startblock == 0) || ($startblock > $start))) {
                   4734:             $startblock = $start;
1.1062    raeburn  4735:             if ($trigger ne '') {
                   4736:                 $triggerblock = $trigger;
                   4737:             }
1.502     raeburn  4738:         }
                   4739:         if (($end != 0)  &&
                   4740:             (($endblock == 0) || ($endblock < $end))) {
                   4741:             $endblock = $end;
1.1062    raeburn  4742:             if ($trigger ne '') {
                   4743:                 $triggerblock = $trigger;
                   4744:             }
1.502     raeburn  4745:         }
1.490     raeburn  4746:     }
1.1062    raeburn  4747:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4748: }
                   4749: 
                   4750: sub get_blocks {
1.1062    raeburn  4751:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4752:     my $startblock = 0;
                   4753:     my $endblock = 0;
1.1062    raeburn  4754:     my $triggerblock = '';
1.490     raeburn  4755:     my $course = $cdom.'_'.$cnum;
                   4756:     $setters->{$course} = {};
                   4757:     $setters->{$course}{'staff'} = [];
                   4758:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4759:     $setters->{$course}{'triggers'} = [];
                   4760:     my (@blockers,%triggered);
                   4761:     my $now = time;
                   4762:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4763:     if ($activity eq 'docs') {
                   4764:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4765:         foreach my $block (@blockers) {
                   4766:             if ($block =~ /^firstaccess____(.+)$/) {
                   4767:                 my $item = $1;
                   4768:                 my $type = 'map';
                   4769:                 my $timersymb = $item;
                   4770:                 if ($item eq 'course') {
                   4771:                     $type = 'course';
                   4772:                 } elsif ($item =~ /___\d+___/) {
                   4773:                     $type = 'resource';
                   4774:                 } else {
                   4775:                     $timersymb = &Apache::lonnet::symbread($item);
                   4776:                 }
                   4777:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4778:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4779:                 $triggered{$block} = {
                   4780:                                        start => $start,
                   4781:                                        end   => $end,
                   4782:                                        type  => $type,
                   4783:                                      };
                   4784:             }
                   4785:         }
                   4786:     } else {
                   4787:         foreach my $block (keys(%commblocks)) {
                   4788:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4789:                 my ($start,$end) = ($1,$2);
                   4790:                 if ($start <= time && $end >= time) {
                   4791:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4792:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4793:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4794:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4795:                                     push(@blockers,$block);
                   4796:                                 }
                   4797:                             }
                   4798:                         }
                   4799:                     }
                   4800:                 }
                   4801:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4802:                 my $item = $1;
                   4803:                 my $timersymb = $item; 
                   4804:                 my $type = 'map';
                   4805:                 if ($item eq 'course') {
                   4806:                     $type = 'course';
                   4807:                 } elsif ($item =~ /___\d+___/) {
                   4808:                     $type = 'resource';
                   4809:                 } else {
                   4810:                     $timersymb = &Apache::lonnet::symbread($item);
                   4811:                 }
                   4812:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4813:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4814:                 if ($start && $end) {
                   4815:                     if (($start <= time) && ($end >= time)) {
                   4816:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4817:                             push(@blockers,$block);
                   4818:                             $triggered{$block} = {
                   4819:                                                    start => $start,
                   4820:                                                    end   => $end,
                   4821:                                                    type  => $type,
                   4822:                                                  };
                   4823:                         }
                   4824:                     }
1.490     raeburn  4825:                 }
1.1062    raeburn  4826:             }
                   4827:         }
                   4828:     }
                   4829:     foreach my $blocker (@blockers) {
                   4830:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4831:             &parse_block_record($commblocks{$blocker});
                   4832:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4833:         my ($start,$end,$triggertype);
                   4834:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4835:             ($start,$end) = ($1,$2);
                   4836:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4837:             $start = $triggered{$blocker}{'start'};
                   4838:             $end = $triggered{$blocker}{'end'};
                   4839:             $triggertype = $triggered{$blocker}{'type'};
                   4840:         }
                   4841:         if ($start) {
                   4842:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4843:             if ($triggertype) {
                   4844:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4845:             } else {
                   4846:                 push(@{$$setters{$course}{'triggers'}},0);
                   4847:             }
                   4848:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4849:                 $startblock = $start;
                   4850:                 if ($triggertype) {
                   4851:                     $triggerblock = $blocker;
1.474     raeburn  4852:                 }
                   4853:             }
1.1062    raeburn  4854:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4855:                $endblock = $end;
                   4856:                if ($triggertype) {
                   4857:                    $triggerblock = $blocker;
                   4858:                }
                   4859:             }
1.474     raeburn  4860:         }
                   4861:     }
1.1062    raeburn  4862:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4863: }
                   4864: 
                   4865: sub parse_block_record {
                   4866:     my ($record) = @_;
                   4867:     my ($setuname,$setudom,$title,$blocks);
                   4868:     if (ref($record) eq 'HASH') {
                   4869:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4870:         $title = &unescape($record->{'event'});
                   4871:         $blocks = $record->{'blocks'};
                   4872:     } else {
                   4873:         my @data = split(/:/,$record,3);
                   4874:         if (scalar(@data) eq 2) {
                   4875:             $title = $data[1];
                   4876:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4877:         } else {
                   4878:             ($setuname,$setudom,$title) = @data;
                   4879:         }
                   4880:         $blocks = { 'com' => 'on' };
                   4881:     }
                   4882:     return ($setuname,$setudom,$title,$blocks);
                   4883: }
                   4884: 
1.854     kalberla 4885: sub blocking_status {
1.1075.2.73  raeburn  4886:     my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061    raeburn  4887:     my %setters;
1.890     droeschl 4888: 
1.1061    raeburn  4889: # check for active blocking
1.1062    raeburn  4890:     my ($startblock,$endblock,$triggerblock) = 
1.1075.2.73  raeburn  4891:         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062    raeburn  4892:     my $blocked = 0;
                   4893:     if ($startblock && $endblock) {
                   4894:         $blocked = 1;
                   4895:     }
1.890     droeschl 4896: 
1.1061    raeburn  4897: # caller just wants to know whether a block is active
                   4898:     if (!wantarray) { return $blocked; }
                   4899: 
                   4900: # build a link to a popup window containing the details
                   4901:     my $querystring  = "?activity=$activity";
                   4902: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97  raeburn  4903:     if (($activity eq 'port') || ($activity eq 'passwd')) {
                   4904:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   4905:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  4906:     } elsif ($activity eq 'docs') {
                   4907:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4908:     }
1.1061    raeburn  4909: 
                   4910:     my $output .= <<'END_MYBLOCK';
                   4911: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4912:     var options = "width=" + w + ",height=" + h + ",";
                   4913:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4914:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4915:     var newWin = window.open(url, wdwName, options);
                   4916:     newWin.focus();
                   4917: }
1.890     droeschl 4918: END_MYBLOCK
1.854     kalberla 4919: 
1.1061    raeburn  4920:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 4921:   
1.1061    raeburn  4922:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  4923:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  4924:     my $class = 'LC_comblock';
1.1062    raeburn  4925:     if ($activity eq 'docs') {
                   4926:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  4927:         $class = '';
1.1063    raeburn  4928:     } elsif ($activity eq 'printout') {
                   4929:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  4930:     } elsif ($activity eq 'passwd') {
                   4931:         $text = &mt('Password Changing Blocked');
1.1062    raeburn  4932:     }
1.1061    raeburn  4933:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  4934: <div class='$class'>
1.869     kalberla 4935:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4936:   title='$text'>
                   4937:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4938:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4939:   title='$text'>$text</a>
1.867     kalberla 4940: </div>
                   4941: 
                   4942: END_BLOCK
1.474     raeburn  4943: 
1.1061    raeburn  4944:     return ($blocked, $output);
1.854     kalberla 4945: }
1.490     raeburn  4946: 
1.60      matthew  4947: ###############################################
                   4948: 
1.682     raeburn  4949: sub check_ip_acc {
1.1075.2.105  raeburn  4950:     my ($acc,$clientip)=@_;
1.682     raeburn  4951:     &Apache::lonxml::debug("acc is $acc");
                   4952:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4953:         return 1;
                   4954:     }
                   4955:     my $allowed=0;
1.1075.2.111  raeburn  4956:     my $ip=$ENV{'REMOTE_ADDR'} || $clientip || $env{'request.host'};
1.682     raeburn  4957: 
                   4958:     my $name;
                   4959:     foreach my $pattern (split(',',$acc)) {
                   4960:         $pattern =~ s/^\s*//;
                   4961:         $pattern =~ s/\s*$//;
                   4962:         if ($pattern =~ /\*$/) {
                   4963:             #35.8.*
                   4964:             $pattern=~s/\*//;
                   4965:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4966:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4967:             #35.8.3.[34-56]
                   4968:             my $low=$2;
                   4969:             my $high=$3;
                   4970:             $pattern=$1;
                   4971:             if ($ip =~ /^\Q$pattern\E/) {
                   4972:                 my $last=(split(/\./,$ip))[3];
                   4973:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4974:             }
                   4975:         } elsif ($pattern =~ /^\*/) {
                   4976:             #*.msu.edu
                   4977:             $pattern=~s/\*//;
                   4978:             if (!defined($name)) {
                   4979:                 use Socket;
                   4980:                 my $netaddr=inet_aton($ip);
                   4981:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4982:             }
                   4983:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4984:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4985:             #127.0.0.1
                   4986:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4987:         } else {
                   4988:             #some.name.com
                   4989:             if (!defined($name)) {
                   4990:                 use Socket;
                   4991:                 my $netaddr=inet_aton($ip);
                   4992:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4993:             }
                   4994:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4995:         }
                   4996:         if ($allowed) { last; }
                   4997:     }
                   4998:     return $allowed;
                   4999: }
                   5000: 
                   5001: ###############################################
                   5002: 
1.60      matthew  5003: =pod
                   5004: 
1.112     bowersj2 5005: =head1 Domain Template Functions
                   5006: 
                   5007: =over 4
                   5008: 
                   5009: =item * &determinedomain()
1.60      matthew  5010: 
                   5011: Inputs: $domain (usually will be undef)
                   5012: 
1.63      www      5013: Returns: Determines which domain should be used for designs
1.60      matthew  5014: 
                   5015: =cut
1.54      www      5016: 
1.60      matthew  5017: ###############################################
1.63      www      5018: sub determinedomain {
                   5019:     my $domain=shift;
1.531     albertel 5020:     if (! $domain) {
1.60      matthew  5021:         # Determine domain if we have not been given one
1.893     raeburn  5022:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5023:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5024:         if ($env{'request.role.domain'}) { 
                   5025:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5026:         }
                   5027:     }
1.63      www      5028:     return $domain;
                   5029: }
                   5030: ###############################################
1.517     raeburn  5031: 
1.518     albertel 5032: sub devalidate_domconfig_cache {
                   5033:     my ($udom)=@_;
                   5034:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5035: }
                   5036: 
                   5037: # ---------------------- Get domain configuration for a domain
                   5038: sub get_domainconf {
                   5039:     my ($udom) = @_;
                   5040:     my $cachetime=1800;
                   5041:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5042:     if (defined($cached)) { return %{$result}; }
                   5043: 
                   5044:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5045: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5046:     my (%designhash,%legacy);
1.518     albertel 5047:     if (keys(%domconfig) > 0) {
                   5048:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5049:             if (keys(%{$domconfig{'login'}})) {
                   5050:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5051:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5052:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5053:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5054:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5055:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5056:                                         if ($key eq 'loginvia') {
                   5057:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5058:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5059:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5060:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5061:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5062:                                                 } else {
                   5063:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5064:                                                 }
1.948     raeburn  5065:                                             }
1.1075.2.87  raeburn  5066:                                         } elsif ($key eq 'headtag') {
                   5067:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5068:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5069:                                             }
1.946     raeburn  5070:                                         }
1.1075.2.87  raeburn  5071:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5072:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5073:                                         }
1.946     raeburn  5074:                                     }
                   5075:                                 }
                   5076:                             }
                   5077:                         } else {
                   5078:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5079:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5080:                                     $domconfig{'login'}{$key}{$img};
                   5081:                             }
1.699     raeburn  5082:                         }
                   5083:                     } else {
                   5084:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5085:                     }
1.632     raeburn  5086:                 }
                   5087:             } else {
                   5088:                 $legacy{'login'} = 1;
1.518     albertel 5089:             }
1.632     raeburn  5090:         } else {
                   5091:             $legacy{'login'} = 1;
1.518     albertel 5092:         }
                   5093:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5094:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5095:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5096:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5097:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5098:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5099:                         }
1.518     albertel 5100:                     }
                   5101:                 }
1.632     raeburn  5102:             } else {
                   5103:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5104:             }
1.632     raeburn  5105:         } else {
                   5106:             $legacy{'rolecolors'} = 1;
1.518     albertel 5107:         }
1.948     raeburn  5108:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5109:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5110:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5111:             }
                   5112:         }
1.632     raeburn  5113:         if (keys(%legacy) > 0) {
                   5114:             my %legacyhash = &get_legacy_domconf($udom);
                   5115:             foreach my $item (keys(%legacyhash)) {
                   5116:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5117:                     if ($legacy{'login'}) { 
                   5118:                         $designhash{$item} = $legacyhash{$item};
                   5119:                     }
                   5120:                 } else {
                   5121:                     if ($legacy{'rolecolors'}) {
                   5122:                         $designhash{$item} = $legacyhash{$item};
                   5123:                     }
1.518     albertel 5124:                 }
                   5125:             }
                   5126:         }
1.632     raeburn  5127:     } else {
                   5128:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5129:     }
                   5130:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5131: 				  $cachetime);
                   5132:     return %designhash;
                   5133: }
                   5134: 
1.632     raeburn  5135: sub get_legacy_domconf {
                   5136:     my ($udom) = @_;
                   5137:     my %legacyhash;
                   5138:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5139:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5140:     if (-e $designfile) {
1.1075.2.128  raeburn  5141:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5142:             while (my $line = <$fh>) {
                   5143:                 next if ($line =~ /^\#/);
                   5144:                 chomp($line);
                   5145:                 my ($key,$val)=(split(/\=/,$line));
                   5146:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5147:             }
                   5148:             close($fh);
                   5149:         }
                   5150:     }
1.1026    raeburn  5151:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5152:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5153:     }
                   5154:     return %legacyhash;
                   5155: }
                   5156: 
1.63      www      5157: =pod
                   5158: 
1.112     bowersj2 5159: =item * &domainlogo()
1.63      www      5160: 
                   5161: Inputs: $domain (usually will be undef)
                   5162: 
                   5163: Returns: A link to a domain logo, if the domain logo exists.
                   5164: If the domain logo does not exist, a description of the domain.
                   5165: 
                   5166: =cut
1.112     bowersj2 5167: 
1.63      www      5168: ###############################################
                   5169: sub domainlogo {
1.517     raeburn  5170:     my $domain = &determinedomain(shift);
1.518     albertel 5171:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5172:     # See if there is a logo
                   5173:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5174:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5175:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5176: 	    if ($imgsrc =~ m{^/res/}) {
                   5177: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5178: 		&Apache::lonnet::repcopy($local_name);
                   5179: 	    }
                   5180: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5181:         } 
                   5182:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5183:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5184:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5185:     } else {
1.60      matthew  5186:         return '';
1.59      www      5187:     }
                   5188: }
1.63      www      5189: ##############################################
                   5190: 
                   5191: =pod
                   5192: 
1.112     bowersj2 5193: =item * &designparm()
1.63      www      5194: 
                   5195: Inputs: $which parameter; $domain (usually will be undef)
                   5196: 
                   5197: Returns: value of designparamter $which
                   5198: 
                   5199: =cut
1.112     bowersj2 5200: 
1.397     albertel 5201: 
1.400     albertel 5202: ##############################################
1.397     albertel 5203: sub designparm {
                   5204:     my ($which,$domain)=@_;
                   5205:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5206:         return $env{'environment.color.'.$which};
1.96      www      5207:     }
1.63      www      5208:     $domain=&determinedomain($domain);
1.1016    raeburn  5209:     my %domdesign;
                   5210:     unless ($domain eq 'public') {
                   5211:         %domdesign = &get_domainconf($domain);
                   5212:     }
1.520     raeburn  5213:     my $output;
1.517     raeburn  5214:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5215:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5216:     } else {
1.520     raeburn  5217:         $output = $defaultdesign{$which};
                   5218:     }
                   5219:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5220:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5221:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5222:             if ($output =~ m{^/res/}) {
                   5223:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5224:                 &Apache::lonnet::repcopy($local_name);
                   5225:             }
1.520     raeburn  5226:             $output = &lonhttpdurl($output);
                   5227:         }
1.63      www      5228:     }
1.520     raeburn  5229:     return $output;
1.63      www      5230: }
1.59      www      5231: 
1.822     bisitz   5232: ##############################################
                   5233: =pod
                   5234: 
1.832     bisitz   5235: =item * &authorspace()
                   5236: 
1.1028    raeburn  5237: Inputs: $url (usually will be undef).
1.832     bisitz   5238: 
1.1075.2.40  raeburn  5239: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5240:          directory being viewed (or for which action is being taken). 
                   5241:          If $url is provided, and begins /priv/<domain>/<uname>
                   5242:          the path will be that portion of the $context argument.
                   5243:          Otherwise the path will be for the author space of the current
                   5244:          user when the current role is author, or for that of the 
                   5245:          co-author/assistant co-author space when the current role 
                   5246:          is co-author or assistant co-author.
1.832     bisitz   5247: 
                   5248: =cut
                   5249: 
                   5250: sub authorspace {
1.1028    raeburn  5251:     my ($url) = @_;
                   5252:     if ($url ne '') {
                   5253:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5254:            return $1;
                   5255:         }
                   5256:     }
1.832     bisitz   5257:     my $caname = '';
1.1024    www      5258:     my $cadom = '';
1.1028    raeburn  5259:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5260:         ($cadom,$caname) =
1.832     bisitz   5261:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5262:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5263:         $caname = $env{'user.name'};
1.1024    www      5264:         $cadom = $env{'user.domain'};
1.832     bisitz   5265:     }
1.1028    raeburn  5266:     if (($caname ne '') && ($cadom ne '')) {
                   5267:         return "/priv/$cadom/$caname/";
                   5268:     }
                   5269:     return;
1.832     bisitz   5270: }
                   5271: 
                   5272: ##############################################
                   5273: =pod
                   5274: 
1.822     bisitz   5275: =item * &head_subbox()
                   5276: 
                   5277: Inputs: $content (contains HTML code with page functions, etc.)
                   5278: 
                   5279: Returns: HTML div with $content
                   5280:          To be included in page header
                   5281: 
                   5282: =cut
                   5283: 
                   5284: sub head_subbox {
                   5285:     my ($content)=@_;
                   5286:     my $output =
1.993     raeburn  5287:         '<div class="LC_head_subbox">'
1.822     bisitz   5288:        .$content
                   5289:        .'</div>'
                   5290: }
                   5291: 
                   5292: ##############################################
                   5293: =pod
                   5294: 
                   5295: =item * &CSTR_pageheader()
                   5296: 
1.1026    raeburn  5297: Input: (optional) filename from which breadcrumb trail is built.
                   5298:        In most cases no input as needed, as $env{'request.filename'}
                   5299:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5300: 
                   5301: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5302:          To be included on Authoring Space pages
1.822     bisitz   5303: 
                   5304: =cut
                   5305: 
                   5306: sub CSTR_pageheader {
1.1026    raeburn  5307:     my ($trailfile) = @_;
                   5308:     if ($trailfile eq '') {
                   5309:         $trailfile = $env{'request.filename'};
                   5310:     }
                   5311: 
                   5312: # this is for resources; directories have customtitle, and crumbs
                   5313: # and select recent are created in lonpubdir.pm
                   5314: 
                   5315:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5316:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5317:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5318:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5319:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5320: 
                   5321:     my $parentpath = '';
                   5322:     my $lastitem = '';
                   5323:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5324:         $parentpath = $1;
                   5325:         $lastitem = $2;
                   5326:     } else {
                   5327:         $lastitem = $thisdisfn;
                   5328:     }
1.921     bisitz   5329: 
                   5330:     my $output =
1.822     bisitz   5331:          '<div>'
                   5332:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5333:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5334:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5335:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5336:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5337: 
                   5338:     if ($lastitem) {
                   5339:         $output .=
                   5340:              '<span class="LC_filename">'
                   5341:             .$lastitem
                   5342:             .'</span>';
                   5343:     }
                   5344:     $output .=
                   5345:          '<br />'
1.822     bisitz   5346:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5347:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5348:         .'</form>'
                   5349:         .&Apache::lonmenu::constspaceform()
                   5350:         .'</div>';
1.921     bisitz   5351: 
                   5352:     return $output;
1.822     bisitz   5353: }
                   5354: 
1.60      matthew  5355: ###############################################
                   5356: ###############################################
                   5357: 
                   5358: =pod
                   5359: 
1.112     bowersj2 5360: =back
                   5361: 
1.549     albertel 5362: =head1 HTML Helpers
1.112     bowersj2 5363: 
                   5364: =over 4
                   5365: 
                   5366: =item * &bodytag()
1.60      matthew  5367: 
                   5368: Returns a uniform header for LON-CAPA web pages.
                   5369: 
                   5370: Inputs: 
                   5371: 
1.112     bowersj2 5372: =over 4
                   5373: 
                   5374: =item * $title, A title to be displayed on the page.
                   5375: 
                   5376: =item * $function, the current role (can be undef).
                   5377: 
                   5378: =item * $addentries, extra parameters for the <body> tag.
                   5379: 
                   5380: =item * $bodyonly, if defined, only return the <body> tag.
                   5381: 
                   5382: =item * $domain, if defined, force a given domain.
                   5383: 
                   5384: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5385:             text interface only)
1.60      matthew  5386: 
1.814     bisitz   5387: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5388:                      navigational links
1.317     albertel 5389: 
1.338     albertel 5390: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5391: 
1.1075.2.12  raeburn  5392: =item * $no_inline_link, if true and in remote mode, don't show the
                   5393:          'Switch To Inline Menu' link
                   5394: 
1.460     albertel 5395: =item * $args, optional argument valid values are
                   5396:             no_auto_mt_title -> prevents &mt()ing the title arg
                   5397: 
1.1075.2.15  raeburn  5398: =item * $advtoolsref, optional argument, ref to an array containing
                   5399:             inlineremote items to be added in "Functions" menu below
                   5400:             breadcrumbs.
                   5401: 
1.112     bowersj2 5402: =back
                   5403: 
1.60      matthew  5404: Returns: A uniform header for LON-CAPA web pages.  
                   5405: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5406: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5407: other decorations will be returned.
                   5408: 
                   5409: =cut
                   5410: 
1.54      www      5411: sub bodytag {
1.831     bisitz   5412:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5413:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5414: 
1.954     raeburn  5415:     my $public;
                   5416:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5417:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5418:         $public = 1;
                   5419:     }
1.460     albertel 5420:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5421:     my $httphost = $args->{'use_absolute'};
1.339     albertel 5422: 
1.183     matthew  5423:     $function = &get_users_function() if (!$function);
1.339     albertel 5424:     my $img =    &designparm($function.'.img',$domain);
                   5425:     my $font =   &designparm($function.'.font',$domain);
                   5426:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5427: 
1.803     bisitz   5428:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5429: 		   'bgcolor' => $pgbg,
1.339     albertel 5430: 		   'text'    => $font,
                   5431:                    'alink'   => &designparm($function.'.alink',$domain),
                   5432: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5433: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5434:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5435: 
1.63      www      5436:  # role and realm
1.1075.2.68  raeburn  5437:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5438:     if ($realm) {
                   5439:         $realm = '/'.$realm;
                   5440:     }
1.378     raeburn  5441:     if ($role  eq 'ca') {
1.479     albertel 5442:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5443:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5444:     } 
1.55      www      5445: # realm
1.258     albertel 5446:     if ($env{'request.course.id'}) {
1.378     raeburn  5447:         if ($env{'request.role'} !~ /^cr/) {
                   5448:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5449:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5450:             if ($env{'request.role.desc'}) {
                   5451:                 $role = $env{'request.role.desc'};
                   5452:             } else {
                   5453:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5454:             }
1.1075.2.115  raeburn  5455:         } else {
                   5456:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5457:         }
1.898     raeburn  5458:         if ($env{'request.course.sec'}) {
                   5459:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5460:         }   
1.359     albertel 5461: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5462:     } else {
                   5463:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5464:     }
1.433     albertel 5465: 
1.359     albertel 5466:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5467: 
1.438     albertel 5468:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5469: 
1.101     www      5470: # construct main body tag
1.359     albertel 5471:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5472: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5473: 
1.1075.2.38  raeburn  5474:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5475: 
                   5476:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5477:         return $bodytag;
1.1075.2.38  raeburn  5478:     }
1.359     albertel 5479: 
1.954     raeburn  5480:     if ($public) {
1.433     albertel 5481: 	undef($role);
                   5482:     }
1.359     albertel 5483:     
1.762     bisitz   5484:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5485:     #
                   5486:     # Extra info if you are the DC
                   5487:     my $dc_info = '';
                   5488:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5489:                         $env{'course.'.$env{'request.course.id'}.
                   5490:                                  '.domain'}.'/'})) {
                   5491:         my $cid = $env{'request.course.id'};
1.917     raeburn  5492:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5493:         $dc_info =~ s/\s+$//;
1.359     albertel 5494:     }
                   5495: 
1.1075.2.108  raeburn  5496:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5497: 
1.1075.2.13  raeburn  5498:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5499: 
1.1075.2.38  raeburn  5500: 
                   5501: 
1.1075.2.21  raeburn  5502:     my $funclist;
                   5503:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5504:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5505:                     Apache::lonmenu::serverform();
                   5506:         my $forbodytag;
                   5507:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5508:                                             $forcereg,$args->{'group'},
                   5509:                                             $args->{'bread_crumbs'},
                   5510:                                             $advtoolsref,'',\$forbodytag);
                   5511:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5512:             $funclist = $forbodytag;
                   5513:         }
                   5514:     } else {
1.903     droeschl 5515: 
                   5516:         #    if ($env{'request.state'} eq 'construct') {
                   5517:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5518:         #    }
                   5519: 
1.1075.2.38  raeburn  5520:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5521:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5522: 
1.1075.2.38  raeburn  5523:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2  raeburn  5524: 
1.916     droeschl 5525:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5526:             if ($dc_info) {
                   5527:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5528:             }
1.1075.2.38  raeburn  5529:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5530:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5531:             return $bodytag;
                   5532:         }
1.894     droeschl 5533: 
1.927     raeburn  5534:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5535:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5536:         }
1.916     droeschl 5537: 
1.1075.2.38  raeburn  5538:         $bodytag .= $right;
1.852     droeschl 5539: 
1.917     raeburn  5540:         if ($dc_info) {
                   5541:             $dc_info = &dc_courseid_toggle($dc_info);
                   5542:         }
                   5543:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5544: 
1.1075.2.61  raeburn  5545:         #if directed to not display the secondary menu, don't.
                   5546:         if ($args->{'no_secondary_menu'}) {
                   5547:             return $bodytag;
                   5548:         }
1.903     droeschl 5549:         #don't show menus for public users
1.954     raeburn  5550:         if (!$public){
1.1075.2.52  raeburn  5551:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5552:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5553:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5554:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5555:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.920     raeburn  5556:                                 $args->{'bread_crumbs'});
1.1075.2.116  raeburn  5557:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5558:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5559:                                                             $args->{'group'},
                   5560:                                                             $args->{'hide_buttons'});
1.1075.2.15  raeburn  5561:             } else {
1.1075.2.21  raeburn  5562:                 my $forbodytag;
                   5563:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5564:                                                     $forcereg,$args->{'group'},
                   5565:                                                     $args->{'bread_crumbs'},
                   5566:                                                     $advtoolsref,'',\$forbodytag);
                   5567:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5568:                     $bodytag .= $forbodytag;
                   5569:                 }
1.920     raeburn  5570:             }
1.903     droeschl 5571:         }else{
                   5572:             # this is to seperate menu from content when there's no secondary
                   5573:             # menu. Especially needed for public accessible ressources.
                   5574:             $bodytag .= '<hr style="clear:both" />';
                   5575:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5576:         }
1.903     droeschl 5577: 
1.235     raeburn  5578:         return $bodytag;
1.1075.2.12  raeburn  5579:     }
                   5580: 
                   5581: #
                   5582: # Top frame rendering, Remote is up
                   5583: #
                   5584: 
                   5585:     my $imgsrc = $img;
                   5586:     if ($img =~ /^\/adm/) {
                   5587:         $imgsrc = &lonhttpdurl($img);
                   5588:     }
                   5589:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5590: 
1.1075.2.60  raeburn  5591:     my $help=($no_inline_link?''
                   5592:               :&Apache::loncommon::top_nav_help('Help'));
                   5593: 
1.1075.2.12  raeburn  5594:     # Explicit link to get inline menu
                   5595:     my $menu= ($no_inline_link?''
                   5596:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5597: 
                   5598:     if ($dc_info) {
                   5599:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5600:     }
                   5601: 
1.1075.2.38  raeburn  5602:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5603:     unless ($public) {
                   5604:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5605:                                 undef,'LC_menubuttons_link');
                   5606:     }
                   5607: 
1.1075.2.12  raeburn  5608:     unless ($env{'form.inhibitmenu'}) {
                   5609:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5610:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5611:                        <li>$help</li>
1.1075.2.12  raeburn  5612:                        <li>$menu</li>
                   5613:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5614:     }
1.1075.2.13  raeburn  5615:     if ($env{'request.state'} eq 'construct') {
                   5616:         if (!$public){
                   5617:             if ($env{'request.state'} eq 'construct') {
                   5618:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5619:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5620:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5621:                             &Apache::lonmenu::innerregister($forcereg,
                   5622:                                                             $args->{'bread_crumbs'});
                   5623:             }
                   5624:         }
                   5625:     }
1.1075.2.21  raeburn  5626:     return $bodytag."\n".$funclist;
1.182     matthew  5627: }
                   5628: 
1.917     raeburn  5629: sub dc_courseid_toggle {
                   5630:     my ($dc_info) = @_;
1.980     raeburn  5631:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5632:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5633:            &mt('(More ...)').'</a></span>'.
                   5634:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5635: }
                   5636: 
1.330     albertel 5637: sub make_attr_string {
                   5638:     my ($register,$attr_ref) = @_;
                   5639: 
                   5640:     if ($attr_ref && !ref($attr_ref)) {
                   5641: 	die("addentries Must be a hash ref ".
                   5642: 	    join(':',caller(1))." ".
                   5643: 	    join(':',caller(0))." ");
                   5644:     }
                   5645: 
                   5646:     if ($register) {
1.339     albertel 5647: 	my ($on_load,$on_unload);
                   5648: 	foreach my $key (keys(%{$attr_ref})) {
                   5649: 	    if      (lc($key) eq 'onload') {
                   5650: 		$on_load.=$attr_ref->{$key}.';';
                   5651: 		delete($attr_ref->{$key});
                   5652: 
                   5653: 	    } elsif (lc($key) eq 'onunload') {
                   5654: 		$on_unload.=$attr_ref->{$key}.';';
                   5655: 		delete($attr_ref->{$key});
                   5656: 	    }
                   5657: 	}
1.1075.2.12  raeburn  5658:         if ($env{'environment.remote'} eq 'on') {
                   5659:             $attr_ref->{'onload'}  =
                   5660:                 &Apache::lonmenu::loadevents().  $on_load;
                   5661:             $attr_ref->{'onunload'}=
                   5662:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5663:         } else {  
                   5664: 	    $attr_ref->{'onload'}  = $on_load;
                   5665: 	    $attr_ref->{'onunload'}= $on_unload;
                   5666:         }
1.330     albertel 5667:     }
1.339     albertel 5668: 
1.330     albertel 5669:     my $attr_string;
1.1075.2.56  raeburn  5670:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5671: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5672:     }
                   5673:     return $attr_string;
                   5674: }
                   5675: 
                   5676: 
1.182     matthew  5677: ###############################################
1.251     albertel 5678: ###############################################
                   5679: 
                   5680: =pod
                   5681: 
                   5682: =item * &endbodytag()
                   5683: 
                   5684: Returns a uniform footer for LON-CAPA web pages.
                   5685: 
1.635     raeburn  5686: Inputs: 1 - optional reference to an args hash
                   5687: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5688: a 'Continue' link is not displayed if the page contains an
                   5689: internal redirect in the <head></head> section,
                   5690: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5691: 
                   5692: =cut
                   5693: 
                   5694: sub endbodytag {
1.635     raeburn  5695:     my ($args) = @_;
1.1075.2.6  raeburn  5696:     my $endbodytag;
                   5697:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5698:         $endbodytag='</body>';
                   5699:     }
1.315     albertel 5700:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5701:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5702: 	    $endbodytag=
                   5703: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5704: 	        &mt('Continue').'</a>'.
                   5705: 	        $endbodytag;
                   5706:         }
1.315     albertel 5707:     }
1.251     albertel 5708:     return $endbodytag;
                   5709: }
                   5710: 
1.352     albertel 5711: =pod
                   5712: 
                   5713: =item * &standard_css()
                   5714: 
                   5715: Returns a style sheet
                   5716: 
                   5717: Inputs: (all optional)
                   5718:             domain         -> force to color decorate a page for a specific
                   5719:                                domain
                   5720:             function       -> force usage of a specific rolish color scheme
                   5721:             bgcolor        -> override the default page bgcolor
                   5722: 
                   5723: =cut
                   5724: 
1.343     albertel 5725: sub standard_css {
1.345     albertel 5726:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5727:     $function  = &get_users_function() if (!$function);
                   5728:     my $img    = &designparm($function.'.img',   $domain);
                   5729:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5730:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5731:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5732: #second colour for later usage
1.345     albertel 5733:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5734:     my $pgbg_or_bgcolor =
                   5735: 	         $bgcolor ||
1.352     albertel 5736: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5737:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5738:     my $alink  = &designparm($function.'.alink', $domain);
                   5739:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5740:     my $link   = &designparm($function.'.link',  $domain);
                   5741: 
1.602     albertel 5742:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5743:     my $mono                 = 'monospace';
1.850     bisitz   5744:     my $data_table_head      = $sidebg;
                   5745:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5746:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5747:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5748:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5749:     my $mail_new             = '#FFBB77';
                   5750:     my $mail_new_hover       = '#DD9955';
                   5751:     my $mail_read            = '#BBBB77';
                   5752:     my $mail_read_hover      = '#999944';
                   5753:     my $mail_replied         = '#AAAA88';
                   5754:     my $mail_replied_hover   = '#888855';
                   5755:     my $mail_other           = '#99BBBB';
                   5756:     my $mail_other_hover     = '#669999';
1.391     albertel 5757:     my $table_header         = '#DDDDDD';
1.489     raeburn  5758:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5759:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5760:     my $button_hover         = '#BF2317';
1.392     albertel 5761: 
1.608     albertel 5762:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5763:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5764:                                              : '0 3px 0 4px';
1.448     albertel 5765: 
1.523     albertel 5766: 
1.343     albertel 5767:     return <<END;
1.947     droeschl 5768: 
                   5769: /* needed for iframe to allow 100% height in FF */
                   5770: body, html { 
                   5771:     margin: 0;
                   5772:     padding: 0 0.5%;
                   5773:     height: 99%; /* to avoid scrollbars */
                   5774: }
                   5775: 
1.795     www      5776: body {
1.911     bisitz   5777:   font-family: $sans;
                   5778:   line-height:130%;
                   5779:   font-size:0.83em;
                   5780:   color:$font;
1.795     www      5781: }
                   5782: 
1.959     onken    5783: a:focus,
                   5784: a:focus img {
1.795     www      5785:   color: red;
                   5786: }
1.698     harmsja  5787: 
1.911     bisitz   5788: form, .inline {
                   5789:   display: inline;
1.795     www      5790: }
1.721     harmsja  5791: 
1.795     www      5792: .LC_right {
1.911     bisitz   5793:   text-align:right;
1.795     www      5794: }
                   5795: 
                   5796: .LC_middle {
1.911     bisitz   5797:   vertical-align:middle;
1.795     www      5798: }
1.721     harmsja  5799: 
1.1075.2.38  raeburn  5800: .LC_floatleft {
                   5801:   float: left;
                   5802: }
                   5803: 
                   5804: .LC_floatright {
                   5805:   float: right;
                   5806: }
                   5807: 
1.911     bisitz   5808: .LC_400Box {
                   5809:   width:400px;
                   5810: }
1.721     harmsja  5811: 
1.947     droeschl 5812: .LC_iframecontainer {
                   5813:     width: 98%;
                   5814:     margin: 0;
                   5815:     position: fixed;
                   5816:     top: 8.5em;
                   5817:     bottom: 0;
                   5818: }
                   5819: 
                   5820: .LC_iframecontainer iframe{
                   5821:     border: none;
                   5822:     width: 100%;
                   5823:     height: 100%;
                   5824: }
                   5825: 
1.778     bisitz   5826: .LC_filename {
                   5827:   font-family: $mono;
                   5828:   white-space:pre;
1.921     bisitz   5829:   font-size: 120%;
1.778     bisitz   5830: }
                   5831: 
                   5832: .LC_fileicon {
                   5833:   border: none;
                   5834:   height: 1.3em;
                   5835:   vertical-align: text-bottom;
                   5836:   margin-right: 0.3em;
                   5837:   text-decoration:none;
                   5838: }
                   5839: 
1.1008    www      5840: .LC_setting {
                   5841:   text-decoration:underline;
                   5842: }
                   5843: 
1.350     albertel 5844: .LC_error {
                   5845:   color: red;
                   5846: }
1.795     www      5847: 
1.1075.2.15  raeburn  5848: .LC_warning {
                   5849:   color: darkorange;
                   5850: }
                   5851: 
1.457     albertel 5852: .LC_diff_removed {
1.733     bisitz   5853:   color: red;
1.394     albertel 5854: }
1.532     albertel 5855: 
                   5856: .LC_info,
1.457     albertel 5857: .LC_success,
                   5858: .LC_diff_added {
1.350     albertel 5859:   color: green;
                   5860: }
1.795     www      5861: 
1.802     bisitz   5862: div.LC_confirm_box {
                   5863:   background-color: #FAFAFA;
                   5864:   border: 1px solid $lg_border_color;
                   5865:   margin-right: 0;
                   5866:   padding: 5px;
                   5867: }
                   5868: 
                   5869: div.LC_confirm_box .LC_error img,
                   5870: div.LC_confirm_box .LC_success img {
                   5871:   vertical-align: middle;
                   5872: }
                   5873: 
1.1075.2.108  raeburn  5874: .LC_maxwidth {
                   5875:   max-width: 100%;
                   5876:   height: auto;
                   5877: }
                   5878: 
                   5879: .LC_textsize_mobile {
                   5880:   \@media only screen and (max-device-width: 480px) {
                   5881:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   5882:   }
                   5883: }
                   5884: 
1.440     albertel 5885: .LC_icon {
1.771     droeschl 5886:   border: none;
1.790     droeschl 5887:   vertical-align: middle;
1.771     droeschl 5888: }
                   5889: 
1.543     albertel 5890: .LC_docs_spacer {
                   5891:   width: 25px;
                   5892:   height: 1px;
1.771     droeschl 5893:   border: none;
1.543     albertel 5894: }
1.346     albertel 5895: 
1.532     albertel 5896: .LC_internal_info {
1.735     bisitz   5897:   color: #999999;
1.532     albertel 5898: }
                   5899: 
1.794     www      5900: .LC_discussion {
1.1050    www      5901:   background: $data_table_dark;
1.911     bisitz   5902:   border: 1px solid black;
                   5903:   margin: 2px;
1.794     www      5904: }
                   5905: 
                   5906: .LC_disc_action_left {
1.1050    www      5907:   background: $sidebg;
1.911     bisitz   5908:   text-align: left;
1.1050    www      5909:   padding: 4px;
                   5910:   margin: 2px;
1.794     www      5911: }
                   5912: 
                   5913: .LC_disc_action_right {
1.1050    www      5914:   background: $sidebg;
1.911     bisitz   5915:   text-align: right;
1.1050    www      5916:   padding: 4px;
                   5917:   margin: 2px;
1.794     www      5918: }
                   5919: 
                   5920: .LC_disc_new_item {
1.911     bisitz   5921:   background: white;
                   5922:   border: 2px solid red;
1.1050    www      5923:   margin: 4px;
                   5924:   padding: 4px;
1.794     www      5925: }
                   5926: 
                   5927: .LC_disc_old_item {
1.911     bisitz   5928:   background: white;
1.1050    www      5929:   margin: 4px;
                   5930:   padding: 4px;
1.794     www      5931: }
                   5932: 
1.458     albertel 5933: table.LC_pastsubmission {
                   5934:   border: 1px solid black;
                   5935:   margin: 2px;
                   5936: }
                   5937: 
1.924     bisitz   5938: table#LC_menubuttons {
1.345     albertel 5939:   width: 100%;
                   5940:   background: $pgbg;
1.392     albertel 5941:   border: 2px;
1.402     albertel 5942:   border-collapse: separate;
1.803     bisitz   5943:   padding: 0;
1.345     albertel 5944: }
1.392     albertel 5945: 
1.801     tempelho 5946: table#LC_title_bar a {
                   5947:   color: $fontmenu;
                   5948: }
1.836     bisitz   5949: 
1.807     droeschl 5950: table#LC_title_bar {
1.819     tempelho 5951:   clear: both;
1.836     bisitz   5952:   display: none;
1.807     droeschl 5953: }
                   5954: 
1.795     www      5955: table#LC_title_bar,
1.933     droeschl 5956: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 5957: table#LC_title_bar.LC_with_remote {
1.359     albertel 5958:   width: 100%;
1.392     albertel 5959:   border-color: $pgbg;
                   5960:   border-style: solid;
                   5961:   border-width: $border;
1.379     albertel 5962:   background: $pgbg;
1.801     tempelho 5963:   color: $fontmenu;
1.392     albertel 5964:   border-collapse: collapse;
1.803     bisitz   5965:   padding: 0;
1.819     tempelho 5966:   margin: 0;
1.359     albertel 5967: }
1.795     www      5968: 
1.933     droeschl 5969: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 5970:     margin: 0;
                   5971:     padding: 0;
1.933     droeschl 5972:     position: relative;
                   5973:     list-style: none;
1.913     droeschl 5974: }
1.933     droeschl 5975: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 5976:     display: inline;
                   5977: }
1.933     droeschl 5978: 
                   5979: .LC_breadcrumb_tools_navigation {
1.913     droeschl 5980:     padding: 0;
1.933     droeschl 5981:     margin: 0;
                   5982:     float: left;
1.913     droeschl 5983: }
1.933     droeschl 5984: .LC_breadcrumb_tools_tools {
                   5985:     padding: 0;
                   5986:     margin: 0;
1.913     droeschl 5987:     float: right;
                   5988: }
                   5989: 
1.359     albertel 5990: table#LC_title_bar td {
                   5991:   background: $tabbg;
                   5992: }
1.795     www      5993: 
1.911     bisitz   5994: table#LC_menubuttons img {
1.803     bisitz   5995:   border: none;
1.346     albertel 5996: }
1.795     www      5997: 
1.842     droeschl 5998: .LC_breadcrumbs_component {
1.911     bisitz   5999:   float: right;
                   6000:   margin: 0 1em;
1.357     albertel 6001: }
1.842     droeschl 6002: .LC_breadcrumbs_component img {
1.911     bisitz   6003:   vertical-align: middle;
1.777     tempelho 6004: }
1.795     www      6005: 
1.1075.2.108  raeburn  6006: .LC_breadcrumbs_hoverable {
                   6007:   background: $sidebg;
                   6008: }
                   6009: 
1.383     albertel 6010: td.LC_table_cell_checkbox {
                   6011:   text-align: center;
                   6012: }
1.795     www      6013: 
                   6014: .LC_fontsize_small {
1.911     bisitz   6015:   font-size: 70%;
1.705     tempelho 6016: }
                   6017: 
1.844     bisitz   6018: #LC_breadcrumbs {
1.911     bisitz   6019:   clear:both;
                   6020:   background: $sidebg;
                   6021:   border-bottom: 1px solid $lg_border_color;
                   6022:   line-height: 2.5em;
1.933     droeschl 6023:   overflow: hidden;
1.911     bisitz   6024:   margin: 0;
                   6025:   padding: 0;
1.995     raeburn  6026:   text-align: left;
1.819     tempelho 6027: }
1.862     bisitz   6028: 
1.1075.2.16  raeburn  6029: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6030:   clear:both;
                   6031:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6032:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6033:   margin: 0 0 10px 0;
1.966     bisitz   6034:   padding: 3px;
1.995     raeburn  6035:   text-align: left;
1.822     bisitz   6036: }
                   6037: 
1.795     www      6038: .LC_fontsize_medium {
1.911     bisitz   6039:   font-size: 85%;
1.705     tempelho 6040: }
                   6041: 
1.795     www      6042: .LC_fontsize_large {
1.911     bisitz   6043:   font-size: 120%;
1.705     tempelho 6044: }
                   6045: 
1.346     albertel 6046: .LC_menubuttons_inline_text {
                   6047:   color: $font;
1.698     harmsja  6048:   font-size: 90%;
1.701     harmsja  6049:   padding-left:3px;
1.346     albertel 6050: }
                   6051: 
1.934     droeschl 6052: .LC_menubuttons_inline_text img{
                   6053:   vertical-align: middle;
                   6054: }
                   6055: 
1.1051    www      6056: li.LC_menubuttons_inline_text img {
1.951     onken    6057:   cursor:pointer;
1.1002    droeschl 6058:   text-decoration: none;
1.951     onken    6059: }
                   6060: 
1.526     www      6061: .LC_menubuttons_link {
                   6062:   text-decoration: none;
                   6063: }
1.795     www      6064: 
1.522     albertel 6065: .LC_menubuttons_category {
1.521     www      6066:   color: $font;
1.526     www      6067:   background: $pgbg;
1.521     www      6068:   font-size: larger;
                   6069:   font-weight: bold;
                   6070: }
                   6071: 
1.346     albertel 6072: td.LC_menubuttons_text {
1.911     bisitz   6073:   color: $font;
1.346     albertel 6074: }
1.706     harmsja  6075: 
1.346     albertel 6076: .LC_current_location {
                   6077:   background: $tabbg;
                   6078: }
1.795     www      6079: 
1.938     bisitz   6080: table.LC_data_table {
1.347     albertel 6081:   border: 1px solid #000000;
1.402     albertel 6082:   border-collapse: separate;
1.426     albertel 6083:   border-spacing: 1px;
1.610     albertel 6084:   background: $pgbg;
1.347     albertel 6085: }
1.795     www      6086: 
1.422     albertel 6087: .LC_data_table_dense {
                   6088:   font-size: small;
                   6089: }
1.795     www      6090: 
1.507     raeburn  6091: table.LC_nested_outer {
                   6092:   border: 1px solid #000000;
1.589     raeburn  6093:   border-collapse: collapse;
1.803     bisitz   6094:   border-spacing: 0;
1.507     raeburn  6095:   width: 100%;
                   6096: }
1.795     www      6097: 
1.879     raeburn  6098: table.LC_innerpickbox,
1.507     raeburn  6099: table.LC_nested {
1.803     bisitz   6100:   border: none;
1.589     raeburn  6101:   border-collapse: collapse;
1.803     bisitz   6102:   border-spacing: 0;
1.507     raeburn  6103:   width: 100%;
                   6104: }
1.795     www      6105: 
1.911     bisitz   6106: table.LC_data_table tr th,
                   6107: table.LC_calendar tr th,
1.879     raeburn  6108: table.LC_prior_tries tr th,
                   6109: table.LC_innerpickbox tr th {
1.349     albertel 6110:   font-weight: bold;
                   6111:   background-color: $data_table_head;
1.801     tempelho 6112:   color:$fontmenu;
1.701     harmsja  6113:   font-size:90%;
1.347     albertel 6114: }
1.795     www      6115: 
1.879     raeburn  6116: table.LC_innerpickbox tr th,
                   6117: table.LC_innerpickbox tr td {
                   6118:   vertical-align: top;
                   6119: }
                   6120: 
1.711     raeburn  6121: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6122:   background-color: #CCCCCC;
1.711     raeburn  6123:   font-weight: bold;
                   6124:   text-align: left;
                   6125: }
1.795     www      6126: 
1.912     bisitz   6127: table.LC_data_table tr.LC_odd_row > td {
                   6128:   background-color: $data_table_light;
                   6129:   padding: 2px;
                   6130:   vertical-align: top;
                   6131: }
                   6132: 
1.809     bisitz   6133: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6134:   background-color: $data_table_light;
1.912     bisitz   6135:   vertical-align: top;
                   6136: }
                   6137: 
                   6138: table.LC_data_table tr.LC_even_row > td {
                   6139:   background-color: $data_table_dark;
1.425     albertel 6140:   padding: 2px;
1.900     bisitz   6141:   vertical-align: top;
1.347     albertel 6142: }
1.795     www      6143: 
1.809     bisitz   6144: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6145:   background-color: $data_table_dark;
1.900     bisitz   6146:   vertical-align: top;
1.347     albertel 6147: }
1.795     www      6148: 
1.425     albertel 6149: table.LC_data_table tr.LC_data_table_highlight td {
                   6150:   background-color: $data_table_darker;
                   6151: }
1.795     www      6152: 
1.639     raeburn  6153: table.LC_data_table tr td.LC_leftcol_header {
                   6154:   background-color: $data_table_head;
                   6155:   font-weight: bold;
                   6156: }
1.795     www      6157: 
1.451     albertel 6158: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6159: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6160:   font-weight: bold;
                   6161:   font-style: italic;
                   6162:   text-align: center;
                   6163:   padding: 8px;
1.347     albertel 6164: }
1.795     www      6165: 
1.1075.2.30  raeburn  6166: table.LC_data_table tr.LC_empty_row td,
                   6167: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6168:   background-color: $sidebg;
                   6169: }
                   6170: 
                   6171: table.LC_nested tr.LC_empty_row td {
                   6172:   background-color: #FFFFFF;
                   6173: }
                   6174: 
1.890     droeschl 6175: table.LC_caption {
                   6176: }
                   6177: 
1.507     raeburn  6178: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6179:   padding: 4ex
                   6180: }
1.795     www      6181: 
1.507     raeburn  6182: table.LC_nested_outer tr th {
                   6183:   font-weight: bold;
1.801     tempelho 6184:   color:$fontmenu;
1.507     raeburn  6185:   background-color: $data_table_head;
1.701     harmsja  6186:   font-size: small;
1.507     raeburn  6187:   border-bottom: 1px solid #000000;
                   6188: }
1.795     www      6189: 
1.507     raeburn  6190: table.LC_nested_outer tr td.LC_subheader {
                   6191:   background-color: $data_table_head;
                   6192:   font-weight: bold;
                   6193:   font-size: small;
                   6194:   border-bottom: 1px solid #000000;
                   6195:   text-align: right;
1.451     albertel 6196: }
1.795     www      6197: 
1.507     raeburn  6198: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6199:   background-color: #CCCCCC;
1.451     albertel 6200:   font-weight: bold;
                   6201:   font-size: small;
1.507     raeburn  6202:   text-align: center;
                   6203: }
1.795     www      6204: 
1.589     raeburn  6205: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6206: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6207:   text-align: left;
1.451     albertel 6208: }
1.795     www      6209: 
1.507     raeburn  6210: table.LC_nested td {
1.735     bisitz   6211:   background-color: #FFFFFF;
1.451     albertel 6212:   font-size: small;
1.507     raeburn  6213: }
1.795     www      6214: 
1.507     raeburn  6215: table.LC_nested_outer tr th.LC_right_item,
                   6216: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6217: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6218: table.LC_nested tr td.LC_right_item {
1.451     albertel 6219:   text-align: right;
                   6220: }
                   6221: 
1.507     raeburn  6222: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6223:   background-color: #EEEEEE;
1.451     albertel 6224: }
                   6225: 
1.473     raeburn  6226: table.LC_createuser {
                   6227: }
                   6228: 
                   6229: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6230:   font-size: small;
1.473     raeburn  6231: }
                   6232: 
                   6233: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6234:   background-color: #CCCCCC;
1.473     raeburn  6235:   font-weight: bold;
                   6236:   text-align: center;
                   6237: }
                   6238: 
1.349     albertel 6239: table.LC_calendar {
                   6240:   border: 1px solid #000000;
                   6241:   border-collapse: collapse;
1.917     raeburn  6242:   width: 98%;
1.349     albertel 6243: }
1.795     www      6244: 
1.349     albertel 6245: table.LC_calendar_pickdate {
                   6246:   font-size: xx-small;
                   6247: }
1.795     www      6248: 
1.349     albertel 6249: table.LC_calendar tr td {
                   6250:   border: 1px solid #000000;
                   6251:   vertical-align: top;
1.917     raeburn  6252:   width: 14%;
1.349     albertel 6253: }
1.795     www      6254: 
1.349     albertel 6255: table.LC_calendar tr td.LC_calendar_day_empty {
                   6256:   background-color: $data_table_dark;
                   6257: }
1.795     www      6258: 
1.779     bisitz   6259: table.LC_calendar tr td.LC_calendar_day_current {
                   6260:   background-color: $data_table_highlight;
1.777     tempelho 6261: }
1.795     www      6262: 
1.938     bisitz   6263: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6264:   background-color: $mail_new;
                   6265: }
1.795     www      6266: 
1.938     bisitz   6267: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6268:   background-color: $mail_new_hover;
                   6269: }
1.795     www      6270: 
1.938     bisitz   6271: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6272:   background-color: $mail_read;
                   6273: }
1.795     www      6274: 
1.938     bisitz   6275: /*
                   6276: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6277:   background-color: $mail_read_hover;
                   6278: }
1.938     bisitz   6279: */
1.795     www      6280: 
1.938     bisitz   6281: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6282:   background-color: $mail_replied;
                   6283: }
1.795     www      6284: 
1.938     bisitz   6285: /*
                   6286: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6287:   background-color: $mail_replied_hover;
                   6288: }
1.938     bisitz   6289: */
1.795     www      6290: 
1.938     bisitz   6291: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6292:   background-color: $mail_other;
                   6293: }
1.795     www      6294: 
1.938     bisitz   6295: /*
                   6296: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6297:   background-color: $mail_other_hover;
                   6298: }
1.938     bisitz   6299: */
1.494     raeburn  6300: 
1.777     tempelho 6301: table.LC_data_table tr > td.LC_browser_file,
                   6302: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6303:   background: #AAEE77;
1.389     albertel 6304: }
1.795     www      6305: 
1.777     tempelho 6306: table.LC_data_table tr > td.LC_browser_file_locked,
                   6307: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6308:   background: #FFAA99;
1.387     albertel 6309: }
1.795     www      6310: 
1.777     tempelho 6311: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6312:   background: #888888;
1.779     bisitz   6313: }
1.795     www      6314: 
1.777     tempelho 6315: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6316: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6317:   background: #F8F866;
1.777     tempelho 6318: }
1.795     www      6319: 
1.696     bisitz   6320: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6321:   background: #E0E8FF;
1.387     albertel 6322: }
1.696     bisitz   6323: 
1.707     bisitz   6324: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6325:   /* background: #77FF77; */
1.707     bisitz   6326: }
1.795     www      6327: 
1.707     bisitz   6328: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6329:   border-right: 8px solid #FFFF77;
1.707     bisitz   6330: }
1.795     www      6331: 
1.707     bisitz   6332: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6333:   border-right: 8px solid #FFAA77;
1.707     bisitz   6334: }
1.795     www      6335: 
1.707     bisitz   6336: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6337:   border-right: 8px solid #FF7777;
1.707     bisitz   6338: }
1.795     www      6339: 
1.707     bisitz   6340: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6341:   border-right: 8px solid #AAFF77;
1.707     bisitz   6342: }
1.795     www      6343: 
1.707     bisitz   6344: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6345:   border-right: 8px solid #11CC55;
1.707     bisitz   6346: }
                   6347: 
1.388     albertel 6348: span.LC_current_location {
1.701     harmsja  6349:   font-size:larger;
1.388     albertel 6350:   background: $pgbg;
                   6351: }
1.387     albertel 6352: 
1.1029    www      6353: span.LC_current_nav_location {
                   6354:   font-weight:bold;
                   6355:   background: $sidebg;
                   6356: }
                   6357: 
1.395     albertel 6358: span.LC_parm_menu_item {
                   6359:   font-size: larger;
                   6360: }
1.795     www      6361: 
1.395     albertel 6362: span.LC_parm_scope_all {
                   6363:   color: red;
                   6364: }
1.795     www      6365: 
1.395     albertel 6366: span.LC_parm_scope_folder {
                   6367:   color: green;
                   6368: }
1.795     www      6369: 
1.395     albertel 6370: span.LC_parm_scope_resource {
                   6371:   color: orange;
                   6372: }
1.795     www      6373: 
1.395     albertel 6374: span.LC_parm_part {
                   6375:   color: blue;
                   6376: }
1.795     www      6377: 
1.911     bisitz   6378: span.LC_parm_folder,
                   6379: span.LC_parm_symb {
1.395     albertel 6380:   font-size: x-small;
                   6381:   font-family: $mono;
                   6382:   color: #AAAAAA;
                   6383: }
                   6384: 
1.977     bisitz   6385: ul.LC_parm_parmlist li {
                   6386:   display: inline-block;
                   6387:   padding: 0.3em 0.8em;
                   6388:   vertical-align: top;
                   6389:   width: 150px;
                   6390:   border-top:1px solid $lg_border_color;
                   6391: }
                   6392: 
1.795     www      6393: td.LC_parm_overview_level_menu,
                   6394: td.LC_parm_overview_map_menu,
                   6395: td.LC_parm_overview_parm_selectors,
                   6396: td.LC_parm_overview_restrictions  {
1.396     albertel 6397:   border: 1px solid black;
                   6398:   border-collapse: collapse;
                   6399: }
1.795     www      6400: 
1.396     albertel 6401: table.LC_parm_overview_restrictions td {
                   6402:   border-width: 1px 4px 1px 4px;
                   6403:   border-style: solid;
                   6404:   border-color: $pgbg;
                   6405:   text-align: center;
                   6406: }
1.795     www      6407: 
1.396     albertel 6408: table.LC_parm_overview_restrictions th {
                   6409:   background: $tabbg;
                   6410:   border-width: 1px 4px 1px 4px;
                   6411:   border-style: solid;
                   6412:   border-color: $pgbg;
                   6413: }
1.795     www      6414: 
1.398     albertel 6415: table#LC_helpmenu {
1.803     bisitz   6416:   border: none;
1.398     albertel 6417:   height: 55px;
1.803     bisitz   6418:   border-spacing: 0;
1.398     albertel 6419: }
                   6420: 
                   6421: table#LC_helpmenu fieldset legend {
                   6422:   font-size: larger;
                   6423: }
1.795     www      6424: 
1.397     albertel 6425: table#LC_helpmenu_links {
                   6426:   width: 100%;
                   6427:   border: 1px solid black;
                   6428:   background: $pgbg;
1.803     bisitz   6429:   padding: 0;
1.397     albertel 6430:   border-spacing: 1px;
                   6431: }
1.795     www      6432: 
1.397     albertel 6433: table#LC_helpmenu_links tr td {
                   6434:   padding: 1px;
                   6435:   background: $tabbg;
1.399     albertel 6436:   text-align: center;
                   6437:   font-weight: bold;
1.397     albertel 6438: }
1.396     albertel 6439: 
1.795     www      6440: table#LC_helpmenu_links a:link,
                   6441: table#LC_helpmenu_links a:visited,
1.397     albertel 6442: table#LC_helpmenu_links a:active {
                   6443:   text-decoration: none;
                   6444:   color: $font;
                   6445: }
1.795     www      6446: 
1.397     albertel 6447: table#LC_helpmenu_links a:hover {
                   6448:   text-decoration: underline;
                   6449:   color: $vlink;
                   6450: }
1.396     albertel 6451: 
1.417     albertel 6452: .LC_chrt_popup_exists {
                   6453:   border: 1px solid #339933;
                   6454:   margin: -1px;
                   6455: }
1.795     www      6456: 
1.417     albertel 6457: .LC_chrt_popup_up {
                   6458:   border: 1px solid yellow;
                   6459:   margin: -1px;
                   6460: }
1.795     www      6461: 
1.417     albertel 6462: .LC_chrt_popup {
                   6463:   border: 1px solid #8888FF;
                   6464:   background: #CCCCFF;
                   6465: }
1.795     www      6466: 
1.421     albertel 6467: table.LC_pick_box {
                   6468:   border-collapse: separate;
                   6469:   background: white;
                   6470:   border: 1px solid black;
                   6471:   border-spacing: 1px;
                   6472: }
1.795     www      6473: 
1.421     albertel 6474: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6475:   background: $sidebg;
1.421     albertel 6476:   font-weight: bold;
1.900     bisitz   6477:   text-align: left;
1.740     bisitz   6478:   vertical-align: top;
1.421     albertel 6479:   width: 184px;
                   6480:   padding: 8px;
                   6481: }
1.795     www      6482: 
1.579     raeburn  6483: table.LC_pick_box td.LC_pick_box_value {
                   6484:   text-align: left;
                   6485:   padding: 8px;
                   6486: }
1.795     www      6487: 
1.579     raeburn  6488: table.LC_pick_box td.LC_pick_box_select {
                   6489:   text-align: left;
                   6490:   padding: 8px;
                   6491: }
1.795     www      6492: 
1.424     albertel 6493: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6494:   padding: 0;
1.421     albertel 6495:   height: 1px;
                   6496:   background: black;
                   6497: }
1.795     www      6498: 
1.421     albertel 6499: table.LC_pick_box td.LC_pick_box_submit {
                   6500:   text-align: right;
                   6501: }
1.795     www      6502: 
1.579     raeburn  6503: table.LC_pick_box td.LC_evenrow_value {
                   6504:   text-align: left;
                   6505:   padding: 8px;
                   6506:   background-color: $data_table_light;
                   6507: }
1.795     www      6508: 
1.579     raeburn  6509: table.LC_pick_box td.LC_oddrow_value {
                   6510:   text-align: left;
                   6511:   padding: 8px;
                   6512:   background-color: $data_table_light;
                   6513: }
1.795     www      6514: 
1.579     raeburn  6515: span.LC_helpform_receipt_cat {
                   6516:   font-weight: bold;
                   6517: }
1.795     www      6518: 
1.424     albertel 6519: table.LC_group_priv_box {
                   6520:   background: white;
                   6521:   border: 1px solid black;
                   6522:   border-spacing: 1px;
                   6523: }
1.795     www      6524: 
1.424     albertel 6525: table.LC_group_priv_box td.LC_pick_box_title {
                   6526:   background: $tabbg;
                   6527:   font-weight: bold;
                   6528:   text-align: right;
                   6529:   width: 184px;
                   6530: }
1.795     www      6531: 
1.424     albertel 6532: table.LC_group_priv_box td.LC_groups_fixed {
                   6533:   background: $data_table_light;
                   6534:   text-align: center;
                   6535: }
1.795     www      6536: 
1.424     albertel 6537: table.LC_group_priv_box td.LC_groups_optional {
                   6538:   background: $data_table_dark;
                   6539:   text-align: center;
                   6540: }
1.795     www      6541: 
1.424     albertel 6542: table.LC_group_priv_box td.LC_groups_functionality {
                   6543:   background: $data_table_darker;
                   6544:   text-align: center;
                   6545:   font-weight: bold;
                   6546: }
1.795     www      6547: 
1.424     albertel 6548: table.LC_group_priv td {
                   6549:   text-align: left;
1.803     bisitz   6550:   padding: 0;
1.424     albertel 6551: }
                   6552: 
                   6553: .LC_navbuttons {
                   6554:   margin: 2ex 0ex 2ex 0ex;
                   6555: }
1.795     www      6556: 
1.423     albertel 6557: .LC_topic_bar {
                   6558:   font-weight: bold;
                   6559:   background: $tabbg;
1.918     wenzelju 6560:   margin: 1em 0em 1em 2em;
1.805     bisitz   6561:   padding: 3px;
1.918     wenzelju 6562:   font-size: 1.2em;
1.423     albertel 6563: }
1.795     www      6564: 
1.423     albertel 6565: .LC_topic_bar span {
1.918     wenzelju 6566:   left: 0.5em;
                   6567:   position: absolute;
1.423     albertel 6568:   vertical-align: middle;
1.918     wenzelju 6569:   font-size: 1.2em;
1.423     albertel 6570: }
1.795     www      6571: 
1.423     albertel 6572: table.LC_course_group_status {
                   6573:   margin: 20px;
                   6574: }
1.795     www      6575: 
1.423     albertel 6576: table.LC_status_selector td {
                   6577:   vertical-align: top;
                   6578:   text-align: center;
1.424     albertel 6579:   padding: 4px;
                   6580: }
1.795     www      6581: 
1.599     albertel 6582: div.LC_feedback_link {
1.616     albertel 6583:   clear: both;
1.829     kalberla 6584:   background: $sidebg;
1.779     bisitz   6585:   width: 100%;
1.829     kalberla 6586:   padding-bottom: 10px;
                   6587:   border: 1px $tabbg solid;
1.833     kalberla 6588:   height: 22px;
                   6589:   line-height: 22px;
                   6590:   padding-top: 5px;
                   6591: }
                   6592: 
                   6593: div.LC_feedback_link img {
                   6594:   height: 22px;
1.867     kalberla 6595:   vertical-align:middle;
1.829     kalberla 6596: }
                   6597: 
1.911     bisitz   6598: div.LC_feedback_link a {
1.829     kalberla 6599:   text-decoration: none;
1.489     raeburn  6600: }
1.795     www      6601: 
1.867     kalberla 6602: div.LC_comblock {
1.911     bisitz   6603:   display:inline;
1.867     kalberla 6604:   color:$font;
                   6605:   font-size:90%;
                   6606: }
                   6607: 
                   6608: div.LC_feedback_link div.LC_comblock {
                   6609:   padding-left:5px;
                   6610: }
                   6611: 
                   6612: div.LC_feedback_link div.LC_comblock a {
                   6613:   color:$font;
                   6614: }
                   6615: 
1.489     raeburn  6616: span.LC_feedback_link {
1.858     bisitz   6617:   /* background: $feedback_link_bg; */
1.599     albertel 6618:   font-size: larger;
                   6619: }
1.795     www      6620: 
1.599     albertel 6621: span.LC_message_link {
1.858     bisitz   6622:   /* background: $feedback_link_bg; */
1.599     albertel 6623:   font-size: larger;
                   6624:   position: absolute;
                   6625:   right: 1em;
1.489     raeburn  6626: }
1.421     albertel 6627: 
1.515     albertel 6628: table.LC_prior_tries {
1.524     albertel 6629:   border: 1px solid #000000;
                   6630:   border-collapse: separate;
                   6631:   border-spacing: 1px;
1.515     albertel 6632: }
1.523     albertel 6633: 
1.515     albertel 6634: table.LC_prior_tries td {
1.524     albertel 6635:   padding: 2px;
1.515     albertel 6636: }
1.523     albertel 6637: 
                   6638: .LC_answer_correct {
1.795     www      6639:   background: lightgreen;
                   6640:   color: darkgreen;
                   6641:   padding: 6px;
1.523     albertel 6642: }
1.795     www      6643: 
1.523     albertel 6644: .LC_answer_charged_try {
1.797     www      6645:   background: #FFAAAA;
1.795     www      6646:   color: darkred;
                   6647:   padding: 6px;
1.523     albertel 6648: }
1.795     www      6649: 
1.779     bisitz   6650: .LC_answer_not_charged_try,
1.523     albertel 6651: .LC_answer_no_grade,
                   6652: .LC_answer_late {
1.795     www      6653:   background: lightyellow;
1.523     albertel 6654:   color: black;
1.795     www      6655:   padding: 6px;
1.523     albertel 6656: }
1.795     www      6657: 
1.523     albertel 6658: .LC_answer_previous {
1.795     www      6659:   background: lightblue;
                   6660:   color: darkblue;
                   6661:   padding: 6px;
1.523     albertel 6662: }
1.795     www      6663: 
1.779     bisitz   6664: .LC_answer_no_message {
1.777     tempelho 6665:   background: #FFFFFF;
                   6666:   color: black;
1.795     www      6667:   padding: 6px;
1.779     bisitz   6668: }
1.795     www      6669: 
1.779     bisitz   6670: .LC_answer_unknown {
                   6671:   background: orange;
                   6672:   color: black;
1.795     www      6673:   padding: 6px;
1.777     tempelho 6674: }
1.795     www      6675: 
1.529     albertel 6676: span.LC_prior_numerical,
                   6677: span.LC_prior_string,
                   6678: span.LC_prior_custom,
                   6679: span.LC_prior_reaction,
                   6680: span.LC_prior_math {
1.925     bisitz   6681:   font-family: $mono;
1.523     albertel 6682:   white-space: pre;
                   6683: }
                   6684: 
1.525     albertel 6685: span.LC_prior_string {
1.925     bisitz   6686:   font-family: $mono;
1.525     albertel 6687:   white-space: pre;
                   6688: }
                   6689: 
1.523     albertel 6690: table.LC_prior_option {
                   6691:   width: 100%;
                   6692:   border-collapse: collapse;
                   6693: }
1.795     www      6694: 
1.911     bisitz   6695: table.LC_prior_rank,
1.795     www      6696: table.LC_prior_match {
1.528     albertel 6697:   border-collapse: collapse;
                   6698: }
1.795     www      6699: 
1.528     albertel 6700: table.LC_prior_option tr td,
                   6701: table.LC_prior_rank tr td,
                   6702: table.LC_prior_match tr td {
1.524     albertel 6703:   border: 1px solid #000000;
1.515     albertel 6704: }
                   6705: 
1.855     bisitz   6706: .LC_nobreak {
1.544     albertel 6707:   white-space: nowrap;
1.519     raeburn  6708: }
                   6709: 
1.576     raeburn  6710: span.LC_cusr_emph {
                   6711:   font-style: italic;
                   6712: }
                   6713: 
1.633     raeburn  6714: span.LC_cusr_subheading {
                   6715:   font-weight: normal;
                   6716:   font-size: 85%;
                   6717: }
                   6718: 
1.861     bisitz   6719: div.LC_docs_entry_move {
1.859     bisitz   6720:   border: 1px solid #BBBBBB;
1.545     albertel 6721:   background: #DDDDDD;
1.861     bisitz   6722:   width: 22px;
1.859     bisitz   6723:   padding: 1px;
                   6724:   margin: 0;
1.545     albertel 6725: }
                   6726: 
1.861     bisitz   6727: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6728: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6729:   font-size: x-small;
                   6730: }
1.795     www      6731: 
1.861     bisitz   6732: .LC_docs_entry_parameter {
                   6733:   white-space: nowrap;
                   6734: }
                   6735: 
1.544     albertel 6736: .LC_docs_copy {
1.545     albertel 6737:   color: #000099;
1.544     albertel 6738: }
1.795     www      6739: 
1.544     albertel 6740: .LC_docs_cut {
1.545     albertel 6741:   color: #550044;
1.544     albertel 6742: }
1.795     www      6743: 
1.544     albertel 6744: .LC_docs_rename {
1.545     albertel 6745:   color: #009900;
1.544     albertel 6746: }
1.795     www      6747: 
1.544     albertel 6748: .LC_docs_remove {
1.545     albertel 6749:   color: #990000;
                   6750: }
                   6751: 
1.547     albertel 6752: .LC_docs_reinit_warn,
                   6753: .LC_docs_ext_edit {
                   6754:   font-size: x-small;
                   6755: }
                   6756: 
1.545     albertel 6757: table.LC_docs_adddocs td,
                   6758: table.LC_docs_adddocs th {
                   6759:   border: 1px solid #BBBBBB;
                   6760:   padding: 4px;
                   6761:   background: #DDDDDD;
1.543     albertel 6762: }
                   6763: 
1.584     albertel 6764: table.LC_sty_begin {
                   6765:   background: #BBFFBB;
                   6766: }
1.795     www      6767: 
1.584     albertel 6768: table.LC_sty_end {
                   6769:   background: #FFBBBB;
                   6770: }
                   6771: 
1.589     raeburn  6772: table.LC_double_column {
1.803     bisitz   6773:   border-width: 0;
1.589     raeburn  6774:   border-collapse: collapse;
                   6775:   width: 100%;
                   6776:   padding: 2px;
                   6777: }
                   6778: 
                   6779: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6780:   top: 2px;
1.589     raeburn  6781:   left: 2px;
                   6782:   width: 47%;
                   6783:   vertical-align: top;
                   6784: }
                   6785: 
                   6786: table.LC_double_column tr td.LC_right_col {
                   6787:   top: 2px;
1.779     bisitz   6788:   right: 2px;
1.589     raeburn  6789:   width: 47%;
                   6790:   vertical-align: top;
                   6791: }
                   6792: 
1.591     raeburn  6793: div.LC_left_float {
                   6794:   float: left;
                   6795:   padding-right: 5%;
1.597     albertel 6796:   padding-bottom: 4px;
1.591     raeburn  6797: }
                   6798: 
                   6799: div.LC_clear_float_header {
1.597     albertel 6800:   padding-bottom: 2px;
1.591     raeburn  6801: }
                   6802: 
                   6803: div.LC_clear_float_footer {
1.597     albertel 6804:   padding-top: 10px;
1.591     raeburn  6805:   clear: both;
                   6806: }
                   6807: 
1.597     albertel 6808: div.LC_grade_show_user {
1.941     bisitz   6809: /*  border-left: 5px solid $sidebg; */
                   6810:   border-top: 5px solid #000000;
                   6811:   margin: 50px 0 0 0;
1.936     bisitz   6812:   padding: 15px 0 5px 10px;
1.597     albertel 6813: }
1.795     www      6814: 
1.936     bisitz   6815: div.LC_grade_show_user_odd_row {
1.941     bisitz   6816: /*  border-left: 5px solid #000000; */
                   6817: }
                   6818: 
                   6819: div.LC_grade_show_user div.LC_Box {
                   6820:   margin-right: 50px;
1.597     albertel 6821: }
                   6822: 
                   6823: div.LC_grade_submissions,
                   6824: div.LC_grade_message_center,
1.936     bisitz   6825: div.LC_grade_info_links {
1.597     albertel 6826:   margin: 5px;
                   6827:   width: 99%;
                   6828:   background: #FFFFFF;
                   6829: }
1.795     www      6830: 
1.597     albertel 6831: div.LC_grade_submissions_header,
1.936     bisitz   6832: div.LC_grade_message_center_header {
1.705     tempelho 6833:   font-weight: bold;
                   6834:   font-size: large;
1.597     albertel 6835: }
1.795     www      6836: 
1.597     albertel 6837: div.LC_grade_submissions_body,
1.936     bisitz   6838: div.LC_grade_message_center_body {
1.597     albertel 6839:   border: 1px solid black;
                   6840:   width: 99%;
                   6841:   background: #FFFFFF;
                   6842: }
1.795     www      6843: 
1.613     albertel 6844: table.LC_scantron_action {
                   6845:   width: 100%;
                   6846: }
1.795     www      6847: 
1.613     albertel 6848: table.LC_scantron_action tr th {
1.698     harmsja  6849:   font-weight:bold;
                   6850:   font-style:normal;
1.613     albertel 6851: }
1.795     www      6852: 
1.779     bisitz   6853: .LC_edit_problem_header,
1.614     albertel 6854: div.LC_edit_problem_footer {
1.705     tempelho 6855:   font-weight: normal;
                   6856:   font-size:  medium;
1.602     albertel 6857:   margin: 2px;
1.1060    bisitz   6858:   background-color: $sidebg;
1.600     albertel 6859: }
1.795     www      6860: 
1.600     albertel 6861: div.LC_edit_problem_header,
1.602     albertel 6862: div.LC_edit_problem_header div,
1.614     albertel 6863: div.LC_edit_problem_footer,
                   6864: div.LC_edit_problem_footer div,
1.602     albertel 6865: div.LC_edit_problem_editxml_header,
                   6866: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  6867:   z-index: 100;
1.600     albertel 6868: }
1.795     www      6869: 
1.600     albertel 6870: div.LC_edit_problem_header_title {
1.705     tempelho 6871:   font-weight: bold;
                   6872:   font-size: larger;
1.602     albertel 6873:   background: $tabbg;
                   6874:   padding: 3px;
1.1060    bisitz   6875:   margin: 0 0 5px 0;
1.602     albertel 6876: }
1.795     www      6877: 
1.602     albertel 6878: table.LC_edit_problem_header_title {
                   6879:   width: 100%;
1.600     albertel 6880:   background: $tabbg;
1.602     albertel 6881: }
                   6882: 
1.1075.2.112  raeburn  6883: div.LC_edit_actionbar {
                   6884:     background-color: $sidebg;
                   6885:     margin: 0;
                   6886:     padding: 0;
                   6887:     line-height: 200%;
1.602     albertel 6888: }
1.795     www      6889: 
1.1075.2.112  raeburn  6890: div.LC_edit_actionbar div{
                   6891:     padding: 0;
                   6892:     margin: 0;
                   6893:     display: inline-block;
1.600     albertel 6894: }
1.795     www      6895: 
1.1075.2.34  raeburn  6896: .LC_edit_opt {
                   6897:   padding-left: 1em;
                   6898:   white-space: nowrap;
                   6899: }
                   6900: 
1.1075.2.57  raeburn  6901: .LC_edit_problem_latexhelper{
                   6902:     text-align: right;
                   6903: }
                   6904: 
                   6905: #LC_edit_problem_colorful div{
                   6906:     margin-left: 40px;
                   6907: }
                   6908: 
1.1075.2.112  raeburn  6909: #LC_edit_problem_codemirror div{
                   6910:     margin-left: 0px;
                   6911: }
                   6912: 
1.911     bisitz   6913: img.stift {
1.803     bisitz   6914:   border-width: 0;
                   6915:   vertical-align: middle;
1.677     riegler  6916: }
1.680     riegler  6917: 
1.923     bisitz   6918: table td.LC_mainmenu_col_fieldset {
1.680     riegler  6919:   vertical-align: top;
1.777     tempelho 6920: }
1.795     www      6921: 
1.716     raeburn  6922: div.LC_createcourse {
1.911     bisitz   6923:   margin: 10px 10px 10px 10px;
1.716     raeburn  6924: }
                   6925: 
1.917     raeburn  6926: .LC_dccid {
1.1075.2.38  raeburn  6927:   float: right;
1.917     raeburn  6928:   margin: 0.2em 0 0 0;
                   6929:   padding: 0;
                   6930:   font-size: 90%;
                   6931:   display:none;
                   6932: }
                   6933: 
1.897     wenzelju 6934: ol.LC_primary_menu a:hover,
1.721     harmsja  6935: ol#LC_MenuBreadcrumbs a:hover,
                   6936: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 6937: ul#LC_secondary_menu a:hover,
1.721     harmsja  6938: .LC_FormSectionClearButton input:hover
1.795     www      6939: ul.LC_TabContent   li:hover a {
1.952     onken    6940:   color:$button_hover;
1.911     bisitz   6941:   text-decoration:none;
1.693     droeschl 6942: }
                   6943: 
1.779     bisitz   6944: h1 {
1.911     bisitz   6945:   padding: 0;
                   6946:   line-height:130%;
1.693     droeschl 6947: }
1.698     harmsja  6948: 
1.911     bisitz   6949: h2,
                   6950: h3,
                   6951: h4,
                   6952: h5,
                   6953: h6 {
                   6954:   margin: 5px 0 5px 0;
                   6955:   padding: 0;
                   6956:   line-height:130%;
1.693     droeschl 6957: }
1.795     www      6958: 
                   6959: .LC_hcell {
1.911     bisitz   6960:   padding:3px 15px 3px 15px;
                   6961:   margin: 0;
                   6962:   background-color:$tabbg;
                   6963:   color:$fontmenu;
                   6964:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 6965: }
1.795     www      6966: 
1.840     bisitz   6967: .LC_Box > .LC_hcell {
1.911     bisitz   6968:   margin: 0 -10px 10px -10px;
1.835     bisitz   6969: }
                   6970: 
1.721     harmsja  6971: .LC_noBorder {
1.911     bisitz   6972:   border: 0;
1.698     harmsja  6973: }
1.693     droeschl 6974: 
1.721     harmsja  6975: .LC_FormSectionClearButton input {
1.911     bisitz   6976:   background-color:transparent;
                   6977:   border: none;
                   6978:   cursor:pointer;
                   6979:   text-decoration:underline;
1.693     droeschl 6980: }
1.763     bisitz   6981: 
                   6982: .LC_help_open_topic {
1.911     bisitz   6983:   color: #FFFFFF;
                   6984:   background-color: #EEEEFF;
                   6985:   margin: 1px;
                   6986:   padding: 4px;
                   6987:   border: 1px solid #000033;
                   6988:   white-space: nowrap;
                   6989:   /* vertical-align: middle; */
1.759     neumanie 6990: }
1.693     droeschl 6991: 
1.911     bisitz   6992: dl,
                   6993: ul,
                   6994: div,
                   6995: fieldset {
                   6996:   margin: 10px 10px 10px 0;
                   6997:   /* overflow: hidden; */
1.693     droeschl 6998: }
1.795     www      6999: 
1.1075.2.90  raeburn  7000: article.geogebraweb div {
                   7001:     margin: 0;
                   7002: }
                   7003: 
1.838     bisitz   7004: fieldset > legend {
1.911     bisitz   7005:   font-weight: bold;
                   7006:   padding: 0 5px 0 5px;
1.838     bisitz   7007: }
                   7008: 
1.813     bisitz   7009: #LC_nav_bar {
1.911     bisitz   7010:   float: left;
1.995     raeburn  7011:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7012:   margin: 0 0 2px 0;
1.807     droeschl 7013: }
                   7014: 
1.916     droeschl 7015: #LC_realm {
                   7016:   margin: 0.2em 0 0 0;
                   7017:   padding: 0;
                   7018:   font-weight: bold;
                   7019:   text-align: center;
1.995     raeburn  7020:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7021: }
                   7022: 
1.911     bisitz   7023: #LC_nav_bar em {
                   7024:   font-weight: bold;
                   7025:   font-style: normal;
1.807     droeschl 7026: }
                   7027: 
1.897     wenzelju 7028: ol.LC_primary_menu {
1.934     droeschl 7029:   margin: 0;
1.1075.2.2  raeburn  7030:   padding: 0;
1.807     droeschl 7031: }
                   7032: 
1.852     droeschl 7033: ol#LC_PathBreadcrumbs {
1.911     bisitz   7034:   margin: 0;
1.693     droeschl 7035: }
                   7036: 
1.897     wenzelju 7037: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7038:   color: RGB(80, 80, 80);
                   7039:   vertical-align: middle;
                   7040:   text-align: left;
                   7041:   list-style: none;
1.1075.2.112  raeburn  7042:   position: relative;
1.1075.2.2  raeburn  7043:   float: left;
1.1075.2.112  raeburn  7044:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7045:   line-height: 1.5em;
1.1075.2.2  raeburn  7046: }
                   7047: 
1.1075.2.113  raeburn  7048: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7049: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7050:   display: block;
                   7051:   margin: 0;
                   7052:   padding: 0 5px 0 10px;
                   7053:   text-decoration: none;
                   7054: }
                   7055: 
1.1075.2.112  raeburn  7056: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7057:   display: inline-block;
                   7058:   width: 95%;
                   7059:   text-align: left;
                   7060: }
                   7061: 
                   7062: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7063:   display: inline-block;
                   7064:   width: 5%;
                   7065:   float: right;
                   7066:   text-align: right;
                   7067:   font-size: 70%;
                   7068: }
                   7069: 
                   7070: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7071:   display: none;
1.1075.2.112  raeburn  7072:   width: 15em;
1.1075.2.2  raeburn  7073:   background-color: $data_table_light;
1.1075.2.112  raeburn  7074:   position: absolute;
                   7075:   top: 100%;
                   7076: }
                   7077: 
                   7078: ol.LC_primary_menu ul ul {
                   7079:   left: 100%;
                   7080:   top: 0;
1.1075.2.2  raeburn  7081: }
                   7082: 
1.1075.2.112  raeburn  7083: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7084:   display: block;
                   7085:   position: absolute;
                   7086:   margin: 0;
                   7087:   padding: 0;
1.1075.2.5  raeburn  7088:   z-index: 2;
1.1075.2.2  raeburn  7089: }
                   7090: 
                   7091: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7092: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7093:   font-size: 90%;
1.911     bisitz   7094:   vertical-align: top;
1.1075.2.2  raeburn  7095:   float: none;
1.1075.2.5  raeburn  7096:   border-left: 1px solid black;
                   7097:   border-right: 1px solid black;
1.1075.2.112  raeburn  7098: /* A dark bottom border to visualize different menu options;
                   7099: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7100:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7101: }
                   7102: 
1.1075.2.112  raeburn  7103: ol.LC_primary_menu li li p:hover {
                   7104:   color:$button_hover;
                   7105:   text-decoration:none;
                   7106:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7107: }
                   7108: 
                   7109: ol.LC_primary_menu li li a:hover {
                   7110:    color:$button_hover;
                   7111:    background-color:$data_table_dark;
1.693     droeschl 7112: }
                   7113: 
1.1075.2.112  raeburn  7114: /* Font-size equal to the size of the predecessors*/
                   7115: ol.LC_primary_menu li:hover li li {
                   7116:   font-size: 100%;
                   7117: }
                   7118: 
1.897     wenzelju 7119: ol.LC_primary_menu li img {
1.911     bisitz   7120:   vertical-align: bottom;
1.934     droeschl 7121:   height: 1.1em;
1.1075.2.3  raeburn  7122:   margin: 0.2em 0 0 0;
1.693     droeschl 7123: }
                   7124: 
1.897     wenzelju 7125: ol.LC_primary_menu a {
1.911     bisitz   7126:   color: RGB(80, 80, 80);
                   7127:   text-decoration: none;
1.693     droeschl 7128: }
1.795     www      7129: 
1.949     droeschl 7130: ol.LC_primary_menu a.LC_new_message {
                   7131:   font-weight:bold;
                   7132:   color: darkred;
                   7133: }
                   7134: 
1.975     raeburn  7135: ol.LC_docs_parameters {
                   7136:   margin-left: 0;
                   7137:   padding: 0;
                   7138:   list-style: none;
                   7139: }
                   7140: 
                   7141: ol.LC_docs_parameters li {
                   7142:   margin: 0;
                   7143:   padding-right: 20px;
                   7144:   display: inline;
                   7145: }
                   7146: 
1.976     raeburn  7147: ol.LC_docs_parameters li:before {
                   7148:   content: "\\002022 \\0020";
                   7149: }
                   7150: 
                   7151: li.LC_docs_parameters_title {
                   7152:   font-weight: bold;
                   7153: }
                   7154: 
                   7155: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7156:   content: "";
                   7157: }
                   7158: 
1.897     wenzelju 7159: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7160:   clear: right;
1.911     bisitz   7161:   color: $fontmenu;
                   7162:   background: $tabbg;
                   7163:   list-style: none;
                   7164:   padding: 0;
                   7165:   margin: 0;
                   7166:   width: 100%;
1.995     raeburn  7167:   text-align: left;
1.1075.2.4  raeburn  7168:   float: left;
1.808     droeschl 7169: }
                   7170: 
1.897     wenzelju 7171: ul#LC_secondary_menu li {
1.911     bisitz   7172:   font-weight: bold;
                   7173:   line-height: 1.8em;
                   7174:   border-right: 1px solid black;
1.1075.2.4  raeburn  7175:   float: left;
                   7176: }
                   7177: 
                   7178: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7179:   background-color: $data_table_light;
                   7180: }
                   7181: 
                   7182: ul#LC_secondary_menu li a {
                   7183:   padding: 0 0.8em;
                   7184: }
                   7185: 
                   7186: ul#LC_secondary_menu li ul {
                   7187:   display: none;
                   7188: }
                   7189: 
                   7190: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7191:   display: block;
                   7192:   position: absolute;
                   7193:   margin: 0;
                   7194:   padding: 0;
                   7195:   list-style:none;
                   7196:   float: none;
                   7197:   background-color: $data_table_light;
1.1075.2.5  raeburn  7198:   z-index: 2;
1.1075.2.10  raeburn  7199:   margin-left: -1px;
1.1075.2.4  raeburn  7200: }
                   7201: 
                   7202: ul#LC_secondary_menu li ul li {
                   7203:   font-size: 90%;
                   7204:   vertical-align: top;
                   7205:   border-left: 1px solid black;
                   7206:   border-right: 1px solid black;
1.1075.2.33  raeburn  7207:   background-color: $data_table_light;
1.1075.2.4  raeburn  7208:   list-style:none;
                   7209:   float: none;
                   7210: }
                   7211: 
                   7212: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7213:   background-color: $data_table_dark;
1.807     droeschl 7214: }
                   7215: 
1.847     tempelho 7216: ul.LC_TabContent {
1.911     bisitz   7217:   display:block;
                   7218:   background: $sidebg;
                   7219:   border-bottom: solid 1px $lg_border_color;
                   7220:   list-style:none;
1.1020    raeburn  7221:   margin: -1px -10px 0 -10px;
1.911     bisitz   7222:   padding: 0;
1.693     droeschl 7223: }
                   7224: 
1.795     www      7225: ul.LC_TabContent li,
                   7226: ul.LC_TabContentBigger li {
1.911     bisitz   7227:   float:left;
1.741     harmsja  7228: }
1.795     www      7229: 
1.897     wenzelju 7230: ul#LC_secondary_menu li a {
1.911     bisitz   7231:   color: $fontmenu;
                   7232:   text-decoration: none;
1.693     droeschl 7233: }
1.795     www      7234: 
1.721     harmsja  7235: ul.LC_TabContent {
1.952     onken    7236:   min-height:20px;
1.721     harmsja  7237: }
1.795     www      7238: 
                   7239: ul.LC_TabContent li {
1.911     bisitz   7240:   vertical-align:middle;
1.959     onken    7241:   padding: 0 16px 0 10px;
1.911     bisitz   7242:   background-color:$tabbg;
                   7243:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7244:   border-left: solid 1px $font;
1.721     harmsja  7245: }
1.795     www      7246: 
1.847     tempelho 7247: ul.LC_TabContent .right {
1.911     bisitz   7248:   float:right;
1.847     tempelho 7249: }
                   7250: 
1.911     bisitz   7251: ul.LC_TabContent li a,
                   7252: ul.LC_TabContent li {
                   7253:   color:rgb(47,47,47);
                   7254:   text-decoration:none;
                   7255:   font-size:95%;
                   7256:   font-weight:bold;
1.952     onken    7257:   min-height:20px;
                   7258: }
                   7259: 
1.959     onken    7260: ul.LC_TabContent li a:hover,
                   7261: ul.LC_TabContent li a:focus {
1.952     onken    7262:   color: $button_hover;
1.959     onken    7263:   background:none;
                   7264:   outline:none;
1.952     onken    7265: }
                   7266: 
                   7267: ul.LC_TabContent li:hover {
                   7268:   color: $button_hover;
                   7269:   cursor:pointer;
1.721     harmsja  7270: }
1.795     www      7271: 
1.911     bisitz   7272: ul.LC_TabContent li.active {
1.952     onken    7273:   color: $font;
1.911     bisitz   7274:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7275:   border-bottom:solid 1px #FFFFFF;
                   7276:   cursor: default;
1.744     ehlerst  7277: }
1.795     www      7278: 
1.959     onken    7279: ul.LC_TabContent li.active a {
                   7280:   color:$font;
                   7281:   background:#FFFFFF;
                   7282:   outline: none;
                   7283: }
1.1047    raeburn  7284: 
                   7285: ul.LC_TabContent li.goback {
                   7286:   float: left;
                   7287:   border-left: none;
                   7288: }
                   7289: 
1.870     tempelho 7290: #maincoursedoc {
1.911     bisitz   7291:   clear:both;
1.870     tempelho 7292: }
                   7293: 
                   7294: ul.LC_TabContentBigger {
1.911     bisitz   7295:   display:block;
                   7296:   list-style:none;
                   7297:   padding: 0;
1.870     tempelho 7298: }
                   7299: 
1.795     www      7300: ul.LC_TabContentBigger li {
1.911     bisitz   7301:   vertical-align:bottom;
                   7302:   height: 30px;
                   7303:   font-size:110%;
                   7304:   font-weight:bold;
                   7305:   color: #737373;
1.841     tempelho 7306: }
                   7307: 
1.957     onken    7308: ul.LC_TabContentBigger li.active {
                   7309:   position: relative;
                   7310:   top: 1px;
                   7311: }
                   7312: 
1.870     tempelho 7313: ul.LC_TabContentBigger li a {
1.911     bisitz   7314:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7315:   height: 30px;
                   7316:   line-height: 30px;
                   7317:   text-align: center;
                   7318:   display: block;
                   7319:   text-decoration: none;
1.958     onken    7320:   outline: none;  
1.741     harmsja  7321: }
1.795     www      7322: 
1.870     tempelho 7323: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7324:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7325:   color:$font;
1.744     ehlerst  7326: }
1.795     www      7327: 
1.870     tempelho 7328: ul.LC_TabContentBigger li b {
1.911     bisitz   7329:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7330:   display: block;
                   7331:   float: left;
                   7332:   padding: 0 30px;
1.957     onken    7333:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7334: }
                   7335: 
1.956     onken    7336: ul.LC_TabContentBigger li:hover b {
                   7337:   color:$button_hover;
                   7338: }
                   7339: 
1.870     tempelho 7340: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7341:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7342:   color:$font;
1.957     onken    7343:   border: 0;
1.741     harmsja  7344: }
1.693     droeschl 7345: 
1.870     tempelho 7346: 
1.862     bisitz   7347: ul.LC_CourseBreadcrumbs {
                   7348:   background: $sidebg;
1.1020    raeburn  7349:   height: 2em;
1.862     bisitz   7350:   padding-left: 10px;
1.1020    raeburn  7351:   margin: 0;
1.862     bisitz   7352:   list-style-position: inside;
                   7353: }
                   7354: 
1.911     bisitz   7355: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7356: ol#LC_PathBreadcrumbs {
1.911     bisitz   7357:   padding-left: 10px;
                   7358:   margin: 0;
1.933     droeschl 7359:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7360: }
                   7361: 
1.911     bisitz   7362: ol#LC_MenuBreadcrumbs li,
                   7363: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7364: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7365:   display: inline;
1.933     droeschl 7366:   white-space: normal;  
1.693     droeschl 7367: }
                   7368: 
1.823     bisitz   7369: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7370: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7371:   text-decoration: none;
                   7372:   font-size:90%;
1.693     droeschl 7373: }
1.795     www      7374: 
1.969     droeschl 7375: ol#LC_MenuBreadcrumbs h1 {
                   7376:   display: inline;
                   7377:   font-size: 90%;
                   7378:   line-height: 2.5em;
                   7379:   margin: 0;
                   7380:   padding: 0;
                   7381: }
                   7382: 
1.795     www      7383: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7384:   text-decoration:none;
                   7385:   font-size:100%;
                   7386:   font-weight:bold;
1.693     droeschl 7387: }
1.795     www      7388: 
1.840     bisitz   7389: .LC_Box {
1.911     bisitz   7390:   border: solid 1px $lg_border_color;
                   7391:   padding: 0 10px 10px 10px;
1.746     neumanie 7392: }
1.795     www      7393: 
1.1020    raeburn  7394: .LC_DocsBox {
                   7395:   border: solid 1px $lg_border_color;
                   7396:   padding: 0 0 10px 10px;
                   7397: }
                   7398: 
1.795     www      7399: .LC_AboutMe_Image {
1.911     bisitz   7400:   float:left;
                   7401:   margin-right:10px;
1.747     neumanie 7402: }
1.795     www      7403: 
                   7404: .LC_Clear_AboutMe_Image {
1.911     bisitz   7405:   clear:left;
1.747     neumanie 7406: }
1.795     www      7407: 
1.721     harmsja  7408: dl.LC_ListStyleClean dt {
1.911     bisitz   7409:   padding-right: 5px;
                   7410:   display: table-header-group;
1.693     droeschl 7411: }
                   7412: 
1.721     harmsja  7413: dl.LC_ListStyleClean dd {
1.911     bisitz   7414:   display: table-row;
1.693     droeschl 7415: }
                   7416: 
1.721     harmsja  7417: .LC_ListStyleClean,
                   7418: .LC_ListStyleSimple,
                   7419: .LC_ListStyleNormal,
1.795     www      7420: .LC_ListStyleSpecial {
1.911     bisitz   7421:   /* display:block; */
                   7422:   list-style-position: inside;
                   7423:   list-style-type: none;
                   7424:   overflow: hidden;
                   7425:   padding: 0;
1.693     droeschl 7426: }
                   7427: 
1.721     harmsja  7428: .LC_ListStyleSimple li,
                   7429: .LC_ListStyleSimple dd,
                   7430: .LC_ListStyleNormal li,
                   7431: .LC_ListStyleNormal dd,
                   7432: .LC_ListStyleSpecial li,
1.795     www      7433: .LC_ListStyleSpecial dd {
1.911     bisitz   7434:   margin: 0;
                   7435:   padding: 5px 5px 5px 10px;
                   7436:   clear: both;
1.693     droeschl 7437: }
                   7438: 
1.721     harmsja  7439: .LC_ListStyleClean li,
                   7440: .LC_ListStyleClean dd {
1.911     bisitz   7441:   padding-top: 0;
                   7442:   padding-bottom: 0;
1.693     droeschl 7443: }
                   7444: 
1.721     harmsja  7445: .LC_ListStyleSimple dd,
1.795     www      7446: .LC_ListStyleSimple li {
1.911     bisitz   7447:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7448: }
                   7449: 
1.721     harmsja  7450: .LC_ListStyleSpecial li,
                   7451: .LC_ListStyleSpecial dd {
1.911     bisitz   7452:   list-style-type: none;
                   7453:   background-color: RGB(220, 220, 220);
                   7454:   margin-bottom: 4px;
1.693     droeschl 7455: }
                   7456: 
1.721     harmsja  7457: table.LC_SimpleTable {
1.911     bisitz   7458:   margin:5px;
                   7459:   border:solid 1px $lg_border_color;
1.795     www      7460: }
1.693     droeschl 7461: 
1.721     harmsja  7462: table.LC_SimpleTable tr {
1.911     bisitz   7463:   padding: 0;
                   7464:   border:solid 1px $lg_border_color;
1.693     droeschl 7465: }
1.795     www      7466: 
                   7467: table.LC_SimpleTable thead {
1.911     bisitz   7468:   background:rgb(220,220,220);
1.693     droeschl 7469: }
                   7470: 
1.721     harmsja  7471: div.LC_columnSection {
1.911     bisitz   7472:   display: block;
                   7473:   clear: both;
                   7474:   overflow: hidden;
                   7475:   margin: 0;
1.693     droeschl 7476: }
                   7477: 
1.721     harmsja  7478: div.LC_columnSection>* {
1.911     bisitz   7479:   float: left;
                   7480:   margin: 10px 20px 10px 0;
                   7481:   overflow:hidden;
1.693     droeschl 7482: }
1.721     harmsja  7483: 
1.795     www      7484: table em {
1.911     bisitz   7485:   font-weight: bold;
                   7486:   font-style: normal;
1.748     schulted 7487: }
1.795     www      7488: 
1.779     bisitz   7489: table.LC_tableBrowseRes,
1.795     www      7490: table.LC_tableOfContent {
1.911     bisitz   7491:   border:none;
                   7492:   border-spacing: 1px;
                   7493:   padding: 3px;
                   7494:   background-color: #FFFFFF;
                   7495:   font-size: 90%;
1.753     droeschl 7496: }
1.789     droeschl 7497: 
1.911     bisitz   7498: table.LC_tableOfContent {
                   7499:   border-collapse: collapse;
1.789     droeschl 7500: }
                   7501: 
1.771     droeschl 7502: table.LC_tableBrowseRes a,
1.768     schulted 7503: table.LC_tableOfContent a {
1.911     bisitz   7504:   background-color: transparent;
                   7505:   text-decoration: none;
1.753     droeschl 7506: }
                   7507: 
1.795     www      7508: table.LC_tableOfContent img {
1.911     bisitz   7509:   border: none;
                   7510:   height: 1.3em;
                   7511:   vertical-align: text-bottom;
                   7512:   margin-right: 0.3em;
1.753     droeschl 7513: }
1.757     schulted 7514: 
1.795     www      7515: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7516:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7517: }
                   7518: 
1.795     www      7519: a#LC_content_toolbar_everything {
1.911     bisitz   7520:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7521: }
                   7522: 
1.795     www      7523: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7524:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7525: }
                   7526: 
1.795     www      7527: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7528:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7529: }
                   7530: 
1.795     www      7531: a#LC_content_toolbar_changefolder {
1.911     bisitz   7532:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7533: }
                   7534: 
1.795     www      7535: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7536:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7537: }
                   7538: 
1.1043    raeburn  7539: a#LC_content_toolbar_edittoplevel {
                   7540:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7541: }
                   7542: 
1.795     www      7543: ul#LC_toolbar li a:hover {
1.911     bisitz   7544:   background-position: bottom center;
1.757     schulted 7545: }
                   7546: 
1.795     www      7547: ul#LC_toolbar {
1.911     bisitz   7548:   padding: 0;
                   7549:   margin: 2px;
                   7550:   list-style:none;
                   7551:   position:relative;
                   7552:   background-color:white;
1.1075.2.9  raeburn  7553:   overflow: auto;
1.757     schulted 7554: }
                   7555: 
1.795     www      7556: ul#LC_toolbar li {
1.911     bisitz   7557:   border:1px solid white;
                   7558:   padding: 0;
                   7559:   margin: 0;
                   7560:   float: left;
                   7561:   display:inline;
                   7562:   vertical-align:middle;
1.1075.2.9  raeburn  7563:   white-space: nowrap;
1.911     bisitz   7564: }
1.757     schulted 7565: 
1.783     amueller 7566: 
1.795     www      7567: a.LC_toolbarItem {
1.911     bisitz   7568:   display:block;
                   7569:   padding: 0;
                   7570:   margin: 0;
                   7571:   height: 32px;
                   7572:   width: 32px;
                   7573:   color:white;
                   7574:   border: none;
                   7575:   background-repeat:no-repeat;
                   7576:   background-color:transparent;
1.757     schulted 7577: }
                   7578: 
1.915     droeschl 7579: ul.LC_funclist {
                   7580:     margin: 0;
                   7581:     padding: 0.5em 1em 0.5em 0;
                   7582: }
                   7583: 
1.933     droeschl 7584: ul.LC_funclist > li:first-child {
                   7585:     font-weight:bold; 
                   7586:     margin-left:0.8em;
                   7587: }
                   7588: 
1.915     droeschl 7589: ul.LC_funclist + ul.LC_funclist {
                   7590:     /* 
                   7591:        left border as a seperator if we have more than
                   7592:        one list 
                   7593:     */
                   7594:     border-left: 1px solid $sidebg;
                   7595:     /* 
                   7596:        this hides the left border behind the border of the 
                   7597:        outer box if element is wrapped to the next 'line' 
                   7598:     */
                   7599:     margin-left: -1px;
                   7600: }
                   7601: 
1.843     bisitz   7602: ul.LC_funclist li {
1.915     droeschl 7603:   display: inline;
1.782     bisitz   7604:   white-space: nowrap;
1.915     droeschl 7605:   margin: 0 0 0 25px;
                   7606:   line-height: 150%;
1.782     bisitz   7607: }
                   7608: 
1.974     wenzelju 7609: .LC_hidden {
                   7610:   display: none;
                   7611: }
                   7612: 
1.1030    www      7613: .LCmodal-overlay {
                   7614: 		position:fixed;
                   7615: 		top:0;
                   7616: 		right:0;
                   7617: 		bottom:0;
                   7618: 		left:0;
                   7619: 		height:100%;
                   7620: 		width:100%;
                   7621: 		margin:0;
                   7622: 		padding:0;
                   7623: 		background:#999;
                   7624: 		opacity:.75;
                   7625: 		filter: alpha(opacity=75);
                   7626: 		-moz-opacity: 0.75;
                   7627: 		z-index:101;
                   7628: }
                   7629: 
                   7630: * html .LCmodal-overlay {   
                   7631: 		position: absolute;
                   7632: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7633: }
                   7634: 
                   7635: .LCmodal-window {
                   7636: 		position:fixed;
                   7637: 		top:50%;
                   7638: 		left:50%;
                   7639: 		margin:0;
                   7640: 		padding:0;
                   7641: 		z-index:102;
                   7642: 	}
                   7643: 
                   7644: * html .LCmodal-window {
                   7645: 		position:absolute;
                   7646: }
                   7647: 
                   7648: .LCclose-window {
                   7649: 		position:absolute;
                   7650: 		width:32px;
                   7651: 		height:32px;
                   7652: 		right:8px;
                   7653: 		top:8px;
                   7654: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7655: 		text-indent:-99999px;
                   7656: 		overflow:hidden;
                   7657: 		cursor:pointer;
                   7658: }
                   7659: 
1.1075.2.17  raeburn  7660: /*
                   7661:   styles used by TTH when "Default set of options to pass to tth/m
                   7662:   when converting TeX" in course settings has been set
                   7663: 
                   7664:   option passed: -t
                   7665: 
                   7666: */
                   7667: 
                   7668: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7669: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7670: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7671: td div.norm {line-height:normal;}
                   7672: 
                   7673: /*
                   7674:   option passed -y3
                   7675: */
                   7676: 
                   7677: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7678: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7679: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7680: 
1.1075.2.121  raeburn  7681: #LC_minitab_header {
                   7682:   float:left;
                   7683:   width:100%;
                   7684:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   7685:   font-size:93%;
                   7686:   line-height:normal;
                   7687:   margin: 0.5em 0 0.5em 0;
                   7688: }
                   7689: #LC_minitab_header ul {
                   7690:   margin:0;
                   7691:   padding:10px 10px 0;
                   7692:   list-style:none;
                   7693: }
                   7694: #LC_minitab_header li {
                   7695:   float:left;
                   7696:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   7697:   margin:0;
                   7698:   padding:0 0 0 9px;
                   7699: }
                   7700: #LC_minitab_header a {
                   7701:   display:block;
                   7702:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   7703:   padding:5px 15px 4px 6px;
                   7704: }
                   7705: #LC_minitab_header #LC_current_minitab {
                   7706:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   7707: }
                   7708: #LC_minitab_header #LC_current_minitab a {
                   7709:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   7710:   padding-bottom:5px;
                   7711: }
                   7712: 
                   7713: 
1.343     albertel 7714: END
                   7715: }
                   7716: 
1.306     albertel 7717: =pod
                   7718: 
                   7719: =item * &headtag()
                   7720: 
                   7721: Returns a uniform footer for LON-CAPA web pages.
                   7722: 
1.307     albertel 7723: Inputs: $title - optional title for the head
                   7724:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7725:         $args - optional arguments
1.319     albertel 7726:             force_register - if is true call registerurl so the remote is 
                   7727:                              informed
1.415     albertel 7728:             redirect       -> array ref of
                   7729:                                    1- seconds before redirect occurs
                   7730:                                    2- url to redirect to
                   7731:                                    3- whether the side effect should occur
1.315     albertel 7732:                            (side effect of setting 
                   7733:                                $env{'internal.head.redirect'} to the url 
                   7734:                                redirected too)
1.352     albertel 7735:             domain         -> force to color decorate a page for a specific
                   7736:                                domain
                   7737:             function       -> force usage of a specific rolish color scheme
                   7738:             bgcolor        -> override the default page bgcolor
1.460     albertel 7739:             no_auto_mt_title
                   7740:                            -> prevent &mt()ing the title arg
1.464     albertel 7741: 
1.306     albertel 7742: =cut
                   7743: 
                   7744: sub headtag {
1.313     albertel 7745:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7746:     
1.363     albertel 7747:     my $function = $args->{'function'} || &get_users_function();
                   7748:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7749:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  7750:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7751:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7752: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7753: 		   #time(),
1.418     albertel 7754: 		   $env{'environment.color.timestamp'},
1.363     albertel 7755: 		   $function,$domain,$bgcolor);
                   7756: 
1.369     www      7757:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7758: 
1.308     albertel 7759:     my $result =
                   7760: 	'<head>'.
1.1075.2.56  raeburn  7761: 	&font_settings($args);
1.319     albertel 7762: 
1.1075.2.72  raeburn  7763:     my $inhibitprint;
                   7764:     if ($args->{'print_suppress'}) {
                   7765:         $inhibitprint = &print_suppression();
                   7766:     }
1.1064    raeburn  7767: 
1.461     albertel 7768:     if (!$args->{'frameset'}) {
                   7769: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7770:     }
1.1075.2.12  raeburn  7771:     if ($args->{'force_register'}) {
                   7772:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 7773:     }
1.436     albertel 7774:     if (!$args->{'no_nav_bar'} 
                   7775: 	&& !$args->{'only_body'}
                   7776: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  7777: 	$result .= &help_menu_js($httphost);
1.1032    www      7778:         $result.=&modal_window();
1.1038    www      7779:         $result.=&togglebox_script();
1.1034    www      7780:         $result.=&wishlist_window();
1.1041    www      7781:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7782:     } else {
                   7783:         if ($args->{'add_modal'}) {
                   7784:            $result.=&modal_window();
                   7785:         }
                   7786:         if ($args->{'add_wishlist'}) {
                   7787:            $result.=&wishlist_window();
                   7788:         }
1.1038    www      7789:         if ($args->{'add_togglebox'}) {
                   7790:            $result.=&togglebox_script();
                   7791:         }
1.1041    www      7792:         if ($args->{'add_progressbar'}) {
                   7793:            $result.=&LCprogressbarUpdate_script();
                   7794:         }
1.436     albertel 7795:     }
1.314     albertel 7796:     if (ref($args->{'redirect'})) {
1.414     albertel 7797: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7798: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7799: 	if (!$inhibit_continue) {
                   7800: 	    $env{'internal.head.redirect'} = $url;
                   7801: 	}
1.313     albertel 7802: 	$result.=<<ADDMETA
                   7803: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7804: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7805: ADDMETA
1.1075.2.89  raeburn  7806:     } else {
                   7807:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   7808:             my $requrl = $env{'request.uri'};
                   7809:             if ($requrl eq '') {
                   7810:                 $requrl = $ENV{'REQUEST_URI'};
                   7811:                 $requrl =~ s/\?.+$//;
                   7812:             }
                   7813:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   7814:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   7815:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   7816:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   7817:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   7818:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
                   7819:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   7820:                         my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   7821:                         if ($domdefs{'offloadnow'}{$lonhost}) {
                   7822:                             my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
                   7823:                             if (($newserver) && ($newserver ne $lonhost)) {
                   7824:                                 my $numsec = 5;
                   7825:                                 my $timeout = $numsec * 1000;
                   7826:                                 my ($newurl,$locknum,%locks,$msg);
                   7827:                                 if ($env{'request.role.adv'}) {
                   7828:                                     ($locknum,%locks) = &Apache::lonnet::get_locks();
                   7829:                                 }
                   7830:                                 my $disable_submit = 0;
                   7831:                                 if ($requrl =~ /$LONCAPA::assess_re/) {
                   7832:                                     $disable_submit = 1;
                   7833:                                 }
                   7834:                                 if ($locknum) {
                   7835:                                     my @lockinfo = sort(values(%locks));
                   7836:                                     $msg = &mt('Once the following tasks are complete: ')."\\n".
                   7837:                                            join(", ",sort(values(%locks)))."\\n".
                   7838:                                            &mt('your session will be transferred to a different server, after you click "Roles".');
                   7839:                                 } else {
                   7840:                                     if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   7841:                                         $msg = &mt('Your LON-CAPA submission has been recorded')."\\n";
                   7842:                                     }
                   7843:                                     $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   7844:                                     $newurl = '/adm/switchserver?otherserver='.$newserver;
                   7845:                                     if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   7846:                                         $newurl .= '&role='.$env{'request.role'};
                   7847:                                     }
                   7848:                                     if ($env{'request.symb'}) {
                   7849:                                         $newurl .= '&symb='.$env{'request.symb'};
                   7850:                                     } else {
                   7851:                                         $newurl .= '&origurl='.$requrl;
                   7852:                                     }
                   7853:                                 }
1.1075.2.98  raeburn  7854:                                 &js_escape(\$msg);
1.1075.2.89  raeburn  7855:                                 $result.=<<OFFLOAD
                   7856: <meta http-equiv="pragma" content="no-cache" />
                   7857: <script type="text/javascript">
1.1075.2.92  raeburn  7858: // <![CDATA[
1.1075.2.89  raeburn  7859: function LC_Offload_Now() {
                   7860:     var dest = "$newurl";
                   7861:     if (dest != '') {
                   7862:         window.location.href="$newurl";
                   7863:     }
                   7864: }
1.1075.2.92  raeburn  7865: \$(document).ready(function () {
                   7866:     window.alert('$msg');
                   7867:     if ($disable_submit) {
1.1075.2.89  raeburn  7868:         \$(".LC_hwk_submit").prop("disabled", true);
                   7869:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  7870:     }
                   7871:     setTimeout('LC_Offload_Now()', $timeout);
                   7872: });
                   7873: // ]]>
1.1075.2.89  raeburn  7874: </script>
                   7875: OFFLOAD
                   7876:                             }
                   7877:                         }
                   7878:                     }
                   7879:                 }
                   7880:             }
                   7881:         }
1.313     albertel 7882:     }
1.306     albertel 7883:     if (!defined($title)) {
                   7884: 	$title = 'The LearningOnline Network with CAPA';
                   7885:     }
1.460     albertel 7886:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7887:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  7888: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   7889:     if (!$args->{'frameset'}) {
                   7890:         $result .= ' /';
                   7891:     }
                   7892:     $result .= '>'
1.1064    raeburn  7893:         .$inhibitprint
1.414     albertel 7894: 	.$head_extra;
1.1075.2.108  raeburn  7895:     my $clientmobile;
                   7896:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   7897:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   7898:     } else {
                   7899:         $clientmobile = $env{'browser.mobile'};
                   7900:     }
                   7901:     if ($clientmobile) {
1.1075.2.42  raeburn  7902:         $result .= '
                   7903: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   7904: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   7905:     }
1.1075.2.126  raeburn  7906:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 7907:     return $result.'</head>';
1.306     albertel 7908: }
                   7909: 
                   7910: =pod
                   7911: 
1.340     albertel 7912: =item * &font_settings()
                   7913: 
                   7914: Returns neccessary <meta> to set the proper encoding
                   7915: 
1.1075.2.56  raeburn  7916: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 7917: 
                   7918: =cut
                   7919: 
                   7920: sub font_settings {
1.1075.2.56  raeburn  7921:     my ($args) = @_;
1.340     albertel 7922:     my $headerstring='';
1.1075.2.56  raeburn  7923:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   7924:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 7925: 	$headerstring.=
1.1075.2.61  raeburn  7926: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   7927:         if (!$args->{'frameset'}) {
                   7928:             $headerstring.= ' /';
                   7929:         }
                   7930:         $headerstring .= '>'."\n";
1.340     albertel 7931:     }
                   7932:     return $headerstring;
                   7933: }
                   7934: 
1.341     albertel 7935: =pod
                   7936: 
1.1064    raeburn  7937: =item * &print_suppression()
                   7938: 
                   7939: In course context returns css which causes the body to be blank when media="print",
                   7940: if printout generation is unavailable for the current resource.
                   7941: 
                   7942: This could be because:
                   7943: 
                   7944: (a) printstartdate is in the future
                   7945: 
                   7946: (b) printenddate is in the past
                   7947: 
                   7948: (c) there is an active exam block with "printout"
                   7949: functionality blocked
                   7950: 
                   7951: Users with pav, pfo or evb privileges are exempt.
                   7952: 
                   7953: Inputs: none
                   7954: 
                   7955: =cut
                   7956: 
                   7957: 
                   7958: sub print_suppression {
                   7959:     my $noprint;
                   7960:     if ($env{'request.course.id'}) {
                   7961:         my $scope = $env{'request.course.id'};
                   7962:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7963:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   7964:             return;
                   7965:         }
                   7966:         if ($env{'request.course.sec'} ne '') {
                   7967:             $scope .= "/$env{'request.course.sec'}";
                   7968:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   7969:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  7970:                 return;
1.1064    raeburn  7971:             }
                   7972:         }
                   7973:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7974:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73  raeburn  7975:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  7976:         if ($blocked) {
                   7977:             my $checkrole = "cm./$cdom/$cnum";
                   7978:             if ($env{'request.course.sec'} ne '') {
                   7979:                 $checkrole .= "/$env{'request.course.sec'}";
                   7980:             }
                   7981:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   7982:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   7983:                 $noprint = 1;
                   7984:             }
                   7985:         }
                   7986:         unless ($noprint) {
                   7987:             my $symb = &Apache::lonnet::symbread();
                   7988:             if ($symb ne '') {
                   7989:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   7990:                 if (ref($navmap)) {
                   7991:                     my $res = $navmap->getBySymb($symb);
                   7992:                     if (ref($res)) {
                   7993:                         if (!$res->resprintable()) {
                   7994:                             $noprint = 1;
                   7995:                         }
                   7996:                     }
                   7997:                 }
                   7998:             }
                   7999:         }
                   8000:         if ($noprint) {
                   8001:             return <<"ENDSTYLE";
                   8002: <style type="text/css" media="print">
                   8003:     body { display:none }
                   8004: </style>
                   8005: ENDSTYLE
                   8006:         }
                   8007:     }
                   8008:     return;
                   8009: }
                   8010: 
                   8011: =pod
                   8012: 
1.341     albertel 8013: =item * &xml_begin()
                   8014: 
                   8015: Returns the needed doctype and <html>
                   8016: 
                   8017: Inputs: none
                   8018: 
                   8019: =cut
                   8020: 
                   8021: sub xml_begin {
1.1075.2.61  raeburn  8022:     my ($is_frameset) = @_;
1.341     albertel 8023:     my $output='';
                   8024: 
                   8025:     if ($env{'browser.mathml'}) {
                   8026: 	$output='<?xml version="1.0"?>'
                   8027:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8028: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8029:             
                   8030: #	    .'<!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">] >'
                   8031: 	    .'<!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">'
                   8032:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8033: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8034:     } elsif ($is_frameset) {
                   8035:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8036:                 '<html>'."\n";
1.341     albertel 8037:     } else {
1.1075.2.61  raeburn  8038: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8039:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8040:     }
                   8041:     return $output;
                   8042: }
1.340     albertel 8043: 
                   8044: =pod
                   8045: 
1.306     albertel 8046: =item * &start_page()
                   8047: 
                   8048: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8049: 
1.648     raeburn  8050: Inputs:
                   8051: 
                   8052: =over 4
                   8053: 
                   8054: $title - optional title for the page
                   8055: 
                   8056: $head_extra - optional extra HTML to incude inside the <head>
                   8057: 
                   8058: $args - additional optional args supported are:
                   8059: 
                   8060: =over 8
                   8061: 
                   8062:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8063:                                     arg on
1.814     bisitz   8064:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8065:              add_entries    -> additional attributes to add to the  <body>
                   8066:              domain         -> force to color decorate a page for a 
1.317     albertel 8067:                                     specific domain
1.648     raeburn  8068:              function       -> force usage of a specific rolish color
1.317     albertel 8069:                                     scheme
1.648     raeburn  8070:              redirect       -> see &headtag()
                   8071:              bgcolor        -> override the default page bg color
                   8072:              js_ready       -> return a string ready for being used in 
1.317     albertel 8073:                                     a javascript writeln
1.648     raeburn  8074:              html_encode    -> return a string ready for being used in 
1.320     albertel 8075:                                     a html attribute
1.648     raeburn  8076:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8077:                                     $forcereg arg
1.648     raeburn  8078:              frameset       -> if true will start with a <frameset>
1.330     albertel 8079:                                     rather than <body>
1.648     raeburn  8080:              skip_phases    -> hash ref of 
1.338     albertel 8081:                                     head -> skip the <html><head> generation
                   8082:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8083:              no_inline_link -> if true and in remote mode, don't show the
                   8084:                                     'Switch To Inline Menu' link
1.648     raeburn  8085:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8086:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8087:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8088:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8089:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8090:              group          -> includes the current group, if page is for a
                   8091:                                specific group
1.361     albertel 8092: 
1.648     raeburn  8093: =back
1.460     albertel 8094: 
1.648     raeburn  8095: =back
1.562     albertel 8096: 
1.306     albertel 8097: =cut
                   8098: 
                   8099: sub start_page {
1.309     albertel 8100:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8101:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8102: 
1.315     albertel 8103:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8104:     my ($result,@advtools);
1.964     droeschl 8105: 
1.338     albertel 8106:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8107:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8108:     }
                   8109:     
                   8110:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8111: 	if ($args->{'frameset'}) {
                   8112: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8113: 						$args->{'add_entries'});
                   8114: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8115:         } else {
                   8116:             $result .=
                   8117:                 &bodytag($title, 
                   8118:                          $args->{'function'},       $args->{'add_entries'},
                   8119:                          $args->{'only_body'},      $args->{'domain'},
                   8120:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8121:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8122:                          $args,                     \@advtools);
1.831     bisitz   8123:         }
1.330     albertel 8124:     }
1.338     albertel 8125: 
1.315     albertel 8126:     if ($args->{'js_ready'}) {
1.713     kaisler  8127: 		$result = &js_ready($result);
1.315     albertel 8128:     }
1.320     albertel 8129:     if ($args->{'html_encode'}) {
1.713     kaisler  8130: 		$result = &html_encode($result);
                   8131:     }
                   8132: 
1.813     bisitz   8133:     # Preparation for new and consistent functionlist at top of screen
                   8134:     # if ($args->{'functionlist'}) {
                   8135:     #            $result .= &build_functionlist();
                   8136:     #}
                   8137: 
1.964     droeschl 8138:     # Don't add anything more if only_body wanted or in const space
                   8139:     return $result if    $args->{'only_body'} 
                   8140:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8141: 
                   8142:     #Breadcrumbs
1.758     kaisler  8143:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8144: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8145: 		#if any br links exists, add them to the breadcrumbs
                   8146: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8147: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8148: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8149: 			}
                   8150: 		}
1.1075.2.19  raeburn  8151:                 # if @advtools array contains items add then to the breadcrumbs
                   8152:                 if (@advtools > 0) {
                   8153:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8154:                 }
1.1075.2.123  raeburn  8155:                 my $menulink;
                   8156:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8157:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8158:                     $menulink = 0;
                   8159:                 } else {
                   8160:                     undef($menulink);
                   8161:                 }
1.758     kaisler  8162: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8163: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8164: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8165: 		}else{
1.1075.2.123  raeburn  8166: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8167: 		}
1.1075.2.24  raeburn  8168:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8169:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8170:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8171:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8172:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8173:     }
1.315     albertel 8174:     return $result;
1.306     albertel 8175: }
                   8176: 
                   8177: sub end_page {
1.315     albertel 8178:     my ($args) = @_;
                   8179:     $env{'internal.end_page'}++;
1.330     albertel 8180:     my $result;
1.335     albertel 8181:     if ($args->{'discussion'}) {
                   8182: 	my ($target,$parser);
                   8183: 	if (ref($args->{'discussion'})) {
                   8184: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8185: 				$args->{'discussion'}{'parser'});
                   8186: 	}
                   8187: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8188:     }
1.330     albertel 8189:     if ($args->{'frameset'}) {
                   8190: 	$result .= '</frameset>';
                   8191:     } else {
1.635     raeburn  8192: 	$result .= &endbodytag($args);
1.330     albertel 8193:     }
1.1075.2.6  raeburn  8194:     unless ($args->{'notbody'}) {
                   8195:         $result .= "\n</html>";
                   8196:     }
1.330     albertel 8197: 
1.315     albertel 8198:     if ($args->{'js_ready'}) {
1.317     albertel 8199: 	$result = &js_ready($result);
1.315     albertel 8200:     }
1.335     albertel 8201: 
1.320     albertel 8202:     if ($args->{'html_encode'}) {
                   8203: 	$result = &html_encode($result);
                   8204:     }
1.335     albertel 8205: 
1.315     albertel 8206:     return $result;
                   8207: }
                   8208: 
1.1034    www      8209: sub wishlist_window {
                   8210:     return(<<'ENDWISHLIST');
1.1046    raeburn  8211: <script type="text/javascript">
1.1034    www      8212: // <![CDATA[
                   8213: // <!-- BEGIN LON-CAPA Internal
                   8214: function set_wishlistlink(title, path) {
                   8215:     if (!title) {
                   8216:         title = document.title;
                   8217:         title = title.replace(/^LON-CAPA /,'');
                   8218:     }
1.1075.2.65  raeburn  8219:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8220:     title = title.replace("'","\\\'");
1.1034    www      8221:     if (!path) {
                   8222:         path = location.pathname;
                   8223:     }
1.1075.2.65  raeburn  8224:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8225:     path = path.replace("'","\\\'");
1.1034    www      8226:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8227:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8228: }
                   8229: // END LON-CAPA Internal -->
                   8230: // ]]>
                   8231: </script>
                   8232: ENDWISHLIST
                   8233: }
                   8234: 
1.1030    www      8235: sub modal_window {
                   8236:     return(<<'ENDMODAL');
1.1046    raeburn  8237: <script type="text/javascript">
1.1030    www      8238: // <![CDATA[
                   8239: // <!-- BEGIN LON-CAPA Internal
                   8240: var modalWindow = {
                   8241: 	parent:"body",
                   8242: 	windowId:null,
                   8243: 	content:null,
                   8244: 	width:null,
                   8245: 	height:null,
                   8246: 	close:function()
                   8247: 	{
                   8248: 	        $(".LCmodal-window").remove();
                   8249: 	        $(".LCmodal-overlay").remove();
                   8250: 	},
                   8251: 	open:function()
                   8252: 	{
                   8253: 		var modal = "";
                   8254: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8255: 		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;\">";
                   8256: 		modal += this.content;
                   8257: 		modal += "</div>";	
                   8258: 
                   8259: 		$(this.parent).append(modal);
                   8260: 
                   8261: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8262: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8263: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8264: 	}
                   8265: };
1.1075.2.42  raeburn  8266: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8267: 	{
1.1075.2.119  raeburn  8268:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8269: 		modalWindow.windowId = "myModal";
                   8270: 		modalWindow.width = width;
                   8271: 		modalWindow.height = height;
1.1075.2.80  raeburn  8272: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8273: 		modalWindow.open();
1.1075.2.87  raeburn  8274: 	};
1.1030    www      8275: // END LON-CAPA Internal -->
                   8276: // ]]>
                   8277: </script>
                   8278: ENDMODAL
                   8279: }
                   8280: 
                   8281: sub modal_link {
1.1075.2.42  raeburn  8282:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8283:     unless ($width) { $width=480; }
                   8284:     unless ($height) { $height=400; }
1.1031    www      8285:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8286:     unless ($transparency) { $transparency='true'; }
                   8287: 
1.1074    raeburn  8288:     my $target_attr;
                   8289:     if (defined($target)) {
                   8290:         $target_attr = 'target="'.$target.'"';
                   8291:     }
                   8292:     return <<"ENDLINK";
1.1075.2.42  raeburn  8293: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074    raeburn  8294:            $linktext</a>
                   8295: ENDLINK
1.1030    www      8296: }
                   8297: 
1.1032    www      8298: sub modal_adhoc_script {
                   8299:     my ($funcname,$width,$height,$content)=@_;
                   8300:     return (<<ENDADHOC);
1.1046    raeburn  8301: <script type="text/javascript">
1.1032    www      8302: // <![CDATA[
                   8303:         var $funcname = function()
                   8304:         {
                   8305:                 modalWindow.windowId = "myModal";
                   8306:                 modalWindow.width = $width;
                   8307:                 modalWindow.height = $height;
                   8308:                 modalWindow.content = '$content';
                   8309:                 modalWindow.open();
                   8310:         };  
                   8311: // ]]>
                   8312: </script>
                   8313: ENDADHOC
                   8314: }
                   8315: 
1.1041    www      8316: sub modal_adhoc_inner {
                   8317:     my ($funcname,$width,$height,$content)=@_;
                   8318:     my $innerwidth=$width-20;
                   8319:     $content=&js_ready(
1.1042    www      8320:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8321:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8322:                  $content.
1.1041    www      8323:                  &end_scrollbox().
1.1075.2.42  raeburn  8324:                  &end_page()
1.1041    www      8325:              );
                   8326:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8327: }
                   8328: 
                   8329: sub modal_adhoc_window {
                   8330:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8331:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8332:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8333: }
                   8334: 
                   8335: sub modal_adhoc_launch {
                   8336:     my ($funcname,$width,$height,$content)=@_;
                   8337:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8338: <script type="text/javascript">
                   8339: // <![CDATA[
                   8340: $funcname();
                   8341: // ]]>
                   8342: </script>
                   8343: ENDLAUNCH
                   8344: }
                   8345: 
                   8346: sub modal_adhoc_close {
                   8347:     return (<<ENDCLOSE);
                   8348: <script type="text/javascript">
                   8349: // <![CDATA[
                   8350: modalWindow.close();
                   8351: // ]]>
                   8352: </script>
                   8353: ENDCLOSE
                   8354: }
                   8355: 
1.1038    www      8356: sub togglebox_script {
                   8357:    return(<<ENDTOGGLE);
                   8358: <script type="text/javascript"> 
                   8359: // <![CDATA[
                   8360: function LCtoggleDisplay(id,hidetext,showtext) {
                   8361:    link = document.getElementById(id + "link").childNodes[0];
                   8362:    with (document.getElementById(id).style) {
                   8363:       if (display == "none" ) {
                   8364:           display = "inline";
                   8365:           link.nodeValue = hidetext;
                   8366:         } else {
                   8367:           display = "none";
                   8368:           link.nodeValue = showtext;
                   8369:        }
                   8370:    }
                   8371: }
                   8372: // ]]>
                   8373: </script>
                   8374: ENDTOGGLE
                   8375: }
                   8376: 
1.1039    www      8377: sub start_togglebox {
                   8378:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8379:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8380:     unless ($showtext) { $showtext=&mt('show'); }
                   8381:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8382:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8383:     return &start_data_table().
                   8384:            &start_data_table_header_row().
                   8385:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8386:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8387:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8388:            &end_data_table_header_row().
                   8389:            '<tr id="'.$id.'" style="display:none""><td>';
                   8390: }
                   8391: 
                   8392: sub end_togglebox {
                   8393:     return '</td></tr>'.&end_data_table();
                   8394: }
                   8395: 
1.1041    www      8396: sub LCprogressbar_script {
1.1045    www      8397:    my ($id)=@_;
1.1041    www      8398:    return(<<ENDPROGRESS);
                   8399: <script type="text/javascript">
                   8400: // <![CDATA[
1.1045    www      8401: \$('#progressbar$id').progressbar({
1.1041    www      8402:   value: 0,
                   8403:   change: function(event, ui) {
                   8404:     var newVal = \$(this).progressbar('option', 'value');
                   8405:     \$('.pblabel', this).text(LCprogressTxt);
                   8406:   }
                   8407: });
                   8408: // ]]>
                   8409: </script>
                   8410: ENDPROGRESS
                   8411: }
                   8412: 
                   8413: sub LCprogressbarUpdate_script {
                   8414:    return(<<ENDPROGRESSUPDATE);
                   8415: <style type="text/css">
                   8416: .ui-progressbar { position:relative; }
                   8417: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8418: </style>
                   8419: <script type="text/javascript">
                   8420: // <![CDATA[
1.1045    www      8421: var LCprogressTxt='---';
                   8422: 
                   8423: function LCupdateProgress(percent,progresstext,id) {
1.1041    www      8424:    LCprogressTxt=progresstext;
1.1045    www      8425:    \$('#progressbar'+id).progressbar('value',percent);
1.1041    www      8426: }
                   8427: // ]]>
                   8428: </script>
                   8429: ENDPROGRESSUPDATE
                   8430: }
                   8431: 
1.1042    www      8432: my $LClastpercent;
1.1045    www      8433: my $LCidcnt;
                   8434: my $LCcurrentid;
1.1042    www      8435: 
1.1041    www      8436: sub LCprogressbar {
1.1042    www      8437:     my ($r)=(@_);
                   8438:     $LClastpercent=0;
1.1045    www      8439:     $LCidcnt++;
                   8440:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1041    www      8441:     my $starting=&mt('Starting');
                   8442:     my $content=(<<ENDPROGBAR);
1.1045    www      8443:   <div id="progressbar$LCcurrentid">
1.1041    www      8444:     <span class="pblabel">$starting</span>
                   8445:   </div>
                   8446: ENDPROGBAR
1.1045    www      8447:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid));
1.1041    www      8448: }
                   8449: 
                   8450: sub LCprogressbarUpdate {
1.1042    www      8451:     my ($r,$val,$text)=@_;
                   8452:     unless ($val) { 
                   8453:        if ($LClastpercent) {
                   8454:            $val=$LClastpercent;
                   8455:        } else {
                   8456:            $val=0;
                   8457:        }
                   8458:     }
1.1041    www      8459:     if ($val<0) { $val=0; }
                   8460:     if ($val>100) { $val=0; }
1.1042    www      8461:     $LClastpercent=$val;
1.1041    www      8462:     unless ($text) { $text=$val.'%'; }
                   8463:     $text=&js_ready($text);
1.1044    www      8464:     &r_print($r,<<ENDUPDATE);
1.1041    www      8465: <script type="text/javascript">
                   8466: // <![CDATA[
1.1045    www      8467: LCupdateProgress($val,'$text','$LCcurrentid');
1.1041    www      8468: // ]]>
                   8469: </script>
                   8470: ENDUPDATE
1.1035    www      8471: }
                   8472: 
1.1042    www      8473: sub LCprogressbarClose {
                   8474:     my ($r)=@_;
                   8475:     $LClastpercent=0;
1.1044    www      8476:     &r_print($r,<<ENDCLOSE);
1.1042    www      8477: <script type="text/javascript">
                   8478: // <![CDATA[
1.1045    www      8479: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8480: // ]]>
                   8481: </script>
                   8482: ENDCLOSE
1.1044    www      8483: }
                   8484: 
                   8485: sub r_print {
                   8486:     my ($r,$to_print)=@_;
                   8487:     if ($r) {
                   8488:       $r->print($to_print);
                   8489:       $r->rflush();
                   8490:     } else {
                   8491:       print($to_print);
                   8492:     }
1.1042    www      8493: }
                   8494: 
1.320     albertel 8495: sub html_encode {
                   8496:     my ($result) = @_;
                   8497: 
1.322     albertel 8498:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8499:     
                   8500:     return $result;
                   8501: }
1.1044    www      8502: 
1.317     albertel 8503: sub js_ready {
                   8504:     my ($result) = @_;
                   8505: 
1.323     albertel 8506:     $result =~ s/[\n\r]/ /xmsg;
                   8507:     $result =~ s/\\/\\\\/xmsg;
                   8508:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8509:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8510:     
                   8511:     return $result;
                   8512: }
                   8513: 
1.315     albertel 8514: sub validate_page {
                   8515:     if (  exists($env{'internal.start_page'})
1.316     albertel 8516: 	  &&     $env{'internal.start_page'} > 1) {
                   8517: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8518: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8519: 				 $ENV{'request.filename'});
1.315     albertel 8520:     }
                   8521:     if (  exists($env{'internal.end_page'})
1.316     albertel 8522: 	  &&     $env{'internal.end_page'} > 1) {
                   8523: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8524: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8525: 				 $env{'request.filename'});
1.315     albertel 8526:     }
                   8527:     if (     exists($env{'internal.start_page'})
                   8528: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8529: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8530: 				 $env{'request.filename'});
1.315     albertel 8531:     }
                   8532:     if (   ! exists($env{'internal.start_page'})
                   8533: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8534: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8535: 				 $env{'request.filename'});
1.315     albertel 8536:     }
1.306     albertel 8537: }
1.315     albertel 8538: 
1.996     www      8539: 
                   8540: sub start_scrollbox {
1.1075.2.56  raeburn  8541:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8542:     unless ($outerwidth) { $outerwidth='520px'; }
                   8543:     unless ($width) { $width='500px'; }
                   8544:     unless ($height) { $height='200px'; }
1.1075    raeburn  8545:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8546:     if ($id ne '') {
1.1075.2.42  raeburn  8547:         $table_id = ' id="table_'.$id.'"';
                   8548:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8549:     }
1.1075    raeburn  8550:     if ($bgcolor ne '') {
                   8551:         $tdcol = "background-color: $bgcolor;";
                   8552:     }
1.1075.2.42  raeburn  8553:     my $nicescroll_js;
                   8554:     if ($env{'browser.mobile'}) {
                   8555:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8556:     }
1.1075    raeburn  8557:     return <<"END";
1.1075.2.42  raeburn  8558: $nicescroll_js
                   8559: 
                   8560: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8561: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8562: END
1.996     www      8563: }
                   8564: 
                   8565: sub end_scrollbox {
1.1036    www      8566:     return '</div></td></tr></table>';
1.996     www      8567: }
                   8568: 
1.1075.2.42  raeburn  8569: sub nicescroll_javascript {
                   8570:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8571:     my %options;
                   8572:     if (ref($cursor) eq 'HASH') {
                   8573:         %options = %{$cursor};
                   8574:     }
                   8575:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8576:         $options{'railalign'} = 'left';
                   8577:     }
                   8578:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8579:         my $function  = &get_users_function();
                   8580:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8581:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8582:             $options{'cursorcolor'} = '#00F';
                   8583:         }
                   8584:     }
                   8585:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8586:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8587:             $options{'cursoropacity'}='1.0';
                   8588:         }
                   8589:     } else {
                   8590:         $options{'cursoropacity'}='1.0';
                   8591:     }
                   8592:     if ($options{'cursorfixedheight'} eq 'none') {
                   8593:         delete($options{'cursorfixedheight'});
                   8594:     } else {
                   8595:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8596:     }
                   8597:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8598:         delete($options{'railoffset'});
                   8599:     }
                   8600:     my @niceoptions;
                   8601:     while (my($key,$value) = each(%options)) {
                   8602:         if ($value =~ /^\{.+\}$/) {
                   8603:             push(@niceoptions,$key.':'.$value);
                   8604:         } else {
                   8605:             push(@niceoptions,$key.':"'.$value.'"');
                   8606:         }
                   8607:     }
                   8608:     my $nicescroll_js = '
                   8609: $(document).ready(
                   8610:       function() {
                   8611:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8612:       }
                   8613: );
                   8614: ';
                   8615:     if ($framecheck) {
                   8616:         $nicescroll_js .= '
                   8617: function expand_div(caller) {
                   8618:     if (top === self) {
                   8619:         document.getElementById("'.$id.'").style.width = "auto";
                   8620:         document.getElementById("'.$id.'").style.height = "auto";
                   8621:     } else {
                   8622:         try {
                   8623:             if (parent.frames) {
                   8624:                 if (parent.frames.length > 1) {
                   8625:                     var framesrc = parent.frames[1].location.href;
                   8626:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8627:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8628:                         document.getElementById("'.$id.'").style.width = "auto";
                   8629:                         document.getElementById("'.$id.'").style.height = "auto";
                   8630:                     }
                   8631:                 }
                   8632:             }
                   8633:         } catch (e) {
                   8634:             return;
                   8635:         }
                   8636:     }
                   8637:     return;
                   8638: }
                   8639: ';
                   8640:     }
                   8641:     if ($needjsready) {
                   8642:         $nicescroll_js = '
                   8643: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8644:     } else {
                   8645:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8646:     }
                   8647:     return $nicescroll_js;
                   8648: }
                   8649: 
1.318     albertel 8650: sub simple_error_page {
1.1075.2.49  raeburn  8651:     my ($r,$title,$msg,$args) = @_;
                   8652:     if (ref($args) eq 'HASH') {
                   8653:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8654:     } else {
                   8655:         $msg = &mt($msg);
                   8656:     }
                   8657: 
1.318     albertel 8658:     my $page =
                   8659: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8660: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8661: 	&Apache::loncommon::end_page();
                   8662:     if (ref($r)) {
                   8663: 	$r->print($page);
1.327     albertel 8664: 	return;
1.318     albertel 8665:     }
                   8666:     return $page;
                   8667: }
1.347     albertel 8668: 
                   8669: {
1.610     albertel 8670:     my @row_count;
1.961     onken    8671: 
                   8672:     sub start_data_table_count {
                   8673:         unshift(@row_count, 0);
                   8674:         return;
                   8675:     }
                   8676: 
                   8677:     sub end_data_table_count {
                   8678:         shift(@row_count);
                   8679:         return;
                   8680:     }
                   8681: 
1.347     albertel 8682:     sub start_data_table {
1.1018    raeburn  8683: 	my ($add_class,$id) = @_;
1.422     albertel 8684: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8685:         my $table_id;
                   8686:         if (defined($id)) {
                   8687:             $table_id = ' id="'.$id.'"';
                   8688:         }
1.961     onken    8689: 	&start_data_table_count();
1.1018    raeburn  8690: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8691:     }
                   8692: 
                   8693:     sub end_data_table {
1.961     onken    8694: 	&end_data_table_count();
1.389     albertel 8695: 	return '</table>'."\n";;
1.347     albertel 8696:     }
                   8697: 
                   8698:     sub start_data_table_row {
1.974     wenzelju 8699: 	my ($add_class, $id) = @_;
1.610     albertel 8700: 	$row_count[0]++;
                   8701: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8702: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8703:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8704:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8705:     }
1.471     banghart 8706:     
                   8707:     sub continue_data_table_row {
1.974     wenzelju 8708: 	my ($add_class, $id) = @_;
1.610     albertel 8709: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8710: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8711:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8712:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8713:     }
1.347     albertel 8714: 
                   8715:     sub end_data_table_row {
1.389     albertel 8716: 	return '</tr>'."\n";;
1.347     albertel 8717:     }
1.367     www      8718: 
1.421     albertel 8719:     sub start_data_table_empty_row {
1.707     bisitz   8720: #	$row_count[0]++;
1.421     albertel 8721: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8722:     }
                   8723: 
                   8724:     sub end_data_table_empty_row {
                   8725: 	return '</tr>'."\n";;
                   8726:     }
                   8727: 
1.367     www      8728:     sub start_data_table_header_row {
1.389     albertel 8729: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      8730:     }
                   8731: 
                   8732:     sub end_data_table_header_row {
1.389     albertel 8733: 	return '</tr>'."\n";;
1.367     www      8734:     }
1.890     droeschl 8735: 
                   8736:     sub data_table_caption {
                   8737:         my $caption = shift;
                   8738:         return "<caption class=\"LC_caption\">$caption</caption>";
                   8739:     }
1.347     albertel 8740: }
                   8741: 
1.548     albertel 8742: =pod
                   8743: 
                   8744: =item * &inhibit_menu_check($arg)
                   8745: 
                   8746: Checks for a inhibitmenu state and generates output to preserve it
                   8747: 
                   8748: Inputs:         $arg - can be any of
                   8749:                      - undef - in which case the return value is a string 
                   8750:                                to add  into arguments list of a uri
                   8751:                      - 'input' - in which case the return value is a HTML
                   8752:                                  <form> <input> field of type hidden to
                   8753:                                  preserve the value
                   8754:                      - a url - in which case the return value is the url with
                   8755:                                the neccesary cgi args added to preserve the
                   8756:                                inhibitmenu state
                   8757:                      - a ref to a url - no return value, but the string is
                   8758:                                         updated to include the neccessary cgi
                   8759:                                         args to preserve the inhibitmenu state
                   8760: 
                   8761: =cut
                   8762: 
                   8763: sub inhibit_menu_check {
                   8764:     my ($arg) = @_;
                   8765:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   8766:     if ($arg eq 'input') {
                   8767: 	if ($env{'form.inhibitmenu'}) {
                   8768: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   8769: 	} else {
                   8770: 	    return
                   8771: 	}
                   8772:     }
                   8773:     if ($env{'form.inhibitmenu'}) {
                   8774: 	if (ref($arg)) {
                   8775: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8776: 	} elsif ($arg eq '') {
                   8777: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   8778: 	} else {
                   8779: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8780: 	}
                   8781:     }
                   8782:     if (!ref($arg)) {
                   8783: 	return $arg;
                   8784:     }
                   8785: }
                   8786: 
1.251     albertel 8787: ###############################################
1.182     matthew  8788: 
                   8789: =pod
                   8790: 
1.549     albertel 8791: =back
                   8792: 
                   8793: =head1 User Information Routines
                   8794: 
                   8795: =over 4
                   8796: 
1.405     albertel 8797: =item * &get_users_function()
1.182     matthew  8798: 
                   8799: Used by &bodytag to determine the current users primary role.
                   8800: Returns either 'student','coordinator','admin', or 'author'.
                   8801: 
                   8802: =cut
                   8803: 
                   8804: ###############################################
                   8805: sub get_users_function {
1.815     tempelho 8806:     my $function = 'norole';
1.818     tempelho 8807:     if ($env{'request.role'}=~/^(st)/) {
                   8808:         $function='student';
                   8809:     }
1.907     raeburn  8810:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  8811:         $function='coordinator';
                   8812:     }
1.258     albertel 8813:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  8814:         $function='admin';
                   8815:     }
1.826     bisitz   8816:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  8817:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  8818:         $function='author';
                   8819:     }
                   8820:     return $function;
1.54      www      8821: }
1.99      www      8822: 
                   8823: ###############################################
                   8824: 
1.233     raeburn  8825: =pod
                   8826: 
1.821     raeburn  8827: =item * &show_course()
                   8828: 
                   8829: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   8830: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   8831: 
                   8832: Inputs:
                   8833: None
                   8834: 
                   8835: Outputs:
                   8836: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   8837: 
                   8838: =cut
                   8839: 
                   8840: ###############################################
                   8841: sub show_course {
                   8842:     my $course = !$env{'user.adv'};
                   8843:     if (!$env{'user.adv'}) {
                   8844:         foreach my $env (keys(%env)) {
                   8845:             next if ($env !~ m/^user\.priv\./);
                   8846:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   8847:                 $course = 0;
                   8848:                 last;
                   8849:             }
                   8850:         }
                   8851:     }
                   8852:     return $course;
                   8853: }
                   8854: 
                   8855: ###############################################
                   8856: 
                   8857: =pod
                   8858: 
1.542     raeburn  8859: =item * &check_user_status()
1.274     raeburn  8860: 
                   8861: Determines current status of supplied role for a
                   8862: specific user. Roles can be active, previous or future.
                   8863: 
                   8864: Inputs: 
                   8865: user's domain, user's username, course's domain,
1.375     raeburn  8866: course's number, optional section ID.
1.274     raeburn  8867: 
                   8868: Outputs:
                   8869: role status: active, previous or future. 
                   8870: 
                   8871: =cut
                   8872: 
                   8873: sub check_user_status {
1.412     raeburn  8874:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  8875:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  8876:     my @uroles = keys(%userinfo);
1.274     raeburn  8877:     my $srchstr;
                   8878:     my $active_chk = 'none';
1.412     raeburn  8879:     my $now = time;
1.274     raeburn  8880:     if (@uroles > 0) {
1.908     raeburn  8881:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  8882:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   8883:         } else {
1.412     raeburn  8884:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   8885:         }
                   8886:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  8887:             my $role_end = 0;
                   8888:             my $role_start = 0;
                   8889:             $active_chk = 'active';
1.412     raeburn  8890:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   8891:                 $role_end = $1;
                   8892:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   8893:                     $role_start = $1;
1.274     raeburn  8894:                 }
                   8895:             }
                   8896:             if ($role_start > 0) {
1.412     raeburn  8897:                 if ($now < $role_start) {
1.274     raeburn  8898:                     $active_chk = 'future';
                   8899:                 }
                   8900:             }
                   8901:             if ($role_end > 0) {
1.412     raeburn  8902:                 if ($now > $role_end) {
1.274     raeburn  8903:                     $active_chk = 'previous';
                   8904:                 }
                   8905:             }
                   8906:         }
                   8907:     }
                   8908:     return $active_chk;
                   8909: }
                   8910: 
                   8911: ###############################################
                   8912: 
                   8913: =pod
                   8914: 
1.405     albertel 8915: =item * &get_sections()
1.233     raeburn  8916: 
                   8917: Determines all the sections for a course including
                   8918: sections with students and sections containing other roles.
1.419     raeburn  8919: Incoming parameters: 
                   8920: 
                   8921: 1. domain
                   8922: 2. course number 
                   8923: 3. reference to array containing roles for which sections should 
                   8924: be gathered (optional).
                   8925: 4. reference to array containing status types for which sections 
                   8926: should be gathered (optional).
                   8927: 
                   8928: If the third argument is undefined, sections are gathered for any role. 
                   8929: If the fourth argument is undefined, sections are gathered for any status.
                   8930: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  8931:  
1.374     raeburn  8932: Returns section hash (keys are section IDs, values are
                   8933: number of users in each section), subject to the
1.419     raeburn  8934: optional roles filter, optional status filter 
1.233     raeburn  8935: 
                   8936: =cut
                   8937: 
                   8938: ###############################################
                   8939: sub get_sections {
1.419     raeburn  8940:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 8941:     if (!defined($cdom) || !defined($cnum)) {
                   8942:         my $cid =  $env{'request.course.id'};
                   8943: 
                   8944: 	return if (!defined($cid));
                   8945: 
                   8946:         $cdom = $env{'course.'.$cid.'.domain'};
                   8947:         $cnum = $env{'course.'.$cid.'.num'};
                   8948:     }
                   8949: 
                   8950:     my %sectioncount;
1.419     raeburn  8951:     my $now = time;
1.240     albertel 8952: 
1.1075.2.33  raeburn  8953:     my $check_students = 1;
                   8954:     my $only_students = 0;
                   8955:     if (ref($possible_roles) eq 'ARRAY') {
                   8956:         if (grep(/^st$/,@{$possible_roles})) {
                   8957:             if (@{$possible_roles} == 1) {
                   8958:                 $only_students = 1;
                   8959:             }
                   8960:         } else {
                   8961:             $check_students = 0;
                   8962:         }
                   8963:     }
                   8964: 
                   8965:     if ($check_students) {
1.276     albertel 8966: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 8967: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   8968: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  8969:         my $start_index = &Apache::loncoursedata::CL_START();
                   8970:         my $end_index = &Apache::loncoursedata::CL_END();
                   8971:         my $status;
1.366     albertel 8972: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  8973: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   8974: 				                     $data->[$status_index],
                   8975:                                                      $data->[$start_index],
                   8976:                                                      $data->[$end_index]);
                   8977:             if ($stu_status eq 'Active') {
                   8978:                 $status = 'active';
                   8979:             } elsif ($end < $now) {
                   8980:                 $status = 'previous';
                   8981:             } elsif ($start > $now) {
                   8982:                 $status = 'future';
                   8983:             } 
                   8984: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   8985:                 if ((!defined($possible_status)) || (($status ne '') && 
                   8986:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   8987: 		    $sectioncount{$section}++;
                   8988:                 }
1.240     albertel 8989: 	    }
                   8990: 	}
                   8991:     }
1.1075.2.33  raeburn  8992:     if ($only_students) {
                   8993:         return %sectioncount;
                   8994:     }
1.240     albertel 8995:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   8996:     foreach my $user (sort(keys(%courseroles))) {
                   8997: 	if ($user !~ /^(\w{2})/) { next; }
                   8998: 	my ($role) = ($user =~ /^(\w{2})/);
                   8999: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9000: 	my ($section,$status);
1.240     albertel 9001: 	if ($role eq 'cr' &&
                   9002: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9003: 	    $section=$1;
                   9004: 	}
                   9005: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9006: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9007:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9008:         if ($end == -1 && $start == -1) {
                   9009:             next; #deleted role
                   9010:         }
                   9011:         if (!defined($possible_status)) { 
                   9012:             $sectioncount{$section}++;
                   9013:         } else {
                   9014:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9015:                 $status = 'active';
                   9016:             } elsif ($end < $now) {
                   9017:                 $status = 'future';
                   9018:             } elsif ($start > $now) {
                   9019:                 $status = 'previous';
                   9020:             }
                   9021:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9022:                 $sectioncount{$section}++;
                   9023:             }
                   9024:         }
1.233     raeburn  9025:     }
1.366     albertel 9026:     return %sectioncount;
1.233     raeburn  9027: }
                   9028: 
1.274     raeburn  9029: ###############################################
1.294     raeburn  9030: 
                   9031: =pod
1.405     albertel 9032: 
                   9033: =item * &get_course_users()
                   9034: 
1.275     raeburn  9035: Retrieves usernames:domains for users in the specified course
                   9036: with specific role(s), and access status. 
                   9037: 
                   9038: Incoming parameters:
1.277     albertel 9039: 1. course domain
                   9040: 2. course number
                   9041: 3. access status: users must have - either active, 
1.275     raeburn  9042: previous, future, or all.
1.277     albertel 9043: 4. reference to array of permissible roles
1.288     raeburn  9044: 5. reference to array of section restrictions (optional)
                   9045: 6. reference to results object (hash of hashes).
                   9046: 7. reference to optional userdata hash
1.609     raeburn  9047: 8. reference to optional statushash
1.630     raeburn  9048: 9. flag if privileged users (except those set to unhide in
                   9049:    course settings) should be excluded    
1.609     raeburn  9050: Keys of top level results hash are roles.
1.275     raeburn  9051: Keys of inner hashes are username:domain, with 
                   9052: values set to access type.
1.288     raeburn  9053: Optional userdata hash returns an array with arguments in the 
                   9054: same order as loncoursedata::get_classlist() for student data.
                   9055: 
1.609     raeburn  9056: Optional statushash returns
                   9057: 
1.288     raeburn  9058: Entries for end, start, section and status are blank because
                   9059: of the possibility of multiple values for non-student roles.
                   9060: 
1.275     raeburn  9061: =cut
1.405     albertel 9062: 
1.275     raeburn  9063: ###############################################
1.405     albertel 9064: 
1.275     raeburn  9065: sub get_course_users {
1.630     raeburn  9066:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9067:     my %idx = ();
1.419     raeburn  9068:     my %seclists;
1.288     raeburn  9069: 
                   9070:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9071:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9072:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9073:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9074:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9075:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9076:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9077:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9078: 
1.290     albertel 9079:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9080:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9081:         my $now = time;
1.277     albertel 9082:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9083:             my $match = 0;
1.412     raeburn  9084:             my $secmatch = 0;
1.419     raeburn  9085:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9086:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9087:             if ($section eq '') {
                   9088:                 $section = 'none';
                   9089:             }
1.291     albertel 9090:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9091:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9092:                     $secmatch = 1;
                   9093:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9094:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9095:                         $secmatch = 1;
                   9096:                     }
                   9097:                 } else {  
1.419     raeburn  9098: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9099: 		        $secmatch = 1;
                   9100:                     }
1.290     albertel 9101: 		}
1.412     raeburn  9102:                 if (!$secmatch) {
                   9103:                     next;
                   9104:                 }
1.419     raeburn  9105:             }
1.275     raeburn  9106:             if (defined($$types{'active'})) {
1.288     raeburn  9107:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9108:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9109:                     $match = 1;
1.275     raeburn  9110:                 }
                   9111:             }
                   9112:             if (defined($$types{'previous'})) {
1.609     raeburn  9113:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9114:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9115:                     $match = 1;
1.275     raeburn  9116:                 }
                   9117:             }
                   9118:             if (defined($$types{'future'})) {
1.609     raeburn  9119:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9120:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9121:                     $match = 1;
1.275     raeburn  9122:                 }
                   9123:             }
1.609     raeburn  9124:             if ($match) {
                   9125:                 push(@{$seclists{$student}},$section);
                   9126:                 if (ref($userdata) eq 'HASH') {
                   9127:                     $$userdata{$student} = $$classlist{$student};
                   9128:                 }
                   9129:                 if (ref($statushash) eq 'HASH') {
                   9130:                     $statushash->{$student}{'st'}{$section} = $status;
                   9131:                 }
1.288     raeburn  9132:             }
1.275     raeburn  9133:         }
                   9134:     }
1.412     raeburn  9135:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9136:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9137:         my $now = time;
1.609     raeburn  9138:         my %displaystatus = ( previous => 'Expired',
                   9139:                               active   => 'Active',
                   9140:                               future   => 'Future',
                   9141:                             );
1.1075.2.36  raeburn  9142:         my (%nothide,@possdoms);
1.630     raeburn  9143:         if ($hidepriv) {
                   9144:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9145:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9146:                 if ($user !~ /:/) {
                   9147:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9148:                 } else {
                   9149:                     $nothide{$user} = 1;
                   9150:                 }
                   9151:             }
1.1075.2.36  raeburn  9152:             my @possdoms = ($cdom);
                   9153:             if ($coursehash{'checkforpriv'}) {
                   9154:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9155:             }
1.630     raeburn  9156:         }
1.439     raeburn  9157:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9158:             my $match = 0;
1.412     raeburn  9159:             my $secmatch = 0;
1.439     raeburn  9160:             my $status;
1.412     raeburn  9161:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9162:             $user =~ s/:$//;
1.439     raeburn  9163:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9164:             if ($end == -1 || $start == -1) {
                   9165:                 next;
                   9166:             }
                   9167:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9168:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9169:                 my ($uname,$udom) = split(/:/,$user);
                   9170:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9171:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9172:                         $secmatch = 1;
                   9173:                     } elsif ($usec eq '') {
1.420     albertel 9174:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9175:                             $secmatch = 1;
                   9176:                         }
                   9177:                     } else {
                   9178:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9179:                             $secmatch = 1;
                   9180:                         }
                   9181:                     }
                   9182:                     if (!$secmatch) {
                   9183:                         next;
                   9184:                     }
1.288     raeburn  9185:                 }
1.419     raeburn  9186:                 if ($usec eq '') {
                   9187:                     $usec = 'none';
                   9188:                 }
1.275     raeburn  9189:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9190:                     if ($hidepriv) {
1.1075.2.36  raeburn  9191:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9192:                             (!$nothide{$uname.':'.$udom})) {
                   9193:                             next;
                   9194:                         }
                   9195:                     }
1.503     raeburn  9196:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9197:                         $status = 'previous';
                   9198:                     } elsif ($start > $now) {
                   9199:                         $status = 'future';
                   9200:                     } else {
                   9201:                         $status = 'active';
                   9202:                     }
1.277     albertel 9203:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9204:                         if ($status eq $type) {
1.420     albertel 9205:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9206:                                 push(@{$$users{$role}{$user}},$type);
                   9207:                             }
1.288     raeburn  9208:                             $match = 1;
                   9209:                         }
                   9210:                     }
1.419     raeburn  9211:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9212:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9213: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9214:                         }
1.420     albertel 9215:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9216:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9217:                         }
1.609     raeburn  9218:                         if (ref($statushash) eq 'HASH') {
                   9219:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9220:                         }
1.275     raeburn  9221:                     }
                   9222:                 }
                   9223:             }
                   9224:         }
1.290     albertel 9225:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9226:             if ((defined($cdom)) && (defined($cnum))) {
                   9227:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9228:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9229:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9230:                     next if ($owner eq '');
                   9231:                     my ($ownername,$ownerdom);
                   9232:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9233:                         $ownername = $1;
                   9234:                         $ownerdom = $2;
                   9235:                     } else {
                   9236:                         $ownername = $owner;
                   9237:                         $ownerdom = $cdom;
                   9238:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9239:                     }
                   9240:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9241:                     if (defined($userdata) && 
1.609     raeburn  9242: 			!exists($$userdata{$owner})) {
                   9243: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9244:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9245:                             push(@{$seclists{$owner}},'none');
                   9246:                         }
                   9247:                         if (ref($statushash) eq 'HASH') {
                   9248:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9249:                         }
1.290     albertel 9250: 		    }
1.279     raeburn  9251:                 }
                   9252:             }
                   9253:         }
1.419     raeburn  9254:         foreach my $user (keys(%seclists)) {
                   9255:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9256:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9257:         }
1.275     raeburn  9258:     }
                   9259:     return;
                   9260: }
                   9261: 
1.288     raeburn  9262: sub get_user_info {
                   9263:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9264:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9265: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9266:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9267:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9268:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9269:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9270:     return;
                   9271: }
1.275     raeburn  9272: 
1.472     raeburn  9273: ###############################################
                   9274: 
                   9275: =pod
                   9276: 
                   9277: =item * &get_user_quota()
                   9278: 
1.1075.2.41  raeburn  9279: Retrieves quota assigned for storage of user files.
                   9280: Default is to report quota for portfolio files.
1.472     raeburn  9281: 
                   9282: Incoming parameters:
                   9283: 1. user's username
                   9284: 2. user's domain
1.1075.2.41  raeburn  9285: 3. quota name - portfolio, author, or course
                   9286:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9287: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9288:    course
1.472     raeburn  9289: 
                   9290: Returns:
1.1075.2.58  raeburn  9291: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9292: 2. (Optional) Type of setting: custom or default
                   9293:    (individually assigned or default for user's 
                   9294:    institutional status).
                   9295: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9296:    or student - types as defined in localenroll::inst_usertypes 
                   9297:    for user's domain, which determines default quota for user.
                   9298: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9299: 
                   9300: If a value has been stored in the user's environment, 
1.536     raeburn  9301: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9302: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9303: 
                   9304: =cut
                   9305: 
                   9306: ###############################################
                   9307: 
                   9308: 
                   9309: sub get_user_quota {
1.1075.2.42  raeburn  9310:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9311:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9312:     if (!defined($udom)) {
                   9313:         $udom = $env{'user.domain'};
                   9314:     }
                   9315:     if (!defined($uname)) {
                   9316:         $uname = $env{'user.name'};
                   9317:     }
                   9318:     if (($udom eq '' || $uname eq '') ||
                   9319:         ($udom eq 'public') && ($uname eq 'public')) {
                   9320:         $quota = 0;
1.536     raeburn  9321:         $quotatype = 'default';
                   9322:         $defquota = 0; 
1.472     raeburn  9323:     } else {
1.536     raeburn  9324:         my $inststatus;
1.1075.2.41  raeburn  9325:         if ($quotaname eq 'course') {
                   9326:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9327:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9328:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9329:             } else {
                   9330:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9331:                 $quota = $cenv{'internal.uploadquota'};
                   9332:             }
1.536     raeburn  9333:         } else {
1.1075.2.41  raeburn  9334:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9335:                 if ($quotaname eq 'author') {
                   9336:                     $quota = $env{'environment.authorquota'};
                   9337:                 } else {
                   9338:                     $quota = $env{'environment.portfolioquota'};
                   9339:                 }
                   9340:                 $inststatus = $env{'environment.inststatus'};
                   9341:             } else {
                   9342:                 my %userenv = 
                   9343:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9344:                                          'authorquota','inststatus'],$udom,$uname);
                   9345:                 my ($tmp) = keys(%userenv);
                   9346:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9347:                     if ($quotaname eq 'author') {
                   9348:                         $quota = $userenv{'authorquota'};
                   9349:                     } else {
                   9350:                         $quota = $userenv{'portfolioquota'};
                   9351:                     }
                   9352:                     $inststatus = $userenv{'inststatus'};
                   9353:                 } else {
                   9354:                     undef(%userenv);
                   9355:                 }
                   9356:             }
                   9357:         }
                   9358:         if ($quota eq '' || wantarray) {
                   9359:             if ($quotaname eq 'course') {
                   9360:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9361:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9362:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9363:                     $defquota = $domdefs{$crstype.'quota'};
                   9364:                 }
                   9365:                 if ($defquota eq '') {
                   9366:                     $defquota = 500;
                   9367:                 }
1.1075.2.41  raeburn  9368:             } else {
                   9369:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9370:             }
                   9371:             if ($quota eq '') {
                   9372:                 $quota = $defquota;
                   9373:                 $quotatype = 'default';
                   9374:             } else {
                   9375:                 $quotatype = 'custom';
                   9376:             }
1.472     raeburn  9377:         }
                   9378:     }
1.536     raeburn  9379:     if (wantarray) {
                   9380:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9381:     } else {
                   9382:         return $quota;
                   9383:     }
1.472     raeburn  9384: }
                   9385: 
                   9386: ###############################################
                   9387: 
                   9388: =pod
                   9389: 
                   9390: =item * &default_quota()
                   9391: 
1.536     raeburn  9392: Retrieves default quota assigned for storage of user portfolio files,
                   9393: given an (optional) user's institutional status.
1.472     raeburn  9394: 
                   9395: Incoming parameters:
1.1075.2.42  raeburn  9396: 
1.472     raeburn  9397: 1. domain
1.536     raeburn  9398: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9399:    status types (e.g., faculty, staff, student etc.)
                   9400:    which apply to the user for whom the default is being retrieved.
                   9401:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9402:    default quota will be returned.
                   9403: 3.  quota name - portfolio, author, or course
                   9404:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9405: 
                   9406: Returns:
1.1075.2.42  raeburn  9407: 
1.1075.2.58  raeburn  9408: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9409: 2. (Optional) institutional type which determined the value of the
                   9410:    default quota.
1.472     raeburn  9411: 
                   9412: If a value has been stored in the domain's configuration db,
                   9413: it will return that, otherwise it returns 20 (for backwards 
                   9414: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9415: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9416: 
1.536     raeburn  9417: If the user's status includes multiple types (e.g., staff and student),
                   9418: the largest default quota which applies to the user determines the
                   9419: default quota returned.
                   9420: 
1.472     raeburn  9421: =cut
                   9422: 
                   9423: ###############################################
                   9424: 
                   9425: 
                   9426: sub default_quota {
1.1075.2.41  raeburn  9427:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9428:     my ($defquota,$settingstatus);
                   9429:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9430:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9431:     my $key = 'defaultquota';
                   9432:     if ($quotaname eq 'author') {
                   9433:         $key = 'authorquota';
                   9434:     }
1.622     raeburn  9435:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9436:         if ($inststatus ne '') {
1.765     raeburn  9437:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9438:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9439:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9440:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9441:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9442:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9443:                             $settingstatus = $item;
1.1075.2.41  raeburn  9444:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9445:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9446:                             $settingstatus = $item;
                   9447:                         }
                   9448:                     }
1.1075.2.41  raeburn  9449:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9450:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9451:                         if ($defquota eq '') {
                   9452:                             $defquota = $quotahash{'quotas'}{$item};
                   9453:                             $settingstatus = $item;
                   9454:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9455:                             $defquota = $quotahash{'quotas'}{$item};
                   9456:                             $settingstatus = $item;
                   9457:                         }
1.536     raeburn  9458:                     }
                   9459:                 }
                   9460:             }
                   9461:         }
                   9462:         if ($defquota eq '') {
1.1075.2.41  raeburn  9463:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9464:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9465:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9466:                 $defquota = $quotahash{'quotas'}{'default'};
                   9467:             }
1.536     raeburn  9468:             $settingstatus = 'default';
1.1075.2.42  raeburn  9469:             if ($defquota eq '') {
                   9470:                 if ($quotaname eq 'author') {
                   9471:                     $defquota = 500;
                   9472:                 }
                   9473:             }
1.536     raeburn  9474:         }
                   9475:     } else {
                   9476:         $settingstatus = 'default';
1.1075.2.41  raeburn  9477:         if ($quotaname eq 'author') {
                   9478:             $defquota = 500;
                   9479:         } else {
                   9480:             $defquota = 20;
                   9481:         }
1.536     raeburn  9482:     }
                   9483:     if (wantarray) {
                   9484:         return ($defquota,$settingstatus);
1.472     raeburn  9485:     } else {
1.536     raeburn  9486:         return $defquota;
1.472     raeburn  9487:     }
                   9488: }
                   9489: 
1.1075.2.41  raeburn  9490: ###############################################
                   9491: 
                   9492: =pod
                   9493: 
1.1075.2.42  raeburn  9494: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9495: 
                   9496: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9497: of existing file within authoring space will cause quota for the authoring
                   9498: space to be exceeded.
                   9499: 
                   9500: Same, if upload of a file directly to a course/community via Course Editor
                   9501: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9502: 
1.1075.2.61  raeburn  9503: Inputs: 7 
1.1075.2.42  raeburn  9504: 1. username or coursenum
1.1075.2.41  raeburn  9505: 2. domain
1.1075.2.42  raeburn  9506: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9507: 4. filename of file for which action is being requested
                   9508: 5. filesize (kB) of file
                   9509: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9510: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9511: 
                   9512: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9513:          otherwise return null.
                   9514: 
1.1075.2.42  raeburn  9515: =back
                   9516: 
1.1075.2.41  raeburn  9517: =cut
                   9518: 
1.1075.2.42  raeburn  9519: sub excess_filesize_warning {
1.1075.2.59  raeburn  9520:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9521:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9522:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9523:     if ($context eq 'author') {
                   9524:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9525:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9526:     } else {
                   9527:         foreach my $subdir ('docs','supplemental') {
                   9528:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9529:         }
                   9530:     }
1.1075.2.41  raeburn  9531:     $disk_quota = int($disk_quota * 1000);
                   9532:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9533:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9534:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9535:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9536:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9537:                             $disk_quota,$current_disk_usage).
                   9538:                '</p>';
                   9539:     }
                   9540:     return;
                   9541: }
                   9542: 
                   9543: ###############################################
                   9544: 
                   9545: 
1.384     raeburn  9546: sub get_secgrprole_info {
                   9547:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9548:     my %sections_count = &get_sections($cdom,$cnum);
                   9549:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9550:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9551:     my @groups = sort(keys(%curr_groups));
                   9552:     my $allroles = [];
                   9553:     my $rolehash;
                   9554:     my $accesshash = {
                   9555:                      active => 'Currently has access',
                   9556:                      future => 'Will have future access',
                   9557:                      previous => 'Previously had access',
                   9558:                   };
                   9559:     if ($needroles) {
                   9560:         $rolehash = {'all' => 'all'};
1.385     albertel 9561:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9562: 	if (&Apache::lonnet::error(%user_roles)) {
                   9563: 	    undef(%user_roles);
                   9564: 	}
                   9565:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9566:             my ($role)=split(/\:/,$item,2);
                   9567:             if ($role eq 'cr') { next; }
                   9568:             if ($role =~ /^cr/) {
                   9569:                 $$rolehash{$role} = (split('/',$role))[3];
                   9570:             } else {
                   9571:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9572:             }
                   9573:         }
                   9574:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9575:             push(@{$allroles},$key);
                   9576:         }
                   9577:         push (@{$allroles},'st');
                   9578:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9579:     }
                   9580:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9581: }
                   9582: 
1.555     raeburn  9583: sub user_picker {
1.1075.2.127  raeburn  9584:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9585:     my $currdom = $dom;
1.1075.2.114  raeburn  9586:     my @alldoms = &Apache::lonnet::all_domains();
                   9587:     if (@alldoms == 1) {
                   9588:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9589:                                                ['directorysrch'],$alldoms[0]);
                   9590:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9591:         my $showdom = $domdesc;
                   9592:         if ($showdom eq '') {
                   9593:             $showdom = $dom;
                   9594:         }
                   9595:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9596:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9597:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9598:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9599:             }
                   9600:         }
                   9601:     }
1.555     raeburn  9602:     my %curr_selected = (
                   9603:                         srchin => 'dom',
1.580     raeburn  9604:                         srchby => 'lastname',
1.555     raeburn  9605:                       );
                   9606:     my $srchterm;
1.625     raeburn  9607:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9608:         if ($srch->{'srchby'} ne '') {
                   9609:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9610:         }
                   9611:         if ($srch->{'srchin'} ne '') {
                   9612:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9613:         }
                   9614:         if ($srch->{'srchtype'} ne '') {
                   9615:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9616:         }
                   9617:         if ($srch->{'srchdomain'} ne '') {
                   9618:             $currdom = $srch->{'srchdomain'};
                   9619:         }
                   9620:         $srchterm = $srch->{'srchterm'};
                   9621:     }
1.1075.2.98  raeburn  9622:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9623:                     'usr'       => 'Search criteria',
1.563     raeburn  9624:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9625:                     'uname'     => 'username',
                   9626:                     'lastname'  => 'last name',
1.555     raeburn  9627:                     'lastfirst' => 'last name, first name',
1.558     albertel 9628:                     'crs'       => 'in this course',
1.576     raeburn  9629:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9630:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9631:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9632:                     'exact'     => 'is',
                   9633:                     'contains'  => 'contains',
1.569     raeburn  9634:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9635:                                        );
                   9636:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9637:                     'youm'      => "You must include some text to search for.",
                   9638:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9639:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9640:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9641:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9642:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9643:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9644:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9645:                                        );
1.1075.2.98  raeburn  9646:     &html_escape(\%html_lt);
                   9647:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9648:     my $domform;
1.1075.2.126  raeburn  9649:     my $allow_blank = 1;
1.1075.2.115  raeburn  9650:     if ($fixeddom) {
1.1075.2.126  raeburn  9651:         $allow_blank = 0;
                   9652:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9653:     } else {
1.1075.2.126  raeburn  9654:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9655:     }
1.563     raeburn  9656:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9657: 
                   9658:     my @srchins = ('crs','dom','alc','instd');
                   9659: 
                   9660:     foreach my $option (@srchins) {
                   9661:         # FIXME 'alc' option unavailable until 
                   9662:         #       loncreateuser::print_user_query_page()
                   9663:         #       has been completed.
                   9664:         next if ($option eq 'alc');
1.880     raeburn  9665:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9666:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9667:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9668:         if ($curr_selected{'srchin'} eq $option) {
                   9669:             $srchinsel .= ' 
1.1075.2.98  raeburn  9670:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9671:         } else {
                   9672:             $srchinsel .= '
1.1075.2.98  raeburn  9673:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9674:         }
1.555     raeburn  9675:     }
1.563     raeburn  9676:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9677: 
                   9678:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9679:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9680:         if ($curr_selected{'srchby'} eq $option) {
                   9681:             $srchbysel .= '
1.1075.2.98  raeburn  9682:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9683:         } else {
                   9684:             $srchbysel .= '
1.1075.2.98  raeburn  9685:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9686:          }
                   9687:     }
                   9688:     $srchbysel .= "\n  </select>\n";
                   9689: 
                   9690:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9691:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9692:         if ($curr_selected{'srchtype'} eq $option) {
                   9693:             $srchtypesel .= '
1.1075.2.98  raeburn  9694:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9695:         } else {
                   9696:             $srchtypesel .= '
1.1075.2.98  raeburn  9697:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9698:         }
                   9699:     }
                   9700:     $srchtypesel .= "\n  </select>\n";
                   9701: 
1.558     albertel 9702:     my ($newuserscript,$new_user_create);
1.994     raeburn  9703:     my $context_dom = $env{'request.role.domain'};
                   9704:     if ($context eq 'requestcrs') {
                   9705:         if ($env{'form.coursedom'} ne '') { 
                   9706:             $context_dom = $env{'form.coursedom'};
                   9707:         }
                   9708:     }
1.556     raeburn  9709:     if ($forcenewuser) {
1.576     raeburn  9710:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9711:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9712:                 if ($cancreate) {
                   9713:                     $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>';
                   9714:                 } else {
1.799     bisitz   9715:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9716:                     my %usertypetext = (
                   9717:                         official   => 'institutional',
                   9718:                         unofficial => 'non-institutional',
                   9719:                     );
1.799     bisitz   9720:                     $new_user_create = '<p class="LC_warning">'
                   9721:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   9722:                                       .' '
                   9723:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   9724:                                           ,'<a href="'.$helplink.'">','</a>')
                   9725:                                       .'</p><br />';
1.627     raeburn  9726:                 }
1.576     raeburn  9727:             }
                   9728:         }
                   9729: 
1.556     raeburn  9730:         $newuserscript = <<"ENDSCRIPT";
                   9731: 
1.570     raeburn  9732: function setSearch(createnew,callingForm) {
1.556     raeburn  9733:     if (createnew == 1) {
1.570     raeburn  9734:         for (var i=0; i<callingForm.srchby.length; i++) {
                   9735:             if (callingForm.srchby.options[i].value == 'uname') {
                   9736:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  9737:             }
                   9738:         }
1.570     raeburn  9739:         for (var i=0; i<callingForm.srchin.length; i++) {
                   9740:             if ( callingForm.srchin.options[i].value == 'dom') {
                   9741: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  9742:             }
                   9743:         }
1.570     raeburn  9744:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   9745:             if (callingForm.srchtype.options[i].value == 'exact') {
                   9746:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  9747:             }
                   9748:         }
1.570     raeburn  9749:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  9750:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  9751:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  9752:             }
                   9753:         }
                   9754:     }
                   9755: }
                   9756: ENDSCRIPT
1.558     albertel 9757: 
1.556     raeburn  9758:     }
                   9759: 
1.555     raeburn  9760:     my $output = <<"END_BLOCK";
1.556     raeburn  9761: <script type="text/javascript">
1.824     bisitz   9762: // <![CDATA[
1.570     raeburn  9763: function validateEntry(callingForm) {
1.558     albertel 9764: 
1.556     raeburn  9765:     var checkok = 1;
1.558     albertel 9766:     var srchin;
1.570     raeburn  9767:     for (var i=0; i<callingForm.srchin.length; i++) {
                   9768: 	if ( callingForm.srchin[i].checked ) {
                   9769: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 9770: 	}
                   9771:     }
                   9772: 
1.570     raeburn  9773:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   9774:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   9775:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   9776:     var srchterm =  callingForm.srchterm.value;
                   9777:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  9778:     var msg = "";
                   9779: 
                   9780:     if (srchterm == "") {
                   9781:         checkok = 0;
1.1075.2.98  raeburn  9782:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  9783:     }
                   9784: 
1.569     raeburn  9785:     if (srchtype== 'begins') {
                   9786:         if (srchterm.length < 2) {
                   9787:             checkok = 0;
1.1075.2.98  raeburn  9788:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  9789:         }
                   9790:     }
                   9791: 
1.556     raeburn  9792:     if (srchtype== 'contains') {
                   9793:         if (srchterm.length < 3) {
                   9794:             checkok = 0;
1.1075.2.98  raeburn  9795:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  9796:         }
                   9797:     }
                   9798:     if (srchin == 'instd') {
                   9799:         if (srchdomain == '') {
                   9800:             checkok = 0;
1.1075.2.98  raeburn  9801:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  9802:         }
                   9803:     }
                   9804:     if (srchin == 'dom') {
                   9805:         if (srchdomain == '') {
                   9806:             checkok = 0;
1.1075.2.98  raeburn  9807:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  9808:         }
                   9809:     }
                   9810:     if (srchby == 'lastfirst') {
                   9811:         if (srchterm.indexOf(",") == -1) {
                   9812:             checkok = 0;
1.1075.2.98  raeburn  9813:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  9814:         }
                   9815:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   9816:             checkok = 0;
1.1075.2.98  raeburn  9817:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  9818:         }
                   9819:     }
                   9820:     if (checkok == 0) {
1.1075.2.98  raeburn  9821:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  9822:         return;
                   9823:     }
                   9824:     if (checkok == 1) {
1.570     raeburn  9825:         callingForm.submit();
1.556     raeburn  9826:     }
                   9827: }
                   9828: 
                   9829: $newuserscript
                   9830: 
1.824     bisitz   9831: // ]]>
1.556     raeburn  9832: </script>
1.558     albertel 9833: 
                   9834: $new_user_create
                   9835: 
1.555     raeburn  9836: END_BLOCK
1.558     albertel 9837: 
1.876     raeburn  9838:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  9839:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  9840:                $domform.
                   9841:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  9842:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  9843:                $srchbysel.
                   9844:                $srchtypesel. 
                   9845:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   9846:                $srchinsel.
                   9847:                &Apache::lonhtmlcommon::row_closure(1). 
                   9848:                &Apache::lonhtmlcommon::end_pick_box().
                   9849:                '<br />';
1.1075.2.114  raeburn  9850:     return ($output,1);
1.555     raeburn  9851: }
                   9852: 
1.612     raeburn  9853: sub user_rule_check {
1.615     raeburn  9854:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  9855:     my ($response,%inst_response);
1.612     raeburn  9856:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  9857:         if (keys(%{$usershash}) > 1) {
                   9858:             my (%by_username,%by_id,%userdoms);
                   9859:             my $checkid;
1.612     raeburn  9860:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  9861:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   9862:                     $checkid = 1;
                   9863:                 }
                   9864:             }
                   9865:             foreach my $user (keys(%{$usershash})) {
                   9866:                 my ($uname,$udom) = split(/:/,$user);
                   9867:                 if ($checkid) {
                   9868:                     if (ref($usershash->{$user}) eq 'HASH') {
                   9869:                         if ($usershash->{$user}->{'id'} ne '') {
                   9870:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   9871:                             $userdoms{$udom} = 1;
                   9872:                             if (ref($inst_results) eq 'HASH') {
                   9873:                                 $inst_results->{$uname.':'.$udom} = {};
                   9874:                             }
                   9875:                         }
                   9876:                     }
                   9877:                 } else {
                   9878:                     $by_username{$udom}{$uname} = 1;
                   9879:                     $userdoms{$udom} = 1;
                   9880:                     if (ref($inst_results) eq 'HASH') {
                   9881:                         $inst_results->{$uname.':'.$udom} = {};
                   9882:                     }
                   9883:                 }
                   9884:             }
                   9885:             foreach my $udom (keys(%userdoms)) {
                   9886:                 if (!$got_rules->{$udom}) {
                   9887:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   9888:                                                              ['usercreation'],$udom);
                   9889:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   9890:                         foreach my $item ('username','id') {
                   9891:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   9892:                                 $$curr_rules{$udom}{$item} =
                   9893:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   9894:                             }
                   9895:                         }
                   9896:                     }
                   9897:                     $got_rules->{$udom} = 1;
                   9898:                 }
                   9899:             }
                   9900:             if ($checkid) {
                   9901:                 foreach my $udom (keys(%by_id)) {
                   9902:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   9903:                     if ($outcome eq 'ok') {
                   9904:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   9905:                             my $uname = $by_id{$udom}{$id};
                   9906:                             $inst_response{$uname.':'.$udom} = $outcome;
                   9907:                         }
                   9908:                         if (ref($results) eq 'HASH') {
                   9909:                             foreach my $uname (keys(%{$results})) {
                   9910:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   9911:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   9912:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   9913:                                 }
                   9914:                             }
                   9915:                         }
                   9916:                     }
1.612     raeburn  9917:                 }
1.615     raeburn  9918:             } else {
1.1075.2.99  raeburn  9919:                 foreach my $udom (keys(%by_username)) {
                   9920:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   9921:                     if ($outcome eq 'ok') {
                   9922:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   9923:                             $inst_response{$uname.':'.$udom} = $outcome;
                   9924:                         }
                   9925:                         if (ref($results) eq 'HASH') {
                   9926:                             foreach my $uname (keys(%{$results})) {
                   9927:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   9928:                             }
                   9929:                         }
                   9930:                     }
                   9931:                 }
1.612     raeburn  9932:             }
1.1075.2.99  raeburn  9933:         } elsif (keys(%{$usershash}) == 1) {
                   9934:             my $user = (keys(%{$usershash}))[0];
                   9935:             my ($uname,$udom) = split(/:/,$user);
                   9936:             if (($udom ne '') && ($uname ne '')) {
                   9937:                 if (ref($usershash->{$user}) eq 'HASH') {
                   9938:                     if (ref($checks) eq 'HASH') {
                   9939:                         if (defined($checks->{'username'})) {
                   9940:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   9941:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   9942:                         } elsif (defined($checks->{'id'})) {
                   9943:                             if ($usershash->{$user}->{'id'} ne '') {
                   9944:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   9945:                                     &Apache::lonnet::get_instuser($udom,undef,
                   9946:                                                                   $usershash->{$user}->{'id'});
                   9947:                             } else {
                   9948:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   9949:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   9950:                             }
                   9951:                         }
                   9952:                     } else {
                   9953:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   9954:                             &Apache::lonnet::get_instuser($udom,$uname);
                   9955:                        return;
                   9956:                     }
                   9957:                     if (!$got_rules->{$udom}) {
                   9958:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   9959:                                                                  ['usercreation'],$udom);
                   9960:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   9961:                             foreach my $item ('username','id') {
                   9962:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   9963:                                    $$curr_rules{$udom}{$item} =
                   9964:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   9965:                                 }
                   9966:                             }
1.585     raeburn  9967:                         }
1.1075.2.99  raeburn  9968:                         $got_rules->{$udom} = 1;
1.585     raeburn  9969:                     }
                   9970:                 }
1.1075.2.99  raeburn  9971:             } else {
                   9972:                 return;
                   9973:             }
                   9974:         } else {
                   9975:             return;
                   9976:         }
                   9977:         foreach my $user (keys(%{$usershash})) {
                   9978:             my ($uname,$udom) = split(/:/,$user);
                   9979:             next if (($udom eq '') || ($uname eq ''));
                   9980:             my $id;
                   9981:             if (ref($inst_results) eq 'HASH') {
                   9982:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   9983:                     $id = $inst_results->{$user}->{'id'};
                   9984:                 }
                   9985:             }
                   9986:             if ($id eq '') {
                   9987:                 if (ref($usershash->{$user})) {
                   9988:                     $id = $usershash->{$user}->{'id'};
                   9989:                 }
1.585     raeburn  9990:             }
1.612     raeburn  9991:             foreach my $item (keys(%{$checks})) {
                   9992:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   9993:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   9994:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  9995:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   9996:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  9997:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   9998:                                 if ($rule_check{$rule}) {
                   9999:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10000:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10001:                                         if (ref($inst_results) eq 'HASH') {
                   10002:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10003:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10004:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10005:                                                 } elsif ($item eq 'id') {
                   10006:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10007:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10008:                                                     }
1.615     raeburn  10009:                                                 }
1.612     raeburn  10010:                                             }
                   10011:                                         }
1.615     raeburn  10012:                                     }
                   10013:                                     last;
1.585     raeburn  10014:                                 }
                   10015:                             }
                   10016:                         }
                   10017:                     }
                   10018:                 }
                   10019:             }
                   10020:         }
                   10021:     }
1.612     raeburn  10022:     return;
                   10023: }
                   10024: 
                   10025: sub user_rule_formats {
                   10026:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10027:     my %text = ( 
                   10028:                  'username' => 'Usernames',
                   10029:                  'id'       => 'IDs',
                   10030:                );
                   10031:     my $output;
                   10032:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10033:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10034:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10035:             $output = '<br />'.
                   10036:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10037:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10038:                       ' <ul>';
1.612     raeburn  10039:             foreach my $rule (@{$ruleorder}) {
                   10040:                 if (ref($curr_rules) eq 'ARRAY') {
                   10041:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10042:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10043:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10044:                                         $rules->{$rule}{'desc'}.'</li>';
                   10045:                         }
                   10046:                     }
                   10047:                 }
                   10048:             }
                   10049:             $output .= '</ul>';
                   10050:         }
                   10051:     }
                   10052:     return $output;
                   10053: }
                   10054: 
                   10055: sub instrule_disallow_msg {
1.615     raeburn  10056:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10057:     my $response;
                   10058:     my %text = (
                   10059:                   item   => 'username',
                   10060:                   items  => 'usernames',
                   10061:                   match  => 'matches',
                   10062:                   do     => 'does',
                   10063:                   action => 'a username',
                   10064:                   one    => 'one',
                   10065:                );
                   10066:     if ($count > 1) {
                   10067:         $text{'item'} = 'usernames';
                   10068:         $text{'match'} ='match';
                   10069:         $text{'do'} = 'do';
                   10070:         $text{'action'} = 'usernames',
                   10071:         $text{'one'} = 'ones';
                   10072:     }
                   10073:     if ($checkitem eq 'id') {
                   10074:         $text{'items'} = 'IDs';
                   10075:         $text{'item'} = 'ID';
                   10076:         $text{'action'} = 'an ID';
1.615     raeburn  10077:         if ($count > 1) {
                   10078:             $text{'item'} = 'IDs';
                   10079:             $text{'action'} = 'IDs';
                   10080:         }
1.612     raeburn  10081:     }
1.674     bisitz   10082:     $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  10083:     if ($mode eq 'upload') {
                   10084:         if ($checkitem eq 'username') {
                   10085:             $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'}.");
                   10086:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10087:             $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  10088:         }
1.669     raeburn  10089:     } elsif ($mode eq 'selfcreate') {
                   10090:         if ($checkitem eq 'id') {
                   10091:             $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.");
                   10092:         }
1.615     raeburn  10093:     } else {
                   10094:         if ($checkitem eq 'username') {
                   10095:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10096:         } elsif ($checkitem eq 'id') {
                   10097:             $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.");
                   10098:         }
1.612     raeburn  10099:     }
                   10100:     return $response;
1.585     raeburn  10101: }
                   10102: 
1.624     raeburn  10103: sub personal_data_fieldtitles {
                   10104:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10105:                         id => 'Student/Employee ID',
                   10106:                         permanentemail => 'E-mail address',
                   10107:                         lastname => 'Last Name',
                   10108:                         firstname => 'First Name',
                   10109:                         middlename => 'Middle Name',
                   10110:                         generation => 'Generation',
                   10111:                         gen => 'Generation',
1.765     raeburn  10112:                         inststatus => 'Affiliation',
1.624     raeburn  10113:                    );
                   10114:     return %fieldtitles;
                   10115: }
                   10116: 
1.642     raeburn  10117: sub sorted_inst_types {
                   10118:     my ($dom) = @_;
1.1075.2.70  raeburn  10119:     my ($usertypes,$order);
                   10120:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10121:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10122:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10123:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10124:     } else {
                   10125:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10126:     }
1.642     raeburn  10127:     my $othertitle = &mt('All users');
                   10128:     if ($env{'request.course.id'}) {
1.668     raeburn  10129:         $othertitle  = &mt('Any users');
1.642     raeburn  10130:     }
                   10131:     my @types;
                   10132:     if (ref($order) eq 'ARRAY') {
                   10133:         @types = @{$order};
                   10134:     }
                   10135:     if (@types == 0) {
                   10136:         if (ref($usertypes) eq 'HASH') {
                   10137:             @types = sort(keys(%{$usertypes}));
                   10138:         }
                   10139:     }
                   10140:     if (keys(%{$usertypes}) > 0) {
                   10141:         $othertitle = &mt('Other users');
                   10142:     }
                   10143:     return ($othertitle,$usertypes,\@types);
                   10144: }
                   10145: 
1.645     raeburn  10146: sub get_institutional_codes {
                   10147:     my ($settings,$allcourses,$LC_code) = @_;
                   10148: # Get complete list of course sections to update
                   10149:     my @currsections = ();
                   10150:     my @currxlists = ();
                   10151:     my $coursecode = $$settings{'internal.coursecode'};
                   10152: 
                   10153:     if ($$settings{'internal.sectionnums'} ne '') {
                   10154:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10155:     }
                   10156: 
                   10157:     if ($$settings{'internal.crosslistings'} ne '') {
                   10158:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10159:     }
                   10160: 
                   10161:     if (@currxlists > 0) {
                   10162:         foreach (@currxlists) {
                   10163:             if (m/^([^:]+):(\w*)$/) {
                   10164:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10165:                     push(@{$allcourses},$1);
1.645     raeburn  10166:                     $$LC_code{$1} = $2;
                   10167:                 }
                   10168:             }
                   10169:         }
                   10170:     }
                   10171:  
                   10172:     if (@currsections > 0) {
                   10173:         foreach (@currsections) {
                   10174:             if (m/^(\w+):(\w*)$/) {
                   10175:                 my $sec = $coursecode.$1;
                   10176:                 my $lc_sec = $2;
                   10177:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10178:                     push(@{$allcourses},$sec);
1.645     raeburn  10179:                     $$LC_code{$sec} = $lc_sec;
                   10180:                 }
                   10181:             }
                   10182:         }
                   10183:     }
                   10184:     return;
                   10185: }
                   10186: 
1.971     raeburn  10187: sub get_standard_codeitems {
                   10188:     return ('Year','Semester','Department','Number','Section');
                   10189: }
                   10190: 
1.112     bowersj2 10191: =pod
                   10192: 
1.780     raeburn  10193: =head1 Slot Helpers
                   10194: 
                   10195: =over 4
                   10196: 
                   10197: =item * sorted_slots()
                   10198: 
1.1040    raeburn  10199: Sorts an array of slot names in order of an optional sort key,
                   10200: default sort is by slot start time (earliest first). 
1.780     raeburn  10201: 
                   10202: Inputs:
                   10203: 
                   10204: =over 4
                   10205: 
                   10206: slotsarr  - Reference to array of unsorted slot names.
                   10207: 
                   10208: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10209: 
1.1040    raeburn  10210: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10211: 
1.549     albertel 10212: =back
                   10213: 
1.780     raeburn  10214: Returns:
                   10215: 
                   10216: =over 4
                   10217: 
1.1040    raeburn  10218: sorted   - An array of slot names sorted by a specified sort key 
                   10219:            (default sort key is start time of the slot).
1.780     raeburn  10220: 
                   10221: =back
                   10222: 
                   10223: =cut
                   10224: 
                   10225: 
                   10226: sub sorted_slots {
1.1040    raeburn  10227:     my ($slotsarr,$slots,$sortkey) = @_;
                   10228:     if ($sortkey eq '') {
                   10229:         $sortkey = 'starttime';
                   10230:     }
1.780     raeburn  10231:     my @sorted;
                   10232:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10233:         @sorted =
                   10234:             sort {
                   10235:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10236:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10237:                      }
                   10238:                      if (ref($slots->{$a})) { return -1;}
                   10239:                      if (ref($slots->{$b})) { return 1;}
                   10240:                      return 0;
                   10241:                  } @{$slotsarr};
                   10242:     }
                   10243:     return @sorted;
                   10244: }
                   10245: 
1.1040    raeburn  10246: =pod
                   10247: 
                   10248: =item * get_future_slots()
                   10249: 
                   10250: Inputs:
                   10251: 
                   10252: =over 4
                   10253: 
                   10254: cnum - course number
                   10255: 
                   10256: cdom - course domain
                   10257: 
                   10258: now - current UNIX time
                   10259: 
                   10260: symb - optional symb
                   10261: 
                   10262: =back
                   10263: 
                   10264: Returns:
                   10265: 
                   10266: =over 4
                   10267: 
                   10268: sorted_reservable - ref to array of student_schedulable slots currently 
                   10269:                     reservable, ordered by end date of reservation period.
                   10270: 
                   10271: reservable_now - ref to hash of student_schedulable slots currently
                   10272:                  reservable.
                   10273: 
                   10274:     Keys in inner hash are:
                   10275:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10276:     (b) endreserve: end date of reservation period.
                   10277:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10278:         selected.
1.1040    raeburn  10279: 
                   10280: sorted_future - ref to array of student_schedulable slots reservable in
                   10281:                 the future, ordered by start date of reservation period.
                   10282: 
                   10283: future_reservable - ref to hash of student_schedulable slots reservable
                   10284:                     in the future.
                   10285: 
                   10286:     Keys in inner hash are:
                   10287:     (a) symb: either blank or symb to which slot use is restricted.
                   10288:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10289:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10290:         selected.
1.1040    raeburn  10291: 
                   10292: =back
                   10293: 
                   10294: =cut
                   10295: 
                   10296: sub get_future_slots {
                   10297:     my ($cnum,$cdom,$now,$symb) = @_;
                   10298:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10299:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10300:     foreach my $slot (keys(%slots)) {
                   10301:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10302:         if ($symb) {
                   10303:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10304:                      ($slots{$slot}->{'symb'} ne $symb));
                   10305:         }
                   10306:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10307:             ($slots{$slot}->{'endtime'} > $now)) {
                   10308:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10309:                 my $userallowed = 0;
                   10310:                 if ($slots{$slot}->{'allowedsections'}) {
                   10311:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10312:                     if (!defined($env{'request.role.sec'})
                   10313:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10314:                         $userallowed=1;
                   10315:                     } else {
                   10316:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10317:                             $userallowed=1;
                   10318:                         }
                   10319:                     }
                   10320:                     unless ($userallowed) {
                   10321:                         if (defined($env{'request.course.groups'})) {
                   10322:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10323:                             foreach my $group (@groups) {
                   10324:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10325:                                     $userallowed=1;
                   10326:                                     last;
                   10327:                                 }
                   10328:                             }
                   10329:                         }
                   10330:                     }
                   10331:                 }
                   10332:                 if ($slots{$slot}->{'allowedusers'}) {
                   10333:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10334:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10335:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10336:                         $userallowed = 1;
                   10337:                     }
                   10338:                 }
                   10339:                 next unless($userallowed);
                   10340:             }
                   10341:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10342:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10343:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10344:             my $uniqueperiod;
                   10345:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10346:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10347:             }
1.1040    raeburn  10348:             if (($startreserve < $now) &&
                   10349:                 (!$endreserve || $endreserve > $now)) {
                   10350:                 my $lastres = $endreserve;
                   10351:                 if (!$lastres) {
                   10352:                     $lastres = $slots{$slot}->{'starttime'};
                   10353:                 }
                   10354:                 $reservable_now{$slot} = {
                   10355:                                            symb       => $symb,
1.1075.2.104  raeburn  10356:                                            endreserve => $lastres,
                   10357:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10358:                                          };
                   10359:             } elsif (($startreserve > $now) &&
                   10360:                      (!$endreserve || $endreserve > $startreserve)) {
                   10361:                 $future_reservable{$slot} = {
                   10362:                                               symb         => $symb,
1.1075.2.104  raeburn  10363:                                               startreserve => $startreserve,
                   10364:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10365:                                             };
                   10366:             }
                   10367:         }
                   10368:     }
                   10369:     my @unsorted_reservable = keys(%reservable_now);
                   10370:     if (@unsorted_reservable > 0) {
                   10371:         @sorted_reservable = 
                   10372:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10373:     }
                   10374:     my @unsorted_future = keys(%future_reservable);
                   10375:     if (@unsorted_future > 0) {
                   10376:         @sorted_future =
                   10377:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10378:     }
                   10379:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10380: }
1.780     raeburn  10381: 
                   10382: =pod
                   10383: 
1.1057    foxr     10384: =back
                   10385: 
1.549     albertel 10386: =head1 HTTP Helpers
                   10387: 
                   10388: =over 4
                   10389: 
1.648     raeburn  10390: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10391: 
1.258     albertel 10392: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10393: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10394: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10395: 
                   10396: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10397: $possible_names is an ref to an array of form element names.  As an example:
                   10398: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10399: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10400: 
                   10401: =cut
1.1       albertel 10402: 
1.6       albertel 10403: sub get_unprocessed_cgi {
1.25      albertel 10404:   my ($query,$possible_names)= @_;
1.26      matthew  10405:   # $Apache::lonxml::debug=1;
1.356     albertel 10406:   foreach my $pair (split(/&/,$query)) {
                   10407:     my ($name, $value) = split(/=/,$pair);
1.369     www      10408:     $name = &unescape($name);
1.25      albertel 10409:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10410:       $value =~ tr/+/ /;
                   10411:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10412:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10413:     }
1.16      harris41 10414:   }
1.6       albertel 10415: }
                   10416: 
1.112     bowersj2 10417: =pod
                   10418: 
1.648     raeburn  10419: =item * &cacheheader() 
1.112     bowersj2 10420: 
                   10421: returns cache-controlling header code
                   10422: 
                   10423: =cut
                   10424: 
1.7       albertel 10425: sub cacheheader {
1.258     albertel 10426:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10427:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10428:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10429:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10430:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10431:     return $output;
1.7       albertel 10432: }
                   10433: 
1.112     bowersj2 10434: =pod
                   10435: 
1.648     raeburn  10436: =item * &no_cache($r) 
1.112     bowersj2 10437: 
                   10438: specifies header code to not have cache
                   10439: 
                   10440: =cut
                   10441: 
1.9       albertel 10442: sub no_cache {
1.216     albertel 10443:     my ($r) = @_;
                   10444:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10445: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10446:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10447:     $r->no_cache(1);
                   10448:     $r->header_out("Expires" => $date);
                   10449:     $r->header_out("Pragma" => "no-cache");
1.123     www      10450: }
                   10451: 
                   10452: sub content_type {
1.181     albertel 10453:     my ($r,$type,$charset) = @_;
1.299     foxr     10454:     if ($r) {
                   10455: 	#  Note that printout.pl calls this with undef for $r.
                   10456: 	&no_cache($r);
                   10457:     }
1.258     albertel 10458:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10459:     unless ($charset) {
                   10460: 	$charset=&Apache::lonlocal::current_encoding;
                   10461:     }
                   10462:     if ($charset) { $type.='; charset='.$charset; }
                   10463:     if ($r) {
                   10464: 	$r->content_type($type);
                   10465:     } else {
                   10466: 	print("Content-type: $type\n\n");
                   10467:     }
1.9       albertel 10468: }
1.25      albertel 10469: 
1.112     bowersj2 10470: =pod
                   10471: 
1.648     raeburn  10472: =item * &add_to_env($name,$value) 
1.112     bowersj2 10473: 
1.258     albertel 10474: adds $name to the %env hash with value
1.112     bowersj2 10475: $value, if $name already exists, the entry is converted to an array
                   10476: reference and $value is added to the array.
                   10477: 
                   10478: =cut
                   10479: 
1.25      albertel 10480: sub add_to_env {
                   10481:   my ($name,$value)=@_;
1.258     albertel 10482:   if (defined($env{$name})) {
                   10483:     if (ref($env{$name})) {
1.25      albertel 10484:       #already have multiple values
1.258     albertel 10485:       push(@{ $env{$name} },$value);
1.25      albertel 10486:     } else {
                   10487:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10488:       my $first=$env{$name};
                   10489:       undef($env{$name});
                   10490:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10491:     }
                   10492:   } else {
1.258     albertel 10493:     $env{$name}=$value;
1.25      albertel 10494:   }
1.31      albertel 10495: }
1.149     albertel 10496: 
                   10497: =pod
                   10498: 
1.648     raeburn  10499: =item * &get_env_multiple($name) 
1.149     albertel 10500: 
1.258     albertel 10501: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10502: values may be defined and end up as an array ref.
                   10503: 
                   10504: returns an array of values
                   10505: 
                   10506: =cut
                   10507: 
                   10508: sub get_env_multiple {
                   10509:     my ($name) = @_;
                   10510:     my @values;
1.258     albertel 10511:     if (defined($env{$name})) {
1.149     albertel 10512:         # exists is it an array
1.258     albertel 10513:         if (ref($env{$name})) {
                   10514:             @values=@{ $env{$name} };
1.149     albertel 10515:         } else {
1.258     albertel 10516:             $values[0]=$env{$name};
1.149     albertel 10517:         }
                   10518:     }
                   10519:     return(@values);
                   10520: }
                   10521: 
1.660     raeburn  10522: sub ask_for_embedded_content {
                   10523:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10524:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10525:         %currsubfile,%unused,$rem);
1.1071    raeburn  10526:     my $counter = 0;
                   10527:     my $numnew = 0;
1.987     raeburn  10528:     my $numremref = 0;
                   10529:     my $numinvalid = 0;
                   10530:     my $numpathchg = 0;
                   10531:     my $numexisting = 0;
1.1071    raeburn  10532:     my $numunused = 0;
                   10533:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10534:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10535:     my $heading = &mt('Upload embedded files');
                   10536:     my $buttontext = &mt('Upload');
                   10537: 
1.1075.2.11  raeburn  10538:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10539:         if ($actionurl eq '/adm/dependencies') {
                   10540:             $navmap = Apache::lonnavmaps::navmap->new();
                   10541:         }
                   10542:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10543:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10544:     }
1.1075.2.35  raeburn  10545:     if (($actionurl eq '/adm/portfolio') ||
                   10546:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10547:         my $current_path='/';
                   10548:         if ($env{'form.currentpath'}) {
                   10549:             $current_path = $env{'form.currentpath'};
                   10550:         }
                   10551:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10552:             $udom = $cdom;
                   10553:             $uname = $cnum;
1.984     raeburn  10554:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10555:         } else {
                   10556:             $udom = $env{'user.domain'};
                   10557:             $uname = $env{'user.name'};
                   10558:             $url = '/userfiles/portfolio';
                   10559:         }
1.987     raeburn  10560:         $toplevel = $url.'/';
1.984     raeburn  10561:         $url .= $current_path;
                   10562:         $getpropath = 1;
1.987     raeburn  10563:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10564:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10565:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10566:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10567:         $toplevel = $url;
1.984     raeburn  10568:         if ($rest ne '') {
1.987     raeburn  10569:             $url .= $rest;
                   10570:         }
                   10571:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10572:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10573:             $url = $args->{'docs_url'};
                   10574:             $toplevel = $url;
1.1075.2.11  raeburn  10575:             if ($args->{'context'} eq 'paste') {
                   10576:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10577:                 ($path) =
                   10578:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10579:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10580:                 $fileloc =~ s{^/}{};
                   10581:             }
1.1071    raeburn  10582:         }
                   10583:     } elsif ($actionurl eq '/adm/dependencies') {
                   10584:         if ($env{'request.course.id'} ne '') {
                   10585:             if (ref($args) eq 'HASH') {
                   10586:                 $url = $args->{'docs_url'};
                   10587:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10588:                 $toplevel = $url;
                   10589:                 unless ($toplevel =~ m{^/}) {
                   10590:                     $toplevel = "/$url";
                   10591:                 }
1.1075.2.11  raeburn  10592:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10593:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10594:                     $path = $1;
                   10595:                 } else {
                   10596:                     ($path) =
                   10597:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10598:                 }
1.1075.2.79  raeburn  10599:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10600:                     $fileloc = $toplevel;
                   10601:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10602:                     my ($udom,$uname,$fname) =
                   10603:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10604:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10605:                 } else {
                   10606:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10607:                 }
1.1071    raeburn  10608:                 $fileloc =~ s{^/}{};
                   10609:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10610:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10611:             }
1.987     raeburn  10612:         }
1.1075.2.35  raeburn  10613:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10614:         $udom = $cdom;
                   10615:         $uname = $cnum;
                   10616:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10617:         $toplevel = $url;
                   10618:         $path = $url;
                   10619:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10620:         $fileloc =~ s{^/}{};
                   10621:     }
                   10622:     foreach my $file (keys(%{$allfiles})) {
                   10623:         my $embed_file;
                   10624:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10625:             $embed_file = $1;
                   10626:         } else {
                   10627:             $embed_file = $file;
                   10628:         }
1.1075.2.55  raeburn  10629:         my ($absolutepath,$cleaned_file);
                   10630:         if ($embed_file =~ m{^\w+://}) {
                   10631:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10632:             $newfiles{$cleaned_file} = 1;
                   10633:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10634:         } else {
1.1075.2.55  raeburn  10635:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10636:             if ($embed_file =~ m{^/}) {
                   10637:                 $absolutepath = $embed_file;
                   10638:             }
1.1075.2.47  raeburn  10639:             if ($cleaned_file =~ m{/}) {
                   10640:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10641:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10642:                 my $item = $fname;
                   10643:                 if ($path ne '') {
                   10644:                     $item = $path.'/'.$fname;
                   10645:                     $subdependencies{$path}{$fname} = 1;
                   10646:                 } else {
                   10647:                     $dependencies{$item} = 1;
                   10648:                 }
                   10649:                 if ($absolutepath) {
                   10650:                     $mapping{$item} = $absolutepath;
                   10651:                 } else {
                   10652:                     $mapping{$item} = $embed_file;
                   10653:                 }
                   10654:             } else {
                   10655:                 $dependencies{$embed_file} = 1;
                   10656:                 if ($absolutepath) {
1.1075.2.47  raeburn  10657:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10658:                 } else {
1.1075.2.47  raeburn  10659:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10660:                 }
                   10661:             }
1.984     raeburn  10662:         }
                   10663:     }
1.1071    raeburn  10664:     my $dirptr = 16384;
1.984     raeburn  10665:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10666:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10667:         if (($actionurl eq '/adm/portfolio') ||
                   10668:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10669:             my ($sublistref,$listerror) =
                   10670:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10671:             if (ref($sublistref) eq 'ARRAY') {
                   10672:                 foreach my $line (@{$sublistref}) {
                   10673:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10674:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10675:                 }
1.984     raeburn  10676:             }
1.987     raeburn  10677:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10678:             if (opendir(my $dir,$url.'/'.$path)) {
                   10679:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10680:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10681:             }
1.1075.2.11  raeburn  10682:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10683:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10684:                   ($args->{'context'} eq 'paste')) ||
                   10685:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10686:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10687:                 my $dir;
                   10688:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10689:                     $dir = $fileloc;
                   10690:                 } else {
                   10691:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10692:                 }
1.1071    raeburn  10693:                 if ($dir ne '') {
                   10694:                     my ($sublistref,$listerror) =
                   10695:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10696:                     if (ref($sublistref) eq 'ARRAY') {
                   10697:                         foreach my $line (@{$sublistref}) {
                   10698:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10699:                                 undef,$mtime)=split(/\&/,$line,12);
                   10700:                             unless (($testdir&$dirptr) ||
                   10701:                                     ($file_name =~ /^\.\.?$/)) {
                   10702:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10703:                             }
                   10704:                         }
                   10705:                     }
                   10706:                 }
1.984     raeburn  10707:             }
                   10708:         }
                   10709:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10710:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10711:                 my $item = $path.'/'.$file;
                   10712:                 unless ($mapping{$item} eq $item) {
                   10713:                     $pathchanges{$item} = 1;
                   10714:                 }
                   10715:                 $existing{$item} = 1;
                   10716:                 $numexisting ++;
                   10717:             } else {
                   10718:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  10719:             }
                   10720:         }
1.1071    raeburn  10721:         if ($actionurl eq '/adm/dependencies') {
                   10722:             foreach my $path (keys(%currsubfile)) {
                   10723:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   10724:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   10725:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  10726:                              next if (($rem ne '') &&
                   10727:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   10728:                                        (ref($navmap) &&
                   10729:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   10730:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10731:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  10732:                              $unused{$path.'/'.$file} = 1; 
                   10733:                          }
                   10734:                     }
                   10735:                 }
                   10736:             }
                   10737:         }
1.984     raeburn  10738:     }
1.987     raeburn  10739:     my %currfile;
1.1075.2.35  raeburn  10740:     if (($actionurl eq '/adm/portfolio') ||
                   10741:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  10742:         my ($dirlistref,$listerror) =
                   10743:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   10744:         if (ref($dirlistref) eq 'ARRAY') {
                   10745:             foreach my $line (@{$dirlistref}) {
                   10746:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   10747:                 $currfile{$file_name} = 1;
                   10748:             }
1.984     raeburn  10749:         }
1.987     raeburn  10750:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10751:         if (opendir(my $dir,$url)) {
1.987     raeburn  10752:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  10753:             map {$currfile{$_} = 1;} @dir_list;
                   10754:         }
1.1075.2.11  raeburn  10755:     } elsif (($actionurl eq '/adm/dependencies') ||
                   10756:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10757:               ($args->{'context'} eq 'paste')) ||
                   10758:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10759:         if ($env{'request.course.id'} ne '') {
                   10760:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10761:             if ($dir ne '') {
                   10762:                 my ($dirlistref,$listerror) =
                   10763:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   10764:                 if (ref($dirlistref) eq 'ARRAY') {
                   10765:                     foreach my $line (@{$dirlistref}) {
                   10766:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   10767:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   10768:                         unless (($testdir&$dirptr) ||
                   10769:                                 ($file_name =~ /^\.\.?$/)) {
                   10770:                             $currfile{$file_name} = [$size,$mtime];
                   10771:                         }
                   10772:                     }
                   10773:                 }
                   10774:             }
                   10775:         }
1.984     raeburn  10776:     }
                   10777:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  10778:         if (exists($currfile{$file})) {
1.987     raeburn  10779:             unless ($mapping{$file} eq $file) {
                   10780:                 $pathchanges{$file} = 1;
                   10781:             }
                   10782:             $existing{$file} = 1;
                   10783:             $numexisting ++;
                   10784:         } else {
1.984     raeburn  10785:             $newfiles{$file} = 1;
                   10786:         }
                   10787:     }
1.1071    raeburn  10788:     foreach my $file (keys(%currfile)) {
                   10789:         unless (($file eq $filename) ||
                   10790:                 ($file eq $filename.'.bak') ||
                   10791:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  10792:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  10793:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   10794:                     next if (($rem ne '') &&
                   10795:                              (($env{"httpref.$rem".$file} ne '') ||
                   10796:                               (ref($navmap) &&
                   10797:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   10798:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10799:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   10800:                 }
1.1075.2.11  raeburn  10801:             }
1.1071    raeburn  10802:             $unused{$file} = 1;
                   10803:         }
                   10804:     }
1.1075.2.11  raeburn  10805:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   10806:         ($args->{'context'} eq 'paste')) {
                   10807:         $counter = scalar(keys(%existing));
                   10808:         $numpathchg = scalar(keys(%pathchanges));
                   10809:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  10810:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   10811:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   10812:         $counter = scalar(keys(%existing));
                   10813:         $numpathchg = scalar(keys(%pathchanges));
                   10814:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  10815:     }
1.984     raeburn  10816:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  10817:         if ($actionurl eq '/adm/dependencies') {
                   10818:             next if ($embed_file =~ m{^\w+://});
                   10819:         }
1.660     raeburn  10820:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  10821:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  10822:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  10823:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  10824:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   10825:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  10826:         }
1.1075.2.35  raeburn  10827:         $upload_output .= '</td>';
1.1071    raeburn  10828:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  10829:             $upload_output.='<td align="right">'.
                   10830:                             '<span class="LC_info LC_fontsize_medium">'.
                   10831:                             &mt("URL points to web address").'</span>';
1.987     raeburn  10832:             $numremref++;
1.660     raeburn  10833:         } elsif ($args->{'error_on_invalid_names'}
                   10834:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  10835:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   10836:                             &mt('Invalid characters').'</span>';
1.987     raeburn  10837:             $numinvalid++;
1.660     raeburn  10838:         } else {
1.1075.2.35  raeburn  10839:             $upload_output .= '<td>'.
                   10840:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  10841:                                                      $embed_file,\%mapping,
1.1071    raeburn  10842:                                                      $allfiles,$codebase,'upload');
                   10843:             $counter ++;
                   10844:             $numnew ++;
1.987     raeburn  10845:         }
                   10846:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   10847:     }
                   10848:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  10849:         if ($actionurl eq '/adm/dependencies') {
                   10850:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   10851:             $modify_output .= &start_data_table_row().
                   10852:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   10853:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   10854:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   10855:                               '<td>'.$size.'</td>'.
                   10856:                               '<td>'.$mtime.'</td>'.
                   10857:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   10858:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   10859:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   10860:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   10861:                               &embedded_file_element('upload_embedded',$counter,
                   10862:                                                      $embed_file,\%mapping,
                   10863:                                                      $allfiles,$codebase,'modify').
                   10864:                               '</div></td>'.
                   10865:                               &end_data_table_row()."\n";
                   10866:             $counter ++;
                   10867:         } else {
                   10868:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  10869:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   10870:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   10871:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  10872:                               &Apache::loncommon::end_data_table_row()."\n";
                   10873:         }
                   10874:     }
                   10875:     my $delidx = $counter;
                   10876:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   10877:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   10878:         $delete_output .= &start_data_table_row().
                   10879:                           '<td><img src="'.&icon($oldfile).'" />'.
                   10880:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   10881:                           '<td>'.$size.'</td>'.
                   10882:                           '<td>'.$mtime.'</td>'.
                   10883:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   10884:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   10885:                           &embedded_file_element('upload_embedded',$delidx,
                   10886:                                                  $oldfile,\%mapping,$allfiles,
                   10887:                                                  $codebase,'delete').'</td>'.
                   10888:                           &end_data_table_row()."\n"; 
                   10889:         $numunused ++;
                   10890:         $delidx ++;
1.987     raeburn  10891:     }
                   10892:     if ($upload_output) {
                   10893:         $upload_output = &start_data_table().
                   10894:                          $upload_output.
                   10895:                          &end_data_table()."\n";
                   10896:     }
1.1071    raeburn  10897:     if ($modify_output) {
                   10898:         $modify_output = &start_data_table().
                   10899:                          &start_data_table_header_row().
                   10900:                          '<th>'.&mt('File').'</th>'.
                   10901:                          '<th>'.&mt('Size (KB)').'</th>'.
                   10902:                          '<th>'.&mt('Modified').'</th>'.
                   10903:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   10904:                          &end_data_table_header_row().
                   10905:                          $modify_output.
                   10906:                          &end_data_table()."\n";
                   10907:     }
                   10908:     if ($delete_output) {
                   10909:         $delete_output = &start_data_table().
                   10910:                          &start_data_table_header_row().
                   10911:                          '<th>'.&mt('File').'</th>'.
                   10912:                          '<th>'.&mt('Size (KB)').'</th>'.
                   10913:                          '<th>'.&mt('Modified').'</th>'.
                   10914:                          '<th>'.&mt('Delete?').'</th>'.
                   10915:                          &end_data_table_header_row().
                   10916:                          $delete_output.
                   10917:                          &end_data_table()."\n";
                   10918:     }
1.987     raeburn  10919:     my $applies = 0;
                   10920:     if ($numremref) {
                   10921:         $applies ++;
                   10922:     }
                   10923:     if ($numinvalid) {
                   10924:         $applies ++;
                   10925:     }
                   10926:     if ($numexisting) {
                   10927:         $applies ++;
                   10928:     }
1.1071    raeburn  10929:     if ($counter || $numunused) {
1.987     raeburn  10930:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   10931:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  10932:                   $state.'<h3>'.$heading.'</h3>'; 
                   10933:         if ($actionurl eq '/adm/dependencies') {
                   10934:             if ($numnew) {
                   10935:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   10936:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   10937:                            $upload_output.'<br />'."\n";
                   10938:             }
                   10939:             if ($numexisting) {
                   10940:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   10941:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   10942:                            $modify_output.'<br />'."\n";
                   10943:                            $buttontext = &mt('Save changes');
                   10944:             }
                   10945:             if ($numunused) {
                   10946:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   10947:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   10948:                            $delete_output.'<br />'."\n";
                   10949:                            $buttontext = &mt('Save changes');
                   10950:             }
                   10951:         } else {
                   10952:             $output .= $upload_output.'<br />'."\n";
                   10953:         }
                   10954:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   10955:                    $counter.'" />'."\n";
                   10956:         if ($actionurl eq '/adm/dependencies') { 
                   10957:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   10958:                        $numnew.'" />'."\n";
                   10959:         } elsif ($actionurl eq '') {
1.987     raeburn  10960:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   10961:         }
                   10962:     } elsif ($applies) {
                   10963:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   10964:         if ($applies > 1) {
                   10965:             $output .=  
1.1075.2.35  raeburn  10966:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  10967:             if ($numremref) {
                   10968:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   10969:             }
                   10970:             if ($numinvalid) {
                   10971:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   10972:             }
                   10973:             if ($numexisting) {
                   10974:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   10975:             }
                   10976:             $output .= '</ul><br />';
                   10977:         } elsif ($numremref) {
                   10978:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   10979:         } elsif ($numinvalid) {
                   10980:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   10981:         } elsif ($numexisting) {
                   10982:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   10983:         }
                   10984:         $output .= $upload_output.'<br />';
                   10985:     }
                   10986:     my ($pathchange_output,$chgcount);
1.1071    raeburn  10987:     $chgcount = $counter;
1.987     raeburn  10988:     if (keys(%pathchanges) > 0) {
                   10989:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  10990:             if ($counter) {
1.987     raeburn  10991:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   10992:                                                   $embed_file,\%mapping,
1.1071    raeburn  10993:                                                   $allfiles,$codebase,'change');
1.987     raeburn  10994:             } else {
                   10995:                 $pathchange_output .= 
                   10996:                     &start_data_table_row().
                   10997:                     '<td><input type ="checkbox" name="namechange" value="'.
                   10998:                     $chgcount.'" checked="checked" /></td>'.
                   10999:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11000:                     '<td>'.$embed_file.
                   11001:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11002:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11003:                     '</td>'.&end_data_table_row();
1.660     raeburn  11004:             }
1.987     raeburn  11005:             $numpathchg ++;
                   11006:             $chgcount ++;
1.660     raeburn  11007:         }
                   11008:     }
1.1075.2.35  raeburn  11009:     if (($counter) || ($numunused)) {
1.987     raeburn  11010:         if ($numpathchg) {
                   11011:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11012:                        $numpathchg.'" />'."\n";
                   11013:         }
                   11014:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11015:             ($actionurl eq '/adm/imsimport')) {
                   11016:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11017:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11018:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11019:         } elsif ($actionurl eq '/adm/dependencies') {
                   11020:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11021:         }
1.1075.2.35  raeburn  11022:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11023:     } elsif ($numpathchg) {
                   11024:         my %pathchange = ();
                   11025:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11026:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11027:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11028:         }
1.987     raeburn  11029:     }
1.1071    raeburn  11030:     return ($output,$counter,$numpathchg);
1.987     raeburn  11031: }
                   11032: 
1.1075.2.47  raeburn  11033: =pod
                   11034: 
                   11035: =item * clean_path($name)
                   11036: 
                   11037: Performs clean-up of directories, subdirectories and filename in an
                   11038: embedded object, referenced in an HTML file which is being uploaded
                   11039: to a course or portfolio, where
                   11040: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11041: checked.
                   11042: 
                   11043: Clean-up is similar to replacements in lonnet::clean_filename()
                   11044: except each / between sub-directory and next level is preserved.
                   11045: 
                   11046: =cut
                   11047: 
                   11048: sub clean_path {
                   11049:     my ($embed_file) = @_;
                   11050:     $embed_file =~s{^/+}{};
                   11051:     my @contents;
                   11052:     if ($embed_file =~ m{/}) {
                   11053:         @contents = split(/\//,$embed_file);
                   11054:     } else {
                   11055:         @contents = ($embed_file);
                   11056:     }
                   11057:     my $lastidx = scalar(@contents)-1;
                   11058:     for (my $i=0; $i<=$lastidx; $i++) {
                   11059:         $contents[$i]=~s{\\}{/}g;
                   11060:         $contents[$i]=~s/\s+/\_/g;
                   11061:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11062:         if ($i == $lastidx) {
                   11063:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11064:         }
                   11065:     }
                   11066:     if ($lastidx > 0) {
                   11067:         return join('/',@contents);
                   11068:     } else {
                   11069:         return $contents[0];
                   11070:     }
                   11071: }
                   11072: 
1.987     raeburn  11073: sub embedded_file_element {
1.1071    raeburn  11074:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11075:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11076:                    (ref($codebase) eq 'HASH'));
                   11077:     my $output;
1.1071    raeburn  11078:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11079:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11080:     }
                   11081:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11082:                &escape($embed_file).'" />';
                   11083:     unless (($context eq 'upload_embedded') && 
                   11084:             ($mapping->{$embed_file} eq $embed_file)) {
                   11085:         $output .='
                   11086:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11087:     }
                   11088:     my $attrib;
                   11089:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11090:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11091:     }
                   11092:     $output .=
                   11093:         "\n\t\t".
                   11094:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11095:         $attrib.'" />';
                   11096:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11097:         $output .=
                   11098:             "\n\t\t".
                   11099:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11100:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11101:     }
1.987     raeburn  11102:     return $output;
1.660     raeburn  11103: }
                   11104: 
1.1071    raeburn  11105: sub get_dependency_details {
                   11106:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11107:     my ($size,$mtime,$showsize,$showmtime);
                   11108:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11109:         if ($embed_file =~ m{/}) {
                   11110:             my ($path,$fname) = split(/\//,$embed_file);
                   11111:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11112:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11113:             }
                   11114:         } else {
                   11115:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11116:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11117:             }
                   11118:         }
                   11119:         $showsize = $size/1024.0;
                   11120:         $showsize = sprintf("%.1f",$showsize);
                   11121:         if ($mtime > 0) {
                   11122:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11123:         }
                   11124:     }
                   11125:     return ($showsize,$showmtime);
                   11126: }
                   11127: 
                   11128: sub ask_embedded_js {
                   11129:     return <<"END";
                   11130: <script type="text/javascript"">
                   11131: // <![CDATA[
                   11132: function toggleBrowse(counter) {
                   11133:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11134:     var fileid = document.getElementById('embedded_item_'+counter);
                   11135:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11136:     if (chkboxid.checked == true) {
                   11137:         uploaddivid.style.display='block';
                   11138:     } else {
                   11139:         uploaddivid.style.display='none';
                   11140:         fileid.value = '';
                   11141:     }
                   11142: }
                   11143: // ]]>
                   11144: </script>
                   11145: 
                   11146: END
                   11147: }
                   11148: 
1.661     raeburn  11149: sub upload_embedded {
                   11150:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11151:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11152:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11153:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11154:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11155:         my $orig_uploaded_filename =
                   11156:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11157:         foreach my $type ('orig','ref','attrib','codebase') {
                   11158:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11159:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11160:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11161:             }
                   11162:         }
1.661     raeburn  11163:         my ($path,$fname) =
                   11164:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11165:         # no path, whole string is fname
                   11166:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11167:         $fname = &Apache::lonnet::clean_filename($fname);
                   11168:         # See if there is anything left
                   11169:         next if ($fname eq '');
                   11170: 
                   11171:         # Check if file already exists as a file or directory.
                   11172:         my ($state,$msg);
                   11173:         if ($context eq 'portfolio') {
                   11174:             my $port_path = $dirpath;
                   11175:             if ($group ne '') {
                   11176:                 $port_path = "groups/$group/$port_path";
                   11177:             }
1.987     raeburn  11178:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11179:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11180:                                               $dir_root,$port_path,$disk_quota,
                   11181:                                               $current_disk_usage,$uname,$udom);
                   11182:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11183:                 || $state eq 'file_locked') {
1.661     raeburn  11184:                 $output .= $msg;
                   11185:                 next;
                   11186:             }
                   11187:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11188:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11189:             if ($state eq 'exists') {
                   11190:                 $output .= $msg;
                   11191:                 next;
                   11192:             }
                   11193:         }
                   11194:         # Check if extension is valid
                   11195:         if (($fname =~ /\.(\w+)$/) &&
                   11196:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11197:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11198:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11199:             next;
                   11200:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11201:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11202:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11203:             next;
                   11204:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11205:             $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  11206:             next;
                   11207:         }
                   11208:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11209:         my $subdir = $path;
                   11210:         $subdir =~ s{/+$}{};
1.661     raeburn  11211:         if ($context eq 'portfolio') {
1.984     raeburn  11212:             my $result;
                   11213:             if ($state eq 'existingfile') {
                   11214:                 $result=
                   11215:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11216:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11217:             } else {
1.984     raeburn  11218:                 $result=
                   11219:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11220:                                                     $dirpath.
1.1075.2.35  raeburn  11221:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11222:                 if ($result !~ m|^/uploaded/|) {
                   11223:                     $output .= '<span class="LC_error">'
                   11224:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11225:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11226:                                .'</span><br />';
                   11227:                     next;
                   11228:                 } else {
1.987     raeburn  11229:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11230:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11231:                 }
1.661     raeburn  11232:             }
1.1075.2.35  raeburn  11233:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11234:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11235:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11236:             my $result =
1.1075.2.35  raeburn  11237:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11238:             if ($result !~ m|^/uploaded/|) {
                   11239:                 $output .= '<span class="LC_error">'
                   11240:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11241:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11242:                            .'</span><br />';
                   11243:                     next;
                   11244:             } else {
                   11245:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11246:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11247:                 if ($context eq 'syllabus') {
                   11248:                     &Apache::lonnet::make_public_indefinitely($result);
                   11249:                 }
1.987     raeburn  11250:             }
1.661     raeburn  11251:         } else {
                   11252: # Save the file
                   11253:             my $target = $env{'form.embedded_item_'.$i};
                   11254:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11255:             my $dest = $fullpath.$fname;
                   11256:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11257:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11258:             my $count;
                   11259:             my $filepath = $dir_root;
1.1027    raeburn  11260:             foreach my $subdir (@parts) {
                   11261:                 $filepath .= "/$subdir";
                   11262:                 if (!-e $filepath) {
1.661     raeburn  11263:                     mkdir($filepath,0770);
                   11264:                 }
                   11265:             }
                   11266:             my $fh;
                   11267:             if (!open($fh,'>'.$dest)) {
                   11268:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11269:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11270:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11271:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11272:                            '</span><br />';
                   11273:             } else {
                   11274:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11275:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11276:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11277:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11278:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11279:                               '</span><br />';
                   11280:                 } else {
1.987     raeburn  11281:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11282:                                $url.'</span>').'<br />';
                   11283:                     unless ($context eq 'testbank') {
                   11284:                         $footer .= &mt('View embedded file: [_1]',
                   11285:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11286:                     }
                   11287:                 }
                   11288:                 close($fh);
                   11289:             }
                   11290:         }
                   11291:         if ($env{'form.embedded_ref_'.$i}) {
                   11292:             $pathchange{$i} = 1;
                   11293:         }
                   11294:     }
                   11295:     if ($output) {
                   11296:         $output = '<p>'.$output.'</p>';
                   11297:     }
                   11298:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11299:     $returnflag = 'ok';
1.1071    raeburn  11300:     my $numpathchgs = scalar(keys(%pathchange));
                   11301:     if ($numpathchgs > 0) {
1.987     raeburn  11302:         if ($context eq 'portfolio') {
                   11303:             $output .= '<p>'.&mt('or').'</p>';
                   11304:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11305:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11306:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11307:             $returnflag = 'modify_orightml';
                   11308:         }
                   11309:     }
1.1071    raeburn  11310:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11311: }
                   11312: 
                   11313: sub modify_html_form {
                   11314:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11315:     my $end = 0;
                   11316:     my $modifyform;
                   11317:     if ($context eq 'upload_embedded') {
                   11318:         return unless (ref($pathchange) eq 'HASH');
                   11319:         if ($env{'form.number_embedded_items'}) {
                   11320:             $end += $env{'form.number_embedded_items'};
                   11321:         }
                   11322:         if ($env{'form.number_pathchange_items'}) {
                   11323:             $end += $env{'form.number_pathchange_items'};
                   11324:         }
                   11325:         if ($end) {
                   11326:             for (my $i=0; $i<$end; $i++) {
                   11327:                 if ($i < $env{'form.number_embedded_items'}) {
                   11328:                     next unless($pathchange->{$i});
                   11329:                 }
                   11330:                 $modifyform .=
                   11331:                     &start_data_table_row().
                   11332:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11333:                     'checked="checked" /></td>'.
                   11334:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11335:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11336:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11337:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11338:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11339:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11340:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11341:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11342:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11343:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11344:                     &end_data_table_row();
1.1071    raeburn  11345:             }
1.987     raeburn  11346:         }
                   11347:     } else {
                   11348:         $modifyform = $pathchgtable;
                   11349:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11350:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11351:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11352:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11353:         }
                   11354:     }
                   11355:     if ($modifyform) {
1.1071    raeburn  11356:         if ($actionurl eq '/adm/dependencies') {
                   11357:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11358:         }
1.987     raeburn  11359:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11360:                '<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".
                   11361:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11362:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11363:                '</ol></p>'."\n".'<p>'.
                   11364:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11365:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11366:                &start_data_table()."\n".
                   11367:                &start_data_table_header_row().
                   11368:                '<th>'.&mt('Change?').'</th>'.
                   11369:                '<th>'.&mt('Current reference').'</th>'.
                   11370:                '<th>'.&mt('Required reference').'</th>'.
                   11371:                &end_data_table_header_row()."\n".
                   11372:                $modifyform.
                   11373:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11374:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11375:                '</form>'."\n";
                   11376:     }
                   11377:     return;
                   11378: }
                   11379: 
                   11380: sub modify_html_refs {
1.1075.2.35  raeburn  11381:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11382:     my $container;
                   11383:     if ($context eq 'portfolio') {
                   11384:         $container = $env{'form.container'};
                   11385:     } elsif ($context eq 'coursedoc') {
                   11386:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11387:     } elsif ($context eq 'manage_dependencies') {
                   11388:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11389:         $container = "/$container";
1.1075.2.35  raeburn  11390:     } elsif ($context eq 'syllabus') {
                   11391:         $container = $url;
1.987     raeburn  11392:     } else {
1.1027    raeburn  11393:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11394:     }
                   11395:     my (%allfiles,%codebase,$output,$content);
                   11396:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11397:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11398:         if (wantarray) {
                   11399:             return ('',0,0); 
                   11400:         } else {
                   11401:             return;
                   11402:         }
                   11403:     }
                   11404:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11405:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11406:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11407:             if (wantarray) {
                   11408:                 return ('',0,0);
                   11409:             } else {
                   11410:                 return;
                   11411:             }
                   11412:         } 
1.987     raeburn  11413:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11414:         if ($content eq '-1') {
                   11415:             if (wantarray) {
                   11416:                 return ('',0,0);
                   11417:             } else {
                   11418:                 return;
                   11419:             }
                   11420:         }
1.987     raeburn  11421:     } else {
1.1071    raeburn  11422:         unless ($container =~ /^\Q$dir_root\E/) {
                   11423:             if (wantarray) {
                   11424:                 return ('',0,0);
                   11425:             } else {
                   11426:                 return;
                   11427:             }
                   11428:         } 
1.1075.2.128  raeburn  11429:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11430:             $content = join('', <$fh>);
                   11431:             close($fh);
                   11432:         } else {
1.1071    raeburn  11433:             if (wantarray) {
                   11434:                 return ('',0,0);
                   11435:             } else {
                   11436:                 return;
                   11437:             }
1.987     raeburn  11438:         }
                   11439:     }
                   11440:     my ($count,$codebasecount) = (0,0);
                   11441:     my $mm = new File::MMagic;
                   11442:     my $mime_type = $mm->checktype_contents($content);
                   11443:     if ($mime_type eq 'text/html') {
                   11444:         my $parse_result = 
                   11445:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11446:                                                     \%codebase,\$content);
                   11447:         if ($parse_result eq 'ok') {
                   11448:             foreach my $i (@changes) {
                   11449:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11450:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11451:                 if ($allfiles{$ref}) {
                   11452:                     my $newname =  $orig;
                   11453:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11454:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11455:                     if ($attrib_regexp =~ /:/) {
                   11456:                         $attrib_regexp =~ s/\:/|/g;
                   11457:                     }
                   11458:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11459:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11460:                         $count += $numchg;
1.1075.2.35  raeburn  11461:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11462:                         delete($allfiles{$ref});
1.987     raeburn  11463:                     }
                   11464:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11465:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11466:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11467:                         $codebasecount ++;
                   11468:                     }
                   11469:                 }
                   11470:             }
1.1075.2.35  raeburn  11471:             my $skiprewrites;
1.987     raeburn  11472:             if ($count || $codebasecount) {
                   11473:                 my $saveresult;
1.1071    raeburn  11474:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11475:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11476:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11477:                     if ($url eq $container) {
                   11478:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11479:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11480:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11481:                                             $fname.'</span>').'</p>';
1.987     raeburn  11482:                     } else {
                   11483:                          $output = '<p class="LC_error">'.
                   11484:                                    &mt('Error: update failed for: [_1].',
                   11485:                                    '<span class="LC_filename">'.
                   11486:                                    $container.'</span>').'</p>';
                   11487:                     }
1.1075.2.35  raeburn  11488:                     if ($context eq 'syllabus') {
                   11489:                         unless ($saveresult eq 'ok') {
                   11490:                             $skiprewrites = 1;
                   11491:                         }
                   11492:                     }
1.987     raeburn  11493:                 } else {
1.1075.2.128  raeburn  11494:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11495:                         print $fh $content;
                   11496:                         close($fh);
                   11497:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11498:                                   $count,'<span class="LC_filename">'.
                   11499:                                   $container.'</span>').'</p>';
1.661     raeburn  11500:                     } else {
1.987     raeburn  11501:                          $output = '<p class="LC_error">'.
                   11502:                                    &mt('Error: could not update [_1].',
                   11503:                                    '<span class="LC_filename">'.
                   11504:                                    $container.'</span>').'</p>';
1.661     raeburn  11505:                     }
                   11506:                 }
                   11507:             }
1.1075.2.35  raeburn  11508:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11509:                 my ($actionurl,$state);
                   11510:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11511:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11512:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11513:                                               \%codebase,
                   11514:                                               {'context' => 'rewrites',
                   11515:                                                'ignore_remote_references' => 1,});
                   11516:                 if (ref($mapping) eq 'HASH') {
                   11517:                     my $rewrites = 0;
                   11518:                     foreach my $key (keys(%{$mapping})) {
                   11519:                         next if ($key =~ m{^https?://});
                   11520:                         my $ref = $mapping->{$key};
                   11521:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11522:                         my $attrib;
                   11523:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11524:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11525:                         }
                   11526:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11527:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11528:                             $rewrites += $numchg;
                   11529:                         }
                   11530:                     }
                   11531:                     if ($rewrites) {
                   11532:                         my $saveresult;
                   11533:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11534:                         if ($url eq $container) {
                   11535:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11536:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11537:                                             $count,'<span class="LC_filename">'.
                   11538:                                             $fname.'</span>').'</p>';
                   11539:                         } else {
                   11540:                             $output .= '<p class="LC_error">'.
                   11541:                                        &mt('Error: could not update links in [_1].',
                   11542:                                        '<span class="LC_filename">'.
                   11543:                                        $container.'</span>').'</p>';
                   11544: 
                   11545:                         }
                   11546:                     }
                   11547:                 }
                   11548:             }
1.987     raeburn  11549:         } else {
                   11550:             &logthis('Failed to parse '.$container.
                   11551:                      ' to modify references: '.$parse_result);
1.661     raeburn  11552:         }
                   11553:     }
1.1071    raeburn  11554:     if (wantarray) {
                   11555:         return ($output,$count,$codebasecount);
                   11556:     } else {
                   11557:         return $output;
                   11558:     }
1.661     raeburn  11559: }
                   11560: 
                   11561: sub check_for_existing {
                   11562:     my ($path,$fname,$element) = @_;
                   11563:     my ($state,$msg);
                   11564:     if (-d $path.'/'.$fname) {
                   11565:         $state = 'exists';
                   11566:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11567:     } elsif (-e $path.'/'.$fname) {
                   11568:         $state = 'exists';
                   11569:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11570:     }
                   11571:     if ($state eq 'exists') {
                   11572:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11573:     }
                   11574:     return ($state,$msg);
                   11575: }
                   11576: 
                   11577: sub check_for_upload {
                   11578:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11579:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11580:     my $filesize = length($env{'form.'.$element});
                   11581:     if (!$filesize) {
                   11582:         my $msg = '<span class="LC_error">'.
                   11583:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11584:                       '<span class="LC_filename">'.$fname.'</span>',
                   11585:                       $filesize).'<br />'.
1.1007    raeburn  11586:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11587:                   '</span>';
                   11588:         return ('zero_bytes',$msg);
                   11589:     }
                   11590:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11591:     my $getpropath = 1;
1.1021    raeburn  11592:     my ($dirlistref,$listerror) =
                   11593:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11594:     my $found_file = 0;
                   11595:     my $locked_file = 0;
1.991     raeburn  11596:     my @lockers;
                   11597:     my $navmap;
                   11598:     if ($env{'request.course.id'}) {
                   11599:         $navmap = Apache::lonnavmaps::navmap->new();
                   11600:     }
1.1021    raeburn  11601:     if (ref($dirlistref) eq 'ARRAY') {
                   11602:         foreach my $line (@{$dirlistref}) {
                   11603:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11604:             if ($file_name eq $fname){
                   11605:                 $file_name = $path.$file_name;
                   11606:                 if ($group ne '') {
                   11607:                     $file_name = $group.$file_name;
                   11608:                 }
                   11609:                 $found_file = 1;
                   11610:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11611:                     foreach my $lock (@lockers) {
                   11612:                         if (ref($lock) eq 'ARRAY') {
                   11613:                             my ($symb,$crsid) = @{$lock};
                   11614:                             if ($crsid eq $env{'request.course.id'}) {
                   11615:                                 if (ref($navmap)) {
                   11616:                                     my $res = $navmap->getBySymb($symb);
                   11617:                                     foreach my $part (@{$res->parts()}) { 
                   11618:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11619:                                         unless (($slot_status == $res->RESERVED) ||
                   11620:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11621:                                             $locked_file = 1;
                   11622:                                         }
1.991     raeburn  11623:                                     }
1.1021    raeburn  11624:                                 } else {
                   11625:                                     $locked_file = 1;
1.991     raeburn  11626:                                 }
                   11627:                             } else {
                   11628:                                 $locked_file = 1;
                   11629:                             }
                   11630:                         }
1.1021    raeburn  11631:                    }
                   11632:                 } else {
                   11633:                     my @info = split(/\&/,$rest);
                   11634:                     my $currsize = $info[6]/1000;
                   11635:                     if ($currsize < $filesize) {
                   11636:                         my $extra = $filesize - $currsize;
                   11637:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11638:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11639:                                       &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
1.1075.2.69  raeburn  11640:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11641:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11642:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11643:                             return ('will_exceed_quota',$msg);
                   11644:                         }
1.984     raeburn  11645:                     }
                   11646:                 }
1.661     raeburn  11647:             }
                   11648:         }
                   11649:     }
                   11650:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11651:         my $msg = '<p class="LC_warning">'.
                   11652:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11653:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11654:         return ('will_exceed_quota',$msg);
                   11655:     } elsif ($found_file) {
                   11656:         if ($locked_file) {
1.1075.2.69  raeburn  11657:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11658:             $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
1.1075.2.69  raeburn  11659:             $msg .= '</p>';
1.661     raeburn  11660:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11661:             return ('file_locked',$msg);
                   11662:         } else {
1.1075.2.69  raeburn  11663:             my $msg = '<p class="LC_error">';
1.984     raeburn  11664:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1075.2.69  raeburn  11665:             $msg .= '</p>';
1.984     raeburn  11666:             return ('existingfile',$msg);
1.661     raeburn  11667:         }
                   11668:     }
                   11669: }
                   11670: 
1.987     raeburn  11671: sub check_for_traversal {
                   11672:     my ($path,$url,$toplevel) = @_;
                   11673:     my @parts=split(/\//,$path);
                   11674:     my $cleanpath;
                   11675:     my $fullpath = $url;
                   11676:     for (my $i=0;$i<@parts;$i++) {
                   11677:         next if ($parts[$i] eq '.');
                   11678:         if ($parts[$i] eq '..') {
                   11679:             $fullpath =~ s{([^/]+/)$}{};
                   11680:         } else {
                   11681:             $fullpath .= $parts[$i].'/';
                   11682:         }
                   11683:     }
                   11684:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11685:         $cleanpath = $1;
                   11686:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11687:         my $curr_toprel = $1;
                   11688:         my @parts = split(/\//,$curr_toprel);
                   11689:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11690:         my @urlparts = split(/\//,$url_toprel);
                   11691:         my $doubledots;
                   11692:         my $startdiff = -1;
                   11693:         for (my $i=0; $i<@urlparts; $i++) {
                   11694:             if ($startdiff == -1) {
                   11695:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11696:                     $startdiff = $i;
                   11697:                     $doubledots .= '../';
                   11698:                 }
                   11699:             } else {
                   11700:                 $doubledots .= '../';
                   11701:             }
                   11702:         }
                   11703:         if ($startdiff > -1) {
                   11704:             $cleanpath = $doubledots;
                   11705:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11706:                 $cleanpath .= $parts[$i].'/';
                   11707:             }
                   11708:         }
                   11709:     }
                   11710:     $cleanpath =~ s{(/)$}{};
                   11711:     return $cleanpath;
                   11712: }
1.31      albertel 11713: 
1.1053    raeburn  11714: sub is_archive_file {
                   11715:     my ($mimetype) = @_;
                   11716:     if (($mimetype eq 'application/octet-stream') ||
                   11717:         ($mimetype eq 'application/x-stuffit') ||
                   11718:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   11719:         return 1;
                   11720:     }
                   11721:     return;
                   11722: }
                   11723: 
                   11724: sub decompress_form {
1.1065    raeburn  11725:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  11726:     my %lt = &Apache::lonlocal::texthash (
                   11727:         this => 'This file is an archive file.',
1.1067    raeburn  11728:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  11729:         itsc => 'Its contents are as follows:',
1.1053    raeburn  11730:         youm => 'You may wish to extract its contents.',
                   11731:         extr => 'Extract contents',
1.1067    raeburn  11732:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   11733:         proa => 'Process automatically?',
1.1053    raeburn  11734:         yes  => 'Yes',
                   11735:         no   => 'No',
1.1067    raeburn  11736:         fold => 'Title for folder containing movie',
                   11737:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  11738:     );
1.1065    raeburn  11739:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  11740:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  11741:     my $info = &list_archive_contents($fileloc,\@paths);
                   11742:     if (@paths) {
                   11743:         foreach my $path (@paths) {
                   11744:             $path =~ s{^/}{};
1.1067    raeburn  11745:             if ($path =~ m{^([^/]+)/$}) {
                   11746:                 $topdir = $1;
                   11747:             }
1.1065    raeburn  11748:             if ($path =~ m{^([^/]+)/}) {
                   11749:                 $toplevel{$1} = $path;
                   11750:             } else {
                   11751:                 $toplevel{$path} = $path;
                   11752:             }
                   11753:         }
                   11754:     }
1.1067    raeburn  11755:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  11756:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  11757:                         "$topdir/media/",
                   11758:                         "$topdir/media/$topdir.mp4",
                   11759:                         "$topdir/media/FirstFrame.png",
                   11760:                         "$topdir/media/player.swf",
                   11761:                         "$topdir/media/swfobject.js",
                   11762:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  11763:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  11764:                          "$topdir/$topdir.mp4",
                   11765:                          "$topdir/$topdir\_config.xml",
                   11766:                          "$topdir/$topdir\_controller.swf",
                   11767:                          "$topdir/$topdir\_embed.css",
                   11768:                          "$topdir/$topdir\_First_Frame.png",
                   11769:                          "$topdir/$topdir\_player.html",
                   11770:                          "$topdir/$topdir\_Thumbnails.png",
                   11771:                          "$topdir/playerProductInstall.swf",
                   11772:                          "$topdir/scripts/",
                   11773:                          "$topdir/scripts/config_xml.js",
                   11774:                          "$topdir/scripts/handlebars.js",
                   11775:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   11776:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   11777:                          "$topdir/scripts/modernizr.js",
                   11778:                          "$topdir/scripts/player-min.js",
                   11779:                          "$topdir/scripts/swfobject.js",
                   11780:                          "$topdir/skins/",
                   11781:                          "$topdir/skins/configuration_express.xml",
                   11782:                          "$topdir/skins/express_show/",
                   11783:                          "$topdir/skins/express_show/player-min.css",
                   11784:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  11785:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   11786:                          "$topdir/$topdir.mp4",
                   11787:                          "$topdir/$topdir\_config.xml",
                   11788:                          "$topdir/$topdir\_controller.swf",
                   11789:                          "$topdir/$topdir\_embed.css",
                   11790:                          "$topdir/$topdir\_First_Frame.png",
                   11791:                          "$topdir/$topdir\_player.html",
                   11792:                          "$topdir/$topdir\_Thumbnails.png",
                   11793:                          "$topdir/playerProductInstall.swf",
                   11794:                          "$topdir/scripts/",
                   11795:                          "$topdir/scripts/config_xml.js",
                   11796:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   11797:                          "$topdir/skins/",
                   11798:                          "$topdir/skins/configuration_express.xml",
                   11799:                          "$topdir/skins/express_show/",
                   11800:                          "$topdir/skins/express_show/spritesheet.min.css",
                   11801:                          "$topdir/skins/express_show/spritesheet.png",
                   11802:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  11803:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  11804:         if (@diffs == 0) {
1.1075.2.59  raeburn  11805:             $is_camtasia = 6;
                   11806:         } else {
1.1075.2.81  raeburn  11807:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  11808:             if (@diffs == 0) {
                   11809:                 $is_camtasia = 8;
1.1075.2.81  raeburn  11810:             } else {
                   11811:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   11812:                 if (@diffs == 0) {
                   11813:                     $is_camtasia = 8;
                   11814:                 }
1.1075.2.59  raeburn  11815:             }
1.1067    raeburn  11816:         }
                   11817:     }
                   11818:     my $output;
                   11819:     if ($is_camtasia) {
                   11820:         $output = <<"ENDCAM";
                   11821: <script type="text/javascript" language="Javascript">
                   11822: // <![CDATA[
                   11823: 
                   11824: function camtasiaToggle() {
                   11825:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   11826:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  11827:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  11828:                 document.getElementById('camtasia_titles').style.display='block';
                   11829:             } else {
                   11830:                 document.getElementById('camtasia_titles').style.display='none';
                   11831:             }
                   11832:         }
                   11833:     }
                   11834:     return;
                   11835: }
                   11836: 
                   11837: // ]]>
                   11838: </script>
                   11839: <p>$lt{'camt'}</p>
                   11840: ENDCAM
1.1065    raeburn  11841:     } else {
1.1067    raeburn  11842:         $output = '<p>'.$lt{'this'};
                   11843:         if ($info eq '') {
                   11844:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   11845:         } else {
                   11846:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   11847:                        '<div><pre>'.$info.'</pre></div>';
                   11848:         }
1.1065    raeburn  11849:     }
1.1067    raeburn  11850:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  11851:     my $duplicates;
                   11852:     my $num = 0;
                   11853:     if (ref($dirlist) eq 'ARRAY') {
                   11854:         foreach my $item (@{$dirlist}) {
                   11855:             if (ref($item) eq 'ARRAY') {
                   11856:                 if (exists($toplevel{$item->[0]})) {
                   11857:                     $duplicates .= 
                   11858:                         &start_data_table_row().
                   11859:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   11860:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   11861:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   11862:                         'value="1" />'.&mt('Yes').'</label>'.
                   11863:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   11864:                         '<td>'.$item->[0].'</td>';
                   11865:                     if ($item->[2]) {
                   11866:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   11867:                     } else {
                   11868:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   11869:                     }
                   11870:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   11871:                                    '<td>'.
                   11872:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   11873:                                    '</td>'.
                   11874:                                    &end_data_table_row();
                   11875:                     $num ++;
                   11876:                 }
                   11877:             }
                   11878:         }
                   11879:     }
                   11880:     my $itemcount;
                   11881:     if (@paths > 0) {
                   11882:         $itemcount = scalar(@paths);
                   11883:     } else {
                   11884:         $itemcount = 1;
                   11885:     }
1.1067    raeburn  11886:     if ($is_camtasia) {
                   11887:         $output .= $lt{'auto'}.'<br />'.
                   11888:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  11889:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  11890:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   11891:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   11892:                    $lt{'no'}.'</label></span><br />'.
                   11893:                    '<div id="camtasia_titles" style="display:block">'.
                   11894:                    &Apache::lonhtmlcommon::start_pick_box().
                   11895:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   11896:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   11897:                    &Apache::lonhtmlcommon::row_closure().
                   11898:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   11899:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   11900:                    &Apache::lonhtmlcommon::row_closure(1).
                   11901:                    &Apache::lonhtmlcommon::end_pick_box().
                   11902:                    '</div>';
                   11903:     }
1.1065    raeburn  11904:     $output .= 
                   11905:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  11906:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   11907:         "\n";
1.1065    raeburn  11908:     if ($duplicates ne '') {
                   11909:         $output .= '<p><span class="LC_warning">'.
                   11910:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   11911:                    &start_data_table().
                   11912:                    &start_data_table_header_row().
                   11913:                    '<th>'.&mt('Overwrite?').'</th>'.
                   11914:                    '<th>'.&mt('Name').'</th>'.
                   11915:                    '<th>'.&mt('Type').'</th>'.
                   11916:                    '<th>'.&mt('Size').'</th>'.
                   11917:                    '<th>'.&mt('Last modified').'</th>'.
                   11918:                    &end_data_table_header_row().
                   11919:                    $duplicates.
                   11920:                    &end_data_table().
                   11921:                    '</p>';
                   11922:     }
1.1067    raeburn  11923:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  11924:     if (ref($hiddenelements) eq 'HASH') {
                   11925:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   11926:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   11927:         }
                   11928:     }
                   11929:     $output .= <<"END";
1.1067    raeburn  11930: <br />
1.1053    raeburn  11931: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   11932: </form>
                   11933: $noextract
                   11934: END
                   11935:     return $output;
                   11936: }
                   11937: 
1.1065    raeburn  11938: sub decompression_utility {
                   11939:     my ($program) = @_;
                   11940:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   11941:     my $location;
                   11942:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   11943:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   11944:                          '/usr/sbin/') {
                   11945:             if (-x $dir.$program) {
                   11946:                 $location = $dir.$program;
                   11947:                 last;
                   11948:             }
                   11949:         }
                   11950:     }
                   11951:     return $location;
                   11952: }
                   11953: 
                   11954: sub list_archive_contents {
                   11955:     my ($file,$pathsref) = @_;
                   11956:     my (@cmd,$output);
                   11957:     my $needsregexp;
                   11958:     if ($file =~ /\.zip$/) {
                   11959:         @cmd = (&decompression_utility('unzip'),"-l");
                   11960:         $needsregexp = 1;
                   11961:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   11962:              ($file =~ /\.tgz$/)) {
                   11963:         @cmd = (&decompression_utility('tar'),"-ztf");
                   11964:     } elsif ($file =~ /\.tar\.bz2$/) {
                   11965:         @cmd = (&decompression_utility('tar'),"-jtf");
                   11966:     } elsif ($file =~ m|\.tar$|) {
                   11967:         @cmd = (&decompression_utility('tar'),"-tf");
                   11968:     }
                   11969:     if (@cmd) {
                   11970:         undef($!);
                   11971:         undef($@);
                   11972:         if (open(my $fh,"-|", @cmd, $file)) {
                   11973:             while (my $line = <$fh>) {
                   11974:                 $output .= $line;
                   11975:                 chomp($line);
                   11976:                 my $item;
                   11977:                 if ($needsregexp) {
                   11978:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   11979:                 } else {
                   11980:                     $item = $line;
                   11981:                 }
                   11982:                 if ($item ne '') {
                   11983:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   11984:                         push(@{$pathsref},$item);
                   11985:                     } 
                   11986:                 }
                   11987:             }
                   11988:             close($fh);
                   11989:         }
                   11990:     }
                   11991:     return $output;
                   11992: }
                   11993: 
1.1053    raeburn  11994: sub decompress_uploaded_file {
                   11995:     my ($file,$dir) = @_;
                   11996:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   11997:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   11998:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   11999:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12000:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12001:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12002:     my $decompressed = $env{'cgi.decompressed'};
                   12003:     &Apache::lonnet::delenv('cgi.file');
                   12004:     &Apache::lonnet::delenv('cgi.dir');
                   12005:     &Apache::lonnet::delenv('cgi.decompressed');
                   12006:     return ($decompressed,$result);
                   12007: }
                   12008: 
1.1055    raeburn  12009: sub process_decompression {
                   12010:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12011:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12012:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12013:                &mt('Unexpected file path.').'</p>'."\n";
                   12014:     }
                   12015:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12016:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12017:                &mt('Unexpected course context.').'</p>'."\n";
                   12018:     }
                   12019:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12020:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12021:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12022:     }
1.1055    raeburn  12023:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12024:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12025:         $error = &mt('Filename not a supported archive file type.').
                   12026:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12027:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12028:     } else {
                   12029:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12030:         if ($docuhome eq 'no_host') {
                   12031:             $error = &mt('Could not determine home server for course.');
                   12032:         } else {
                   12033:             my @ids=&Apache::lonnet::current_machine_ids();
                   12034:             my $currdir = "$dir_root/$destination";
                   12035:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12036:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12037:                        "$dir_root/$destination";
                   12038:             } else {
                   12039:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12040:                        "$dir_root/$docudom/$docuname/$destination";
                   12041:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12042:                     $error = &mt('Archive file not found.');
                   12043:                 }
                   12044:             }
1.1065    raeburn  12045:             my (@to_overwrite,@to_skip);
                   12046:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12047:                 my $total = $env{'form.archive_overwrite_total'};
                   12048:                 for (my $i=0; $i<$total; $i++) {
                   12049:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12050:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12051:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12052:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12053:                     }
                   12054:                 }
                   12055:             }
                   12056:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12057:             my $numoverwrite = scalar(@to_overwrite);
                   12058:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12059:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12060:             } elsif ($dir eq '') {
1.1055    raeburn  12061:                 $error = &mt('Directory containing archive file unavailable.');
                   12062:             } elsif (!$error) {
1.1065    raeburn  12063:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12064:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12065:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12066:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12067:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12068:                         ($decompressed,$display) =
                   12069:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12070:                         foreach my $item (@to_skip) {
                   12071:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12072:                                 if (-f "$dir/$tempdir/$item") {
                   12073:                                     unlink("$dir/$tempdir/$item");
                   12074:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12075:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12076:                                 }
                   12077:                             }
                   12078:                         }
                   12079:                         foreach my $item (@to_overwrite) {
                   12080:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12081:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12082:                                     if (-f "$dir/$item") {
                   12083:                                         unlink("$dir/$item");
                   12084:                                     } elsif (-d "$dir/$item") {
                   12085:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12086:                                     }
                   12087:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12088:                                 }
1.1065    raeburn  12089:                             }
                   12090:                         }
1.1075.2.128  raeburn  12091:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12092:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12093:                         }
1.1065    raeburn  12094:                     }
                   12095:                 } else {
                   12096:                     ($decompressed,$display) = 
                   12097:                         &decompress_uploaded_file($file,$dir);
                   12098:                 }
1.1055    raeburn  12099:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12100:                     $output = '<p class="LC_info">'.
                   12101:                               &mt('Files extracted successfully from archive.').
                   12102:                               '</p>'."\n";
1.1055    raeburn  12103:                     my ($warning,$result,@contents);
                   12104:                     my ($newdirlistref,$newlisterror) =
                   12105:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12106:                                                  $docuname,1);
                   12107:                     my (%is_dir,%changes,@newitems);
                   12108:                     my $dirptr = 16384;
1.1065    raeburn  12109:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12110:                         foreach my $dir_line (@{$newdirlistref}) {
                   12111:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12112:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12113:                                 push(@newitems,$item);
                   12114:                                 if ($dirptr&$testdir) {
                   12115:                                     $is_dir{$item} = 1;
                   12116:                                 }
                   12117:                                 $changes{$item} = 1;
                   12118:                             }
                   12119:                         }
                   12120:                     }
                   12121:                     if (keys(%changes) > 0) {
                   12122:                         foreach my $item (sort(@newitems)) {
                   12123:                             if ($changes{$item}) {
                   12124:                                 push(@contents,$item);
                   12125:                             }
                   12126:                         }
                   12127:                     }
                   12128:                     if (@contents > 0) {
1.1067    raeburn  12129:                         my $wantform;
                   12130:                         unless ($env{'form.autoextract_camtasia'}) {
                   12131:                             $wantform = 1;
                   12132:                         }
1.1056    raeburn  12133:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12134:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12135:                                                                 $currdir,\%is_dir,
                   12136:                                                                 \%children,\%parent,
1.1056    raeburn  12137:                                                                 \@contents,\%dirorder,
                   12138:                                                                 \%titles,$wantform);
1.1055    raeburn  12139:                         if ($datatable ne '') {
                   12140:                             $output .= &archive_options_form('decompressed',$datatable,
                   12141:                                                              $count,$hiddenelem);
1.1065    raeburn  12142:                             my $startcount = 6;
1.1055    raeburn  12143:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12144:                                                            \%titles,\%children);
1.1055    raeburn  12145:                         }
1.1067    raeburn  12146:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12147:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12148:                             my %displayed;
                   12149:                             my $total = 1;
                   12150:                             $env{'form.archive_directory'} = [];
                   12151:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12152:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12153:                                 $path =~ s{/$}{};
                   12154:                                 my $item;
                   12155:                                 if ($path ne '') {
                   12156:                                     $item = "$path/$titles{$i}";
                   12157:                                 } else {
                   12158:                                     $item = $titles{$i};
                   12159:                                 }
                   12160:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12161:                                 if ($item eq $contents[0]) {
                   12162:                                     push(@{$env{'form.archive_directory'}},$i);
                   12163:                                     $env{'form.archive_'.$i} = 'display';
                   12164:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12165:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12166:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12167:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12168:                                     $env{'form.archive_'.$i} = 'display';
                   12169:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12170:                                     $displayed{'web'} = $i;
                   12171:                                 } else {
1.1075.2.59  raeburn  12172:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12173:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12174:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12175:                                         push(@{$env{'form.archive_directory'}},$i);
                   12176:                                     }
                   12177:                                     $env{'form.archive_'.$i} = 'dependency';
                   12178:                                 }
                   12179:                                 $total ++;
                   12180:                             }
                   12181:                             for (my $i=1; $i<$total; $i++) {
                   12182:                                 next if ($i == $displayed{'web'});
                   12183:                                 next if ($i == $displayed{'folder'});
                   12184:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12185:                             }
                   12186:                             $env{'form.phase'} = 'decompress_cleanup';
                   12187:                             $env{'form.archivedelete'} = 1;
                   12188:                             $env{'form.archive_count'} = $total-1;
                   12189:                             $output .=
                   12190:                                 &process_extracted_files('coursedocs',$docudom,
                   12191:                                                          $docuname,$destination,
                   12192:                                                          $dir_root,$hiddenelem);
                   12193:                         }
1.1055    raeburn  12194:                     } else {
                   12195:                         $warning = &mt('No new items extracted from archive file.');
                   12196:                     }
                   12197:                 } else {
                   12198:                     $output = $display;
                   12199:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12200:                 }
                   12201:             }
                   12202:         }
                   12203:     }
                   12204:     if ($error) {
                   12205:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12206:                    $error.'</p>'."\n";
                   12207:     }
                   12208:     if ($warning) {
                   12209:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12210:     }
                   12211:     return $output;
                   12212: }
                   12213: 
                   12214: sub get_extracted {
1.1056    raeburn  12215:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12216:         $titles,$wantform) = @_;
1.1055    raeburn  12217:     my $count = 0;
                   12218:     my $depth = 0;
                   12219:     my $datatable;
1.1056    raeburn  12220:     my @hierarchy;
1.1055    raeburn  12221:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12222:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12223:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12224:     foreach my $item (@{$contents}) {
                   12225:         $count ++;
1.1056    raeburn  12226:         @{$dirorder->{$count}} = @hierarchy;
                   12227:         $titles->{$count} = $item;
1.1055    raeburn  12228:         &archive_hierarchy($depth,$count,$parent,$children);
                   12229:         if ($wantform) {
                   12230:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12231:                                        $currdir,$depth,$count);
                   12232:         }
                   12233:         if ($is_dir->{$item}) {
                   12234:             $depth ++;
1.1056    raeburn  12235:             push(@hierarchy,$count);
                   12236:             $parent->{$depth} = $count;
1.1055    raeburn  12237:             $datatable .=
                   12238:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12239:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12240:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12241:             $depth --;
1.1056    raeburn  12242:             pop(@hierarchy);
1.1055    raeburn  12243:         }
                   12244:     }
                   12245:     return ($count,$datatable);
                   12246: }
                   12247: 
                   12248: sub recurse_extracted_archive {
1.1056    raeburn  12249:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12250:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12251:     my $result='';
1.1056    raeburn  12252:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12253:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12254:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12255:         return $result;
                   12256:     }
                   12257:     my $dirptr = 16384;
                   12258:     my ($newdirlistref,$newlisterror) =
                   12259:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12260:     if (ref($newdirlistref) eq 'ARRAY') {
                   12261:         foreach my $dir_line (@{$newdirlistref}) {
                   12262:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12263:             unless ($item =~ /^\.+$/) {
                   12264:                 $$count ++;
1.1056    raeburn  12265:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12266:                 $titles->{$$count} = $item;
1.1055    raeburn  12267:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12268: 
1.1055    raeburn  12269:                 my $is_dir;
                   12270:                 if ($dirptr&$testdir) {
                   12271:                     $is_dir = 1;
                   12272:                 }
                   12273:                 if ($wantform) {
                   12274:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12275:                 }
                   12276:                 if ($is_dir) {
                   12277:                     $$depth ++;
1.1056    raeburn  12278:                     push(@{$hierarchy},$$count);
                   12279:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12280:                     $result .=
                   12281:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12282:                                                    $docuname,$depth,$count,
1.1056    raeburn  12283:                                                    $hierarchy,$dirorder,$children,
                   12284:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12285:                     $$depth --;
1.1056    raeburn  12286:                     pop(@{$hierarchy});
1.1055    raeburn  12287:                 }
                   12288:             }
                   12289:         }
                   12290:     }
                   12291:     return $result;
                   12292: }
                   12293: 
                   12294: sub archive_hierarchy {
                   12295:     my ($depth,$count,$parent,$children) =@_;
                   12296:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12297:         if (exists($parent->{$depth})) {
                   12298:              $children->{$parent->{$depth}} .= $count.':';
                   12299:         }
                   12300:     }
                   12301:     return;
                   12302: }
                   12303: 
                   12304: sub archive_row {
                   12305:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12306:     my ($name) = ($item =~ m{([^/]+)$});
                   12307:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12308:                                        'display'    => 'Add as file',
1.1055    raeburn  12309:                                        'dependency' => 'Include as dependency',
                   12310:                                        'discard'    => 'Discard',
                   12311:                                       );
                   12312:     if ($is_dir) {
1.1059    raeburn  12313:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12314:     }
1.1056    raeburn  12315:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12316:     my $offset = 0;
1.1055    raeburn  12317:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12318:         $offset ++;
1.1065    raeburn  12319:         if ($action ne 'display') {
                   12320:             $offset ++;
                   12321:         }  
1.1055    raeburn  12322:         $output .= '<td><span class="LC_nobreak">'.
                   12323:                    '<label><input type="radio" name="archive_'.$count.
                   12324:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12325:         my $text = $choices{$action};
                   12326:         if ($is_dir) {
                   12327:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12328:             if ($action eq 'display') {
1.1059    raeburn  12329:                 $text = &mt('Add as folder');
1.1055    raeburn  12330:             }
1.1056    raeburn  12331:         } else {
                   12332:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12333: 
                   12334:         }
                   12335:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12336:         if ($action eq 'dependency') {
                   12337:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12338:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12339:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12340:                        '<option value=""></option>'."\n".
                   12341:                        '</select>'."\n".
                   12342:                        '</div>';
1.1059    raeburn  12343:         } elsif ($action eq 'display') {
                   12344:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12345:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12346:                        '</div>';
1.1055    raeburn  12347:         }
1.1056    raeburn  12348:         $output .= '</td>';
1.1055    raeburn  12349:     }
                   12350:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12351:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12352:     for (my $i=0; $i<$depth; $i++) {
                   12353:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12354:     }
                   12355:     if ($is_dir) {
                   12356:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12357:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12358:     } else {
                   12359:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12360:     }
                   12361:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12362:                &end_data_table_row();
                   12363:     return $output;
                   12364: }
                   12365: 
                   12366: sub archive_options_form {
1.1065    raeburn  12367:     my ($form,$display,$count,$hiddenelem) = @_;
                   12368:     my %lt = &Apache::lonlocal::texthash(
                   12369:                perm => 'Permanently remove archive file?',
                   12370:                hows => 'How should each extracted item be incorporated in the course?',
                   12371:                cont => 'Content actions for all',
                   12372:                addf => 'Add as folder/file',
                   12373:                incd => 'Include as dependency for a displayed file',
                   12374:                disc => 'Discard',
                   12375:                no   => 'No',
                   12376:                yes  => 'Yes',
                   12377:                save => 'Save',
                   12378:     );
                   12379:     my $output = <<"END";
                   12380: <form name="$form" method="post" action="">
                   12381: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12382: <label>
                   12383:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12384: </label>
                   12385: &nbsp;
                   12386: <label>
                   12387:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12388: </span>
                   12389: </p>
                   12390: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12391: <br />$lt{'hows'}
                   12392: <div class="LC_columnSection">
                   12393:   <fieldset>
                   12394:     <legend>$lt{'cont'}</legend>
                   12395:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12396:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12397:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12398:   </fieldset>
                   12399: </div>
                   12400: END
                   12401:     return $output.
1.1055    raeburn  12402:            &start_data_table()."\n".
1.1065    raeburn  12403:            $display."\n".
1.1055    raeburn  12404:            &end_data_table()."\n".
                   12405:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12406:            $hiddenelem.
1.1065    raeburn  12407:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12408:            '</form>';
                   12409: }
                   12410: 
                   12411: sub archive_javascript {
1.1056    raeburn  12412:     my ($startcount,$numitems,$titles,$children) = @_;
                   12413:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12414:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12415:     my $scripttag = <<START;
                   12416: <script type="text/javascript">
                   12417: // <![CDATA[
                   12418: 
                   12419: function checkAll(form,prefix) {
                   12420:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12421:     for (var i=0; i < form.elements.length; i++) {
                   12422:         var id = form.elements[i].id;
                   12423:         if ((id != '') && (id != undefined)) {
                   12424:             if (idstr.test(id)) {
                   12425:                 if (form.elements[i].type == 'radio') {
                   12426:                     form.elements[i].checked = true;
1.1056    raeburn  12427:                     var nostart = i-$startcount;
1.1059    raeburn  12428:                     var offset = nostart%7;
                   12429:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12430:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12431:                 }
                   12432:             }
                   12433:         }
                   12434:     }
                   12435: }
                   12436: 
                   12437: function propagateCheck(form,count) {
                   12438:     if (count > 0) {
1.1059    raeburn  12439:         var startelement = $startcount + ((count-1) * 7);
                   12440:         for (var j=1; j<6; j++) {
                   12441:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12442:                 var item = startelement + j; 
                   12443:                 if (form.elements[item].type == 'radio') {
                   12444:                     if (form.elements[item].checked) {
                   12445:                         containerCheck(form,count,j);
                   12446:                         break;
                   12447:                     }
1.1055    raeburn  12448:                 }
                   12449:             }
                   12450:         }
                   12451:     }
                   12452: }
                   12453: 
                   12454: numitems = $numitems
1.1056    raeburn  12455: var titles = new Array(numitems);
                   12456: var parents = new Array(numitems);
1.1055    raeburn  12457: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12458:     parents[i] = new Array;
1.1055    raeburn  12459: }
1.1059    raeburn  12460: var maintitle = '$maintitle';
1.1055    raeburn  12461: 
                   12462: START
                   12463: 
1.1056    raeburn  12464:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12465:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12466:         for (my $i=0; $i<@contents; $i ++) {
                   12467:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12468:         }
                   12469:     }
                   12470: 
1.1056    raeburn  12471:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12472:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12473:     }
                   12474: 
1.1055    raeburn  12475:     $scripttag .= <<END;
                   12476: 
                   12477: function containerCheck(form,count,offset) {
                   12478:     if (count > 0) {
1.1056    raeburn  12479:         dependencyCheck(form,count,offset);
1.1059    raeburn  12480:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12481:         form.elements[item].checked = true;
                   12482:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12483:             if (parents[count].length > 0) {
                   12484:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12485:                     containerCheck(form,parents[count][j],offset);
                   12486:                 }
                   12487:             }
                   12488:         }
                   12489:     }
                   12490: }
                   12491: 
                   12492: function dependencyCheck(form,count,offset) {
                   12493:     if (count > 0) {
1.1059    raeburn  12494:         var chosen = (offset+$startcount)+7*(count-1);
                   12495:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12496:         var currtype = form.elements[depitem].type;
                   12497:         if (form.elements[chosen].value == 'dependency') {
                   12498:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12499:             form.elements[depitem].options.length = 0;
                   12500:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12501:             for (var i=1; i<=numitems; i++) {
                   12502:                 if (i == count) {
                   12503:                     continue;
                   12504:                 }
1.1059    raeburn  12505:                 var startelement = $startcount + (i-1) * 7;
                   12506:                 for (var j=1; j<6; j++) {
                   12507:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12508:                         var item = startelement + j;
                   12509:                         if (form.elements[item].type == 'radio') {
                   12510:                             if (form.elements[item].checked) {
                   12511:                                 if (form.elements[item].value == 'display') {
                   12512:                                     var n = form.elements[depitem].options.length;
                   12513:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12514:                                 }
                   12515:                             }
                   12516:                         }
                   12517:                     }
                   12518:                 }
                   12519:             }
                   12520:         } else {
                   12521:             document.getElementById('arc_depon_'+count).style.display='none';
                   12522:             form.elements[depitem].options.length = 0;
                   12523:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12524:         }
1.1059    raeburn  12525:         titleCheck(form,count,offset);
1.1056    raeburn  12526:     }
                   12527: }
                   12528: 
                   12529: function propagateSelect(form,count,offset) {
                   12530:     if (count > 0) {
1.1065    raeburn  12531:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12532:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12533:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12534:             if (parents[count].length > 0) {
                   12535:                 for (var j=0; j<parents[count].length; j++) {
                   12536:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12537:                 }
                   12538:             }
                   12539:         }
                   12540:     }
                   12541: }
1.1056    raeburn  12542: 
                   12543: function containerSelect(form,count,offset,picked) {
                   12544:     if (count > 0) {
1.1065    raeburn  12545:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12546:         if (form.elements[item].type == 'radio') {
                   12547:             if (form.elements[item].value == 'dependency') {
                   12548:                 if (form.elements[item+1].type == 'select-one') {
                   12549:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12550:                         if (form.elements[item+1].options[i].value == picked) {
                   12551:                             form.elements[item+1].selectedIndex = i;
                   12552:                             break;
                   12553:                         }
                   12554:                     }
                   12555:                 }
                   12556:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12557:                     if (parents[count].length > 0) {
                   12558:                         for (var j=0; j<parents[count].length; j++) {
                   12559:                             containerSelect(form,parents[count][j],offset,picked);
                   12560:                         }
                   12561:                     }
                   12562:                 }
                   12563:             }
                   12564:         }
                   12565:     }
                   12566: }
                   12567: 
1.1059    raeburn  12568: function titleCheck(form,count,offset) {
                   12569:     if (count > 0) {
                   12570:         var chosen = (offset+$startcount)+7*(count-1);
                   12571:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12572:         var currtype = form.elements[depitem].type;
                   12573:         if (form.elements[chosen].value == 'display') {
                   12574:             document.getElementById('arc_title_'+count).style.display='block';
                   12575:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12576:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12577:             }
                   12578:         } else {
                   12579:             document.getElementById('arc_title_'+count).style.display='none';
                   12580:             if (currtype == 'text') { 
                   12581:                 document.getElementById('archive_title_'+count).value='';
                   12582:             }
                   12583:         }
                   12584:     }
                   12585:     return;
                   12586: }
                   12587: 
1.1055    raeburn  12588: // ]]>
                   12589: </script>
                   12590: END
                   12591:     return $scripttag;
                   12592: }
                   12593: 
                   12594: sub process_extracted_files {
1.1067    raeburn  12595:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12596:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12597:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12598:     my @ids=&Apache::lonnet::current_machine_ids();
                   12599:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12600:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12601:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12602:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12603:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12604:         $pathtocheck = "$dir_root/$destination";
                   12605:         $dir = $dir_root;
                   12606:         $ishome = 1;
                   12607:     } else {
                   12608:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12609:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12610:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12611:     }
                   12612:     my $currdir = "$dir_root/$destination";
                   12613:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12614:     if ($env{'form.folderpath'}) {
                   12615:         my @items = split('&',$env{'form.folderpath'});
                   12616:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12617:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12618:             $containers{'0'}='page';
                   12619:         } else {
                   12620:             $containers{'0'}='sequence';
                   12621:         }
1.1055    raeburn  12622:     }
                   12623:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12624:     if ($numitems) {
                   12625:         for (my $i=1; $i<=$numitems; $i++) {
                   12626:             my $path = $env{'form.archive_content_'.$i};
                   12627:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12628:                 my $item = $1;
                   12629:                 $toplevelitems{$item} = $i;
                   12630:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12631:                     $is_dir{$item} = 1;
                   12632:                 }
                   12633:             }
                   12634:         }
                   12635:     }
1.1067    raeburn  12636:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12637:     if (keys(%toplevelitems) > 0) {
                   12638:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12639:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12640:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12641:     }
1.1066    raeburn  12642:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12643:     if ($numitems) {
                   12644:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12645:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12646:             my $path = $env{'form.archive_content_'.$i};
                   12647:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12648:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12649:                     if ($prefix ne '' && $path ne '') {
                   12650:                         if (-e $prefix.$path) {
1.1066    raeburn  12651:                             if ((@archdirs > 0) && 
                   12652:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12653:                                 $todeletedir{$prefix.$path} = 1;
                   12654:                             } else {
                   12655:                                 $todelete{$prefix.$path} = 1;
                   12656:                             }
1.1055    raeburn  12657:                         }
                   12658:                     }
                   12659:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12660:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12661:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12662:                     $docstitle = $env{'form.archive_title_'.$i};
                   12663:                     if ($docstitle eq '') {
                   12664:                         $docstitle = $title;
                   12665:                     }
1.1055    raeburn  12666:                     $outer = 0;
1.1056    raeburn  12667:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12668:                         if (@{$dirorder{$i}} > 0) {
                   12669:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12670:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12671:                                     $outer = $item;
                   12672:                                     last;
                   12673:                                 }
                   12674:                             }
                   12675:                         }
                   12676:                     }
                   12677:                     my ($errtext,$fatal) = 
                   12678:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12679:                                                '/'.$folders{$outer}.'.'.
                   12680:                                                $containers{$outer});
                   12681:                     next if ($fatal);
                   12682:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12683:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12684:                             $mapinner{$i} = time;
1.1055    raeburn  12685:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12686:                             $containers{$i} = 'sequence';
                   12687:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12688:                                       $folders{$i}.'.'.$containers{$i};
                   12689:                             my $newidx = &LONCAPA::map::getresidx();
                   12690:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12691:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12692:                             push(@LONCAPA::map::order,$newidx);
                   12693:                             my ($outtext,$errtext) =
                   12694:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12695:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12696:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12697:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12698:                             unless ($errtext) {
1.1075.2.128  raeburn  12699:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12700:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12701:                                             '</li>'."\n";
1.1067    raeburn  12702:                             }
1.1055    raeburn  12703:                         }
                   12704:                     } else {
                   12705:                         if ($context eq 'coursedocs') {
                   12706:                             my $newidx=&LONCAPA::map::getresidx();
                   12707:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12708:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12709:                                       $title;
1.1075.2.128  raeburn  12710:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   12711:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12712:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  12713:                                 }
1.1075.2.128  raeburn  12714:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12715:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12716:                                 }
                   12717:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12718:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   12719:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   12720:                                         unless ($ishome) {
                   12721:                                             my $fetch = "$newdest{$i}/$title";
                   12722:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   12723:                                             $prompttofetch{$fetch} = 1;
                   12724:                                         }
                   12725:                                    }
                   12726:                                 }
                   12727:                                 $LONCAPA::map::resources[$newidx]=
                   12728:                                     $docstitle.':'.$url.':false:normal:res';
                   12729:                                 push(@LONCAPA::map::order, $newidx);
                   12730:                                 my ($outtext,$errtext)=
                   12731:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12732:                                                             $docuname.'/'.$folders{$outer}.
                   12733:                                                             '.'.$containers{$outer},1,1);
                   12734:                                 unless ($errtext) {
                   12735:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   12736:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   12737:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   12738:                                                    '</li>'."\n";
                   12739:                                     }
1.1067    raeburn  12740:                                 }
1.1075.2.128  raeburn  12741:                             } else {
                   12742:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12743:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  12744:                             }
1.1055    raeburn  12745:                         }
                   12746:                     }
1.1075.2.11  raeburn  12747:                 }
                   12748:             } else {
1.1075.2.128  raeburn  12749:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12750:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  12751:             }
                   12752:         }
                   12753:         for (my $i=1; $i<=$numitems; $i++) {
                   12754:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   12755:             my $path = $env{'form.archive_content_'.$i};
                   12756:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12757:                 my ($title) = ($path =~ m{/([^/]+)$});
                   12758:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   12759:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   12760:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12761:                         my ($itemidx,$fullpath,$relpath);
                   12762:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   12763:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  12764:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  12765:                                 if ($dirorder{$i}->[$j] eq $container) {
                   12766:                                     $itemidx = $j;
1.1056    raeburn  12767:                                 }
                   12768:                             }
1.1075.2.11  raeburn  12769:                         }
                   12770:                         if ($itemidx eq '') {
                   12771:                             $itemidx =  0;
                   12772:                         }
                   12773:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   12774:                             if ($mapinner{$referrer{$i}}) {
                   12775:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   12776:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12777:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12778:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12779:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12780:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12781:                                             if (!-e $fullpath) {
                   12782:                                                 mkdir($fullpath,0755);
1.1056    raeburn  12783:                                             }
                   12784:                                         }
1.1075.2.11  raeburn  12785:                                     } else {
                   12786:                                         last;
1.1056    raeburn  12787:                                     }
1.1075.2.11  raeburn  12788:                                 }
                   12789:                             }
                   12790:                         } elsif ($newdest{$referrer{$i}}) {
                   12791:                             $fullpath = $newdest{$referrer{$i}};
                   12792:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12793:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   12794:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   12795:                                     last;
                   12796:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12797:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12798:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12799:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12800:                                         if (!-e $fullpath) {
                   12801:                                             mkdir($fullpath,0755);
1.1056    raeburn  12802:                                         }
                   12803:                                     }
1.1075.2.11  raeburn  12804:                                 } else {
                   12805:                                     last;
1.1056    raeburn  12806:                                 }
1.1075.2.11  raeburn  12807:                             }
                   12808:                         }
                   12809:                         if ($fullpath ne '') {
                   12810:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  12811:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   12812:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   12813:                                 }
1.1075.2.11  raeburn  12814:                             }
                   12815:                             if (-e "$fullpath/$title") {
                   12816:                                 my $showpath;
                   12817:                                 if ($relpath ne '') {
                   12818:                                     $showpath = "$relpath/$title";
                   12819:                                 } else {
                   12820:                                     $showpath = "/$title";
1.1056    raeburn  12821:                                 }
1.1075.2.128  raeburn  12822:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   12823:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   12824:                                            '</li>'."\n";
                   12825:                                 unless ($ishome) {
                   12826:                                     my $fetch = "$fullpath/$title";
                   12827:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   12828:                                     $prompttofetch{$fetch} = 1;
                   12829:                                 }
1.1055    raeburn  12830:                             }
                   12831:                         }
                   12832:                     }
1.1075.2.11  raeburn  12833:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   12834:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  12835:                                     &HTML::Entities::encode($path,'<>&"'),
                   12836:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   12837:                                 '<br />';
1.1055    raeburn  12838:                 }
                   12839:             } else {
1.1075.2.128  raeburn  12840:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12841:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  12842:             }
                   12843:         }
                   12844:         if (keys(%todelete)) {
                   12845:             foreach my $key (keys(%todelete)) {
                   12846:                 unlink($key);
1.1066    raeburn  12847:             }
                   12848:         }
                   12849:         if (keys(%todeletedir)) {
                   12850:             foreach my $key (keys(%todeletedir)) {
                   12851:                 rmdir($key);
                   12852:             }
                   12853:         }
                   12854:         foreach my $dir (sort(keys(%is_dir))) {
                   12855:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   12856:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  12857:             }
                   12858:         }
1.1067    raeburn  12859:         if ($result ne '') {
                   12860:             $output .= '<ul>'."\n".
                   12861:                        $result."\n".
                   12862:                        '</ul>';
                   12863:         }
                   12864:         unless ($ishome) {
                   12865:             my $replicationfail;
                   12866:             foreach my $item (keys(%prompttofetch)) {
                   12867:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   12868:                 unless ($fetchresult eq 'ok') {
                   12869:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   12870:                 }
                   12871:             }
                   12872:             if ($replicationfail) {
                   12873:                 $output .= '<p class="LC_error">'.
                   12874:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   12875:                            $replicationfail.
                   12876:                            '</ul></p>';
                   12877:             }
                   12878:         }
1.1055    raeburn  12879:     } else {
                   12880:         $warning = &mt('No items found in archive.');
                   12881:     }
                   12882:     if ($error) {
                   12883:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12884:                    $error.'</p>'."\n";
                   12885:     }
                   12886:     if ($warning) {
                   12887:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12888:     }
                   12889:     return $output;
                   12890: }
                   12891: 
1.1066    raeburn  12892: sub cleanup_empty_dirs {
                   12893:     my ($path) = @_;
                   12894:     if (($path ne '') && (-d $path)) {
                   12895:         if (opendir(my $dirh,$path)) {
                   12896:             my @dircontents = grep(!/^\./,readdir($dirh));
                   12897:             my $numitems = 0;
                   12898:             foreach my $item (@dircontents) {
                   12899:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  12900:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  12901:                     if (-e "$path/$item") {
                   12902:                         $numitems ++;
                   12903:                     }
                   12904:                 } else {
                   12905:                     $numitems ++;
                   12906:                 }
                   12907:             }
                   12908:             if ($numitems == 0) {
                   12909:                 rmdir($path);
                   12910:             }
                   12911:             closedir($dirh);
                   12912:         }
                   12913:     }
                   12914:     return;
                   12915: }
                   12916: 
1.41      ng       12917: =pod
1.45      matthew  12918: 
1.1075.2.56  raeburn  12919: =item * &get_folder_hierarchy()
1.1068    raeburn  12920: 
                   12921: Provides hierarchy of names of folders/sub-folders containing the current
                   12922: item,
                   12923: 
                   12924: Inputs: 3
                   12925:      - $navmap - navmaps object
                   12926: 
                   12927:      - $map - url for map (either the trigger itself, or map containing
                   12928:                            the resource, which is the trigger).
                   12929: 
                   12930:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   12931: 
                   12932: Outputs: 1 @pathitems - array of folder/subfolder names.
                   12933: 
                   12934: =cut
                   12935: 
                   12936: sub get_folder_hierarchy {
                   12937:     my ($navmap,$map,$showitem) = @_;
                   12938:     my @pathitems;
                   12939:     if (ref($navmap)) {
                   12940:         my $mapres = $navmap->getResourceByUrl($map);
                   12941:         if (ref($mapres)) {
                   12942:             my $pcslist = $mapres->map_hierarchy();
                   12943:             if ($pcslist ne '') {
                   12944:                 my @pcs = split(/,/,$pcslist);
                   12945:                 foreach my $pc (@pcs) {
                   12946:                     if ($pc == 1) {
1.1075.2.38  raeburn  12947:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  12948:                     } else {
                   12949:                         my $res = $navmap->getByMapPc($pc);
                   12950:                         if (ref($res)) {
                   12951:                             my $title = $res->compTitle();
                   12952:                             $title =~ s/\W+/_/g;
                   12953:                             if ($title ne '') {
                   12954:                                 push(@pathitems,$title);
                   12955:                             }
                   12956:                         }
                   12957:                     }
                   12958:                 }
                   12959:             }
1.1071    raeburn  12960:             if ($showitem) {
                   12961:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  12962:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  12963:                 } else {
                   12964:                     my $maptitle = $mapres->compTitle();
                   12965:                     $maptitle =~ s/\W+/_/g;
                   12966:                     if ($maptitle ne '') {
                   12967:                         push(@pathitems,$maptitle);
                   12968:                     }
1.1068    raeburn  12969:                 }
                   12970:             }
                   12971:         }
                   12972:     }
                   12973:     return @pathitems;
                   12974: }
                   12975: 
                   12976: =pod
                   12977: 
1.1015    raeburn  12978: =item * &get_turnedin_filepath()
                   12979: 
                   12980: Determines path in a user's portfolio file for storage of files uploaded
                   12981: to a specific essayresponse or dropbox item.
                   12982: 
                   12983: Inputs: 3 required + 1 optional.
                   12984: $symb is symb for resource, $uname and $udom are for current user (required).
                   12985: $caller is optional (can be "submission", if routine is called when storing
                   12986: an upoaded file when "Submit Answer" button was pressed).
                   12987: 
                   12988: Returns array containing $path and $multiresp. 
                   12989: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   12990: than one file upload item.  Callers of routine should append partid as a 
                   12991: subdirectory to $path in cases where $multiresp is 1.
                   12992: 
                   12993: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   12994: 
                   12995: =cut
                   12996: 
                   12997: sub get_turnedin_filepath {
                   12998:     my ($symb,$uname,$udom,$caller) = @_;
                   12999:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13000:     my $turnindir;
                   13001:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13002:     $turnindir = $userhash{'turnindir'};
                   13003:     my ($path,$multiresp);
                   13004:     if ($turnindir eq '') {
                   13005:         if ($caller eq 'submission') {
                   13006:             $turnindir = &mt('turned in');
                   13007:             $turnindir =~ s/\W+/_/g;
                   13008:             my %newhash = (
                   13009:                             'turnindir' => $turnindir,
                   13010:                           );
                   13011:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13012:         }
                   13013:     }
                   13014:     if ($turnindir ne '') {
                   13015:         $path = '/'.$turnindir.'/';
                   13016:         my ($multipart,$turnin,@pathitems);
                   13017:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13018:         if (defined($navmap)) {
                   13019:             my $mapres = $navmap->getResourceByUrl($map);
                   13020:             if (ref($mapres)) {
                   13021:                 my $pcslist = $mapres->map_hierarchy();
                   13022:                 if ($pcslist ne '') {
                   13023:                     foreach my $pc (split(/,/,$pcslist)) {
                   13024:                         my $res = $navmap->getByMapPc($pc);
                   13025:                         if (ref($res)) {
                   13026:                             my $title = $res->compTitle();
                   13027:                             $title =~ s/\W+/_/g;
                   13028:                             if ($title ne '') {
1.1075.2.48  raeburn  13029:                                 if (($pc > 1) && (length($title) > 12)) {
                   13030:                                     $title = substr($title,0,12);
                   13031:                                 }
1.1015    raeburn  13032:                                 push(@pathitems,$title);
                   13033:                             }
                   13034:                         }
                   13035:                     }
                   13036:                 }
                   13037:                 my $maptitle = $mapres->compTitle();
                   13038:                 $maptitle =~ s/\W+/_/g;
                   13039:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13040:                     if (length($maptitle) > 12) {
                   13041:                         $maptitle = substr($maptitle,0,12);
                   13042:                     }
1.1015    raeburn  13043:                     push(@pathitems,$maptitle);
                   13044:                 }
                   13045:                 unless ($env{'request.state'} eq 'construct') {
                   13046:                     my $res = $navmap->getBySymb($symb);
                   13047:                     if (ref($res)) {
                   13048:                         my $partlist = $res->parts();
                   13049:                         my $totaluploads = 0;
                   13050:                         if (ref($partlist) eq 'ARRAY') {
                   13051:                             foreach my $part (@{$partlist}) {
                   13052:                                 my @types = $res->responseType($part);
                   13053:                                 my @ids = $res->responseIds($part);
                   13054:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13055:                                     if ($types[$i] eq 'essay') {
                   13056:                                         my $partid = $part.'_'.$ids[$i];
                   13057:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13058:                                             $totaluploads ++;
                   13059:                                         }
                   13060:                                     }
                   13061:                                 }
                   13062:                             }
                   13063:                             if ($totaluploads > 1) {
                   13064:                                 $multiresp = 1;
                   13065:                             }
                   13066:                         }
                   13067:                     }
                   13068:                 }
                   13069:             } else {
                   13070:                 return;
                   13071:             }
                   13072:         } else {
                   13073:             return;
                   13074:         }
                   13075:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13076:         $restitle =~ s/\W+/_/g;
                   13077:         if ($restitle eq '') {
                   13078:             $restitle = ($resurl =~ m{/[^/]+$});
                   13079:             if ($restitle eq '') {
                   13080:                 $restitle = time;
                   13081:             }
                   13082:         }
1.1075.2.48  raeburn  13083:         if (length($restitle) > 12) {
                   13084:             $restitle = substr($restitle,0,12);
                   13085:         }
1.1015    raeburn  13086:         push(@pathitems,$restitle);
                   13087:         $path .= join('/',@pathitems);
                   13088:     }
                   13089:     return ($path,$multiresp);
                   13090: }
                   13091: 
                   13092: =pod
                   13093: 
1.464     albertel 13094: =back
1.41      ng       13095: 
1.112     bowersj2 13096: =head1 CSV Upload/Handling functions
1.38      albertel 13097: 
1.41      ng       13098: =over 4
                   13099: 
1.648     raeburn  13100: =item * &upfile_store($r)
1.41      ng       13101: 
                   13102: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13103: needs $env{'form.upfile'}
1.41      ng       13104: returns $datatoken to be put into hidden field
                   13105: 
                   13106: =cut
1.31      albertel 13107: 
                   13108: sub upfile_store {
                   13109:     my $r=shift;
1.258     albertel 13110:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13111:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13112:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13113:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13114: 
1.1075.2.128  raeburn  13115:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13116:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13117:                                      time.'_'.$$);
                   13118:     return if ($datatoken eq '');
                   13119: 
1.31      albertel 13120:     {
1.158     raeburn  13121:         my $datafile = $r->dir_config('lonDaemons').
                   13122:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13123:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13124:             print $fh $env{'form.upfile'};
1.158     raeburn  13125:             close($fh);
                   13126:         }
1.31      albertel 13127:     }
                   13128:     return $datatoken;
                   13129: }
                   13130: 
1.56      matthew  13131: =pod
                   13132: 
1.1075.2.128  raeburn  13133: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13134: 
                   13135: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13136: $datatoken is the name to assign to the temporary file.
1.258     albertel 13137: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13138: 
                   13139: =cut
1.31      albertel 13140: 
                   13141: sub load_tmp_file {
1.1075.2.128  raeburn  13142:     my ($r,$datatoken) = @_;
                   13143:     return if ($datatoken eq '');
1.31      albertel 13144:     my @studentdata=();
                   13145:     {
1.158     raeburn  13146:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13147:                               '/tmp/'.$datatoken.'.tmp';
                   13148:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13149:             @studentdata=<$fh>;
                   13150:             close($fh);
                   13151:         }
1.31      albertel 13152:     }
1.258     albertel 13153:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13154: }
                   13155: 
1.1075.2.128  raeburn  13156: sub valid_datatoken {
                   13157:     my ($datatoken) = @_;
                   13158:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_$match_domain\_$match_courseid\_\d+_\d+$/) {
                   13159:         return $datatoken;
                   13160:     }
                   13161:     return;
                   13162: }
                   13163: 
1.56      matthew  13164: =pod
                   13165: 
1.648     raeburn  13166: =item * &upfile_record_sep()
1.41      ng       13167: 
                   13168: Separate uploaded file into records
                   13169: returns array of records,
1.258     albertel 13170: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13171: 
                   13172: =cut
1.31      albertel 13173: 
                   13174: sub upfile_record_sep {
1.258     albertel 13175:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13176:     } else {
1.248     albertel 13177: 	my @records;
1.258     albertel 13178: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13179: 	    if ($line=~/^\s*$/) { next; }
                   13180: 	    push(@records,$line);
                   13181: 	}
                   13182: 	return @records;
1.31      albertel 13183:     }
                   13184: }
                   13185: 
1.56      matthew  13186: =pod
                   13187: 
1.648     raeburn  13188: =item * &record_sep($record)
1.41      ng       13189: 
1.258     albertel 13190: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13191: 
                   13192: =cut
                   13193: 
1.263     www      13194: sub takeleft {
                   13195:     my $index=shift;
                   13196:     return substr('0000'.$index,-4,4);
                   13197: }
                   13198: 
1.31      albertel 13199: sub record_sep {
                   13200:     my $record=shift;
                   13201:     my %components=();
1.258     albertel 13202:     if ($env{'form.upfiletype'} eq 'xml') {
                   13203:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13204:         my $i=0;
1.356     albertel 13205:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13206:             $field=~s/^(\"|\')//;
                   13207:             $field=~s/(\"|\')$//;
1.263     www      13208:             $components{&takeleft($i)}=$field;
1.31      albertel 13209:             $i++;
                   13210:         }
1.258     albertel 13211:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13212:         my $i=0;
1.356     albertel 13213:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13214:             $field=~s/^(\"|\')//;
                   13215:             $field=~s/(\"|\')$//;
1.263     www      13216:             $components{&takeleft($i)}=$field;
1.31      albertel 13217:             $i++;
                   13218:         }
                   13219:     } else {
1.561     www      13220:         my $separator=',';
1.480     banghart 13221:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13222:             $separator=';';
1.480     banghart 13223:         }
1.31      albertel 13224:         my $i=0;
1.561     www      13225: # the character we are looking for to indicate the end of a quote or a record 
                   13226:         my $looking_for=$separator;
                   13227: # do not add the characters to the fields
                   13228:         my $ignore=0;
                   13229: # we just encountered a separator (or the beginning of the record)
                   13230:         my $just_found_separator=1;
                   13231: # store the field we are working on here
                   13232:         my $field='';
                   13233: # work our way through all characters in record
                   13234:         foreach my $character ($record=~/(.)/g) {
                   13235:             if ($character eq $looking_for) {
                   13236:                if ($character ne $separator) {
                   13237: # Found the end of a quote, again looking for separator
                   13238:                   $looking_for=$separator;
                   13239:                   $ignore=1;
                   13240:                } else {
                   13241: # Found a separator, store away what we got
                   13242:                   $components{&takeleft($i)}=$field;
                   13243: 	          $i++;
                   13244:                   $just_found_separator=1;
                   13245:                   $ignore=0;
                   13246:                   $field='';
                   13247:                }
                   13248:                next;
                   13249:             }
                   13250: # single or double quotation marks after a separator indicate beginning of a quote
                   13251: # we are now looking for the end of the quote and need to ignore separators
                   13252:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13253:                $looking_for=$character;
                   13254:                next;
                   13255:             }
                   13256: # ignore would be true after we reached the end of a quote
                   13257:             if ($ignore) { next; }
                   13258:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13259:             $field.=$character;
                   13260:             $just_found_separator=0; 
1.31      albertel 13261:         }
1.561     www      13262: # catch the very last entry, since we never encountered the separator
                   13263:         $components{&takeleft($i)}=$field;
1.31      albertel 13264:     }
                   13265:     return %components;
                   13266: }
                   13267: 
1.144     matthew  13268: ######################################################
                   13269: ######################################################
                   13270: 
1.56      matthew  13271: =pod
                   13272: 
1.648     raeburn  13273: =item * &upfile_select_html()
1.41      ng       13274: 
1.144     matthew  13275: Return HTML code to select a file from the users machine and specify 
                   13276: the file type.
1.41      ng       13277: 
                   13278: =cut
                   13279: 
1.144     matthew  13280: ######################################################
                   13281: ######################################################
1.31      albertel 13282: sub upfile_select_html {
1.144     matthew  13283:     my %Types = (
                   13284:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13285:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13286:                  space => &mt('Space separated'),
                   13287:                  tab   => &mt('Tabulator separated'),
                   13288: #                 xml   => &mt('HTML/XML'),
                   13289:                  );
                   13290:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13291:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13292:     foreach my $type (sort(keys(%Types))) {
                   13293:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13294:     }
                   13295:     $Str .= "</select>\n";
                   13296:     return $Str;
1.31      albertel 13297: }
                   13298: 
1.301     albertel 13299: sub get_samples {
                   13300:     my ($records,$toget) = @_;
                   13301:     my @samples=({});
                   13302:     my $got=0;
                   13303:     foreach my $rec (@$records) {
                   13304: 	my %temp = &record_sep($rec);
                   13305: 	if (! grep(/\S/, values(%temp))) { next; }
                   13306: 	if (%temp) {
                   13307: 	    $samples[$got]=\%temp;
                   13308: 	    $got++;
                   13309: 	    if ($got == $toget) { last; }
                   13310: 	}
                   13311:     }
                   13312:     return \@samples;
                   13313: }
                   13314: 
1.144     matthew  13315: ######################################################
                   13316: ######################################################
                   13317: 
1.56      matthew  13318: =pod
                   13319: 
1.648     raeburn  13320: =item * &csv_print_samples($r,$records)
1.41      ng       13321: 
                   13322: Prints a table of sample values from each column uploaded $r is an
                   13323: Apache Request ref, $records is an arrayref from
                   13324: &Apache::loncommon::upfile_record_sep
                   13325: 
                   13326: =cut
                   13327: 
1.144     matthew  13328: ######################################################
                   13329: ######################################################
1.31      albertel 13330: sub csv_print_samples {
                   13331:     my ($r,$records) = @_;
1.662     bisitz   13332:     my $samples = &get_samples($records,5);
1.301     albertel 13333: 
1.594     raeburn  13334:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13335:               &start_data_table_header_row());
1.356     albertel 13336:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13337:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13338:     $r->print(&end_data_table_header_row());
1.301     albertel 13339:     foreach my $hash (@$samples) {
1.594     raeburn  13340: 	$r->print(&start_data_table_row());
1.356     albertel 13341: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13342: 	    $r->print('<td>');
1.356     albertel 13343: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13344: 	    $r->print('</td>');
                   13345: 	}
1.594     raeburn  13346: 	$r->print(&end_data_table_row());
1.31      albertel 13347:     }
1.594     raeburn  13348:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13349: }
                   13350: 
1.144     matthew  13351: ######################################################
                   13352: ######################################################
                   13353: 
1.56      matthew  13354: =pod
                   13355: 
1.648     raeburn  13356: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13357: 
                   13358: Prints a table to create associations between values and table columns.
1.144     matthew  13359: 
1.41      ng       13360: $r is an Apache Request ref,
                   13361: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13362: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13363: 
                   13364: =cut
                   13365: 
1.144     matthew  13366: ######################################################
                   13367: ######################################################
1.31      albertel 13368: sub csv_print_select_table {
                   13369:     my ($r,$records,$d) = @_;
1.301     albertel 13370:     my $i=0;
                   13371:     my $samples = &get_samples($records,1);
1.144     matthew  13372:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13373: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13374:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13375:               '<th>'.&mt('Column').'</th>'.
                   13376:               &end_data_table_header_row()."\n");
1.356     albertel 13377:     foreach my $array_ref (@$d) {
                   13378: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13379: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13380: 
1.875     bisitz   13381: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13382: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13383: 	$r->print('<option value="none"></option>');
1.356     albertel 13384: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13385: 	    $r->print('<option value="'.$sample.'"'.
                   13386:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13387:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13388: 	}
1.594     raeburn  13389: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13390: 	$i++;
                   13391:     }
1.594     raeburn  13392:     $r->print(&end_data_table());
1.31      albertel 13393:     $i--;
                   13394:     return $i;
                   13395: }
1.56      matthew  13396: 
1.144     matthew  13397: ######################################################
                   13398: ######################################################
                   13399: 
1.56      matthew  13400: =pod
1.31      albertel 13401: 
1.648     raeburn  13402: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13403: 
                   13404: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13405: 
                   13406: $r is an Apache Request ref,
                   13407: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13408: $d is an array of 2 element arrays (internal name, displayed name)
                   13409: 
                   13410: =cut
                   13411: 
1.144     matthew  13412: ######################################################
                   13413: ######################################################
1.31      albertel 13414: sub csv_samples_select_table {
                   13415:     my ($r,$records,$d) = @_;
                   13416:     my $i=0;
1.144     matthew  13417:     #
1.662     bisitz   13418:     my $max_samples = 5;
                   13419:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13420:     $r->print(&start_data_table().
                   13421:               &start_data_table_header_row().'<th>'.
                   13422:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13423:               &end_data_table_header_row());
1.301     albertel 13424: 
                   13425:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13426: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13427: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13428: 	foreach my $option (@$d) {
                   13429: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13430: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13431:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13432:                       $display.'</option>');
1.31      albertel 13433: 	}
                   13434: 	$r->print('</select></td><td>');
1.662     bisitz   13435: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13436: 	    if (defined($samples->[$line]{$key})) { 
                   13437: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13438: 	    }
                   13439: 	}
1.594     raeburn  13440: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13441: 	$i++;
                   13442:     }
1.594     raeburn  13443:     $r->print(&end_data_table());
1.31      albertel 13444:     $i--;
                   13445:     return($i);
1.115     matthew  13446: }
                   13447: 
1.144     matthew  13448: ######################################################
                   13449: ######################################################
                   13450: 
1.115     matthew  13451: =pod
                   13452: 
1.648     raeburn  13453: =item * &clean_excel_name($name)
1.115     matthew  13454: 
                   13455: Returns a replacement for $name which does not contain any illegal characters.
                   13456: 
                   13457: =cut
                   13458: 
1.144     matthew  13459: ######################################################
                   13460: ######################################################
1.115     matthew  13461: sub clean_excel_name {
                   13462:     my ($name) = @_;
                   13463:     $name =~ s/[:\*\?\/\\]//g;
                   13464:     if (length($name) > 31) {
                   13465:         $name = substr($name,0,31);
                   13466:     }
                   13467:     return $name;
1.25      albertel 13468: }
1.84      albertel 13469: 
1.85      albertel 13470: =pod
                   13471: 
1.648     raeburn  13472: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13473: 
                   13474: Returns either 1 or undef
                   13475: 
                   13476: 1 if the part is to be hidden, undef if it is to be shown
                   13477: 
                   13478: Arguments are:
                   13479: 
                   13480: $id the id of the part to be checked
                   13481: $symb, optional the symb of the resource to check
                   13482: $udom, optional the domain of the user to check for
                   13483: $uname, optional the username of the user to check for
                   13484: 
                   13485: =cut
1.84      albertel 13486: 
                   13487: sub check_if_partid_hidden {
                   13488:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13489:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13490: 					 $symb,$udom,$uname);
1.141     albertel 13491:     my $truth=1;
                   13492:     #if the string starts with !, then the list is the list to show not hide
                   13493:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13494:     my @hiddenlist=split(/,/,$hiddenparts);
                   13495:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13496: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13497:     }
1.141     albertel 13498:     return !$truth;
1.84      albertel 13499: }
1.127     matthew  13500: 
1.138     matthew  13501: 
                   13502: ############################################################
                   13503: ############################################################
                   13504: 
                   13505: =pod
                   13506: 
1.157     matthew  13507: =back 
                   13508: 
1.138     matthew  13509: =head1 cgi-bin script and graphing routines
                   13510: 
1.157     matthew  13511: =over 4
                   13512: 
1.648     raeburn  13513: =item * &get_cgi_id()
1.138     matthew  13514: 
                   13515: Inputs: none
                   13516: 
                   13517: Returns an id which can be used to pass environment variables
                   13518: to various cgi-bin scripts.  These environment variables will
                   13519: be removed from the users environment after a given time by
                   13520: the routine &Apache::lonnet::transfer_profile_to_env.
                   13521: 
                   13522: =cut
                   13523: 
                   13524: ############################################################
                   13525: ############################################################
1.152     albertel 13526: my $uniq=0;
1.136     matthew  13527: sub get_cgi_id {
1.154     albertel 13528:     $uniq=($uniq+1)%100000;
1.280     albertel 13529:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13530: }
                   13531: 
1.127     matthew  13532: ############################################################
                   13533: ############################################################
                   13534: 
                   13535: =pod
                   13536: 
1.648     raeburn  13537: =item * &DrawBarGraph()
1.127     matthew  13538: 
1.138     matthew  13539: Facilitates the plotting of data in a (stacked) bar graph.
                   13540: Puts plot definition data into the users environment in order for 
                   13541: graph.png to plot it.  Returns an <img> tag for the plot.
                   13542: The bars on the plot are labeled '1','2',...,'n'.
                   13543: 
                   13544: Inputs:
                   13545: 
                   13546: =over 4
                   13547: 
                   13548: =item $Title: string, the title of the plot
                   13549: 
                   13550: =item $xlabel: string, text describing the X-axis of the plot
                   13551: 
                   13552: =item $ylabel: string, text describing the Y-axis of the plot
                   13553: 
                   13554: =item $Max: scalar, the maximum Y value to use in the plot
                   13555: If $Max is < any data point, the graph will not be rendered.
                   13556: 
1.140     matthew  13557: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13558: they are plotted.  If undefined, default values will be used.
                   13559: 
1.178     matthew  13560: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13561: 
1.138     matthew  13562: =item @Values: An array of array references.  Each array reference holds data
                   13563: to be plotted in a stacked bar chart.
                   13564: 
1.239     matthew  13565: =item If the final element of @Values is a hash reference the key/value
                   13566: pairs will be added to the graph definition.
                   13567: 
1.138     matthew  13568: =back
                   13569: 
                   13570: Returns:
                   13571: 
                   13572: An <img> tag which references graph.png and the appropriate identifying
                   13573: information for the plot.
                   13574: 
1.127     matthew  13575: =cut
                   13576: 
                   13577: ############################################################
                   13578: ############################################################
1.134     matthew  13579: sub DrawBarGraph {
1.178     matthew  13580:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13581:     #
                   13582:     if (! defined($colors)) {
                   13583:         $colors = ['#33ff00', 
                   13584:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13585:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13586:                   ]; 
                   13587:     }
1.228     matthew  13588:     my $extra_settings = {};
                   13589:     if (ref($Values[-1]) eq 'HASH') {
                   13590:         $extra_settings = pop(@Values);
                   13591:     }
1.127     matthew  13592:     #
1.136     matthew  13593:     my $identifier = &get_cgi_id();
                   13594:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13595:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13596:         return '';
                   13597:     }
1.225     matthew  13598:     #
                   13599:     my @Labels;
                   13600:     if (defined($labels)) {
                   13601:         @Labels = @$labels;
                   13602:     } else {
                   13603:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13604:             push(@Labels,$i+1);
1.225     matthew  13605:         }
                   13606:     }
                   13607:     #
1.129     matthew  13608:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13609:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13610:     my %ValuesHash;
                   13611:     my $NumSets=1;
                   13612:     foreach my $array (@Values) {
                   13613:         next if (! ref($array));
1.136     matthew  13614:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13615:             join(',',@$array);
1.129     matthew  13616:     }
1.127     matthew  13617:     #
1.136     matthew  13618:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13619:     if ($NumBars < 3) {
                   13620:         $width = 120+$NumBars*32;
1.220     matthew  13621:         $xskip = 1;
1.225     matthew  13622:         $bar_width = 30;
                   13623:     } elsif ($NumBars < 5) {
                   13624:         $width = 120+$NumBars*20;
                   13625:         $xskip = 1;
                   13626:         $bar_width = 20;
1.220     matthew  13627:     } elsif ($NumBars < 10) {
1.136     matthew  13628:         $width = 120+$NumBars*15;
                   13629:         $xskip = 1;
                   13630:         $bar_width = 15;
                   13631:     } elsif ($NumBars <= 25) {
                   13632:         $width = 120+$NumBars*11;
                   13633:         $xskip = 5;
                   13634:         $bar_width = 8;
                   13635:     } elsif ($NumBars <= 50) {
                   13636:         $width = 120+$NumBars*8;
                   13637:         $xskip = 5;
                   13638:         $bar_width = 4;
                   13639:     } else {
                   13640:         $width = 120+$NumBars*8;
                   13641:         $xskip = 5;
                   13642:         $bar_width = 4;
                   13643:     }
                   13644:     #
1.137     matthew  13645:     $Max = 1 if ($Max < 1);
                   13646:     if ( int($Max) < $Max ) {
                   13647:         $Max++;
                   13648:         $Max = int($Max);
                   13649:     }
1.127     matthew  13650:     $Title  = '' if (! defined($Title));
                   13651:     $xlabel = '' if (! defined($xlabel));
                   13652:     $ylabel = '' if (! defined($ylabel));
1.369     www      13653:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13654:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13655:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13656:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13657:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13658:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13659:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13660:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13661:     $ValuesHash{$id.'.height'}   = $height;
                   13662:     $ValuesHash{$id.'.width'}    = $width;
                   13663:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13664:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13665:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13666:     #
1.228     matthew  13667:     # Deal with other parameters
                   13668:     while (my ($key,$value) = each(%$extra_settings)) {
                   13669:         $ValuesHash{$id.'.'.$key} = $value;
                   13670:     }
                   13671:     #
1.646     raeburn  13672:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13673:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13674: }
                   13675: 
                   13676: ############################################################
                   13677: ############################################################
                   13678: 
                   13679: =pod
                   13680: 
1.648     raeburn  13681: =item * &DrawXYGraph()
1.137     matthew  13682: 
1.138     matthew  13683: Facilitates the plotting of data in an XY graph.
                   13684: Puts plot definition data into the users environment in order for 
                   13685: graph.png to plot it.  Returns an <img> tag for the plot.
                   13686: 
                   13687: Inputs:
                   13688: 
                   13689: =over 4
                   13690: 
                   13691: =item $Title: string, the title of the plot
                   13692: 
                   13693: =item $xlabel: string, text describing the X-axis of the plot
                   13694: 
                   13695: =item $ylabel: string, text describing the Y-axis of the plot
                   13696: 
                   13697: =item $Max: scalar, the maximum Y value to use in the plot
                   13698: If $Max is < any data point, the graph will not be rendered.
                   13699: 
                   13700: =item $colors: Array ref containing the hex color codes for the data to be 
                   13701: plotted in.  If undefined, default values will be used.
                   13702: 
                   13703: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13704: 
                   13705: =item $Ydata: Array ref containing Array refs.  
1.185     www      13706: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13707: 
                   13708: =item %Values: hash indicating or overriding any default values which are 
                   13709: passed to graph.png.  
                   13710: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13711: 
                   13712: =back
                   13713: 
                   13714: Returns:
                   13715: 
                   13716: An <img> tag which references graph.png and the appropriate identifying
                   13717: information for the plot.
                   13718: 
1.137     matthew  13719: =cut
                   13720: 
                   13721: ############################################################
                   13722: ############################################################
                   13723: sub DrawXYGraph {
                   13724:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   13725:     #
                   13726:     # Create the identifier for the graph
                   13727:     my $identifier = &get_cgi_id();
                   13728:     my $id = 'cgi.'.$identifier;
                   13729:     #
                   13730:     $Title  = '' if (! defined($Title));
                   13731:     $xlabel = '' if (! defined($xlabel));
                   13732:     $ylabel = '' if (! defined($ylabel));
                   13733:     my %ValuesHash = 
                   13734:         (
1.369     www      13735:          $id.'.title'  => &escape($Title),
                   13736:          $id.'.xlabel' => &escape($xlabel),
                   13737:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  13738:          $id.'.y_max_value'=> $Max,
                   13739:          $id.'.labels'     => join(',',@$Xlabels),
                   13740:          $id.'.PlotType'   => 'XY',
                   13741:          );
                   13742:     #
                   13743:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13744:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13745:     }
                   13746:     #
                   13747:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   13748:         return '';
                   13749:     }
                   13750:     my $NumSets=1;
1.138     matthew  13751:     foreach my $array (@{$Ydata}){
1.137     matthew  13752:         next if (! ref($array));
                   13753:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   13754:     }
1.138     matthew  13755:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  13756:     #
                   13757:     # Deal with other parameters
                   13758:     while (my ($key,$value) = each(%Values)) {
                   13759:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  13760:     }
                   13761:     #
1.646     raeburn  13762:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  13763:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13764: }
                   13765: 
                   13766: ############################################################
                   13767: ############################################################
                   13768: 
                   13769: =pod
                   13770: 
1.648     raeburn  13771: =item * &DrawXYYGraph()
1.138     matthew  13772: 
                   13773: Facilitates the plotting of data in an XY graph with two Y axes.
                   13774: Puts plot definition data into the users environment in order for 
                   13775: graph.png to plot it.  Returns an <img> tag for the plot.
                   13776: 
                   13777: Inputs:
                   13778: 
                   13779: =over 4
                   13780: 
                   13781: =item $Title: string, the title of the plot
                   13782: 
                   13783: =item $xlabel: string, text describing the X-axis of the plot
                   13784: 
                   13785: =item $ylabel: string, text describing the Y-axis of the plot
                   13786: 
                   13787: =item $colors: Array ref containing the hex color codes for the data to be 
                   13788: plotted in.  If undefined, default values will be used.
                   13789: 
                   13790: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13791: 
                   13792: =item $Ydata1: The first data set
                   13793: 
                   13794: =item $Min1: The minimum value of the left Y-axis
                   13795: 
                   13796: =item $Max1: The maximum value of the left Y-axis
                   13797: 
                   13798: =item $Ydata2: The second data set
                   13799: 
                   13800: =item $Min2: The minimum value of the right Y-axis
                   13801: 
                   13802: =item $Max2: The maximum value of the left Y-axis
                   13803: 
                   13804: =item %Values: hash indicating or overriding any default values which are 
                   13805: passed to graph.png.  
                   13806: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13807: 
                   13808: =back
                   13809: 
                   13810: Returns:
                   13811: 
                   13812: An <img> tag which references graph.png and the appropriate identifying
                   13813: information for the plot.
1.136     matthew  13814: 
                   13815: =cut
                   13816: 
                   13817: ############################################################
                   13818: ############################################################
1.137     matthew  13819: sub DrawXYYGraph {
                   13820:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   13821:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  13822:     #
                   13823:     # Create the identifier for the graph
                   13824:     my $identifier = &get_cgi_id();
                   13825:     my $id = 'cgi.'.$identifier;
                   13826:     #
                   13827:     $Title  = '' if (! defined($Title));
                   13828:     $xlabel = '' if (! defined($xlabel));
                   13829:     $ylabel = '' if (! defined($ylabel));
                   13830:     my %ValuesHash = 
                   13831:         (
1.369     www      13832:          $id.'.title'  => &escape($Title),
                   13833:          $id.'.xlabel' => &escape($xlabel),
                   13834:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  13835:          $id.'.labels' => join(',',@$Xlabels),
                   13836:          $id.'.PlotType' => 'XY',
                   13837:          $id.'.NumSets' => 2,
1.137     matthew  13838:          $id.'.two_axes' => 1,
                   13839:          $id.'.y1_max_value' => $Max1,
                   13840:          $id.'.y1_min_value' => $Min1,
                   13841:          $id.'.y2_max_value' => $Max2,
                   13842:          $id.'.y2_min_value' => $Min2,
1.136     matthew  13843:          );
                   13844:     #
1.137     matthew  13845:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13846:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13847:     }
                   13848:     #
                   13849:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   13850:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  13851:         return '';
                   13852:     }
                   13853:     my $NumSets=1;
1.137     matthew  13854:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  13855:         next if (! ref($array));
                   13856:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  13857:     }
                   13858:     #
                   13859:     # Deal with other parameters
                   13860:     while (my ($key,$value) = each(%Values)) {
                   13861:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  13862:     }
                   13863:     #
1.646     raeburn  13864:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 13865:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  13866: }
                   13867: 
                   13868: ############################################################
                   13869: ############################################################
                   13870: 
                   13871: =pod
                   13872: 
1.157     matthew  13873: =back 
                   13874: 
1.139     matthew  13875: =head1 Statistics helper routines?  
                   13876: 
                   13877: Bad place for them but what the hell.
                   13878: 
1.157     matthew  13879: =over 4
                   13880: 
1.648     raeburn  13881: =item * &chartlink()
1.139     matthew  13882: 
                   13883: Returns a link to the chart for a specific student.  
                   13884: 
                   13885: Inputs:
                   13886: 
                   13887: =over 4
                   13888: 
                   13889: =item $linktext: The text of the link
                   13890: 
                   13891: =item $sname: The students username
                   13892: 
                   13893: =item $sdomain: The students domain
                   13894: 
                   13895: =back
                   13896: 
1.157     matthew  13897: =back
                   13898: 
1.139     matthew  13899: =cut
                   13900: 
                   13901: ############################################################
                   13902: ############################################################
                   13903: sub chartlink {
                   13904:     my ($linktext, $sname, $sdomain) = @_;
                   13905:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      13906:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 13907:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  13908:        '">'.$linktext.'</a>';
1.153     matthew  13909: }
                   13910: 
                   13911: #######################################################
                   13912: #######################################################
                   13913: 
                   13914: =pod
                   13915: 
                   13916: =head1 Course Environment Routines
1.157     matthew  13917: 
                   13918: =over 4
1.153     matthew  13919: 
1.648     raeburn  13920: =item * &restore_course_settings()
1.153     matthew  13921: 
1.648     raeburn  13922: =item * &store_course_settings()
1.153     matthew  13923: 
                   13924: Restores/Store indicated form parameters from the course environment.
                   13925: Will not overwrite existing values of the form parameters.
                   13926: 
                   13927: Inputs: 
                   13928: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   13929: 
                   13930: a hash ref describing the data to be stored.  For example:
                   13931:    
                   13932: %Save_Parameters = ('Status' => 'scalar',
                   13933:     'chartoutputmode' => 'scalar',
                   13934:     'chartoutputdata' => 'scalar',
                   13935:     'Section' => 'array',
1.373     raeburn  13936:     'Group' => 'array',
1.153     matthew  13937:     'StudentData' => 'array',
                   13938:     'Maps' => 'array');
                   13939: 
                   13940: Returns: both routines return nothing
                   13941: 
1.631     raeburn  13942: =back
                   13943: 
1.153     matthew  13944: =cut
                   13945: 
                   13946: #######################################################
                   13947: #######################################################
                   13948: sub store_course_settings {
1.496     albertel 13949:     return &store_settings($env{'request.course.id'},@_);
                   13950: }
                   13951: 
                   13952: sub store_settings {
1.153     matthew  13953:     # save to the environment
                   13954:     # appenv the same items, just to be safe
1.300     albertel 13955:     my $udom  = $env{'user.domain'};
                   13956:     my $uname = $env{'user.name'};
1.496     albertel 13957:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  13958:     my %SaveHash;
                   13959:     my %AppHash;
                   13960:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 13961:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 13962:         my $envname = 'environment.'.$basename;
1.258     albertel 13963:         if (exists($env{'form.'.$setting})) {
1.153     matthew  13964:             # Save this value away
                   13965:             if ($type eq 'scalar' &&
1.258     albertel 13966:                 (! exists($env{$envname}) || 
                   13967:                  $env{$envname} ne $env{'form.'.$setting})) {
                   13968:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   13969:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  13970:             } elsif ($type eq 'array') {
                   13971:                 my $stored_form;
1.258     albertel 13972:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  13973:                     $stored_form = join(',',
                   13974:                                         map {
1.369     www      13975:                                             &escape($_);
1.258     albertel 13976:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  13977:                 } else {
                   13978:                     $stored_form = 
1.369     www      13979:                         &escape($env{'form.'.$setting});
1.153     matthew  13980:                 }
                   13981:                 # Determine if the array contents are the same.
1.258     albertel 13982:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  13983:                     $SaveHash{$basename} = $stored_form;
                   13984:                     $AppHash{$envname}   = $stored_form;
                   13985:                 }
                   13986:             }
                   13987:         }
                   13988:     }
                   13989:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 13990:                                           $udom,$uname);
1.153     matthew  13991:     if ($put_result !~ /^(ok|delayed)/) {
                   13992:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   13993:                                  'got error:'.$put_result);
                   13994:     }
                   13995:     # Make sure these settings stick around in this session, too
1.646     raeburn  13996:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  13997:     return;
                   13998: }
                   13999: 
                   14000: sub restore_course_settings {
1.499     albertel 14001:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14002: }
                   14003: 
                   14004: sub restore_settings {
                   14005:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14006:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14007:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14008:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14009:             '.'.$setting;
1.258     albertel 14010:         if (exists($env{$envname})) {
1.153     matthew  14011:             if ($type eq 'scalar') {
1.258     albertel 14012:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14013:             } elsif ($type eq 'array') {
1.258     albertel 14014:                 $env{'form.'.$setting} = [ 
1.153     matthew  14015:                                            map { 
1.369     www      14016:                                                &unescape($_); 
1.258     albertel 14017:                                            } split(',',$env{$envname})
1.153     matthew  14018:                                            ];
                   14019:             }
                   14020:         }
                   14021:     }
1.127     matthew  14022: }
                   14023: 
1.618     raeburn  14024: #######################################################
                   14025: #######################################################
                   14026: 
                   14027: =pod
                   14028: 
                   14029: =head1 Domain E-mail Routines  
                   14030: 
                   14031: =over 4
                   14032: 
1.648     raeburn  14033: =item * &build_recipient_list()
1.618     raeburn  14034: 
1.1075.2.44  raeburn  14035: Build recipient lists for following types of e-mail:
1.766     raeburn  14036: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14037: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14038: module change checking, student/employee ID conflict checks, as
                   14039: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14040: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14041: 
                   14042: Inputs:
1.1075.2.44  raeburn  14043: defmail (scalar - email address of default recipient),
                   14044: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14045: requestsmail, updatesmail, or idconflictsmail).
                   14046: 
1.619     raeburn  14047: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14048: 
                   14049: origmail (scalar - email address of recipient from loncapa.conf,
                   14050: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14051: 
1.655     raeburn  14052: Returns: comma separated list of addresses to which to send e-mail.
                   14053: 
                   14054: =back
1.618     raeburn  14055: 
                   14056: =cut
                   14057: 
                   14058: ############################################################
                   14059: ############################################################
                   14060: sub build_recipient_list {
1.619     raeburn  14061:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  14062:     my @recipients;
1.1075.2.122  raeburn  14063:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14064:     my %domconfig =
1.1075.2.122  raeburn  14065:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14066:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14067:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14068:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14069:                 my @contacts = ('adminemail','supportemail');
                   14070:                 foreach my $item (@contacts) {
                   14071:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14072:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14073:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14074:                             push(@recipients,$addr);
                   14075:                         }
1.619     raeburn  14076:                     }
1.1075.2.122  raeburn  14077:                 }
                   14078:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14079:                 if ($mailing eq 'helpdeskmail') {
                   14080:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14081:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14082:                         my @ok_bccs;
                   14083:                         foreach my $bcc (@bccs) {
                   14084:                             $bcc =~ s/^\s+//g;
                   14085:                             $bcc =~ s/\s+$//g;
                   14086:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14087:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14088:                                     push(@ok_bccs,$bcc);
                   14089:                                 }
                   14090:                             }
                   14091:                         }
                   14092:                         if (@ok_bccs > 0) {
                   14093:                             $allbcc = join(', ',@ok_bccs);
                   14094:                         }
                   14095:                     }
                   14096:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14097:                 }
                   14098:             }
1.766     raeburn  14099:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14100:             $lastresort = $origmail;
1.618     raeburn  14101:         }
1.619     raeburn  14102:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14103:         $lastresort = $origmail;
                   14104:     }
                   14105: 
1.1075.2.128  raeburn  14106:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14107:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14108:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14109:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14110:             my %what = (
                   14111:                           perlvar => 1,
                   14112:                        );
                   14113:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14114:             if ($primary) {
                   14115:                 my $gotaddr;
                   14116:                 my ($result,$returnhash) =
                   14117:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14118:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14119:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14120:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14121:                         $gotaddr = 1;
                   14122:                     }
                   14123:                 }
                   14124:                 unless ($gotaddr) {
                   14125:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14126:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14127:                     unless ($uintdom eq $intdom) {
                   14128:                         my %domconfig =
                   14129:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14130:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14131:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14132:                                 my @contacts = ('adminemail','supportemail');
                   14133:                                 foreach my $item (@contacts) {
                   14134:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14135:                                         my $addr = $domconfig{'contacts'}{$item};
                   14136:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14137:                                             push(@recipients,$addr);
                   14138:                                         }
                   14139:                                     }
                   14140:                                 }
                   14141:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14142:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14143:                                 }
                   14144:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14145:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14146:                                     my @ok_bccs;
                   14147:                                     foreach my $bcc (@bccs) {
                   14148:                                         $bcc =~ s/^\s+//g;
                   14149:                                         $bcc =~ s/\s+$//g;
                   14150:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14151:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14152:                                                 push(@ok_bccs,$bcc);
                   14153:                                             }
                   14154:                                         }
                   14155:                                     }
                   14156:                                     if (@ok_bccs > 0) {
                   14157:                                         $allbcc = join(', ',@ok_bccs);
                   14158:                                     }
                   14159:                                 }
                   14160:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14161:                             }
                   14162:                         }
                   14163:                     }
                   14164:                 }
                   14165:             }
                   14166:         }
1.618     raeburn  14167:     }
1.688     raeburn  14168:     if (defined($defmail)) {
                   14169:         if ($defmail ne '') {
                   14170:             push(@recipients,$defmail);
                   14171:         }
1.618     raeburn  14172:     }
                   14173:     if ($otheremails) {
1.619     raeburn  14174:         my @others;
                   14175:         if ($otheremails =~ /,/) {
                   14176:             @others = split(/,/,$otheremails);
1.618     raeburn  14177:         } else {
1.619     raeburn  14178:             push(@others,$otheremails);
                   14179:         }
                   14180:         foreach my $addr (@others) {
                   14181:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14182:                 push(@recipients,$addr);
                   14183:             }
1.618     raeburn  14184:         }
                   14185:     }
1.1075.2.128  raeburn  14186:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14187:         if ((!@recipients) && ($lastresort ne '')) {
                   14188:             push(@recipients,$lastresort);
                   14189:         }
                   14190:     } elsif ($lastresort ne '') {
                   14191:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14192:             push(@recipients,$lastresort);
                   14193:         }
                   14194:     }
                   14195:     my $recipientlist = join(',',@recipients);
                   14196:     if (wantarray) {
                   14197:         return ($recipientlist,$allbcc,$addtext);
                   14198:     } else {
                   14199:         return $recipientlist;
                   14200:     }
1.618     raeburn  14201: }
                   14202: 
1.127     matthew  14203: ############################################################
                   14204: ############################################################
1.154     albertel 14205: 
1.655     raeburn  14206: =pod
                   14207: 
                   14208: =head1 Course Catalog Routines
                   14209: 
                   14210: =over 4
                   14211: 
                   14212: =item * &gather_categories()
                   14213: 
                   14214: Converts category definitions - keys of categories hash stored in  
                   14215: coursecategories in configuration.db on the primary library server in a 
                   14216: domain - to an array.  Also generates javascript and idx hash used to 
                   14217: generate Domain Coordinator interface for editing Course Categories.
                   14218: 
                   14219: Inputs:
1.663     raeburn  14220: 
1.655     raeburn  14221: categories (reference to hash of category definitions).
1.663     raeburn  14222: 
1.655     raeburn  14223: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14224:       categories and subcategories).
1.663     raeburn  14225: 
1.655     raeburn  14226: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14227:       editing Course Categories).
1.663     raeburn  14228: 
1.655     raeburn  14229: jsarray (reference to array of categories used to create Javascript arrays for
                   14230:          Domain Coordinator interface for editing Course Categories).
                   14231: 
                   14232: Returns: nothing
                   14233: 
                   14234: Side effects: populates cats, idx and jsarray. 
                   14235: 
                   14236: =cut
                   14237: 
                   14238: sub gather_categories {
                   14239:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14240:     my %counters;
                   14241:     my $num = 0;
                   14242:     foreach my $item (keys(%{$categories})) {
                   14243:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14244:         if ($container eq '' && $depth == 0) {
                   14245:             $cats->[$depth][$categories->{$item}] = $cat;
                   14246:         } else {
                   14247:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14248:         }
                   14249:         my ($escitem,$tail) = split(/:/,$item,2);
                   14250:         if ($counters{$tail} eq '') {
                   14251:             $counters{$tail} = $num;
                   14252:             $num ++;
                   14253:         }
                   14254:         if (ref($idx) eq 'HASH') {
                   14255:             $idx->{$item} = $counters{$tail};
                   14256:         }
                   14257:         if (ref($jsarray) eq 'ARRAY') {
                   14258:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14259:         }
                   14260:     }
                   14261:     return;
                   14262: }
                   14263: 
                   14264: =pod
                   14265: 
                   14266: =item * &extract_categories()
                   14267: 
                   14268: Used to generate breadcrumb trails for course categories.
                   14269: 
                   14270: Inputs:
1.663     raeburn  14271: 
1.655     raeburn  14272: categories (reference to hash of category definitions).
1.663     raeburn  14273: 
1.655     raeburn  14274: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14275:       categories and subcategories).
1.663     raeburn  14276: 
1.655     raeburn  14277: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14278: 
1.655     raeburn  14279: allitems (reference to hash - key is category key 
                   14280:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14281: 
1.655     raeburn  14282: idx (reference to hash of counters used in Domain Coordinator interface for
                   14283:       editing Course Categories).
1.663     raeburn  14284: 
1.655     raeburn  14285: jsarray (reference to array of categories used to create Javascript arrays for
                   14286:          Domain Coordinator interface for editing Course Categories).
                   14287: 
1.665     raeburn  14288: subcats (reference to hash of arrays containing all subcategories within each 
                   14289:          category, -recursive)
                   14290: 
1.655     raeburn  14291: Returns: nothing
                   14292: 
                   14293: Side effects: populates trails and allitems hash references.
                   14294: 
                   14295: =cut
                   14296: 
                   14297: sub extract_categories {
1.665     raeburn  14298:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  14299:     if (ref($categories) eq 'HASH') {
                   14300:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14301:         if (ref($cats->[0]) eq 'ARRAY') {
                   14302:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14303:                 my $name = $cats->[0][$i];
                   14304:                 my $item = &escape($name).'::0';
                   14305:                 my $trailstr;
                   14306:                 if ($name eq 'instcode') {
                   14307:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14308:                 } elsif ($name eq 'communities') {
                   14309:                     $trailstr = &mt('Communities');
1.655     raeburn  14310:                 } else {
                   14311:                     $trailstr = $name;
                   14312:                 }
                   14313:                 if ($allitems->{$item} eq '') {
                   14314:                     push(@{$trails},$trailstr);
                   14315:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14316:                 }
                   14317:                 my @parents = ($name);
                   14318:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14319:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14320:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14321:                         if (ref($subcats) eq 'HASH') {
                   14322:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14323:                         }
                   14324:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   14325:                     }
                   14326:                 } else {
                   14327:                     if (ref($subcats) eq 'HASH') {
                   14328:                         $subcats->{$item} = [];
1.655     raeburn  14329:                     }
                   14330:                 }
                   14331:             }
                   14332:         }
                   14333:     }
                   14334:     return;
                   14335: }
                   14336: 
                   14337: =pod
                   14338: 
1.1075.2.56  raeburn  14339: =item * &recurse_categories()
1.655     raeburn  14340: 
                   14341: Recursively used to generate breadcrumb trails for course categories.
                   14342: 
                   14343: Inputs:
1.663     raeburn  14344: 
1.655     raeburn  14345: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14346:       categories and subcategories).
1.663     raeburn  14347: 
1.655     raeburn  14348: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14349: 
                   14350: category (current course category, for which breadcrumb trail is being generated).
                   14351: 
                   14352: trails (reference to array of breadcrumb trails for each category).
                   14353: 
1.655     raeburn  14354: allitems (reference to hash - key is category key
                   14355:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14356: 
1.655     raeburn  14357: parents (array containing containers directories for current category, 
                   14358:          back to top level). 
                   14359: 
                   14360: Returns: nothing
                   14361: 
                   14362: Side effects: populates trails and allitems hash references
                   14363: 
                   14364: =cut
                   14365: 
                   14366: sub recurse_categories {
1.665     raeburn  14367:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  14368:     my $shallower = $depth - 1;
                   14369:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14370:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14371:             my $name = $cats->[$depth]{$category}[$k];
                   14372:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14373:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14374:             if ($allitems->{$item} eq '') {
                   14375:                 push(@{$trails},$trailstr);
                   14376:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14377:             }
                   14378:             my $deeper = $depth+1;
                   14379:             push(@{$parents},$category);
1.665     raeburn  14380:             if (ref($subcats) eq 'HASH') {
                   14381:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14382:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14383:                     my $higher;
                   14384:                     if ($j > 0) {
                   14385:                         $higher = &escape($parents->[$j]).':'.
                   14386:                                   &escape($parents->[$j-1]).':'.$j;
                   14387:                     } else {
                   14388:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14389:                     }
                   14390:                     push(@{$subcats->{$higher}},$subcat);
                   14391:                 }
                   14392:             }
                   14393:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   14394:                                 $subcats);
1.655     raeburn  14395:             pop(@{$parents});
                   14396:         }
                   14397:     } else {
                   14398:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14399:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14400:         if ($allitems->{$item} eq '') {
                   14401:             push(@{$trails},$trailstr);
                   14402:             $allitems->{$item} = scalar(@{$trails})-1;
                   14403:         }
                   14404:     }
                   14405:     return;
                   14406: }
                   14407: 
1.663     raeburn  14408: =pod
                   14409: 
1.1075.2.56  raeburn  14410: =item * &assign_categories_table()
1.663     raeburn  14411: 
                   14412: Create a datatable for display of hierarchical categories in a domain,
                   14413: with checkboxes to allow a course to be categorized. 
                   14414: 
                   14415: Inputs:
                   14416: 
                   14417: cathash - reference to hash of categories defined for the domain (from
                   14418:           configuration.db)
                   14419: 
                   14420: currcat - scalar with an & separated list of categories assigned to a course. 
                   14421: 
1.919     raeburn  14422: type    - scalar contains course type (Course or Community).
                   14423: 
1.1075.2.117  raeburn  14424: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14425:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14426: 
1.663     raeburn  14427: Returns: $output (markup to be displayed) 
                   14428: 
                   14429: =cut
                   14430: 
                   14431: sub assign_categories_table {
1.1075.2.117  raeburn  14432:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14433:     my $output;
                   14434:     if (ref($cathash) eq 'HASH') {
                   14435:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   14436:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   14437:         $maxdepth = scalar(@cats);
                   14438:         if (@cats > 0) {
                   14439:             my $itemcount = 0;
                   14440:             if (ref($cats[0]) eq 'ARRAY') {
                   14441:                 my @currcategories;
                   14442:                 if ($currcat ne '') {
                   14443:                     @currcategories = split('&',$currcat);
                   14444:                 }
1.919     raeburn  14445:                 my $table;
1.663     raeburn  14446:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14447:                     my $parent = $cats[0][$i];
1.919     raeburn  14448:                     next if ($parent eq 'instcode');
                   14449:                     if ($type eq 'Community') {
                   14450:                         next unless ($parent eq 'communities');
                   14451:                     } else {
                   14452:                         next if ($parent eq 'communities');
                   14453:                     }
1.663     raeburn  14454:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14455:                     my $item = &escape($parent).'::0';
                   14456:                     my $checked = '';
                   14457:                     if (@currcategories > 0) {
                   14458:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14459:                             $checked = ' checked="checked"';
1.663     raeburn  14460:                         }
                   14461:                     }
1.919     raeburn  14462:                     my $parent_title = $parent;
                   14463:                     if ($parent eq 'communities') {
                   14464:                         $parent_title = &mt('Communities');
                   14465:                     }
                   14466:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14467:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14468:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14469:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14470:                     my $depth = 1;
                   14471:                     push(@path,$parent);
1.1075.2.117  raeburn  14472:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14473:                     pop(@path);
1.919     raeburn  14474:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14475:                     $itemcount ++;
                   14476:                 }
1.919     raeburn  14477:                 if ($itemcount) {
                   14478:                     $output = &Apache::loncommon::start_data_table().
                   14479:                               $table.
                   14480:                               &Apache::loncommon::end_data_table();
                   14481:                 }
1.663     raeburn  14482:             }
                   14483:         }
                   14484:     }
                   14485:     return $output;
                   14486: }
                   14487: 
                   14488: =pod
                   14489: 
1.1075.2.56  raeburn  14490: =item * &assign_category_rows()
1.663     raeburn  14491: 
                   14492: Create a datatable row for display of nested categories in a domain,
                   14493: with checkboxes to allow a course to be categorized,called recursively.
                   14494: 
                   14495: Inputs:
                   14496: 
                   14497: itemcount - track row number for alternating colors
                   14498: 
                   14499: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14500:       categories and subcategories.
                   14501: 
                   14502: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14503: 
                   14504: parent - parent of current category item
                   14505: 
                   14506: path - Array containing all categories back up through the hierarchy from the
                   14507:        current category to the top level.
                   14508: 
                   14509: currcategories - reference to array of current categories assigned to the course
                   14510: 
1.1075.2.117  raeburn  14511: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14512:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14513: 
1.663     raeburn  14514: Returns: $output (markup to be displayed).
                   14515: 
                   14516: =cut
                   14517: 
                   14518: sub assign_category_rows {
1.1075.2.117  raeburn  14519:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14520:     my ($text,$name,$item,$chgstr);
                   14521:     if (ref($cats) eq 'ARRAY') {
                   14522:         my $maxdepth = scalar(@{$cats});
                   14523:         if (ref($cats->[$depth]) eq 'HASH') {
                   14524:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14525:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14526:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14527:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14528:                 for (my $j=0; $j<$numchildren; $j++) {
                   14529:                     $name = $cats->[$depth]{$parent}[$j];
                   14530:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14531:                     my $deeper = $depth+1;
                   14532:                     my $checked = '';
                   14533:                     if (ref($currcategories) eq 'ARRAY') {
                   14534:                         if (@{$currcategories} > 0) {
                   14535:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14536:                                 $checked = ' checked="checked"';
1.663     raeburn  14537:                             }
                   14538:                         }
                   14539:                     }
1.664     raeburn  14540:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14541:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14542:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14543:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14544:                              '</td><td>';
1.663     raeburn  14545:                     if (ref($path) eq 'ARRAY') {
                   14546:                         push(@{$path},$name);
1.1075.2.117  raeburn  14547:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14548:                         pop(@{$path});
                   14549:                     }
                   14550:                     $text .= '</td></tr>';
                   14551:                 }
                   14552:                 $text .= '</table></td>';
                   14553:             }
                   14554:         }
                   14555:     }
                   14556:     return $text;
                   14557: }
                   14558: 
1.1075.2.69  raeburn  14559: =pod
                   14560: 
                   14561: =back
                   14562: 
                   14563: =cut
                   14564: 
1.655     raeburn  14565: ############################################################
                   14566: ############################################################
                   14567: 
                   14568: 
1.443     albertel 14569: sub commit_customrole {
1.664     raeburn  14570:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14571:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14572:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14573:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14574:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14575:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14576:                  '</b><br />';
                   14577:     return $output;
                   14578: }
                   14579: 
                   14580: sub commit_standardrole {
1.1075.2.31  raeburn  14581:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14582:     my ($output,$logmsg,$linefeed);
                   14583:     if ($context eq 'auto') {
                   14584:         $linefeed = "\n";
                   14585:     } else {
                   14586:         $linefeed = "<br />\n";
                   14587:     }  
1.443     albertel 14588:     if ($three eq 'st') {
1.541     raeburn  14589:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14590:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14591:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14592:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14593:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14594:         } else {
1.541     raeburn  14595:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14596:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14597:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14598:             if ($context eq 'auto') {
                   14599:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14600:             } else {
                   14601:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14602:                &mt('Add to classlist').': <b>ok</b>';
                   14603:             }
                   14604:             $output .= $linefeed;
1.443     albertel 14605:         }
                   14606:     } else {
                   14607:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14608:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14609:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14610:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14611:         if ($context eq 'auto') {
                   14612:             $output .= $result.$linefeed;
                   14613:         } else {
                   14614:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   14615:         }
1.443     albertel 14616:     }
                   14617:     return $output;
                   14618: }
                   14619: 
                   14620: sub commit_studentrole {
1.1075.2.31  raeburn  14621:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   14622:         $credits) = @_;
1.626     raeburn  14623:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  14624:     if ($context eq 'auto') {
                   14625:         $linefeed = "\n";
                   14626:     } else {
                   14627:         $linefeed = '<br />'."\n";
                   14628:     }
1.443     albertel 14629:     if (defined($one) && defined($two)) {
                   14630:         my $cid=$one.'_'.$two;
                   14631:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   14632:         my $secchange = 0;
                   14633:         my $expire_role_result;
                   14634:         my $modify_section_result;
1.628     raeburn  14635:         if ($oldsec ne '-1') { 
                   14636:             if ($oldsec ne $sec) {
1.443     albertel 14637:                 $secchange = 1;
1.628     raeburn  14638:                 my $now = time;
1.443     albertel 14639:                 my $uurl='/'.$cid;
                   14640:                 $uurl=~s/\_/\//g;
                   14641:                 if ($oldsec) {
                   14642:                     $uurl.='/'.$oldsec;
                   14643:                 }
1.626     raeburn  14644:                 $oldsecurl = $uurl;
1.628     raeburn  14645:                 $expire_role_result = 
1.652     raeburn  14646:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  14647:                 if ($env{'request.course.sec'} ne '') { 
                   14648:                     if ($expire_role_result eq 'refused') {
                   14649:                         my @roles = ('st');
                   14650:                         my @statuses = ('previous');
                   14651:                         my @roledoms = ($one);
                   14652:                         my $withsec = 1;
                   14653:                         my %roleshash = 
                   14654:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   14655:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   14656:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   14657:                             my ($oldstart,$oldend) = 
                   14658:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   14659:                             if ($oldend > 0 && $oldend <= $now) {
                   14660:                                 $expire_role_result = 'ok';
                   14661:                             }
                   14662:                         }
                   14663:                     }
                   14664:                 }
1.443     albertel 14665:                 $result = $expire_role_result;
                   14666:             }
                   14667:         }
                   14668:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  14669:             $modify_section_result = 
                   14670:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   14671:                                                            undef,undef,undef,$sec,
                   14672:                                                            $end,$start,'','',$cid,
                   14673:                                                            '',$context,$credits);
1.443     albertel 14674:             if ($modify_section_result =~ /^ok/) {
                   14675:                 if ($secchange == 1) {
1.628     raeburn  14676:                     if ($sec eq '') {
                   14677:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   14678:                     } else {
                   14679:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   14680:                     }
1.443     albertel 14681:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  14682:                     if ($sec eq '') {
                   14683:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   14684:                     } else {
                   14685:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14686:                     }
1.443     albertel 14687:                 } else {
1.628     raeburn  14688:                     if ($sec eq '') {
                   14689:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   14690:                     } else {
                   14691:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14692:                     }
1.443     albertel 14693:                 }
                   14694:             } else {
1.628     raeburn  14695:                 if ($secchange) {       
                   14696:                     $$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;
                   14697:                 } else {
                   14698:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   14699:                 }
1.443     albertel 14700:             }
                   14701:             $result = $modify_section_result;
                   14702:         } elsif ($secchange == 1) {
1.628     raeburn  14703:             if ($oldsec eq '') {
1.1075.2.20  raeburn  14704:                 $$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  14705:             } else {
                   14706:                 $$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;
                   14707:             }
1.626     raeburn  14708:             if ($expire_role_result eq 'refused') {
                   14709:                 my $newsecurl = '/'.$cid;
                   14710:                 $newsecurl =~ s/\_/\//g;
                   14711:                 if ($sec ne '') {
                   14712:                     $newsecurl.='/'.$sec;
                   14713:                 }
                   14714:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   14715:                     if ($sec eq '') {
                   14716:                         $$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;
                   14717:                     } else {
                   14718:                         $$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;
                   14719:                     }
                   14720:                 }
                   14721:             }
1.443     albertel 14722:         }
                   14723:     } else {
1.626     raeburn  14724:         $$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 14725:         $result = "error: incomplete course id\n";
                   14726:     }
                   14727:     return $result;
                   14728: }
                   14729: 
1.1075.2.25  raeburn  14730: sub show_role_extent {
                   14731:     my ($scope,$context,$role) = @_;
                   14732:     $scope =~ s{^/}{};
                   14733:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   14734:     push(@courseroles,'co');
                   14735:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   14736:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   14737:         $scope =~ s{/}{_};
                   14738:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   14739:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   14740:         my ($audom,$auname) = split(/\//,$scope);
                   14741:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   14742:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   14743:     } else {
                   14744:         $scope =~ s{/$}{};
                   14745:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   14746:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   14747:     }
                   14748: }
                   14749: 
1.443     albertel 14750: ############################################################
                   14751: ############################################################
                   14752: 
1.566     albertel 14753: sub check_clone {
1.578     raeburn  14754:     my ($args,$linefeed) = @_;
1.566     albertel 14755:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   14756:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   14757:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   14758:     my $clonemsg;
                   14759:     my $can_clone = 0;
1.944     raeburn  14760:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  14761:     if ($lctype ne 'community') {
                   14762:         $lctype = 'course';
                   14763:     }
1.566     albertel 14764:     if ($clonehome eq 'no_host') {
1.944     raeburn  14765:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14766:             $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'});
                   14767:         } else {
                   14768:             $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'});
                   14769:         }     
1.566     albertel 14770:     } else {
                   14771: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  14772:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  14773:             if ($clonedesc{'type'} ne 'Community') {
                   14774:                  $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'});
                   14775:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14776:             }
                   14777:         }
1.1075.2.119  raeburn  14778: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  14779:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 14780: 	    $can_clone = 1;
                   14781: 	} else {
1.1075.2.95  raeburn  14782: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 14783: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  14784:             if ($clonehash{'cloners'} eq '') {
                   14785:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   14786:                 if ($domdefs{'canclone'}) {
                   14787:                     unless ($domdefs{'canclone'} eq 'none') {
                   14788:                         if ($domdefs{'canclone'} eq 'domain') {
                   14789:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   14790:                                 $can_clone = 1;
                   14791:                             }
                   14792:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   14793:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   14794:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   14795:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   14796:                                 $can_clone = 1;
                   14797:                             }
                   14798:                         }
                   14799:                     }
1.908     raeburn  14800:                 }
1.1075.2.95  raeburn  14801:             } else {
                   14802: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   14803:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  14804:                     $can_clone = 1;
1.1075.2.95  raeburn  14805:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  14806:                     $can_clone = 1;
1.1075.2.96  raeburn  14807:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   14808:                     $can_clone = 1;
1.1075.2.95  raeburn  14809:                 }
                   14810:                 unless ($can_clone) {
1.1075.2.96  raeburn  14811:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   14812:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  14813:                         my (%gotdomdefaults,%gotcodedefaults);
                   14814:                         foreach my $cloner (@cloners) {
                   14815:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   14816:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   14817:                                 my (%codedefaults,@code_order);
                   14818:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   14819:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   14820:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   14821:                                     }
                   14822:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   14823:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   14824:                                     }
                   14825:                                 } else {
                   14826:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   14827:                                                                             \%codedefaults,
                   14828:                                                                             \@code_order);
                   14829:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   14830:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   14831:                                 }
                   14832:                                 if (@code_order > 0) {
                   14833:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   14834:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   14835:                                                                                 $args->{'crscode'})) {
                   14836:                                         $can_clone = 1;
                   14837:                                         last;
                   14838:                                     }
                   14839:                                 }
                   14840:                             }
                   14841:                         }
                   14842:                     }
1.1075.2.96  raeburn  14843:                 }
                   14844:             }
                   14845:             unless ($can_clone) {
                   14846:                 my $ccrole = 'cc';
                   14847:                 if ($args->{'crstype'} eq 'Community') {
                   14848:                     $ccrole = 'co';
                   14849:                 }
                   14850:                 my %roleshash =
                   14851:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   14852:                                                   $args->{'ccdomain'},
                   14853:                                                   'userroles',['active'],[$ccrole],
                   14854:                                                   [$args->{'clonedomain'}]);
                   14855:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   14856:                     $can_clone = 1;
                   14857:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   14858:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   14859:                     $can_clone = 1;
1.1075.2.95  raeburn  14860:                 }
                   14861:             }
                   14862:             unless ($can_clone) {
                   14863:                 if ($args->{'crstype'} eq 'Community') {
                   14864:                     $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'});
                   14865:                 } else {
                   14866:                     $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'});
1.578     raeburn  14867: 	        }
1.566     albertel 14868: 	    }
1.578     raeburn  14869:         }
1.566     albertel 14870:     }
                   14871:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14872: }
                   14873: 
1.444     albertel 14874: sub construct_course {
1.1075.2.119  raeburn  14875:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   14876:         $cnum,$category,$coderef) = @_;
1.444     albertel 14877:     my $outcome;
1.541     raeburn  14878:     my $linefeed =  '<br />'."\n";
                   14879:     if ($context eq 'auto') {
                   14880:         $linefeed = "\n";
                   14881:     }
1.566     albertel 14882: 
                   14883: #
                   14884: # Are we cloning?
                   14885: #
                   14886:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   14887:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  14888: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 14889: 	if ($context ne 'auto') {
1.578     raeburn  14890:             if ($clonemsg ne '') {
                   14891: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   14892:             }
1.566     albertel 14893: 	}
                   14894: 	$outcome .= $clonemsg.$linefeed;
                   14895: 
                   14896:         if (!$can_clone) {
                   14897: 	    return (0,$outcome);
                   14898: 	}
                   14899:     }
                   14900: 
1.444     albertel 14901: #
                   14902: # Open course
                   14903: #
                   14904:     my $crstype = lc($args->{'crstype'});
                   14905:     my %cenv=();
                   14906:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   14907:                                              $args->{'cdescr'},
                   14908:                                              $args->{'curl'},
                   14909:                                              $args->{'course_home'},
                   14910:                                              $args->{'nonstandard'},
                   14911:                                              $args->{'crscode'},
                   14912:                                              $args->{'ccuname'}.':'.
                   14913:                                              $args->{'ccdomain'},
1.882     raeburn  14914:                                              $args->{'crstype'},
1.885     raeburn  14915:                                              $cnum,$context,$category);
1.444     albertel 14916: 
                   14917:     # Note: The testing routines depend on this being output; see 
                   14918:     # Utils::Course. This needs to at least be output as a comment
                   14919:     # if anyone ever decides to not show this, and Utils::Course::new
                   14920:     # will need to be suitably modified.
1.541     raeburn  14921:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  14922:     if ($$courseid =~ /^error:/) {
                   14923:         return (0,$outcome);
                   14924:     }
                   14925: 
1.444     albertel 14926: #
                   14927: # Check if created correctly
                   14928: #
1.479     albertel 14929:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 14930:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  14931:     if ($crsuhome eq 'no_host') {
                   14932:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   14933:         return (0,$outcome);
                   14934:     }
1.541     raeburn  14935:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 14936: 
1.444     albertel 14937: #
1.566     albertel 14938: # Do the cloning
                   14939: #   
                   14940:     if ($can_clone && $cloneid) {
                   14941: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   14942: 	if ($context ne 'auto') {
                   14943: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   14944: 	}
                   14945: 	$outcome .= $clonemsg.$linefeed;
                   14946: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 14947: # Copy all files
1.637     www      14948: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 14949: # Restore URL
1.566     albertel 14950: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 14951: # Restore title
1.566     albertel 14952: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  14953: # Restore creation date, creator and creation context.
                   14954:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   14955:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   14956:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 14957: # Mark as cloned
1.566     albertel 14958: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      14959: # Need to clone grading mode
                   14960:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   14961:         $cenv{'grading'}=$newenv{'grading'};
                   14962: # Do not clone these environment entries
                   14963:         &Apache::lonnet::del('environment',
                   14964:                   ['default_enrollment_start_date',
                   14965:                    'default_enrollment_end_date',
                   14966:                    'question.email',
                   14967:                    'policy.email',
                   14968:                    'comment.email',
                   14969:                    'pch.users.denied',
1.725     raeburn  14970:                    'plc.users.denied',
                   14971:                    'hidefromcat',
1.1075.2.36  raeburn  14972:                    'checkforpriv',
1.1075.2.59  raeburn  14973:                    'categories',
                   14974:                    'internal.uniquecode'],
1.638     www      14975:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  14976:         if ($args->{'textbook'}) {
                   14977:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   14978:         }
1.444     albertel 14979:     }
1.566     albertel 14980: 
1.444     albertel 14981: #
                   14982: # Set environment (will override cloned, if existing)
                   14983: #
                   14984:     my @sections = ();
                   14985:     my @xlists = ();
                   14986:     if ($args->{'crstype'}) {
                   14987:         $cenv{'type'}=$args->{'crstype'};
                   14988:     }
                   14989:     if ($args->{'crsid'}) {
                   14990:         $cenv{'courseid'}=$args->{'crsid'};
                   14991:     }
                   14992:     if ($args->{'crscode'}) {
                   14993:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   14994:     }
                   14995:     if ($args->{'crsquota'} ne '') {
                   14996:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   14997:     } else {
                   14998:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   14999:     }
                   15000:     if ($args->{'ccuname'}) {
                   15001:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15002:                                         ':'.$args->{'ccdomain'};
                   15003:     } else {
                   15004:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15005:     }
1.1075.2.31  raeburn  15006:     if ($args->{'defaultcredits'}) {
                   15007:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15008:     }
1.444     albertel 15009:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15010:     if ($args->{'crssections'}) {
                   15011:         $cenv{'internal.sectionnums'} = '';
                   15012:         if ($args->{'crssections'} =~ m/,/) {
                   15013:             @sections = split/,/,$args->{'crssections'};
                   15014:         } else {
                   15015:             $sections[0] = $args->{'crssections'};
                   15016:         }
                   15017:         if (@sections > 0) {
                   15018:             foreach my $item (@sections) {
                   15019:                 my ($sec,$gp) = split/:/,$item;
                   15020:                 my $class = $args->{'crscode'}.$sec;
                   15021:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15022:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15023:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15024:                     push(@badclasses,$class);
1.444     albertel 15025:                 }
                   15026:             }
                   15027:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15028:         }
                   15029:     }
                   15030: # do not hide course coordinator from staff listing, 
                   15031: # even if privileged
                   15032:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15033: # add course coordinator's domain to domains to check for privileged users
                   15034: # if different to course domain
                   15035:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15036:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15037:     }
1.444     albertel 15038: # add crosslistings
                   15039:     if ($args->{'crsxlist'}) {
                   15040:         $cenv{'internal.crosslistings'}='';
                   15041:         if ($args->{'crsxlist'} =~ m/,/) {
                   15042:             @xlists = split/,/,$args->{'crsxlist'};
                   15043:         } else {
                   15044:             $xlists[0] = $args->{'crsxlist'};
                   15045:         }
                   15046:         if (@xlists > 0) {
                   15047:             foreach my $item (@xlists) {
                   15048:                 my ($xl,$gp) = split/:/,$item;
                   15049:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15050:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15051:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15052:                     push(@badclasses,$xl);
1.444     albertel 15053:                 }
                   15054:             }
                   15055:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15056:         }
                   15057:     }
                   15058:     if ($args->{'autoadds'}) {
                   15059:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15060:     }
                   15061:     if ($args->{'autodrops'}) {
                   15062:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15063:     }
                   15064: # check for notification of enrollment changes
                   15065:     my @notified = ();
                   15066:     if ($args->{'notify_owner'}) {
                   15067:         if ($args->{'ccuname'} ne '') {
                   15068:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15069:         }
                   15070:     }
                   15071:     if ($args->{'notify_dc'}) {
                   15072:         if ($uname ne '') { 
1.630     raeburn  15073:             push(@notified,$uname.':'.$udom);
1.444     albertel 15074:         }
                   15075:     }
                   15076:     if (@notified > 0) {
                   15077:         my $notifylist;
                   15078:         if (@notified > 1) {
                   15079:             $notifylist = join(',',@notified);
                   15080:         } else {
                   15081:             $notifylist = $notified[0];
                   15082:         }
                   15083:         $cenv{'internal.notifylist'} = $notifylist;
                   15084:     }
                   15085:     if (@badclasses > 0) {
                   15086:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15087:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15088:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15089:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15090:         );
1.1075.2.119  raeburn  15091:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15092:                            &mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
1.541     raeburn  15093:         if ($context eq 'auto') {
                   15094:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15095:         } else {
1.566     albertel 15096:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15097:         }
                   15098:         foreach my $item (@badclasses) {
1.541     raeburn  15099:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15100:                 $outcome .= " - $item\n";
1.541     raeburn  15101:             } else {
1.1075.2.119  raeburn  15102:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15103:             }
1.1075.2.119  raeburn  15104:         }
                   15105:         if ($context eq 'auto') {
                   15106:             $outcome .= $linefeed;
                   15107:         } else {
                   15108:             $outcome .= "</ul><br /><br /></div>\n";
                   15109:         }
1.444     albertel 15110:     }
                   15111:     if ($args->{'no_end_date'}) {
                   15112:         $args->{'endaccess'} = 0;
                   15113:     }
                   15114:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15115:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15116:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15117:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15118:     if ($args->{'showphotos'}) {
                   15119:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15120:     }
                   15121:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15122:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15123:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15124:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15125:             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'); 
                   15126:             if ($context eq 'auto') {
                   15127:                 $outcome .= $krb_msg;
                   15128:             } else {
1.566     albertel 15129:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15130:             }
                   15131:             $outcome .= $linefeed;
1.444     albertel 15132:         }
                   15133:     }
                   15134:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15135:        if ($args->{'setpolicy'}) {
                   15136:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15137:        }
                   15138:        if ($args->{'setcontent'}) {
                   15139:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15140:        }
1.1075.2.110  raeburn  15141:        if ($args->{'setcomment'}) {
                   15142:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15143:        }
1.444     albertel 15144:     }
                   15145:     if ($args->{'reshome'}) {
                   15146: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15147: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15148:     }
                   15149: #
                   15150: # course has keyed access
                   15151: #
                   15152:     if ($args->{'setkeys'}) {
                   15153:        $cenv{'keyaccess'}='yes';
                   15154:     }
                   15155: # if specified, key authority is not course, but user
                   15156: # only active if keyaccess is yes
                   15157:     if ($args->{'keyauth'}) {
1.487     albertel 15158: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15159: 	$user = &LONCAPA::clean_username($user);
                   15160: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15161: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15162: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15163: 	}
                   15164:     }
                   15165: 
1.1075.2.59  raeburn  15166: #
                   15167: #  generate and store uniquecode (available to course requester), if course should have one.
                   15168: #
                   15169:     if ($args->{'uniquecode'}) {
                   15170:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15171:         if ($code) {
                   15172:             $cenv{'internal.uniquecode'} = $code;
                   15173:             my %crsinfo =
                   15174:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15175:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15176:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15177:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15178:             }
                   15179:             if (ref($coderef)) {
                   15180:                 $$coderef = $code;
                   15181:             }
                   15182:         }
                   15183:     }
                   15184: 
1.444     albertel 15185:     if ($args->{'disresdis'}) {
                   15186:         $cenv{'pch.roles.denied'}='st';
                   15187:     }
                   15188:     if ($args->{'disablechat'}) {
                   15189:         $cenv{'plc.roles.denied'}='st';
                   15190:     }
                   15191: 
                   15192:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15193:     # course
                   15194:     $cenv{'course.helper.not.run'} = 1;
                   15195:     #
                   15196:     # Use new Randomseed
                   15197:     #
                   15198:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15199:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15200:     #
                   15201:     # The encryption code and receipt prefix for this course
                   15202:     #
                   15203:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15204:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15205:     #
                   15206:     # By default, use standard grading
                   15207:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15208: 
1.541     raeburn  15209:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15210:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15211: #
                   15212: # Open all assignments
                   15213: #
                   15214:     if ($args->{'openall'}) {
                   15215:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   15216:        my %storecontent = ($storeunder         => time,
                   15217:                            $storeunder.'.type' => 'date_start');
                   15218:        
                   15219:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  15220:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15221:    }
                   15222: #
                   15223: # Set first page
                   15224: #
                   15225:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15226: 	    || ($cloneid)) {
1.445     albertel 15227: 	use LONCAPA::map;
1.444     albertel 15228: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15229: 
                   15230: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15231:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15232: 
1.444     albertel 15233:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15234:         my $title; my $url;
                   15235:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15236: 	    $title=&mt('Syllabus');
1.444     albertel 15237:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15238:         } else {
1.963     raeburn  15239:             $title=&mt('Table of Contents');
1.444     albertel 15240:             $url='/adm/navmaps';
                   15241:         }
1.445     albertel 15242: 
                   15243:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15244: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15245: 
                   15246: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15247:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15248:     }
1.566     albertel 15249: 
                   15250:     return (1,$outcome);
1.444     albertel 15251: }
                   15252: 
1.1075.2.59  raeburn  15253: sub make_unique_code {
                   15254:     my ($cdom,$cnum) = @_;
                   15255:     # get lock on uniquecodes db
                   15256:     my $lockhash = {
                   15257:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15258:                                                   ':'.$env{'user.domain'},
                   15259:                    };
                   15260:     my $tries = 0;
                   15261:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15262:     my ($code,$error);
                   15263: 
                   15264:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15265:         $tries ++;
                   15266:         sleep 1;
                   15267:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15268:     }
                   15269:     if ($gotlock eq 'ok') {
                   15270:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15271:         my $gotcode;
                   15272:         my $attempts = 0;
                   15273:         while ((!$gotcode) && ($attempts < 100)) {
                   15274:             $code = &generate_code();
                   15275:             if (!exists($currcodes{$code})) {
                   15276:                 $gotcode = 1;
                   15277:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15278:                     $error = 'nostore';
                   15279:                 }
                   15280:             }
                   15281:             $attempts ++;
                   15282:         }
                   15283:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15284:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15285:     } else {
                   15286:         $error = 'nolock';
                   15287:     }
                   15288:     return ($code,$error);
                   15289: }
                   15290: 
                   15291: sub generate_code {
                   15292:     my $code;
                   15293:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15294:     for (my $i=0; $i<6; $i++) {
                   15295:         my $lettnum = int (rand 2);
                   15296:         my $item = '';
                   15297:         if ($lettnum) {
                   15298:             $item = $letts[int( rand(18) )];
                   15299:         } else {
                   15300:             $item = 1+int( rand(8) );
                   15301:         }
                   15302:         $code .= $item;
                   15303:     }
                   15304:     return $code;
                   15305: }
                   15306: 
1.444     albertel 15307: ############################################################
                   15308: ############################################################
                   15309: 
1.953     droeschl 15310: #SD
                   15311: # only Community and Course, or anything else?
1.378     raeburn  15312: sub course_type {
                   15313:     my ($cid) = @_;
                   15314:     if (!defined($cid)) {
                   15315:         $cid = $env{'request.course.id'};
                   15316:     }
1.404     albertel 15317:     if (defined($env{'course.'.$cid.'.type'})) {
                   15318:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15319:     } else {
                   15320:         return 'Course';
1.377     raeburn  15321:     }
                   15322: }
1.156     albertel 15323: 
1.406     raeburn  15324: sub group_term {
                   15325:     my $crstype = &course_type();
                   15326:     my %names = (
                   15327:                   'Course' => 'group',
1.865     raeburn  15328:                   'Community' => 'group',
1.406     raeburn  15329:                 );
                   15330:     return $names{$crstype};
                   15331: }
                   15332: 
1.902     raeburn  15333: sub course_types {
1.1075.2.59  raeburn  15334:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15335:     my %typename = (
                   15336:                          official   => 'Official course',
                   15337:                          unofficial => 'Unofficial course',
                   15338:                          community  => 'Community',
1.1075.2.59  raeburn  15339:                          textbook   => 'Textbook course',
1.902     raeburn  15340:                    );
                   15341:     return (\@types,\%typename);
                   15342: }
                   15343: 
1.156     albertel 15344: sub icon {
                   15345:     my ($file)=@_;
1.505     albertel 15346:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15347:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15348:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15349:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15350: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15351: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15352: 	            $curfext.".gif") {
                   15353: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15354: 		$curfext.".gif";
                   15355: 	}
                   15356:     }
1.249     albertel 15357:     return &lonhttpdurl($iconname);
1.154     albertel 15358: } 
1.84      albertel 15359: 
1.575     albertel 15360: sub lonhttpdurl {
1.692     www      15361: #
                   15362: # Had been used for "small fry" static images on separate port 8080.
                   15363: # Modify here if lightweight http functionality desired again.
                   15364: # Currently eliminated due to increasing firewall issues.
                   15365: #
1.575     albertel 15366:     my ($url)=@_;
1.692     www      15367:     return $url;
1.215     albertel 15368: }
                   15369: 
1.213     albertel 15370: sub connection_aborted {
                   15371:     my ($r)=@_;
                   15372:     $r->print(" ");$r->rflush();
                   15373:     my $c = $r->connection;
                   15374:     return $c->aborted();
                   15375: }
                   15376: 
1.221     foxr     15377: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15378: #    strings as 'strings'.
                   15379: sub escape_single {
1.221     foxr     15380:     my ($input) = @_;
1.223     albertel 15381:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15382:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15383:     return $input;
                   15384: }
1.223     albertel 15385: 
1.222     foxr     15386: #  Same as escape_single, but escape's "'s  This 
                   15387: #  can be used for  "strings"
                   15388: sub escape_double {
                   15389:     my ($input) = @_;
                   15390:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15391:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15392:     return $input;
                   15393: }
1.223     albertel 15394:  
1.222     foxr     15395: #   Escapes the last element of a full URL.
                   15396: sub escape_url {
                   15397:     my ($url)   = @_;
1.238     raeburn  15398:     my @urlslices = split(/\//, $url,-1);
1.369     www      15399:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15400:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15401: }
1.462     albertel 15402: 
1.820     raeburn  15403: sub compare_arrays {
                   15404:     my ($arrayref1,$arrayref2) = @_;
                   15405:     my (@difference,%count);
                   15406:     @difference = ();
                   15407:     %count = ();
                   15408:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15409:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15410:         foreach my $element (keys(%count)) {
                   15411:             if ($count{$element} == 1) {
                   15412:                 push(@difference,$element);
                   15413:             }
                   15414:         }
                   15415:     }
                   15416:     return @difference;
                   15417: }
                   15418: 
1.817     bisitz   15419: # -------------------------------------------------------- Initialize user login
1.462     albertel 15420: sub init_user_environment {
1.463     albertel 15421:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15422:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15423: 
                   15424:     my $public=($username eq 'public' && $domain eq 'public');
                   15425: 
                   15426: # See if old ID present, if so, remove
                   15427: 
1.1062    raeburn  15428:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15429:     my $now=time;
                   15430: 
                   15431:     if ($public) {
                   15432: 	my $max_public=100;
                   15433: 	my $oldest;
                   15434: 	my $oldest_time=0;
                   15435: 	for(my $next=1;$next<=$max_public;$next++) {
                   15436: 	    if (-e $lonids."/publicuser_$next.id") {
                   15437: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15438: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15439: 		    $oldest_time=$mtime;
                   15440: 		    $oldest=$next;
                   15441: 		}
                   15442: 	    } else {
                   15443: 		$cookie="publicuser_$next";
                   15444: 		last;
                   15445: 	    }
                   15446: 	}
                   15447: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15448:     } else {
1.463     albertel 15449: 	# if this isn't a robot, kill any existing non-robot sessions
                   15450: 	if (!$args->{'robot'}) {
                   15451: 	    opendir(DIR,$lonids);
                   15452: 	    while ($filename=readdir(DIR)) {
                   15453: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   15454: 		    unlink($lonids.'/'.$filename);
                   15455: 		}
1.462     albertel 15456: 	    }
1.463     albertel 15457: 	    closedir(DIR);
1.1075.2.84  raeburn  15458: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15459:             my $namespace = 'nohist_courseeditor';
                   15460:             my $lockingkey = 'paste'."\0".'locked_num';
                   15461:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15462:                                                 $domain,$username);
                   15463:             if (exists($lockhash{$lockingkey})) {
                   15464:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15465:                 unless ($delresult eq 'ok') {
                   15466:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15467:                 }
                   15468:             }
1.462     albertel 15469: 	}
                   15470: # Give them a new cookie
1.463     albertel 15471: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15472: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15473: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15474:     
                   15475: # Initialize roles
                   15476: 
1.1062    raeburn  15477: 	($userroles,$firstaccenv,$timerintenv) = 
                   15478:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15479:     }
                   15480: # ------------------------------------ Check browser type and MathML capability
                   15481: 
1.1075.2.77  raeburn  15482:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15483:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15484: 
                   15485: # ------------------------------------------------------------- Get environment
                   15486: 
                   15487:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15488:     my ($tmp) = keys(%userenv);
                   15489:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15490:     } else {
                   15491: 	undef(%userenv);
                   15492:     }
                   15493:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15494: 	$form->{'interface'}=$userenv{'interface'};
                   15495:     }
                   15496:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15497: 
                   15498: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15499:     foreach my $option ('interface','localpath','localres') {
                   15500:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15501:     }
                   15502: # --------------------------------------------------------- Write first profile
                   15503: 
                   15504:     {
                   15505: 	my %initial_env = 
                   15506: 	    ("user.name"          => $username,
                   15507: 	     "user.domain"        => $domain,
                   15508: 	     "user.home"          => $authhost,
                   15509: 	     "browser.type"       => $clientbrowser,
                   15510: 	     "browser.version"    => $clientversion,
                   15511: 	     "browser.mathml"     => $clientmathml,
                   15512: 	     "browser.unicode"    => $clientunicode,
                   15513: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15514:              "browser.mobile"     => $clientmobile,
                   15515:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15516:              "browser.osversion"  => $clientosversion,
1.462     albertel 15517: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15518: 	     "request.course.fn"  => '',
                   15519: 	     "request.course.uri" => '',
                   15520: 	     "request.course.sec" => '',
                   15521: 	     "request.role"       => 'cm',
                   15522: 	     "request.role.adv"   => $env{'user.adv'},
                   15523: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   15524: 
                   15525:         if ($form->{'localpath'}) {
                   15526: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15527: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15528:         }
                   15529: 	
                   15530: 	if ($form->{'interface'}) {
                   15531: 	    $form->{'interface'}=~s/\W//gs;
                   15532: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15533: 	    $env{'browser.interface'}=$form->{'interface'};
                   15534: 	}
                   15535: 
1.1075.2.54  raeburn  15536:         if ($form->{'iptoken'}) {
                   15537:             my $lonhost = $r->dir_config('lonHostID');
                   15538:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15539:             $env{'user.noloadbalance'} = $lonhost;
                   15540:         }
                   15541: 
1.1075.2.120  raeburn  15542:         if ($form->{'noloadbalance'}) {
                   15543:             my @hosts = &Apache::lonnet::current_machine_ids();
                   15544:             my $hosthere = $form->{'noloadbalance'};
                   15545:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   15546:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   15547:                 $env{'user.noloadbalance'} = $hosthere;
                   15548:             }
                   15549:         }
                   15550: 
1.1016    raeburn  15551:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  15552:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   15553:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  15554: 
1.1075.2.125  raeburn  15555:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   15556:                 $userenv{'availabletools.'.$tool} = 
                   15557:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15558:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   15559:             }
1.724     raeburn  15560: 
1.1075.2.125  raeburn  15561:             foreach my $crstype ('official','unofficial','community','textbook') {
                   15562:                 $userenv{'canrequest.'.$crstype} =
                   15563:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   15564:                                                       'reload','requestcourses',
                   15565:                                                       \%userenv,\%domdef,\%is_adv);
                   15566:             }
1.765     raeburn  15567: 
1.1075.2.125  raeburn  15568:             $userenv{'canrequest.author'} =
                   15569:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15570:                                                   'reload','requestauthor',
                   15571:                                                   \%userenv,\%domdef,\%is_adv);
                   15572:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15573:                                                  $domain,$username);
                   15574:             my $reqstatus = $reqauthor{'author_status'};
                   15575:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   15576:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   15577:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   15578:                                                       $reqauthor{'author'}{'timestamp'};
                   15579:                 }
1.1075.2.14  raeburn  15580:             }
                   15581:         }
                   15582: 
1.462     albertel 15583: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  15584: 
1.462     albertel 15585: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   15586: 		 &GDBM_WRCREAT(),0640)) {
                   15587: 	    &_add_to_env(\%disk_env,\%initial_env);
                   15588: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   15589: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  15590:             if (ref($firstaccenv) eq 'HASH') {
                   15591:                 &_add_to_env(\%disk_env,$firstaccenv);
                   15592:             }
                   15593:             if (ref($timerintenv) eq 'HASH') {
                   15594:                 &_add_to_env(\%disk_env,$timerintenv);
                   15595:             }
1.463     albertel 15596: 	    if (ref($args->{'extra_env'})) {
                   15597: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   15598: 	    }
1.462     albertel 15599: 	    untie(%disk_env);
                   15600: 	} else {
1.705     tempelho 15601: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   15602: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 15603: 	    return 'error: '.$!;
                   15604: 	}
                   15605:     }
                   15606:     $env{'request.role'}='cm';
                   15607:     $env{'request.role.adv'}=$env{'user.adv'};
                   15608:     $env{'browser.type'}=$clientbrowser;
                   15609: 
                   15610:     return $cookie;
                   15611: 
                   15612: }
                   15613: 
                   15614: sub _add_to_env {
                   15615:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  15616:     if (ref($env_data) eq 'HASH') {
                   15617:         while (my ($key,$value) = each(%$env_data)) {
                   15618: 	    $idf->{$prefix.$key} = $value;
                   15619: 	    $env{$prefix.$key}   = $value;
                   15620:         }
1.462     albertel 15621:     }
                   15622: }
                   15623: 
1.685     tempelho 15624: # --- Get the symbolic name of a problem and the url
                   15625: sub get_symb {
                   15626:     my ($request,$silent) = @_;
1.726     raeburn  15627:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 15628:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   15629:     if ($symb eq '') {
                   15630:         if (!$silent) {
1.1071    raeburn  15631:             if (ref($request)) { 
                   15632:                 $request->print("Unable to handle ambiguous references:$url:.");
                   15633:             }
1.685     tempelho 15634:             return ();
                   15635:         }
                   15636:     }
                   15637:     &Apache::lonenc::check_decrypt(\$symb);
                   15638:     return ($symb);
                   15639: }
                   15640: 
                   15641: # --------------------------------------------------------------Get annotation
                   15642: 
                   15643: sub get_annotation {
                   15644:     my ($symb,$enc) = @_;
                   15645: 
                   15646:     my $key = $symb;
                   15647:     if (!$enc) {
                   15648:         $key =
                   15649:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   15650:     }
                   15651:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   15652:     return $annotation{$key};
                   15653: }
                   15654: 
                   15655: sub clean_symb {
1.731     raeburn  15656:     my ($symb,$delete_enc) = @_;
1.685     tempelho 15657: 
                   15658:     &Apache::lonenc::check_decrypt(\$symb);
                   15659:     my $enc = $env{'request.enc'};
1.731     raeburn  15660:     if ($delete_enc) {
1.730     raeburn  15661:         delete($env{'request.enc'});
                   15662:     }
1.685     tempelho 15663: 
                   15664:     return ($symb,$enc);
                   15665: }
1.462     albertel 15666: 
1.1075.2.69  raeburn  15667: ############################################################
                   15668: ############################################################
                   15669: 
                   15670: =pod
                   15671: 
                   15672: =head1 Routines for building display used to search for courses
                   15673: 
                   15674: 
                   15675: =over 4
                   15676: 
                   15677: =item * &build_filters()
                   15678: 
                   15679: Create markup for a table used to set filters to use when selecting
                   15680: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   15681: and quotacheck.pl
                   15682: 
                   15683: 
                   15684: Inputs:
                   15685: 
                   15686: filterlist - anonymous array of fields to include as potential filters
                   15687: 
                   15688: crstype - course type
                   15689: 
                   15690: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   15691:               to pop-open a course selector (will contain "extra element").
                   15692: 
                   15693: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   15694: 
                   15695: filter - anonymous hash of criteria and their values
                   15696: 
                   15697: action - form action
                   15698: 
                   15699: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   15700: 
                   15701: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   15702: 
                   15703: cloneruname - username of owner of new course who wants to clone
                   15704: 
                   15705: clonerudom - domain of owner of new course who wants to clone
                   15706: 
                   15707: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   15708: 
                   15709: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   15710: 
                   15711: codedom - domain
                   15712: 
                   15713: formname - value of form element named "form".
                   15714: 
                   15715: fixeddom - domain, if fixed.
                   15716: 
                   15717: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   15718: 
                   15719: cnameelement - name of form element in form on opener page which will receive title of selected course
                   15720: 
                   15721: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   15722: 
                   15723: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   15724: 
                   15725: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   15726: 
                   15727: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   15728: 
                   15729: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   15730: 
                   15731: 
                   15732: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   15733: 
                   15734: 
                   15735: Side Effects: None
                   15736: 
                   15737: =cut
                   15738: 
                   15739: # ---------------------------------------------- search for courses based on last activity etc.
                   15740: 
                   15741: sub build_filters {
                   15742:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   15743:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   15744:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   15745:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   15746:         $clonetext,$clonewarning) = @_;
                   15747:     my ($list,$jscript);
                   15748:     my $onchange = 'javascript:updateFilters(this)';
                   15749:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   15750:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   15751:         $typeselectform,$instcodetitle);
                   15752:     if ($formname eq '') {
                   15753:         $formname = $caller;
                   15754:     }
                   15755:     foreach my $item (@{$filterlist}) {
                   15756:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   15757:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   15758:             if ($item eq 'domainfilter') {
                   15759:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   15760:             } elsif ($item eq 'coursefilter') {
                   15761:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   15762:             } elsif ($item eq 'ownerfilter') {
                   15763:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   15764:             } elsif ($item eq 'ownerdomfilter') {
                   15765:                 $filter->{'ownerdomfilter'} =
                   15766:                     &LONCAPA::clean_domain($filter->{$item});
                   15767:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   15768:                                                        'ownerdomfilter',1);
                   15769:             } elsif ($item eq 'personfilter') {
                   15770:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   15771:             } elsif ($item eq 'persondomfilter') {
                   15772:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   15773:                                                         'persondomfilter',1);
                   15774:             } else {
                   15775:                 $filter->{$item} =~ s/\W//g;
                   15776:             }
                   15777:             if (!$filter->{$item}) {
                   15778:                 $filter->{$item} = '';
                   15779:             }
                   15780:         }
                   15781:         if ($item eq 'domainfilter') {
                   15782:             my $allow_blank = 1;
                   15783:             if ($formname eq 'portform') {
                   15784:                 $allow_blank=0;
                   15785:             } elsif ($formname eq 'studentform') {
                   15786:                 $allow_blank=0;
                   15787:             }
                   15788:             if ($fixeddom) {
                   15789:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   15790:                                     ' value="'.$codedom.'" />'.
                   15791:                                     &Apache::lonnet::domain($codedom,'description');
                   15792:             } else {
                   15793:                 $domainselectform = &select_dom_form($filter->{$item},
                   15794:                                                      'domainfilter',
                   15795:                                                       $allow_blank,'',$onchange);
                   15796:             }
                   15797:         } else {
                   15798:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   15799:         }
                   15800:     }
                   15801: 
                   15802:     # last course activity filter and selection
                   15803:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   15804: 
                   15805:     # course created filter and selection
                   15806:     if (exists($filter->{'createdfilter'})) {
                   15807:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   15808:     }
                   15809: 
                   15810:     my %lt = &Apache::lonlocal::texthash(
                   15811:                 'cac' => "$crstype Activity",
                   15812:                 'ccr' => "$crstype Created",
                   15813:                 'cde' => "$crstype Title",
                   15814:                 'cdo' => "$crstype Domain",
                   15815:                 'ins' => 'Institutional Code',
                   15816:                 'inc' => 'Institutional Categorization',
                   15817:                 'cow' => "$crstype Owner/Co-owner",
                   15818:                 'cop' => "$crstype Personnel Includes",
                   15819:                 'cog' => 'Type',
                   15820:              );
                   15821: 
                   15822:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   15823:         my $typeval = 'Course';
                   15824:         if ($crstype eq 'Community') {
                   15825:             $typeval = 'Community';
                   15826:         }
                   15827:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   15828:     } else {
                   15829:         $typeselectform =  '<select name="type" size="1"';
                   15830:         if ($onchange) {
                   15831:             $typeselectform .= ' onchange="'.$onchange.'"';
                   15832:         }
                   15833:         $typeselectform .= '>'."\n";
                   15834:         foreach my $posstype ('Course','Community') {
                   15835:             $typeselectform.='<option value="'.$posstype.'"'.
                   15836:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   15837:         }
                   15838:         $typeselectform.="</select>";
                   15839:     }
                   15840: 
                   15841:     my ($cloneableonlyform,$cloneabletitle);
                   15842:     if (exists($filter->{'cloneableonly'})) {
                   15843:         my $cloneableon = '';
                   15844:         my $cloneableoff = ' checked="checked"';
                   15845:         if ($filter->{'cloneableonly'}) {
                   15846:             $cloneableon = $cloneableoff;
                   15847:             $cloneableoff = '';
                   15848:         }
                   15849:         $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/>&nbsp;'.&mt('Required').'</label>'.('&nbsp;'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' />&nbsp;'.&mt('No restriction').'</label></span>';
                   15850:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  15851:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  15852:         } else {
                   15853:             $cloneabletitle = &mt('Cloneable by you');
                   15854:         }
                   15855:     }
                   15856:     my $officialjs;
                   15857:     if ($crstype eq 'Course') {
                   15858:         if (exists($filter->{'instcodefilter'})) {
                   15859: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   15860: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   15861:             if ($codedom) {
                   15862:                 $officialjs = 1;
                   15863:                 ($instcodeform,$jscript,$$numtitlesref) =
                   15864:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   15865:                                                                   $officialjs,$codetitlesref);
                   15866:                 if ($jscript) {
                   15867:                     $jscript = '<script type="text/javascript">'."\n".
                   15868:                                '// <![CDATA['."\n".
                   15869:                                $jscript."\n".
                   15870:                                '// ]]>'."\n".
                   15871:                                '</script>'."\n";
                   15872:                 }
                   15873:             }
                   15874:             if ($instcodeform eq '') {
                   15875:                 $instcodeform =
                   15876:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   15877:                     $list->{'instcodefilter'}.'" />';
                   15878:                 $instcodetitle = $lt{'ins'};
                   15879:             } else {
                   15880:                 $instcodetitle = $lt{'inc'};
                   15881:             }
                   15882:             if ($fixeddom) {
                   15883:                 $instcodetitle .= '<br />('.$codedom.')';
                   15884:             }
                   15885:         }
                   15886:     }
                   15887:     my $output = qq|
                   15888: <form method="post" name="filterpicker" action="$action">
                   15889: <input type="hidden" name="form" value="$formname" />
                   15890: |;
                   15891:     if ($formname eq 'modifycourse') {
                   15892:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   15893:                    '<input type="hidden" name="prevphase" value="'.
                   15894:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  15895:     } elsif ($formname eq 'quotacheck') {
                   15896:         $output .= qq|
                   15897: <input type="hidden" name="sortby" value="" />
                   15898: <input type="hidden" name="sortorder" value="" />
                   15899: |;
                   15900:     } else {
1.1075.2.69  raeburn  15901:         my $name_input;
                   15902:         if ($cnameelement ne '') {
                   15903:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   15904:                           $cnameelement.'" />';
                   15905:         }
                   15906:         $output .= qq|
                   15907: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   15908: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   15909: $name_input
                   15910: $roleelement
                   15911: $multelement
                   15912: $typeelement
                   15913: |;
                   15914:         if ($formname eq 'portform') {
                   15915:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   15916:         }
                   15917:     }
                   15918:     if ($fixeddom) {
                   15919:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   15920:     }
                   15921:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   15922:     if ($sincefilterform) {
                   15923:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   15924:                   .$sincefilterform
                   15925:                   .&Apache::lonhtmlcommon::row_closure();
                   15926:     }
                   15927:     if ($createdfilterform) {
                   15928:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   15929:                   .$createdfilterform
                   15930:                   .&Apache::lonhtmlcommon::row_closure();
                   15931:     }
                   15932:     if ($domainselectform) {
                   15933:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   15934:                   .$domainselectform
                   15935:                   .&Apache::lonhtmlcommon::row_closure();
                   15936:     }
                   15937:     if ($typeselectform) {
                   15938:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   15939:             $output .= $typeselectform;
                   15940:         } else {
                   15941:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   15942:                       .$typeselectform
                   15943:                       .&Apache::lonhtmlcommon::row_closure();
                   15944:         }
                   15945:     }
                   15946:     if ($instcodeform) {
                   15947:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   15948:                   .$instcodeform
                   15949:                   .&Apache::lonhtmlcommon::row_closure();
                   15950:     }
                   15951:     if (exists($filter->{'ownerfilter'})) {
                   15952:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   15953:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   15954:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   15955:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   15956:                    $ownerdomselectform.'</td></tr></table>'.
                   15957:                    &Apache::lonhtmlcommon::row_closure();
                   15958:     }
                   15959:     if (exists($filter->{'personfilter'})) {
                   15960:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   15961:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   15962:                    '<input type="text" name="personfilter" size="20" value="'.
                   15963:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   15964:                    $persondomselectform.'</td></tr></table>'.
                   15965:                    &Apache::lonhtmlcommon::row_closure();
                   15966:     }
                   15967:     if (exists($filter->{'coursefilter'})) {
                   15968:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   15969:                   .'<input type="text" name="coursefilter" size="25" value="'
                   15970:                   .$list->{'coursefilter'}.'" />'
                   15971:                   .&Apache::lonhtmlcommon::row_closure();
                   15972:     }
                   15973:     if ($cloneableonlyform) {
                   15974:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   15975:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   15976:     }
                   15977:     if (exists($filter->{'descriptfilter'})) {
                   15978:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   15979:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   15980:                   .$list->{'descriptfilter'}.'" />'
                   15981:                   .&Apache::lonhtmlcommon::row_closure(1);
                   15982:     }
                   15983:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   15984:                '<input type="hidden" name="updater" value="" />'."\n".
                   15985:                '<input type="submit" name="gosearch" value="'.
                   15986:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   15987:     return $jscript.$clonewarning.$output;
                   15988: }
                   15989: 
                   15990: =pod
                   15991: 
                   15992: =item * &timebased_select_form()
                   15993: 
                   15994: Create markup for a dropdown list used to select a time-based
                   15995: filter e.g., Course Activity, Course Created, when searching for courses
                   15996: or communities
                   15997: 
                   15998: Inputs:
                   15999: 
                   16000: item - name of form element (sincefilter or createdfilter)
                   16001: 
                   16002: filter - anonymous hash of criteria and their values
                   16003: 
                   16004: Returns: HTML for a select box contained a blank, then six time selections,
                   16005:          with value set in incoming form variables currently selected.
                   16006: 
                   16007: Side Effects: None
                   16008: 
                   16009: =cut
                   16010: 
                   16011: sub timebased_select_form {
                   16012:     my ($item,$filter) = @_;
                   16013:     if (ref($filter) eq 'HASH') {
                   16014:         $filter->{$item} =~ s/[^\d-]//g;
                   16015:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16016:         return &select_form(
                   16017:                             $filter->{$item},
                   16018:                             $item,
                   16019:                             {      '-1' => '',
                   16020:                                 '86400' => &mt('today'),
                   16021:                                '604800' => &mt('last week'),
                   16022:                               '2592000' => &mt('last month'),
                   16023:                               '7776000' => &mt('last three months'),
                   16024:                              '15552000' => &mt('last six months'),
                   16025:                              '31104000' => &mt('last year'),
                   16026:                     'select_form_order' =>
                   16027:                            ['-1','86400','604800','2592000','7776000',
                   16028:                             '15552000','31104000']});
                   16029:     }
                   16030: }
                   16031: 
                   16032: =pod
                   16033: 
                   16034: =item * &js_changer()
                   16035: 
                   16036: Create script tag containing Javascript used to submit course search form
                   16037: when course type or domain is changed, and also to hide 'Searching ...' on
                   16038: page load completion for page showing search result.
                   16039: 
                   16040: Inputs: None
                   16041: 
                   16042: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16043: 
                   16044: Side Effects: None
                   16045: 
                   16046: =cut
                   16047: 
                   16048: sub js_changer {
                   16049:     return <<ENDJS;
                   16050: <script type="text/javascript">
                   16051: // <![CDATA[
                   16052: function updateFilters(caller) {
                   16053:     if (typeof(caller) != "undefined") {
                   16054:         document.filterpicker.updater.value = caller.name;
                   16055:     }
                   16056:     document.filterpicker.submit();
                   16057: }
                   16058: 
                   16059: function hideSearching() {
                   16060:     if (document.getElementById('searching')) {
                   16061:         document.getElementById('searching').style.display = 'none';
                   16062:     }
                   16063:     return;
                   16064: }
                   16065: 
                   16066: // ]]>
                   16067: </script>
                   16068: 
                   16069: ENDJS
                   16070: }
                   16071: 
                   16072: =pod
                   16073: 
                   16074: =item * &search_courses()
                   16075: 
                   16076: Process selected filters form course search form and pass to lonnet::courseiddump
                   16077: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16078: 
                   16079: Inputs:
                   16080: 
                   16081: dom - domain being searched
                   16082: 
                   16083: type - course type ('Course' or 'Community' or '.' if any).
                   16084: 
                   16085: filter - anonymous hash of criteria and their values
                   16086: 
                   16087: numtitles - for institutional codes - number of categories
                   16088: 
                   16089: cloneruname - optional username of new course owner
                   16090: 
                   16091: clonerudom - optional domain of new course owner
                   16092: 
1.1075.2.95  raeburn  16093: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16094:             (used when DC is using course creation form)
                   16095: 
                   16096: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16097: 
1.1075.2.95  raeburn  16098: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16099:            (and so can clone automatically)
                   16100: 
                   16101: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16102: 
                   16103: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16104:               courses to clone
1.1075.2.69  raeburn  16105: 
                   16106: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16107: 
                   16108: 
                   16109: Side Effects: None
                   16110: 
                   16111: =cut
                   16112: 
                   16113: 
                   16114: sub search_courses {
1.1075.2.95  raeburn  16115:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16116:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16117:     my (%courses,%showcourses,$cloner);
                   16118:     if (($filter->{'ownerfilter'} ne '') ||
                   16119:         ($filter->{'ownerdomfilter'} ne '')) {
                   16120:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16121:                                        $filter->{'ownerdomfilter'};
                   16122:     }
                   16123:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16124:         if (!$filter->{$item}) {
                   16125:             $filter->{$item}='.';
                   16126:         }
                   16127:     }
                   16128:     my $now = time;
                   16129:     my $timefilter =
                   16130:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16131:     my ($createdbefore,$createdafter);
                   16132:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16133:         $createdbefore = $now;
                   16134:         $createdafter = $now-$filter->{'createdfilter'};
                   16135:     }
                   16136:     my ($instcodefilter,$regexpok);
                   16137:     if ($numtitles) {
                   16138:         if ($env{'form.official'} eq 'on') {
                   16139:             $instcodefilter =
                   16140:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16141:             $regexpok = 1;
                   16142:         } elsif ($env{'form.official'} eq 'off') {
                   16143:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16144:             unless ($instcodefilter eq '') {
                   16145:                 $regexpok = -1;
                   16146:             }
                   16147:         }
                   16148:     } else {
                   16149:         $instcodefilter = $filter->{'instcodefilter'};
                   16150:     }
                   16151:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16152:     if ($type eq '') { $type = '.'; }
                   16153: 
                   16154:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16155:         $cloner = $cloneruname.':'.$clonerudom;
                   16156:     }
                   16157:     %courses = &Apache::lonnet::courseiddump($dom,
                   16158:                                              $filter->{'descriptfilter'},
                   16159:                                              $timefilter,
                   16160:                                              $instcodefilter,
                   16161:                                              $filter->{'combownerfilter'},
                   16162:                                              $filter->{'coursefilter'},
                   16163:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16164:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16165:                                              $filter->{'cloneableonly'},
                   16166:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16167:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16168:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16169:         my $ccrole;
                   16170:         if ($type eq 'Community') {
                   16171:             $ccrole = 'co';
                   16172:         } else {
                   16173:             $ccrole = 'cc';
                   16174:         }
                   16175:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16176:                                                      $filter->{'persondomfilter'},
                   16177:                                                      'userroles',undef,
                   16178:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16179:                                                      $dom);
                   16180:         foreach my $role (keys(%rolehash)) {
                   16181:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16182:             my $cid = $cdom.'_'.$cnum;
                   16183:             if (exists($courses{$cid})) {
                   16184:                 if (ref($courses{$cid}) eq 'HASH') {
                   16185:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16186:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16187:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16188:                         }
                   16189:                     } else {
                   16190:                         $courses{$cid}{roles} = [$courserole];
                   16191:                     }
                   16192:                     $showcourses{$cid} = $courses{$cid};
                   16193:                 }
                   16194:             }
                   16195:         }
                   16196:         %courses = %showcourses;
                   16197:     }
                   16198:     return %courses;
                   16199: }
                   16200: 
                   16201: =pod
                   16202: 
                   16203: =back
                   16204: 
1.1075.2.88  raeburn  16205: =head1 Routines for version requirements for current course.
                   16206: 
                   16207: =over 4
                   16208: 
                   16209: =item * &check_release_required()
                   16210: 
                   16211: Compares required LON-CAPA version with version on server, and
                   16212: if required version is newer looks for a server with the required version.
                   16213: 
                   16214: Looks first at servers in user's owen domain; if none suitable, looks at
                   16215: servers in course's domain are permitted to host sessions for user's domain.
                   16216: 
                   16217: Inputs:
                   16218: 
                   16219: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16220: 
                   16221: $courseid - Course ID of current course
                   16222: 
                   16223: $rolecode - User's current role in course (for switchserver query string).
                   16224: 
                   16225: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16226: 
                   16227: 
                   16228: Returns:
                   16229: 
                   16230: $switchserver - query string tp append to /adm/switchserver call (if
                   16231:                 current server's LON-CAPA version is too old.
                   16232: 
                   16233: $warning - Message is displayed if no suitable server could be found.
                   16234: 
                   16235: =cut
                   16236: 
                   16237: sub check_release_required {
                   16238:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16239:     my ($switchserver,$warning);
                   16240:     if ($required ne '') {
                   16241:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16242:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16243:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16244:             my $otherserver;
                   16245:             if (($major eq '' && $minor eq '') ||
                   16246:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16247:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16248:                 my $switchlcrev =
                   16249:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16250:                                                            $userdomserver);
                   16251:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16252:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16253:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16254:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16255:                     if ($cdom ne $env{'user.domain'}) {
                   16256:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16257:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16258:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16259:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16260:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16261:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16262:                         my $canhost =
                   16263:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16264:                                                               $coursedomserver,
                   16265:                                                               $remoterev,
                   16266:                                                               $udomdefaults{'remotesessions'},
                   16267:                                                               $defdomdefaults{'hostedsessions'});
                   16268: 
                   16269:                         if ($canhost) {
                   16270:                             $otherserver = $coursedomserver;
                   16271:                         } else {
                   16272:                             $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
                   16273:                         }
                   16274:                     } else {
                   16275:                         $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
                   16276:                     }
                   16277:                 } else {
                   16278:                     $otherserver = $userdomserver;
                   16279:                 }
                   16280:             }
                   16281:             if ($otherserver ne '') {
                   16282:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16283:             }
                   16284:         }
                   16285:     }
                   16286:     return ($switchserver,$warning);
                   16287: }
                   16288: 
                   16289: =pod
                   16290: 
                   16291: =item * &check_release_result()
                   16292: 
                   16293: Inputs:
                   16294: 
                   16295: $switchwarning - Warning message if no suitable server found to host session.
                   16296: 
                   16297: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16298:                 and current role.
                   16299: 
                   16300: Returns: HTML to display with information about requirement to switch server.
                   16301:          Either displaying warning with link to Roles/Courses screen or
                   16302:          display link to switchserver.
                   16303: 
1.1075.2.69  raeburn  16304: =cut
                   16305: 
1.1075.2.88  raeburn  16306: sub check_release_result {
                   16307:     my ($switchwarning,$switchserver) = @_;
                   16308:     my $output = &start_page('Selected course unavailable on this server').
                   16309:                  '<p class="LC_warning">';
                   16310:     if ($switchwarning) {
                   16311:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16312:         if (&show_course()) {
                   16313:             $output .= &mt('Display courses');
                   16314:         } else {
                   16315:             $output .= &mt('Display roles');
                   16316:         }
                   16317:         $output .= '</a>';
                   16318:     } elsif ($switchserver) {
                   16319:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16320:                    '<br />'.
                   16321:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16322:                    &mt('Switch Server').
                   16323:                    '</a>';
                   16324:     }
                   16325:     $output .= '</p>'.&end_page();
                   16326:     return $output;
                   16327: }
                   16328: 
                   16329: =pod
                   16330: 
                   16331: =item * &needs_coursereinit()
                   16332: 
                   16333: Determine if course contents stored for user's session needs to be
                   16334: refreshed, because content has changed since "Big Hash" last tied.
                   16335: 
                   16336: Check for change is made if time last checked is more than 10 minutes ago
                   16337: (by default).
                   16338: 
                   16339: Inputs:
                   16340: 
                   16341: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16342: 
                   16343: $interval (optional) - Time which may elapse (in s) between last check for content
                   16344:                        change in current course. (default: 600 s).
                   16345: 
                   16346: Returns: an array; first element is:
                   16347: 
                   16348: =over 4
                   16349: 
                   16350: 'switch' - if content updates mean user's session
                   16351:            needs to be switched to a server running a newer LON-CAPA version
                   16352: 
                   16353: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16354:            on current server hosting user's session
                   16355: 
                   16356: ''       - if no action required.
                   16357: 
                   16358: =back
                   16359: 
                   16360: If first item element is 'switch':
                   16361: 
                   16362: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16363: 
                   16364: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16365:                               and current role.
                   16366: 
                   16367: otherwise: no other elements returned.
                   16368: 
                   16369: =back
                   16370: 
                   16371: =cut
                   16372: 
                   16373: sub needs_coursereinit {
                   16374:     my ($loncaparev,$interval) = @_;
                   16375:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16376:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16377:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16378:     my $now = time;
                   16379:     if ($interval eq '') {
                   16380:         $interval = 600;
                   16381:     }
                   16382:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16383:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16384:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   16385:         if ($lastchange > $env{'request.course.tied'}) {
                   16386:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16387:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16388:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16389:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16390:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16391:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16392:                     my ($switchserver,$switchwarning) =
                   16393:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16394:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16395:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16396:                         return ('switch',$switchwarning,$switchserver);
                   16397:                     }
                   16398:                 }
                   16399:             }
                   16400:             return ('update');
                   16401:         }
                   16402:     }
                   16403:     return ();
                   16404: }
1.1075.2.69  raeburn  16405: 
1.1075.2.11  raeburn  16406: sub update_content_constraints {
                   16407:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16408:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16409:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16410:     my %checkresponsetypes;
                   16411:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16412:         my ($item,$name,$value) = split(/:/,$key);
                   16413:         if ($item eq 'resourcetag') {
                   16414:             if ($name eq 'responsetype') {
                   16415:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16416:             }
                   16417:         }
                   16418:     }
                   16419:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16420:     if (defined($navmap)) {
                   16421:         my %allresponses;
                   16422:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16423:             my %responses = $res->responseTypes();
                   16424:             foreach my $key (keys(%responses)) {
                   16425:                 next unless(exists($checkresponsetypes{$key}));
                   16426:                 $allresponses{$key} += $responses{$key};
                   16427:             }
                   16428:         }
                   16429:         foreach my $key (keys(%allresponses)) {
                   16430:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16431:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16432:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16433:             }
                   16434:         }
                   16435:         undef($navmap);
                   16436:     }
                   16437:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16438:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16439:     }
                   16440:     return;
                   16441: }
                   16442: 
1.1075.2.27  raeburn  16443: sub allmaps_incourse {
                   16444:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16445:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16446:         $cid = $env{'request.course.id'};
                   16447:         $cdom = $env{'course.'.$cid.'.domain'};
                   16448:         $cnum = $env{'course.'.$cid.'.num'};
                   16449:         $chome = $env{'course.'.$cid.'.home'};
                   16450:     }
                   16451:     my %allmaps = ();
                   16452:     my $lastchange =
                   16453:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16454:     if ($lastchange > $env{'request.course.tied'}) {
                   16455:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16456:         unless ($ferr) {
                   16457:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16458:         }
                   16459:     }
                   16460:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16461:     if (defined($navmap)) {
                   16462:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16463:             $allmaps{$res->src()} = 1;
                   16464:         }
                   16465:     }
                   16466:     return \%allmaps;
                   16467: }
                   16468: 
1.1075.2.11  raeburn  16469: sub parse_supplemental_title {
                   16470:     my ($title) = @_;
                   16471: 
                   16472:     my ($foldertitle,$renametitle);
                   16473:     if ($title =~ /&amp;&amp;&amp;/) {
                   16474:         $title = &HTML::Entites::decode($title);
                   16475:     }
                   16476:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16477:         $renametitle=$4;
                   16478:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16479:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16480:         my $name =  &plainname($uname,$udom);
                   16481:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16482:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16483:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16484:             $name.': <br />'.$foldertitle;
                   16485:     }
                   16486:     if (wantarray) {
                   16487:         return ($title,$foldertitle,$renametitle);
                   16488:     }
                   16489:     return $title;
                   16490: }
                   16491: 
1.1075.2.43  raeburn  16492: sub recurse_supplemental {
                   16493:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16494:     if ($suppmap) {
                   16495:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16496:         if ($fatal) {
                   16497:             $errors ++;
                   16498:         } else {
                   16499:             if ($#LONCAPA::map::resources > 0) {
                   16500:                 foreach my $res (@LONCAPA::map::resources) {
                   16501:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16502:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16503:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16504:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16505:                         } else {
                   16506:                             $numfiles ++;
                   16507:                         }
                   16508:                     }
                   16509:                 }
                   16510:             }
                   16511:         }
                   16512:     }
                   16513:     return ($numfiles,$errors);
                   16514: }
                   16515: 
1.1075.2.18  raeburn  16516: sub symb_to_docspath {
1.1075.2.119  raeburn  16517:     my ($symb,$navmapref) = @_;
                   16518:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16519:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16520:     if ($resurl=~/\.(sequence|page)$/) {
                   16521:         $mapurl=$resurl;
                   16522:     } elsif ($resurl eq 'adm/navmaps') {
                   16523:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16524:     }
                   16525:     my $mapresobj;
1.1075.2.119  raeburn  16526:     unless (ref($$navmapref)) {
                   16527:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   16528:     }
                   16529:     if (ref($$navmapref)) {
                   16530:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  16531:     }
                   16532:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16533:     my $type=$2;
                   16534:     my $path;
                   16535:     if (ref($mapresobj)) {
                   16536:         my $pcslist = $mapresobj->map_hierarchy();
                   16537:         if ($pcslist ne '') {
                   16538:             foreach my $pc (split(/,/,$pcslist)) {
                   16539:                 next if ($pc <= 1);
1.1075.2.119  raeburn  16540:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  16541:                 if (ref($res)) {
                   16542:                     my $thisurl = $res->src();
                   16543:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16544:                     my $thistitle = $res->title();
                   16545:                     $path .= '&'.
                   16546:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  16547:                              &escape($thistitle).
1.1075.2.18  raeburn  16548:                              ':'.$res->randompick().
                   16549:                              ':'.$res->randomout().
                   16550:                              ':'.$res->encrypted().
                   16551:                              ':'.$res->randomorder().
                   16552:                              ':'.$res->is_page();
                   16553:                 }
                   16554:             }
                   16555:         }
                   16556:         $path =~ s/^\&//;
                   16557:         my $maptitle = $mapresobj->title();
                   16558:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16559:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16560:         }
                   16561:         $path .= (($path ne '')? '&' : '').
                   16562:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16563:                  &escape($maptitle).
1.1075.2.18  raeburn  16564:                  ':'.$mapresobj->randompick().
                   16565:                  ':'.$mapresobj->randomout().
                   16566:                  ':'.$mapresobj->encrypted().
                   16567:                  ':'.$mapresobj->randomorder().
                   16568:                  ':'.$mapresobj->is_page();
                   16569:     } else {
                   16570:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16571:         my $ispage = (($type eq 'page')? 1 : '');
                   16572:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16573:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16574:         }
                   16575:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16576:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  16577:     }
                   16578:     unless ($mapurl eq 'default') {
                   16579:         $path = 'default&'.
1.1075.2.46  raeburn  16580:                 &escape('Main Content').
1.1075.2.18  raeburn  16581:                 ':::::&'.$path;
                   16582:     }
                   16583:     return $path;
                   16584: }
                   16585: 
1.1075.2.14  raeburn  16586: sub captcha_display {
                   16587:     my ($context,$lonhost) = @_;
                   16588:     my ($output,$error);
1.1075.2.107  raeburn  16589:     my ($captcha,$pubkey,$privkey,$version) =
                   16590:         &get_captcha_config($context,$lonhost);
1.1075.2.14  raeburn  16591:     if ($captcha eq 'original') {
                   16592:         $output = &create_captcha();
                   16593:         unless ($output) {
                   16594:             $error = 'captcha';
                   16595:         }
                   16596:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  16597:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  16598:         unless ($output) {
                   16599:             $error = 'recaptcha';
                   16600:         }
                   16601:     }
1.1075.2.107  raeburn  16602:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  16603: }
                   16604: 
                   16605: sub captcha_response {
                   16606:     my ($context,$lonhost) = @_;
                   16607:     my ($captcha_chk,$captcha_error);
1.1075.2.109  raeburn  16608:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost);
1.1075.2.14  raeburn  16609:     if ($captcha eq 'original') {
                   16610:         ($captcha_chk,$captcha_error) = &check_captcha();
                   16611:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  16612:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  16613:     } else {
                   16614:         $captcha_chk = 1;
                   16615:     }
                   16616:     return ($captcha_chk,$captcha_error);
                   16617: }
                   16618: 
                   16619: sub get_captcha_config {
                   16620:     my ($context,$lonhost) = @_;
1.1075.2.107  raeburn  16621:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  16622:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   16623:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   16624:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16625:     if ($context eq 'usercreation') {
                   16626:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   16627:         if (ref($domconfig{$context}) eq 'HASH') {
                   16628:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   16629:             if (ref($hashtocheck) eq 'HASH') {
                   16630:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   16631:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   16632:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   16633:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   16634:                     }
                   16635:                     if ($privkey && $pubkey) {
                   16636:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  16637:                         $version = $hashtocheck->{'recaptchaversion'};
                   16638:                         if ($version ne '2') {
                   16639:                             $version = 1;
                   16640:                         }
1.1075.2.14  raeburn  16641:                     } else {
                   16642:                         $captcha = 'original';
                   16643:                     }
                   16644:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   16645:                     $captcha = 'original';
                   16646:                 }
                   16647:             }
                   16648:         } else {
                   16649:             $captcha = 'captcha';
                   16650:         }
                   16651:     } elsif ($context eq 'login') {
                   16652:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   16653:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   16654:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   16655:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   16656:             if ($privkey && $pubkey) {
                   16657:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  16658:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   16659:                 if ($version ne '2') {
                   16660:                     $version = 1;
                   16661:                 }
1.1075.2.14  raeburn  16662:             } else {
                   16663:                 $captcha = 'original';
                   16664:             }
                   16665:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   16666:             $captcha = 'original';
                   16667:         }
                   16668:     }
1.1075.2.107  raeburn  16669:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  16670: }
                   16671: 
                   16672: sub create_captcha {
                   16673:     my %captcha_params = &captcha_settings();
                   16674:     my ($output,$maxtries,$tries) = ('',10,0);
                   16675:     while ($tries < $maxtries) {
                   16676:         $tries ++;
                   16677:         my $captcha = Authen::Captcha->new (
                   16678:                                            output_folder => $captcha_params{'output_dir'},
                   16679:                                            data_folder   => $captcha_params{'db_dir'},
                   16680:                                           );
                   16681:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   16682: 
                   16683:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   16684:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   16685:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  16686:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   16687:                       '<br />'.
                   16688:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  16689:             last;
                   16690:         }
                   16691:     }
                   16692:     return $output;
                   16693: }
                   16694: 
                   16695: sub captcha_settings {
                   16696:     my %captcha_params = (
                   16697:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   16698:                            www_output_dir => "/captchaspool",
                   16699:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   16700:                            numchars       => '5',
                   16701:                          );
                   16702:     return %captcha_params;
                   16703: }
                   16704: 
                   16705: sub check_captcha {
                   16706:     my ($captcha_chk,$captcha_error);
                   16707:     my $code = $env{'form.code'};
                   16708:     my $md5sum = $env{'form.crypt'};
                   16709:     my %captcha_params = &captcha_settings();
                   16710:     my $captcha = Authen::Captcha->new(
                   16711:                       output_folder => $captcha_params{'output_dir'},
                   16712:                       data_folder   => $captcha_params{'db_dir'},
                   16713:                   );
1.1075.2.26  raeburn  16714:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  16715:     my %captcha_hash = (
                   16716:                         0       => 'Code not checked (file error)',
                   16717:                        -1      => 'Failed: code expired',
                   16718:                        -2      => 'Failed: invalid code (not in database)',
                   16719:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   16720:     );
                   16721:     if ($captcha_chk != 1) {
                   16722:         $captcha_error = $captcha_hash{$captcha_chk}
                   16723:     }
                   16724:     return ($captcha_chk,$captcha_error);
                   16725: }
                   16726: 
                   16727: sub create_recaptcha {
1.1075.2.107  raeburn  16728:     my ($pubkey,$version) = @_;
                   16729:     if ($version >= 2) {
                   16730:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   16731:     } else {
                   16732:         my $use_ssl;
                   16733:         if ($ENV{'SERVER_PORT'} == 443) {
                   16734:             $use_ssl = 1;
                   16735:         }
                   16736:         my $captcha = Captcha::reCAPTCHA->new;
                   16737:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   16738:                $captcha->get_html($pubkey,undef,$use_ssl).
                   16739:                &mt('If the text is hard to read, [_1] will replace them.',
                   16740:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   16741:                '<br /><br />';
                   16742:      }
1.1075.2.14  raeburn  16743: }
                   16744: 
                   16745: sub check_recaptcha {
1.1075.2.107  raeburn  16746:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  16747:     my $captcha_chk;
1.1075.2.107  raeburn  16748:     if ($version >= 2) {
                   16749:         my $ua = LWP::UserAgent->new;
                   16750:         $ua->timeout(10);
                   16751:         my %info = (
                   16752:                      secret   => $privkey,
                   16753:                      response => $env{'form.g-recaptcha-response'},
                   16754:                      remoteip => $ENV{'REMOTE_ADDR'},
                   16755:                    );
                   16756:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   16757:         if ($response->is_success)  {
                   16758:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   16759:             if (ref($data) eq 'HASH') {
                   16760:                 if ($data->{'success'}) {
                   16761:                     $captcha_chk = 1;
                   16762:                 }
                   16763:             }
                   16764:         }
                   16765:     } else {
                   16766:         my $captcha = Captcha::reCAPTCHA->new;
                   16767:         my $captcha_result =
                   16768:             $captcha->check_answer(
                   16769:                                     $privkey,
                   16770:                                     $ENV{'REMOTE_ADDR'},
                   16771:                                     $env{'form.recaptcha_challenge_field'},
                   16772:                                     $env{'form.recaptcha_response_field'},
                   16773:                                   );
                   16774:         if ($captcha_result->{is_valid}) {
                   16775:             $captcha_chk = 1;
                   16776:         }
1.1075.2.14  raeburn  16777:     }
                   16778:     return $captcha_chk;
                   16779: }
                   16780: 
1.1075.2.64  raeburn  16781: sub emailusername_info {
1.1075.2.103  raeburn  16782:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  16783:     my %titles = &Apache::lonlocal::texthash (
                   16784:                      lastname      => 'Last Name',
                   16785:                      firstname     => 'First Name',
                   16786:                      institution   => 'School/college/university',
                   16787:                      location      => "School's city, state/province, country",
                   16788:                      web           => "School's web address",
                   16789:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  16790:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  16791:                  );
                   16792:     return (\@fields,\%titles);
                   16793: }
                   16794: 
1.1075.2.56  raeburn  16795: sub cleanup_html {
                   16796:     my ($incoming) = @_;
                   16797:     my $outgoing;
                   16798:     if ($incoming ne '') {
                   16799:         $outgoing = $incoming;
                   16800:         $outgoing =~ s/;/&#059;/g;
                   16801:         $outgoing =~ s/\#/&#035;/g;
                   16802:         $outgoing =~ s/\&/&#038;/g;
                   16803:         $outgoing =~ s/</&#060;/g;
                   16804:         $outgoing =~ s/>/&#062;/g;
                   16805:         $outgoing =~ s/\(/&#040/g;
                   16806:         $outgoing =~ s/\)/&#041;/g;
                   16807:         $outgoing =~ s/"/&#034;/g;
                   16808:         $outgoing =~ s/'/&#039;/g;
                   16809:         $outgoing =~ s/\$/&#036;/g;
                   16810:         $outgoing =~ s{/}{&#047;}g;
                   16811:         $outgoing =~ s/=/&#061;/g;
                   16812:         $outgoing =~ s/\\/&#092;/g
                   16813:     }
                   16814:     return $outgoing;
                   16815: }
                   16816: 
1.1075.2.74  raeburn  16817: # Checks for critical messages and returns a redirect url if one exists.
                   16818: # $interval indicates how often to check for messages.
                   16819: sub critical_redirect {
                   16820:     my ($interval) = @_;
                   16821:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   16822:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   16823:                                         $env{'user.name'});
                   16824:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   16825:         my $redirecturl;
                   16826:         if ($what[0]) {
                   16827:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   16828:                 $redirecturl='/adm/email?critical=display';
                   16829:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   16830:                 return (1, $url);
                   16831:             }
                   16832:         }
                   16833:     }
                   16834:     return ();
                   16835: }
                   16836: 
1.1075.2.64  raeburn  16837: # Use:
                   16838: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   16839: #
                   16840: ##################################################
                   16841: #          password associated functions         #
                   16842: ##################################################
                   16843: sub des_keys {
                   16844:     # Make a new key for DES encryption.
                   16845:     # Each key has two parts which are returned separately.
                   16846:     # Please note:  Each key must be passed through the &hex function
                   16847:     # before it is output to the web browser.  The hex versions cannot
                   16848:     # be used to decrypt.
                   16849:     my @hexstr=('0','1','2','3','4','5','6','7',
                   16850:                 '8','9','a','b','c','d','e','f');
                   16851:     my $lkey='';
                   16852:     for (0..7) {
                   16853:         $lkey.=$hexstr[rand(15)];
                   16854:     }
                   16855:     my $ukey='';
                   16856:     for (0..7) {
                   16857:         $ukey.=$hexstr[rand(15)];
                   16858:     }
                   16859:     return ($lkey,$ukey);
                   16860: }
                   16861: 
                   16862: sub des_decrypt {
                   16863:     my ($key,$cyphertext) = @_;
                   16864:     my $keybin=pack("H16",$key);
                   16865:     my $cypher;
                   16866:     if ($Crypt::DES::VERSION>=2.03) {
                   16867:         $cypher=new Crypt::DES $keybin;
                   16868:     } else {
                   16869:         $cypher=new DES $keybin;
                   16870:     }
1.1075.2.106  raeburn  16871:     my $plaintext='';
                   16872:     my $cypherlength = length($cyphertext);
                   16873:     my $numchunks = int($cypherlength/32);
                   16874:     for (my $j=0; $j<$numchunks; $j++) {
                   16875:         my $start = $j*32;
                   16876:         my $cypherblock = substr($cyphertext,$start,32);
                   16877:         my $chunk =
                   16878:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   16879:         $chunk .=
                   16880:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   16881:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   16882:         $plaintext .= $chunk;
                   16883:     }
1.1075.2.64  raeburn  16884:     return $plaintext;
                   16885: }
                   16886: 
1.112     bowersj2 16887: 1;
                   16888: __END__;
1.41      ng       16889: 

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