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

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.141.  .10(raeb    4:-20): # $Id: loncommon.pm,v 1.1075.2.141.2.9 2020/10/01 12:34:08 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.1075.2.135  raeburn    74: use HTTP::Request;
1.657     raeburn    75: use DateTime::TimeZone;
1.1075.2.102  raeburn    76: use DateTime::Locale;
1.1075.2.94  raeburn    77: use Encode();
1.1075.2.14  raeburn    78: use Authen::Captcha;
                     79: use Captcha::reCAPTCHA;
1.1075.2.107  raeburn    80: use JSON::DWIW;
                     81: use LWP::UserAgent;
1.1075.2.64  raeburn    82: use Crypt::DES;
                     83: use DynaLoader; # for Crypt::DES version
1.1075.2.128  raeburn    84: use File::Copy();
                     85: use File::Path();
1.1075.2.141.  .1(raebu   86:20): use String::CRC32();
                     87:20): use Short::URL();
1.117     www        88: 
1.517     raeburn    89: # ---------------------------------------------- Designs
                     90: use vars qw(%defaultdesign);
                     91: 
1.22      www        92: my $readit;
                     93: 
1.517     raeburn    94: 
1.157     matthew    95: ##
                     96: ## Global Variables
                     97: ##
1.46      matthew    98: 
1.643     foxr       99: 
                    100: # ----------------------------------------------- SSI with retries:
                    101: #
                    102: 
                    103: =pod
                    104: 
1.648     raeburn   105: =head1 Server Side include with retries:
1.643     foxr      106: 
                    107: =over 4
                    108: 
1.648     raeburn   109: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      110: 
                    111: Performs an ssi with some number of retries.  Retries continue either
                    112: until the result is ok or until the retry count supplied by the
                    113: caller is exhausted.  
                    114: 
                    115: Inputs:
1.648     raeburn   116: 
                    117: =over 4
                    118: 
1.643     foxr      119: resource   - Identifies the resource to insert.
1.648     raeburn   120: 
1.643     foxr      121: retries    - Count of the number of retries allowed.
1.648     raeburn   122: 
1.643     foxr      123: form       - Hash that identifies the rendering options.
                    124: 
1.648     raeburn   125: =back
                    126: 
                    127: Returns:
                    128: 
                    129: =over 4
                    130: 
1.643     foxr      131: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   132: 
1.643     foxr      133: response   - The response from the last attempt (which may or may not have been successful.
                    134: 
1.648     raeburn   135: =back
                    136: 
                    137: =back
                    138: 
1.643     foxr      139: =cut
                    140: 
                    141: sub ssi_with_retries {
                    142:     my ($resource, $retries, %form) = @_;
                    143: 
                    144: 
                    145:     my $ok = 0;			# True if we got a good response.
                    146:     my $content;
                    147:     my $response;
                    148: 
                    149:     # Try to get the ssi done. within the retries count:
                    150: 
                    151:     do {
                    152: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    153: 	$ok      = $response->is_success;
1.650     www       154:         if (!$ok) {
                    155:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    156:         }
1.643     foxr      157: 	$retries--;
                    158:     } while (!$ok && ($retries > 0));
                    159: 
                    160:     if (!$ok) {
                    161: 	$content = '';		# On error return an empty content.
                    162:     }
                    163:     return ($content, $response);
                    164: 
                    165: }
                    166: 
                    167: 
                    168: 
1.20      www       169: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  170: my %language;
1.124     www       171: my %supported_language;
1.1048    foxr      172: my %latex_language;		# For choosing hyphenation in <transl..>
                    173: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  174: my %cprtag;
1.192     taceyjo1  175: my %scprtag;
1.351     www       176: my %fe; my %fd; my %fm;
1.41      ng        177: my %category_extensions;
1.12      harris41  178: 
1.46      matthew   179: # ---------------------------------------------- Thesaurus variables
1.144     matthew   180: #
                    181: # %Keywords:
                    182: #      A hash used by &keyword to determine if a word is considered a keyword.
                    183: # $thesaurus_db_file 
                    184: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   185: 
                    186: my %Keywords;
                    187: my $thesaurus_db_file;
                    188: 
1.144     matthew   189: #
                    190: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    191: # thesaurus.tab, and filecategories.tab.
                    192: #
1.18      www       193: BEGIN {
1.46      matthew   194:     # Variable initialization
                    195:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    196:     #
1.22      www       197:     unless ($readit) {
1.12      harris41  198: # ------------------------------------------------------------------- languages
                    199:     {
1.158     raeburn   200:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    201:                                    '/language.tab';
1.1075.2.128  raeburn   202:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
1.1048    foxr      206:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   207:                 $language{$key}=$val.' - '.$enc;
                    208:                 if ($sup) {
                    209:                     $supported_language{$key}=$sup;
                    210:                 }
1.1048    foxr      211: 		if ($latex) {
                    212: 		    $latex_language_bykey{$key} = $latex;
                    213: 		    $latex_language{$two} = $latex;
                    214: 		}
1.158     raeburn   215:             }
                    216:             close($fh);
                    217:         }
1.12      harris41  218:     }
                    219: # ------------------------------------------------------------------ copyrights
                    220:     {
1.158     raeburn   221:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    222:                                   '/copyright.tab';
1.1075.2.128  raeburn   223:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  224:             while (my $line = <$fh>) {
                    225:                 next if ($line=~/^\#/);
                    226:                 chomp($line);
                    227:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   228:                 $cprtag{$key}=$val;
                    229:             }
                    230:             close($fh);
                    231:         }
1.12      harris41  232:     }
1.351     www       233: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  234:     {
                    235:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    236:                                   '/source_copyright.tab';
1.1075.2.128  raeburn   237:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  238:             while (my $line = <$fh>) {
                    239:                 next if ($line =~ /^\#/);
                    240:                 chomp($line);
                    241:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  242:                 $scprtag{$key}=$val;
                    243:             }
                    244:             close($fh);
                    245:         }
                    246:     }
1.63      www       247: 
1.517     raeburn   248: # -------------------------------------------------------------- default domain designs
1.63      www       249:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   250:     my $designfile = $designdir.'/default.tab';
1.1075.2.128  raeburn   251:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   252:         while (my $line = <$fh>) {
                    253:             next if ($line =~ /^\#/);
                    254:             chomp($line);
                    255:             my ($key,$val)=(split(/\=/,$line));
                    256:             if ($val) { $defaultdesign{$key}=$val; }
                    257:         }
                    258:         close($fh);
1.63      www       259:     }
                    260: 
1.15      harris41  261: # ------------------------------------------------------------- file categories
                    262:     {
1.158     raeburn   263:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    264:                                   '/filecategories.tab';
1.1075.2.128  raeburn   265:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  266: 	    while (my $line = <$fh>) {
                    267: 		next if ($line =~ /^\#/);
                    268: 		chomp($line);
                    269:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119  raeburn   270:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   271:             }
                    272:             close($fh);
                    273:         }
                    274: 
1.15      harris41  275:     }
1.12      harris41  276: # ------------------------------------------------------------------ file types
                    277:     {
1.158     raeburn   278:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    279:                '/filetypes.tab';
1.1075.2.128  raeburn   280:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  281:             while (my $line = <$fh>) {
                    282: 		next if ($line =~ /^\#/);
                    283: 		chomp($line);
                    284:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   285:                 if ($descr ne '') {
                    286:                     $fe{$ending}=lc($emb);
                    287:                     $fd{$ending}=$descr;
1.351     www       288:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   289:                 }
                    290:             }
                    291:             close($fh);
                    292:         }
1.12      harris41  293:     }
1.22      www       294:     &Apache::lonnet::logthis(
1.705     tempelho  295:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       296:     $readit=1;
1.46      matthew   297:     }  # end of unless($readit) 
1.32      matthew   298:     
                    299: }
1.112     bowersj2  300: 
1.42      matthew   301: ###############################################################
                    302: ##           HTML and Javascript Helper Functions            ##
                    303: ###############################################################
                    304: 
                    305: =pod 
                    306: 
1.112     bowersj2  307: =head1 HTML and Javascript Functions
1.42      matthew   308: 
1.112     bowersj2  309: =over 4
                    310: 
1.648     raeburn   311: =item * &browser_and_searcher_javascript()
1.112     bowersj2  312: 
                    313: X<browsing, javascript>X<searching, javascript>Returns a string
                    314: containing javascript with two functions, C<openbrowser> and
                    315: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    316: tags.
1.42      matthew   317: 
1.648     raeburn   318: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   319: 
                    320: inputs: formname, elementname, only, omit
                    321: 
                    322: formname and elementname indicate the name of the html form and name of
                    323: the element that the results of the browsing selection are to be placed in. 
                    324: 
                    325: Specifying 'only' will restrict the browser to displaying only files
1.185     www       326: with the given extension.  Can be a comma separated list.
1.42      matthew   327: 
                    328: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       329: with the given extension.  Can be a comma separated list.
1.42      matthew   330: 
1.648     raeburn   331: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   332: 
                    333: Inputs: formname, elementname
                    334: 
                    335: formname and elementname specify the name of the html form and the name
                    336: of the element the selection from the search results will be placed in.
1.542     raeburn   337: 
1.42      matthew   338: =cut
                    339: 
                    340: sub browser_and_searcher_javascript {
1.199     albertel  341:     my ($mode)=@_;
                    342:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  343:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   344:     return <<END;
1.219     albertel  345: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   346:     var editbrowser = null;
1.135     albertel  347:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       348:         var url = '$resurl/?';
1.42      matthew   349:         if (editbrowser == null) {
                    350:             url += 'launch=1&';
                    351:         }
                    352:         url += 'catalogmode=interactive&';
1.199     albertel  353:         url += 'mode=$mode&';
1.611     albertel  354:         url += 'inhibitmenu=yes&';
1.42      matthew   355:         url += 'form=' + formname + '&';
                    356:         if (only != null) {
                    357:             url += 'only=' + only + '&';
1.217     albertel  358:         } else {
                    359:             url += 'only=&';
                    360: 	}
1.42      matthew   361:         if (omit != null) {
                    362:             url += 'omit=' + omit + '&';
1.217     albertel  363:         } else {
                    364:             url += 'omit=&';
                    365: 	}
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Browser';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editbrowser = open(url,title,options,'1');
                    376:         editbrowser.focus();
                    377:     }
                    378:     var editsearcher;
1.135     albertel  379:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   380:         var url = '/adm/searchcat?';
                    381:         if (editsearcher == null) {
                    382:             url += 'launch=1&';
                    383:         }
                    384:         url += 'catalogmode=interactive&';
1.199     albertel  385:         url += 'mode=$mode&';
1.42      matthew   386:         url += 'form=' + formname + '&';
1.135     albertel  387:         if (titleelement != null) {
                    388:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  389:         } else {
                    390: 	    url += 'titleelement=&';
                    391: 	}
1.42      matthew   392:         url += 'element=' + elementname + '';
                    393:         var title = 'Search';
1.435     albertel  394:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   395:         options += ',width=700,height=600';
                    396:         editsearcher = open(url,title,options,'1');
                    397:         editsearcher.focus();
                    398:     }
1.219     albertel  399: // END LON-CAPA Internal -->
1.42      matthew   400: END
1.170     www       401: }
                    402: 
                    403: sub lastresurl {
1.258     albertel  404:     if ($env{'environment.lastresurl'}) {
                    405: 	return $env{'environment.lastresurl'}
1.170     www       406:     } else {
                    407: 	return '/res';
                    408:     }
                    409: }
                    410: 
                    411: sub storeresurl {
                    412:     my $resurl=&Apache::lonnet::clutter(shift);
                    413:     unless ($resurl=~/^\/res/) { return 0; }
                    414:     $resurl=~s/\/$//;
                    415:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   416:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       417:     return 1;
1.42      matthew   418: }
                    419: 
1.74      www       420: sub studentbrowser_javascript {
1.111     www       421:    unless (
1.258     albertel  422:             (($env{'request.course.id'}) && 
1.302     albertel  423:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    424: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    425: 					  '/'.$env{'request.course.sec'})
                    426: 	      ))
1.258     albertel  427:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       428:           ) { return ''; }  
1.74      www       429:    return (<<'ENDSTDBRW');
1.776     bisitz    430: <script type="text/javascript" language="Javascript">
1.824     bisitz    431: // <![CDATA[
1.74      www       432:     var stdeditbrowser;
1.1075.2.141.  .3(raebu  433:20):     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74      www       434:         var url = '/adm/pickstudent?';
                    435:         var filter;
1.558     albertel  436: 	if (!ignorefilter) {
                    437: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    438: 	}
1.74      www       439:         if (filter != null) {
                    440:            if (filter != '') {
                    441:                url += 'filter='+filter+'&';
                    442: 	   }
                    443:         }
                    444:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       445:                                     '&udomelement='+udom+
                    446:                                     '&clicker='+clicker;
1.111     www       447: 	if (roleflag) { url+="&roles=1"; }
1.1075.2.141.  .3(raebu  448:20):         if (courseadv == 'condition') {
                    449:20):             if (document.getElementById('courseadv')) {
                    450:20):                 courseadv = document.getElementById('courseadv').value;
                    451:20):             }
                    452:20):         }
                    453:20):         if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102     www       454:         var title = 'Student_Browser';
1.74      www       455:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    456:         options += ',width=700,height=600';
                    457:         stdeditbrowser = open(url,title,options,'1');
                    458:         stdeditbrowser.focus();
                    459:     }
1.824     bisitz    460: // ]]>
1.74      www       461: </script>
                    462: ENDSTDBRW
                    463: }
1.42      matthew   464: 
1.1003    www       465: sub resourcebrowser_javascript {
                    466:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       467:    return (<<'ENDRESBRW');
1.1003    www       468: <script type="text/javascript" language="Javascript">
                    469: // <![CDATA[
                    470:     var reseditbrowser;
1.1004    www       471:     function openresbrowser(formname,reslink) {
1.1005    www       472:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       473:         var title = 'Resource_Browser';
                    474:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       475:         options += ',width=700,height=500';
1.1004    www       476:         reseditbrowser = open(url,title,options,'1');
                    477:         reseditbrowser.focus();
1.1003    www       478:     }
                    479: // ]]>
                    480: </script>
1.1004    www       481: ENDRESBRW
1.1003    www       482: }
                    483: 
1.74      www       484: sub selectstudent_link {
1.1075.2.141.  .3(raebu  485:20):    my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999     www       486:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    487:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    488:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  489:    if ($env{'request.course.id'}) {  
1.302     albertel  490:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    491: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    492: 					'/'.$env{'request.course.sec'})) {
1.111     www       493: 	   return '';
                    494:        }
1.999     www       495:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.141.  .3(raebu  496:20):        if ($courseadv eq 'only') {
                    497:20):            $callargs .= ",'',1,'$courseadv'";
                    498:20):        } elsif ($courseadv eq 'none') {
                    499:20):            $callargs .= ",'','','$courseadv'";
                    500:20):        } elsif ($courseadv eq 'condition') {
                    501:20):            $callargs .= ",'','','$courseadv'";
1.793     raeburn   502:        }
                    503:        return '<span class="LC_nobreak">'.
                    504:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    505:               &mt('Select User').'</a></span>';
1.74      www       506:    }
1.258     albertel  507:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       508:        $callargs .= ",'',1"; 
1.793     raeburn   509:        return '<span class="LC_nobreak">'.
                    510:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    511:               &mt('Select User').'</a></span>';
1.111     www       512:    }
                    513:    return '';
1.91      www       514: }
                    515: 
1.1004    www       516: sub selectresource_link {
                    517:    my ($form,$reslink,$arg)=@_;
                    518:    
                    519:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    520:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    521:    unless ($env{'request.course.id'}) { return $arg; }
                    522:    return '<span class="LC_nobreak">'.
                    523:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    524:               $arg.'</a></span>';
                    525: }
                    526: 
                    527: 
                    528: 
1.653     raeburn   529: sub authorbrowser_javascript {
                    530:     return <<"ENDAUTHORBRW";
1.776     bisitz    531: <script type="text/javascript" language="JavaScript">
1.824     bisitz    532: // <![CDATA[
1.653     raeburn   533: var stdeditbrowser;
                    534: 
                    535: function openauthorbrowser(formname,udom) {
                    536:     var url = '/adm/pickauthor?';
                    537:     url += 'form='+formname+'&roledom='+udom;
                    538:     var title = 'Author_Browser';
                    539:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    540:     options += ',width=700,height=600';
                    541:     stdeditbrowser = open(url,title,options,'1');
                    542:     stdeditbrowser.focus();
                    543: }
                    544: 
1.824     bisitz    545: // ]]>
1.653     raeburn   546: </script>
                    547: ENDAUTHORBRW
                    548: }
                    549: 
1.91      www       550: sub coursebrowser_javascript {
1.1075.2.31  raeburn   551:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95  raeburn   552:         $credits_element,$instcode) = @_;
1.932     raeburn   553:     my $wintitle = 'Course_Browser';
1.931     raeburn   554:     if ($crstype eq 'Community') {
1.932     raeburn   555:         $wintitle = 'Community_Browser';
1.909     raeburn   556:     }
1.876     raeburn   557:     my $id_functions = &javascript_index_functions();
                    558:     my $output = '
1.776     bisitz    559: <script type="text/javascript" language="JavaScript">
1.824     bisitz    560: // <![CDATA[
1.468     raeburn   561:     var stdeditbrowser;'."\n";
1.876     raeburn   562: 
                    563:     $output .= <<"ENDSTDBRW";
1.909     raeburn   564:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       565:         var url = '/adm/pickcourse?';
1.895     raeburn   566:         var formid = getFormIdByName(formname);
1.876     raeburn   567:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  568:         if (domainfilter != null) {
                    569:            if (domainfilter != '') {
                    570:                url += 'domainfilter='+domainfilter+'&';
                    571: 	   }
                    572:         }
1.91      www       573:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  574: 	                            '&cdomelement='+udom+
                    575:                                     '&cnameelement='+desc;
1.468     raeburn   576:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   577:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   578:                 url += '&roleelement='+extra_element;
                    579:                 if (domainfilter == null || domainfilter == '') {
                    580:                     url += '&domainfilter='+extra_element;
                    581:                 }
1.234     raeburn   582:             }
1.468     raeburn   583:             else {
                    584:                 if (formname == 'portform') {
                    585:                     url += '&setroles='+extra_element;
1.800     raeburn   586:                 } else {
                    587:                     if (formname == 'rules') {
                    588:                         url += '&fixeddom='+extra_element; 
                    589:                     }
1.468     raeburn   590:                 }
                    591:             }     
1.230     raeburn   592:         }
1.909     raeburn   593:         if (type != null && type != '') {
                    594:             url += '&type='+type;
                    595:         }
                    596:         if (type_elem != null && type_elem != '') {
                    597:             url += '&typeelement='+type_elem;
                    598:         }
1.872     raeburn   599:         if (formname == 'ccrs') {
                    600:             var ownername = document.forms[formid].ccuname.value;
                    601:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101  raeburn   602:             url += '&cloner='+ownername+':'+ownerdom;
                    603:             if (type == 'Course') {
                    604:                 url += '&crscode='+document.forms[formid].crscode.value;
                    605:             }
1.1075.2.95  raeburn   606:         }
                    607:         if (formname == 'requestcrs') {
                    608:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   609:         }
1.293     raeburn   610:         if (multflag !=null && multflag != '') {
                    611:             url += '&multiple='+multflag;
                    612:         }
1.909     raeburn   613:         var title = '$wintitle';
1.91      www       614:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    615:         options += ',width=700,height=600';
                    616:         stdeditbrowser = open(url,title,options,'1');
                    617:         stdeditbrowser.focus();
                    618:     }
1.876     raeburn   619: $id_functions
                    620: ENDSTDBRW
1.1075.2.31  raeburn   621:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    622:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    623:                                       $credits_element);
1.876     raeburn   624:     }
                    625:     $output .= '
                    626: // ]]>
                    627: </script>';
                    628:     return $output;
                    629: }
                    630: 
                    631: sub javascript_index_functions {
                    632:     return <<"ENDJS";
                    633: 
                    634: function getFormIdByName(formname) {
                    635:     for (var i=0;i<document.forms.length;i++) {
                    636:         if (document.forms[i].name == formname) {
                    637:             return i;
                    638:         }
                    639:     }
                    640:     return -1;
                    641: }
                    642: 
                    643: function getIndexByName(formid,item) {
                    644:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    645:         if (document.forms[formid].elements[i].name == item) {
                    646:             return i;
                    647:         }
                    648:     }
                    649:     return -1;
                    650: }
1.468     raeburn   651: 
1.876     raeburn   652: function getDomainFromSelectbox(formname,udom) {
                    653:     var userdom;
                    654:     var formid = getFormIdByName(formname);
                    655:     if (formid > -1) {
                    656:         var domid = getIndexByName(formid,udom);
                    657:         if (domid > -1) {
                    658:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    659:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    660:             }
                    661:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    662:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   663:             }
                    664:         }
                    665:     }
1.876     raeburn   666:     return userdom;
                    667: }
                    668: 
                    669: ENDJS
1.468     raeburn   670: 
1.876     raeburn   671: }
                    672: 
1.1017    raeburn   673: sub javascript_array_indexof {
1.1018    raeburn   674:     return <<ENDJS;
1.1017    raeburn   675: <script type="text/javascript" language="JavaScript">
                    676: // <![CDATA[
                    677: 
                    678: if (!Array.prototype.indexOf) {
                    679:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    680:         "use strict";
                    681:         if (this === void 0 || this === null) {
                    682:             throw new TypeError();
                    683:         }
                    684:         var t = Object(this);
                    685:         var len = t.length >>> 0;
                    686:         if (len === 0) {
                    687:             return -1;
                    688:         }
                    689:         var n = 0;
                    690:         if (arguments.length > 0) {
                    691:             n = Number(arguments[1]);
                    692:             if (n !== n) { // shortcut for verifying if it's NaN
                    693:                 n = 0;
                    694:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    695:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    696:             }
                    697:         }
                    698:         if (n >= len) {
                    699:             return -1;
                    700:         }
                    701:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    702:         for (; k < len; k++) {
                    703:             if (k in t && t[k] === searchElement) {
                    704:                 return k;
                    705:             }
                    706:         }
                    707:         return -1;
                    708:     }
                    709: }
                    710: 
                    711: // ]]>
                    712: </script>
                    713: 
                    714: ENDJS
                    715: 
                    716: }
                    717: 
1.876     raeburn   718: sub userbrowser_javascript {
                    719:     my $id_functions = &javascript_index_functions();
                    720:     return <<"ENDUSERBRW";
                    721: 
1.888     raeburn   722: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   723:     var url = '/adm/pickuser?';
                    724:     var userdom = getDomainFromSelectbox(formname,udom);
                    725:     if (userdom != null) {
                    726:        if (userdom != '') {
                    727:            url += 'srchdom='+userdom+'&';
                    728:        }
                    729:     }
                    730:     url += 'form=' + formname + '&unameelement='+uname+
                    731:                                 '&udomelement='+udom+
                    732:                                 '&ulastelement='+ulast+
                    733:                                 '&ufirstelement='+ufirst+
                    734:                                 '&uemailelement='+uemail+
1.881     raeburn   735:                                 '&hideudomelement='+hideudom+
                    736:                                 '&coursedom='+crsdom;
1.888     raeburn   737:     if ((caller != null) && (caller != undefined)) {
                    738:         url += '&caller='+caller;
                    739:     }
1.876     raeburn   740:     var title = 'User_Browser';
                    741:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    742:     options += ',width=700,height=600';
                    743:     var stdeditbrowser = open(url,title,options,'1');
                    744:     stdeditbrowser.focus();
                    745: }
                    746: 
1.888     raeburn   747: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   748:     var formid = getFormIdByName(formname);
                    749:     if (formid > -1) {
1.888     raeburn   750:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   751:         var domid = getIndexByName(formid,udom);
                    752:         var hidedomid = getIndexByName(formid,origdom);
                    753:         if (hidedomid > -1) {
                    754:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   755:             var unameval = document.forms[formid].elements[unameid].value;
                    756:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    757:                 if (domid > -1) {
                    758:                     var slct = document.forms[formid].elements[domid];
                    759:                     if (slct.type == 'select-one') {
                    760:                         var i;
                    761:                         for (i=0;i<slct.length;i++) {
                    762:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    763:                         }
                    764:                     }
                    765:                     if (slct.type == 'hidden') {
                    766:                         slct.value = fixeddom;
1.876     raeburn   767:                     }
                    768:                 }
1.468     raeburn   769:             }
                    770:         }
                    771:     }
1.876     raeburn   772:     return;
                    773: }
                    774: 
                    775: $id_functions
                    776: ENDUSERBRW
1.468     raeburn   777: }
                    778: 
                    779: sub setsec_javascript {
1.1075.2.31  raeburn   780:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   781:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    782:         $communityrolestr);
                    783:     if ($role_element ne '') {
                    784:         my @allroles = ('st','ta','ep','in','ad');
                    785:         foreach my $crstype ('Course','Community') {
                    786:             if ($crstype eq 'Community') {
                    787:                 foreach my $role (@allroles) {
                    788:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    789:                 }
                    790:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    791:             } else {
                    792:                 foreach my $role (@allroles) {
                    793:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    794:                 }
                    795:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    796:             }
                    797:         }
                    798:         $rolestr = '"'.join('","',@allroles).'"';
                    799:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    800:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    801:     }
1.468     raeburn   802:     my $setsections = qq|
                    803: function setSect(sectionlist) {
1.629     raeburn   804:     var sectionsArray = new Array();
                    805:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    806:         sectionsArray = sectionlist.split(",");
                    807:     }
1.468     raeburn   808:     var numSections = sectionsArray.length;
                    809:     document.$formname.$sec_element.length = 0;
                    810:     if (numSections == 0) {
                    811:         document.$formname.$sec_element.multiple=false;
                    812:         document.$formname.$sec_element.size=1;
                    813:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    814:     } else {
                    815:         if (numSections == 1) {
                    816:             document.$formname.$sec_element.multiple=false;
                    817:             document.$formname.$sec_element.size=1;
                    818:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    819:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    820:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    821:         } else {
                    822:             for (var i=0; i<numSections; i++) {
                    823:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    824:             }
                    825:             document.$formname.$sec_element.multiple=true
                    826:             if (numSections < 3) {
                    827:                 document.$formname.$sec_element.size=numSections;
                    828:             } else {
                    829:                 document.$formname.$sec_element.size=3;
                    830:             }
                    831:             document.$formname.$sec_element.options[0].selected = false
                    832:         }
                    833:     }
1.91      www       834: }
1.905     raeburn   835: 
                    836: function setRole(crstype) {
1.468     raeburn   837: |;
1.905     raeburn   838:     if ($role_element eq '') {
                    839:         $setsections .= '    return;
                    840: }
                    841: ';
                    842:     } else {
                    843:         $setsections .= qq|
                    844:     var elementLength = document.$formname.$role_element.length;
                    845:     var allroles = Array($rolestr);
                    846:     var courserolenames = Array($courserolestr);
                    847:     var communityrolenames = Array($communityrolestr);
                    848:     if (elementLength != undefined) {
                    849:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    850:             if (crstype == 'Course') {
                    851:                 return;
                    852:             } else {
                    853:                 allroles[5] = 'co';
                    854:                 for (var i=0; i<6; i++) {
                    855:                     document.$formname.$role_element.options[i].value = allroles[i];
                    856:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    857:                 }
                    858:             }
                    859:         } else {
                    860:             if (crstype == 'Community') {
                    861:                 return;
                    862:             } else {
                    863:                 allroles[5] = 'cc';
                    864:                 for (var i=0; i<6; i++) {
                    865:                     document.$formname.$role_element.options[i].value = allroles[i];
                    866:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    867:                 }
                    868:             }
                    869:         }
                    870:     }
                    871:     return;
                    872: }
                    873: |;
                    874:     }
1.1075.2.31  raeburn   875:     if ($credits_element) {
                    876:         $setsections .= qq|
                    877: function setCredits(defaultcredits) {
                    878:     document.$formname.$credits_element.value = defaultcredits;
                    879:     return;
                    880: }
                    881: |;
                    882:     }
1.468     raeburn   883:     return $setsections;
                    884: }
                    885: 
1.91      www       886: sub selectcourse_link {
1.909     raeburn   887:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    888:        $typeelement) = @_;
                    889:    my $type = $selecttype;
1.871     raeburn   890:    my $linktext = &mt('Select Course');
                    891:    if ($selecttype eq 'Community') {
1.909     raeburn   892:        $linktext = &mt('Select Community');
1.906     raeburn   893:    } elsif ($selecttype eq 'Course/Community') {
                    894:        $linktext = &mt('Select Course/Community');
1.909     raeburn   895:        $type = '';
1.1019    raeburn   896:    } elsif ($selecttype eq 'Select') {
                    897:        $linktext = &mt('Select');
                    898:        $type = '';
1.871     raeburn   899:    }
1.787     bisitz    900:    return '<span class="LC_nobreak">'
                    901:          ."<a href='"
                    902:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    903:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   904:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   905:          ."'>".$linktext.'</a>'
1.787     bisitz    906:          .'</span>';
1.74      www       907: }
1.42      matthew   908: 
1.653     raeburn   909: sub selectauthor_link {
                    910:    my ($form,$udom)=@_;
                    911:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    912:           &mt('Select Author').'</a>';
                    913: }
                    914: 
1.876     raeburn   915: sub selectuser_link {
1.881     raeburn   916:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   917:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   918:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   919:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   920:            ');">'.$linktext.'</a>';
1.876     raeburn   921: }
                    922: 
1.273     raeburn   923: sub check_uncheck_jscript {
                    924:     my $jscript = <<"ENDSCRT";
                    925: function checkAll(field) {
                    926:     if (field.length > 0) {
                    927:         for (i = 0; i < field.length; i++) {
1.1075.2.14  raeburn   928:             if (!field[i].disabled) {
                    929:                 field[i].checked = true;
                    930:             }
1.273     raeburn   931:         }
                    932:     } else {
1.1075.2.14  raeburn   933:         if (!field.disabled) {
                    934:             field.checked = true;
                    935:         }
1.273     raeburn   936:     }
                    937: }
                    938:  
                    939: function uncheckAll(field) {
                    940:     if (field.length > 0) {
                    941:         for (i = 0; i < field.length; i++) {
                    942:             field[i].checked = false ;
1.543     albertel  943:         }
                    944:     } else {
1.273     raeburn   945:         field.checked = false ;
                    946:     }
                    947: }
                    948: ENDSCRT
                    949:     return $jscript;
                    950: }
                    951: 
1.656     www       952: sub select_timezone {
1.1075.2.115  raeburn   953:    my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    954:    my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659     raeburn   955:    if ($includeempty) {
                    956:        $output .= '<option value=""';
                    957:        if (($selected eq '') || ($selected eq 'local')) {
                    958:            $output .= ' selected="selected" ';
                    959:        }
                    960:        $output .= '> </option>';
                    961:    }
1.657     raeburn   962:    my @timezones = DateTime::TimeZone->all_names;
                    963:    foreach my $tzone (@timezones) {
                    964:        $output.= '<option value="'.$tzone.'"';
                    965:        if ($tzone eq $selected) {
                    966:            $output.=' selected="selected"';
                    967:        }
                    968:        $output.=">$tzone</option>\n";
1.656     www       969:    }
                    970:    $output.="</select>";
                    971:    return $output;
                    972: }
1.273     raeburn   973: 
1.687     raeburn   974: sub select_datelocale {
1.1075.2.115  raeburn   975:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    976:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   977:     if ($includeempty) {
                    978:         $output .= '<option value=""';
                    979:         if ($selected eq '') {
                    980:             $output .= ' selected="selected" ';
                    981:         }
                    982:         $output .= '> </option>';
                    983:     }
1.1075.2.102  raeburn   984:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   985:     my (@possibles,%locale_names);
1.1075.2.102  raeburn   986:     my @locales = DateTime::Locale->ids();
                    987:     foreach my $id (@locales) {
                    988:         if ($id ne '') {
                    989:             my ($en_terr,$native_terr);
                    990:             my $loc = DateTime::Locale->load($id);
                    991:             if (ref($loc)) {
                    992:                 $en_terr = $loc->name();
                    993:                 $native_terr = $loc->native_name();
1.687     raeburn   994:                 if (grep(/^en$/,@languages) || !@languages) {
                    995:                     if ($en_terr ne '') {
                    996:                         $locale_names{$id} = '('.$en_terr.')';
                    997:                     } elsif ($native_terr ne '') {
                    998:                         $locale_names{$id} = $native_terr;
                    999:                     }
                   1000:                 } else {
                   1001:                     if ($native_terr ne '') {
                   1002:                         $locale_names{$id} = $native_terr.' ';
                   1003:                     } elsif ($en_terr ne '') {
                   1004:                         $locale_names{$id} = '('.$en_terr.')';
                   1005:                     }
                   1006:                 }
1.1075.2.94  raeburn  1007:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102  raeburn  1008:                 push(@possibles,$id);
1.687     raeburn  1009:             }
                   1010:         }
                   1011:     }
                   1012:     foreach my $item (sort(@possibles)) {
                   1013:         $output.= '<option value="'.$item.'"';
                   1014:         if ($item eq $selected) {
                   1015:             $output.=' selected="selected"';
                   1016:         }
                   1017:         $output.=">$item";
                   1018:         if ($locale_names{$item} ne '') {
1.1075.2.94  raeburn  1019:             $output.='  '.$locale_names{$item};
1.687     raeburn  1020:         }
                   1021:         $output.="</option>\n";
                   1022:     }
                   1023:     $output.="</select>";
                   1024:     return $output;
                   1025: }
                   1026: 
1.792     raeburn  1027: sub select_language {
1.1075.2.115  raeburn  1028:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1029:     my %langchoices;
                   1030:     if ($includeempty) {
1.1075.2.32  raeburn  1031:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1032:     }
                   1033:     foreach my $id (&languageids()) {
                   1034:         my $code = &supportedlanguagecode($id);
                   1035:         if ($code) {
                   1036:             $langchoices{$code} = &plainlanguagedescription($id);
                   1037:         }
                   1038:     }
1.1075.2.32  raeburn  1039:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115  raeburn  1040:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1041: }
                   1042: 
1.42      matthew  1043: =pod
1.36      matthew  1044: 
1.648     raeburn  1045: =item * &linked_select_forms(...)
1.36      matthew  1046: 
                   1047: linked_select_forms returns a string containing a <script></script> block
                   1048: and html for two <select> menus.  The select menus will be linked in that
                   1049: changing the value of the first menu will result in new values being placed
                   1050: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1051: order unless a defined order is provided.
1.36      matthew  1052: 
                   1053: linked_select_forms takes the following ordered inputs:
                   1054: 
                   1055: =over 4
                   1056: 
1.112     bowersj2 1057: =item * $formname, the name of the <form> tag
1.36      matthew  1058: 
1.112     bowersj2 1059: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1060: 
1.112     bowersj2 1061: =item * $firstdefault, the default value for the first menu
1.36      matthew  1062: 
1.112     bowersj2 1063: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1064: 
1.112     bowersj2 1065: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1066: 
1.112     bowersj2 1067: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1068: 
1.609     raeburn  1069: =item * $menuorder, the order of values in the first menu
                   1070: 
1.1075.2.31  raeburn  1071: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1072:         event for the first <select> tag
                   1073: 
                   1074: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1075:         event for the second <select> tag
                   1076: 
1.41      ng       1077: =back 
                   1078: 
1.36      matthew  1079: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1080: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1081: values for the first select menu.  The text that coincides with the 
1.41      ng       1082: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1083: and text for the second menu are given in the hash pointed to by 
                   1084: $menu{$choice1}->{'select2'}.  
                   1085: 
1.112     bowersj2 1086:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1087:                        default => "B3",
                   1088:                        select2 => { 
                   1089:                            B1 => "Choice B1",
                   1090:                            B2 => "Choice B2",
                   1091:                            B3 => "Choice B3",
                   1092:                            B4 => "Choice B4"
1.609     raeburn  1093:                            },
                   1094:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1095:                    },
                   1096:                A2 => { text =>"Choice A2" ,
                   1097:                        default => "C2",
                   1098:                        select2 => { 
                   1099:                            C1 => "Choice C1",
                   1100:                            C2 => "Choice C2",
                   1101:                            C3 => "Choice C3"
1.609     raeburn  1102:                            },
                   1103:                        order => ['C2','C1','C3'],
1.112     bowersj2 1104:                    },
                   1105:                A3 => { text =>"Choice A3" ,
                   1106:                        default => "D6",
                   1107:                        select2 => { 
                   1108:                            D1 => "Choice D1",
                   1109:                            D2 => "Choice D2",
                   1110:                            D3 => "Choice D3",
                   1111:                            D4 => "Choice D4",
                   1112:                            D5 => "Choice D5",
                   1113:                            D6 => "Choice D6",
                   1114:                            D7 => "Choice D7"
1.609     raeburn  1115:                            },
                   1116:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1117:                    }
                   1118:                );
1.36      matthew  1119: 
                   1120: =cut
                   1121: 
                   1122: sub linked_select_forms {
                   1123:     my ($formname,
                   1124:         $middletext,
                   1125:         $firstdefault,
                   1126:         $firstselectname,
                   1127:         $secondselectname, 
1.609     raeburn  1128:         $hashref,
                   1129:         $menuorder,
1.1075.2.31  raeburn  1130:         $onchangefirst,
                   1131:         $onchangesecond
1.36      matthew  1132:         ) = @_;
                   1133:     my $second = "document.$formname.$secondselectname";
                   1134:     my $first = "document.$formname.$firstselectname";
                   1135:     # output the javascript to do the changing
                   1136:     my $result = '';
1.776     bisitz   1137:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1138:     $result.="// <![CDATA[\n";
1.36      matthew  1139:     $result.="var select2data = new Object();\n";
                   1140:     $" = '","';
                   1141:     my $debug = '';
                   1142:     foreach my $s1 (sort(keys(%$hashref))) {
                   1143:         $result.="select2data.d_$s1 = new Object();\n";        
                   1144:         $result.="select2data.d_$s1.def = new String('".
                   1145:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1146:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1147:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1148:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1149:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1150:         }
1.36      matthew  1151:         $result.="\"@s2values\");\n";
                   1152:         $result.="select2data.d_$s1.texts = new Array(";        
                   1153:         my @s2texts;
                   1154:         foreach my $value (@s2values) {
1.1075.2.119  raeburn  1155:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1156:         }
                   1157:         $result.="\"@s2texts\");\n";
                   1158:     }
                   1159:     $"=' ';
                   1160:     $result.= <<"END";
                   1161: 
                   1162: function select1_changed() {
                   1163:     // Determine new choice
                   1164:     var newvalue = "d_" + $first.value;
                   1165:     // update select2
                   1166:     var values     = select2data[newvalue].values;
                   1167:     var texts      = select2data[newvalue].texts;
                   1168:     var select2def = select2data[newvalue].def;
                   1169:     var i;
                   1170:     // out with the old
                   1171:     for (i = 0; i < $second.options.length; i++) {
                   1172:         $second.options[i] = null;
                   1173:     }
                   1174:     // in with the nuclear
                   1175:     for (i=0;i<values.length; i++) {
                   1176:         $second.options[i] = new Option(values[i]);
1.143     matthew  1177:         $second.options[i].value = values[i];
1.36      matthew  1178:         $second.options[i].text = texts[i];
                   1179:         if (values[i] == select2def) {
                   1180:             $second.options[i].selected = true;
                   1181:         }
                   1182:     }
                   1183: }
1.824     bisitz   1184: // ]]>
1.36      matthew  1185: </script>
                   1186: END
                   1187:     # output the initial values for the selection lists
1.1075.2.31  raeburn  1188:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1189:     my @order = sort(keys(%{$hashref}));
                   1190:     if (ref($menuorder) eq 'ARRAY') {
                   1191:         @order = @{$menuorder};
                   1192:     }
                   1193:     foreach my $value (@order) {
1.36      matthew  1194:         $result.="    <option value=\"$value\" ";
1.253     albertel 1195:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1196:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1197:     }
                   1198:     $result .= "</select>\n";
                   1199:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1200:     $result .= $middletext;
1.1075.2.31  raeburn  1201:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1202:     if ($onchangesecond) {
                   1203:         $result .= ' onchange="'.$onchangesecond.'"';
                   1204:     }
                   1205:     $result .= ">\n";
1.36      matthew  1206:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1207:     
                   1208:     my @secondorder = sort(keys(%select2));
                   1209:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1210:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1211:     }
                   1212:     foreach my $value (@secondorder) {
1.36      matthew  1213:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1214:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1215:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1216:     }
                   1217:     $result .= "</select>\n";
                   1218:     #    return $debug;
                   1219:     return $result;
                   1220: }   #  end of sub linked_select_forms {
                   1221: 
1.45      matthew  1222: =pod
1.44      bowersj2 1223: 
1.973     raeburn  1224: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1225: 
1.112     bowersj2 1226: Returns a string corresponding to an HTML link to the given help
                   1227: $topic, where $topic corresponds to the name of a .tex file in
                   1228: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1229: spaces. 
                   1230: 
                   1231: $text will optionally be linked to the same topic, allowing you to
                   1232: link text in addition to the graphic. If you do not want to link
                   1233: text, but wish to specify one of the later parameters, pass an
                   1234: empty string. 
                   1235: 
                   1236: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1237: the link will not open a new window. If false, the link will open
                   1238: a new window using Javascript. (Default is false.) 
                   1239: 
                   1240: $width and $height are optional numerical parameters that will
                   1241: override the width and height of the popped up window, which may
1.973     raeburn  1242: be useful for certain help topics with big pictures included.
                   1243: 
                   1244: $imgid is the id of the img tag used for the help icon. This may be
                   1245: used in a javascript call to switch the image src.  See 
                   1246: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1247: 
                   1248: =cut
                   1249: 
                   1250: sub help_open_topic {
1.973     raeburn  1251:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1252:     $text = "" if (not defined $text);
1.44      bowersj2 1253:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1254:     $width = 500 if (not defined $width);
1.44      bowersj2 1255:     $height = 400 if (not defined $height);
                   1256:     my $filename = $topic;
                   1257:     $filename =~ s/ /_/g;
                   1258: 
1.48      bowersj2 1259:     my $template = "";
                   1260:     my $link;
1.572     banghart 1261:     
1.159     www      1262:     $topic=~s/\W/\_/g;
1.44      bowersj2 1263: 
1.572     banghart 1264:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1265:         if ($env{'browser.mobile'}) {
                   1266: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1267:         } else {
                   1268:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1269:         }
1.1037    www      1270:     } elsif ($stayOnPage eq 'popup') {
                   1271:         $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 1272:     } else {
1.48      bowersj2 1273: 	$link = "/adm/help/${filename}.hlp";
                   1274:     }
                   1275: 
                   1276:     # Add the text
1.755     neumanie 1277:     if ($text ne "") {	
1.763     bisitz   1278: 	$template.='<span class="LC_help_open_topic">'
                   1279:                   .'<a target="_top" href="'.$link.'">'
                   1280:                   .$text.'</a>';
1.48      bowersj2 1281:     }
                   1282: 
1.763     bisitz   1283:     # (Always) Add the graphic
1.179     matthew  1284:     my $title = &mt('Online Help');
1.667     raeburn  1285:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1286:     if ($imgid ne '') {
                   1287:         $imgid = ' id="'.$imgid.'"';
                   1288:     }
1.763     bisitz   1289:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1290:               .'<img src="'.$helpicon.'" border="0"'
                   1291:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1292:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1293:               .' /></a>';
                   1294:     if ($text ne "") {	
                   1295:         $template.='</span>';
                   1296:     }
1.44      bowersj2 1297:     return $template;
                   1298: 
1.106     bowersj2 1299: }
                   1300: 
                   1301: # This is a quicky function for Latex cheatsheet editing, since it 
                   1302: # appears in at least four places
                   1303: sub helpLatexCheatsheet {
1.1037    www      1304:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1305:     my $out;
1.106     bowersj2 1306:     my $addOther = '';
1.732     raeburn  1307:     if ($topic) {
1.1037    www      1308: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1309:     }
                   1310:     $out = '<span>' # Start cheatsheet
                   1311: 	  .$addOther
                   1312:           .'<span>'
1.1037    www      1313: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1314: 	  .'</span> <span>'
1.1037    www      1315: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1316: 	  .'</span>';
1.732     raeburn  1317:     unless ($not_author) {
1.763     bisitz   1318:         $out .= ' <span>'
1.1037    www      1319: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1320: 	       .'</span> <span>'
1.1075.2.78  raeburn  1321:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1322:                .'</span>';
1.732     raeburn  1323:     }
1.763     bisitz   1324:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1325:     return $out;
1.172     www      1326: }
                   1327: 
1.430     albertel 1328: sub general_help {
                   1329:     my $helptopic='Student_Intro';
                   1330:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1331: 	$helptopic='Authoring_Intro';
1.907     raeburn  1332:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1333: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1334:     } elsif ($env{'request.role'}=~/^dc/) {
                   1335:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1336:     }
                   1337:     return $helptopic;
                   1338: }
                   1339: 
                   1340: sub update_help_link {
                   1341:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1342:     my $origurl = $ENV{'REQUEST_URI'};
                   1343:     $origurl=~s|^/~|/priv/|;
                   1344:     my $timestamp = time;
                   1345:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1346:         $$datum = &escape($$datum);
                   1347:     }
                   1348: 
                   1349:     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";
                   1350:     my $output .= <<"ENDOUTPUT";
                   1351: <script type="text/javascript">
1.824     bisitz   1352: // <![CDATA[
1.430     albertel 1353: banner_link = '$banner_link';
1.824     bisitz   1354: // ]]>
1.430     albertel 1355: </script>
                   1356: ENDOUTPUT
                   1357:     return $output;
                   1358: }
                   1359: 
                   1360: # now just updates the help link and generates a blue icon
1.193     raeburn  1361: sub help_open_menu {
1.430     albertel 1362:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1363: 	= @_;    
1.949     droeschl 1364:     $stayOnPage = 1;
1.430     albertel 1365:     my $output;
                   1366:     if ($component_help) {
                   1367: 	if (!$text) {
                   1368: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1369: 				       $width,$height);
                   1370: 	} else {
                   1371: 	    my $help_text;
                   1372: 	    $help_text=&unescape($topic);
                   1373: 	    $output='<table><tr><td>'.
                   1374: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1375: 				 $width,$height).'</td></tr></table>';
                   1376: 	}
                   1377:     }
                   1378:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1379:     return $output.$banner_link;
                   1380: }
                   1381: 
                   1382: sub top_nav_help {
                   1383:     my ($text) = @_;
1.436     albertel 1384:     $text = &mt($text);
1.1075.2.60  raeburn  1385:     my $stay_on_page;
                   1386:     unless ($env{'environment.remote'} eq 'on') {
                   1387:         $stay_on_page = 1;
                   1388:     }
1.1075.2.61  raeburn  1389:     my ($link,$banner_link);
                   1390:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1391:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1392: 	                         : "javascript:helpMenu('open')";
                   1393:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1394:     }
1.201     raeburn  1395:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1396:     if ($link) {
                   1397:         return <<"END";
1.436     albertel 1398: $banner_link
1.1075.2.56  raeburn  1399: <a href="$link" title="$title">$text</a>
1.436     albertel 1400: END
1.1075.2.61  raeburn  1401:     } else {
                   1402:         return '&nbsp;'.$text.'&nbsp;';
                   1403:     }
1.436     albertel 1404: }
                   1405: 
                   1406: sub help_menu_js {
1.1075.2.52  raeburn  1407:     my ($httphost) = @_;
1.949     droeschl 1408:     my $stayOnPage = 1;
1.436     albertel 1409:     my $width = 620;
                   1410:     my $height = 600;
1.430     albertel 1411:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1412:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1413:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1414:     my $start_page =
                   1415:         &Apache::loncommon::start_page('Help Menu', undef,
                   1416: 				       {'frameset'    => 1,
                   1417: 					'js_ready'    => 1,
1.1075.2.136  raeburn  1418:                                         'use_absolute' => $httphost,
1.331     albertel 1419: 					'add_entries' => {
                   1420: 					    'border' => '0',
1.579     raeburn  1421: 					    'rows'   => "110,*",},});
1.331     albertel 1422:     my $end_page =
                   1423:         &Apache::loncommon::end_page({'frameset' => 1,
                   1424: 				      'js_ready' => 1,});
                   1425: 
1.436     albertel 1426:     my $template .= <<"ENDTEMPLATE";
                   1427: <script type="text/javascript">
1.877     bisitz   1428: // <![CDATA[
1.253     albertel 1429: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1430: var banner_link = '';
1.243     raeburn  1431: function helpMenu(target) {
                   1432:     var caller = this;
                   1433:     if (target == 'open') {
                   1434:         var newWindow = null;
                   1435:         try {
1.262     albertel 1436:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1437:         }
                   1438:         catch(error) {
                   1439:             writeHelp(caller);
                   1440:             return;
                   1441:         }
                   1442:         if (newWindow) {
                   1443:             caller = newWindow;
                   1444:         }
1.193     raeburn  1445:     }
1.243     raeburn  1446:     writeHelp(caller);
                   1447:     return;
                   1448: }
                   1449: function writeHelp(caller) {
1.1075.2.61  raeburn  1450:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1451:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1452:     caller.document.close();
                   1453:     caller.focus();
1.193     raeburn  1454: }
1.877     bisitz   1455: // END LON-CAPA Internal -->
1.253     albertel 1456: // ]]>
1.436     albertel 1457: </script>
1.193     raeburn  1458: ENDTEMPLATE
                   1459:     return $template;
                   1460: }
                   1461: 
1.172     www      1462: sub help_open_bug {
                   1463:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1464:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1465:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1466:     $text = "" if (not defined $text);
                   1467: 	$stayOnPage=1;
1.184     albertel 1468:     $width = 600 if (not defined $width);
                   1469:     $height = 600 if (not defined $height);
1.172     www      1470: 
                   1471:     $topic=~s/\W+/\+/g;
                   1472:     my $link='';
                   1473:     my $template='';
1.379     albertel 1474:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1475: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1476:     if (!$stayOnPage)
                   1477:     {
                   1478: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1479:     }
                   1480:     else
                   1481:     {
                   1482: 	$link = $url;
                   1483:     }
                   1484:     # Add the text
                   1485:     if ($text ne "")
                   1486:     {
                   1487: 	$template .= 
                   1488:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1489:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1490:     }
                   1491: 
                   1492:     # Add the graphic
1.179     matthew  1493:     my $title = &mt('Report a Bug');
1.215     albertel 1494:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1495:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1496:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1497: ENDTEMPLATE
                   1498:     if ($text ne '') { $template.='</td></tr></table>' };
                   1499:     return $template;
                   1500: 
                   1501: }
                   1502: 
                   1503: sub help_open_faq {
                   1504:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1505:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1506:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1507:     $text = "" if (not defined $text);
                   1508: 	$stayOnPage=1;
                   1509:     $width = 350 if (not defined $width);
                   1510:     $height = 400 if (not defined $height);
                   1511: 
                   1512:     $topic=~s/\W+/\+/g;
                   1513:     my $link='';
                   1514:     my $template='';
                   1515:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1516:     if (!$stayOnPage)
                   1517:     {
                   1518: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1519:     }
                   1520:     else
                   1521:     {
                   1522: 	$link = $url;
                   1523:     }
                   1524: 
                   1525:     # Add the text
                   1526:     if ($text ne "")
                   1527:     {
                   1528: 	$template .= 
1.173     www      1529:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1530:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1531:     }
                   1532: 
                   1533:     # Add the graphic
1.179     matthew  1534:     my $title = &mt('View the FAQ');
1.215     albertel 1535:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1536:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1537:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1538: ENDTEMPLATE
                   1539:     if ($text ne '') { $template.='</td></tr></table>' };
                   1540:     return $template;
                   1541: 
1.44      bowersj2 1542: }
1.37      matthew  1543: 
1.180     matthew  1544: ###############################################################
                   1545: ###############################################################
                   1546: 
1.45      matthew  1547: =pod
                   1548: 
1.648     raeburn  1549: =item * &change_content_javascript():
1.256     matthew  1550: 
                   1551: This and the next function allow you to create small sections of an
                   1552: otherwise static HTML page that you can update on the fly with
                   1553: Javascript, even in Netscape 4.
                   1554: 
                   1555: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1556: must be written to the HTML page once. It will prove the Javascript
                   1557: function "change(name, content)". Calling the change function with the
                   1558: name of the section 
                   1559: you want to update, matching the name passed to C<changable_area>, and
                   1560: the new content you want to put in there, will put the content into
                   1561: that area.
                   1562: 
                   1563: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1564: to contain room for the original contents. You need to "make space"
                   1565: for whatever changes you wish to make, and be B<sure> to check your
                   1566: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1567: it's adequate for updating a one-line status display, but little more.
                   1568: This script will set the space to 100% width, so you only need to
                   1569: worry about height in Netscape 4.
                   1570: 
                   1571: Modern browsers are much less limiting, and if you can commit to the
                   1572: user not using Netscape 4, this feature may be used freely with
                   1573: pretty much any HTML.
                   1574: 
                   1575: =cut
                   1576: 
                   1577: sub change_content_javascript {
                   1578:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1579:     if ($env{'browser.type'} eq 'netscape' &&
                   1580: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1581: 	return (<<NETSCAPE4);
                   1582: 	function change(name, content) {
                   1583: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1584: 	    doc.open();
                   1585: 	    doc.write(content);
                   1586: 	    doc.close();
                   1587: 	}
                   1588: NETSCAPE4
                   1589:     } else {
                   1590: 	# Otherwise, we need to use semi-standards-compliant code
                   1591: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1592: 	# is really scary, and every useful browser supports it
                   1593: 	return (<<DOMBASED);
                   1594: 	function change(name, content) {
                   1595: 	    element = document.getElementById(name);
                   1596: 	    element.innerHTML = content;
                   1597: 	}
                   1598: DOMBASED
                   1599:     }
                   1600: }
                   1601: 
                   1602: =pod
                   1603: 
1.648     raeburn  1604: =item * &changable_area($name,$origContent):
1.256     matthew  1605: 
                   1606: This provides a "changable area" that can be modified on the fly via
                   1607: the Javascript code provided in C<change_content_javascript>. $name is
                   1608: the name you will use to reference the area later; do not repeat the
                   1609: same name on a given HTML page more then once. $origContent is what
                   1610: the area will originally contain, which can be left blank.
                   1611: 
                   1612: =cut
                   1613: 
                   1614: sub changable_area {
                   1615:     my ($name, $origContent) = @_;
                   1616: 
1.258     albertel 1617:     if ($env{'browser.type'} eq 'netscape' &&
                   1618: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1619: 	# If this is netscape 4, we need to use the Layer tag
                   1620: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1621:     } else {
                   1622: 	return "<span id='$name'>$origContent</span>";
                   1623:     }
                   1624: }
                   1625: 
                   1626: =pod
                   1627: 
1.648     raeburn  1628: =item * &viewport_geometry_js 
1.590     raeburn  1629: 
                   1630: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1631: 
                   1632: =cut
                   1633: 
                   1634: 
                   1635: sub viewport_geometry_js { 
                   1636:     return <<"GEOMETRY";
                   1637: var Geometry = {};
                   1638: function init_geometry() {
                   1639:     if (Geometry.init) { return };
                   1640:     Geometry.init=1;
                   1641:     if (window.innerHeight) {
                   1642:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1643:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1644:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1645:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1646:     }
                   1647:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1648:         Geometry.getViewportHeight =
                   1649:             function() { return document.documentElement.clientHeight; };
                   1650:         Geometry.getViewportWidth =
                   1651:             function() { return document.documentElement.clientWidth; };
                   1652: 
                   1653:         Geometry.getHorizontalScroll =
                   1654:             function() { return document.documentElement.scrollLeft; };
                   1655:         Geometry.getVerticalScroll =
                   1656:             function() { return document.documentElement.scrollTop; };
                   1657:     }
                   1658:     else if (document.body.clientHeight) {
                   1659:         Geometry.getViewportHeight =
                   1660:             function() { return document.body.clientHeight; };
                   1661:         Geometry.getViewportWidth =
                   1662:             function() { return document.body.clientWidth; };
                   1663:         Geometry.getHorizontalScroll =
                   1664:             function() { return document.body.scrollLeft; };
                   1665:         Geometry.getVerticalScroll =
                   1666:             function() { return document.body.scrollTop; };
                   1667:     }
                   1668: }
                   1669: 
                   1670: GEOMETRY
                   1671: }
                   1672: 
                   1673: =pod
                   1674: 
1.648     raeburn  1675: =item * &viewport_size_js()
1.590     raeburn  1676: 
                   1677: 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. 
                   1678: 
                   1679: =cut
                   1680: 
                   1681: sub viewport_size_js {
                   1682:     my $geometry = &viewport_geometry_js();
                   1683:     return <<"DIMS";
                   1684: 
                   1685: $geometry
                   1686: 
                   1687: function getViewportDims(width,height) {
                   1688:     init_geometry();
                   1689:     width.value = Geometry.getViewportWidth();
                   1690:     height.value = Geometry.getViewportHeight();
                   1691:     return;
                   1692: }
                   1693: 
                   1694: DIMS
                   1695: }
                   1696: 
                   1697: =pod
                   1698: 
1.648     raeburn  1699: =item * &resize_textarea_js()
1.565     albertel 1700: 
                   1701: emits the needed javascript to resize a textarea to be as big as possible
                   1702: 
                   1703: creates a function resize_textrea that takes two IDs first should be
                   1704: the id of the element to resize, second should be the id of a div that
                   1705: surrounds everything that comes after the textarea, this routine needs
                   1706: to be attached to the <body> for the onload and onresize events.
                   1707: 
1.648     raeburn  1708: =back
1.565     albertel 1709: 
                   1710: =cut
                   1711: 
                   1712: sub resize_textarea_js {
1.590     raeburn  1713:     my $geometry = &viewport_geometry_js();
1.565     albertel 1714:     return <<"RESIZE";
                   1715:     <script type="text/javascript">
1.824     bisitz   1716: // <![CDATA[
1.590     raeburn  1717: $geometry
1.565     albertel 1718: 
1.588     albertel 1719: function getX(element) {
                   1720:     var x = 0;
                   1721:     while (element) {
                   1722: 	x += element.offsetLeft;
                   1723: 	element = element.offsetParent;
                   1724:     }
                   1725:     return x;
                   1726: }
                   1727: function getY(element) {
                   1728:     var y = 0;
                   1729:     while (element) {
                   1730: 	y += element.offsetTop;
                   1731: 	element = element.offsetParent;
                   1732:     }
                   1733:     return y;
                   1734: }
                   1735: 
                   1736: 
1.565     albertel 1737: function resize_textarea(textarea_id,bottom_id) {
                   1738:     init_geometry();
                   1739:     var textarea        = document.getElementById(textarea_id);
                   1740:     //alert(textarea);
                   1741: 
1.588     albertel 1742:     var textarea_top    = getY(textarea);
1.565     albertel 1743:     var textarea_height = textarea.offsetHeight;
                   1744:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1745:     var bottom_top      = getY(bottom);
1.565     albertel 1746:     var bottom_height   = bottom.offsetHeight;
                   1747:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1748:     var fudge           = 23;
1.565     albertel 1749:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1750:     if (new_height < 300) {
                   1751: 	new_height = 300;
                   1752:     }
                   1753:     textarea.style.height=new_height+'px';
                   1754: }
1.824     bisitz   1755: // ]]>
1.565     albertel 1756: </script>
                   1757: RESIZE
                   1758: 
                   1759: }
                   1760: 
1.1075.2.112  raeburn  1761: sub colorfuleditor_js {
                   1762:     return <<"COLORFULEDIT"
                   1763: <script type="text/javascript">
                   1764: // <![CDATA[>
                   1765:     function fold_box(curDepth, lastresource){
                   1766: 
                   1767:     // we need a list because there can be several blocks you need to fold in one tag
                   1768:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1769:     // but there is only one folding button per tag
                   1770:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1771: 
                   1772:         if(block.item(0).style.display == 'none'){
                   1773: 
                   1774:             foldbutton.value = '@{[&mt("Hide")]}';
                   1775:             for (i = 0; i < block.length; i++){
                   1776:                 block.item(i).style.display = '';
                   1777:             }
                   1778:         }else{
                   1779: 
                   1780:             foldbutton.value = '@{[&mt("Show")]}';
                   1781:             for (i = 0; i < block.length; i++){
                   1782:                 // block.item(i).style.visibility = 'collapse';
                   1783:                 block.item(i).style.display = 'none';
                   1784:             }
                   1785:         };
                   1786:         saveState(lastresource);
                   1787:     }
                   1788: 
                   1789:     function saveState (lastresource) {
                   1790: 
                   1791:         var tag_list = getTagList();
                   1792:         if(tag_list != null){
                   1793:             var timestamp = new Date().getTime();
                   1794:             var key = lastresource;
                   1795: 
                   1796:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1797:             // starting with timestamp
                   1798:             var value = timestamp+';';
                   1799: 
                   1800:             // building the list of key-value pairs
                   1801:             for(var i = 0; i < tag_list.length; i++){
                   1802:                 value += tag_list[i]+',';
                   1803:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1804:             }
                   1805: 
                   1806:             // only iterate whole storage if nothing to override
                   1807:             if(localStorage.getItem(key) == null){
                   1808: 
                   1809:                 // prevent storage from growing large
                   1810:                 if(localStorage.length > 50){
                   1811:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1812:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1813:                     var oldest_key;
                   1814: 
                   1815:                     for(var i = 1; i < localStorage.length; i++){
                   1816:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1817:                             oldest_key = localStorage.key(i);
                   1818:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1819:                         }
                   1820:                     }
                   1821:                     localStorage.removeItem(oldest_key);
                   1822:                 }
                   1823:             }
                   1824:             localStorage.setItem(key,value);
                   1825:         }
                   1826:     }
                   1827: 
                   1828:     // restore folding status of blocks (on page load)
                   1829:     function restoreState (lastresource) {
                   1830:         if(localStorage.getItem(lastresource) != null){
                   1831:             var key = lastresource;
                   1832:             var value = localStorage.getItem(key);
                   1833:             var regex_delTimestamp = /^\d+;/;
                   1834: 
                   1835:             value.replace(regex_delTimestamp, '');
                   1836: 
                   1837:             var valueArr = value.split(';');
                   1838:             var pairs;
                   1839:             var elements;
                   1840:             for (var i = 0; i < valueArr.length; i++){
                   1841:                 pairs = valueArr[i].split(',');
                   1842:                 elements = document.getElementsByName(pairs[0]);
                   1843: 
                   1844:                 for (var j = 0; j < elements.length; j++){
                   1845:                     elements[j].style.display = pairs[1];
                   1846:                     if (pairs[1] == "none"){
                   1847:                         var regex_id = /([_\\d]+)\$/;
                   1848:                         regex_id.exec(pairs[0]);
                   1849:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1850:                     }
                   1851:                 }
                   1852:             }
                   1853:         }
                   1854:     }
                   1855: 
                   1856:     function getTagList () {
                   1857: 
                   1858:         var stringToSearch = document.lonhomework.innerHTML;
                   1859: 
                   1860:         var ret = new Array();
                   1861:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1862:         var tag_list = stringToSearch.match(regex_findBlock);
                   1863: 
                   1864:         if(tag_list != null){
                   1865:             for(var i = 0; i < tag_list.length; i++){
                   1866:                 ret.push(tag_list[i].replace(/"/, ''));
                   1867:             }
                   1868:         }
                   1869:         return ret;
                   1870:     }
                   1871: 
                   1872:     function saveScrollPosition (resource) {
                   1873:         var tag_list = getTagList();
                   1874: 
                   1875:         // we dont always want to jump to the first block
                   1876:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1877:         if(\$(window).scrollTop() > 170){
                   1878:             if(tag_list != null){
                   1879:                 var result;
                   1880:                 for(var i = 0; i < tag_list.length; i++){
                   1881:                     if(isElementInViewport(tag_list[i])){
                   1882:                         result += tag_list[i]+';';
                   1883:                     }
                   1884:                 }
                   1885:                 sessionStorage.setItem('anchor_'+resource, result);
                   1886:             }
                   1887:         } else {
                   1888:             // we dont need to save zero, just delete the item to leave everything tidy
                   1889:             sessionStorage.removeItem('anchor_'+resource);
                   1890:         }
                   1891:     }
                   1892: 
                   1893:     function restoreScrollPosition(resource){
                   1894: 
                   1895:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1896:         if(elem != null){
                   1897:             var tag_list = elem.split(';');
                   1898:             var elem_list;
                   1899: 
                   1900:             for(var i = 0; i < tag_list.length; i++){
                   1901:                 elem_list = document.getElementsByName(tag_list[i]);
                   1902: 
                   1903:                 if(elem_list.length > 0){
                   1904:                     elem = elem_list[0];
                   1905:                     break;
                   1906:                 }
                   1907:             }
                   1908:             elem.scrollIntoView();
                   1909:         }
                   1910:     }
                   1911: 
                   1912:     function isElementInViewport(el) {
                   1913: 
                   1914:         // change to last element instead of first
                   1915:         var elem = document.getElementsByName(el);
                   1916:         var rect = elem[0].getBoundingClientRect();
                   1917: 
                   1918:         return (
                   1919:             rect.top >= 0 &&
                   1920:             rect.left >= 0 &&
                   1921:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1922:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1923:         );
                   1924:     }
                   1925: 
                   1926:     function autosize(depth){
                   1927:         var cmInst = window['cm'+depth];
                   1928:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1929: 
                   1930:         // is fixed size, switching to dynamic
                   1931:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1932:             cmInst.setSize("","auto");
                   1933:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1934:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1935: 
                   1936:         // is dynamic size, switching to fixed
                   1937:         } else {
                   1938:             cmInst.setSize("","300px");
                   1939:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1940:             sessionStorage.removeItem("autosized_"+depth);
                   1941:         }
                   1942:     }
                   1943: 
                   1944: 
                   1945: 
                   1946: // ]]>
                   1947: </script>
                   1948: COLORFULEDIT
                   1949: }
                   1950: 
                   1951: sub xmleditor_js {
                   1952:     return <<XMLEDIT
                   1953: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1954: <script type="text/javascript">
                   1955: // <![CDATA[>
                   1956: 
                   1957:     function saveScrollPosition (resource) {
                   1958: 
                   1959:         var scrollPos = \$(window).scrollTop();
                   1960:         sessionStorage.setItem(resource,scrollPos);
                   1961:     }
                   1962: 
                   1963:     function restoreScrollPosition(resource){
                   1964: 
                   1965:         var scrollPos = sessionStorage.getItem(resource);
                   1966:         \$(window).scrollTop(scrollPos);
                   1967:     }
                   1968: 
                   1969:     // unless internet explorer
                   1970:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1971: 
                   1972:         \$(document).ready(function() {
                   1973:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1974:         });
                   1975:     }
                   1976: 
                   1977:     // inserts text at cursor position into codemirror (xml editor only)
                   1978:     function insertText(text){
                   1979:         cm.focus();
                   1980:         var curPos = cm.getCursor();
                   1981:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1982:     }
                   1983: // ]]>
                   1984: </script>
                   1985: XMLEDIT
                   1986: }
                   1987: 
                   1988: sub insert_folding_button {
                   1989:     my $curDepth = $Apache::lonxml::curdepth;
                   1990:     my $lastresource = $env{'request.ambiguous'};
                   1991: 
                   1992:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   1993:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1994: }
                   1995: 
                   1996: 
1.565     albertel 1997: =pod
                   1998: 
1.256     matthew  1999: =head1 Excel and CSV file utility routines
                   2000: 
                   2001: =cut
                   2002: 
                   2003: ###############################################################
                   2004: ###############################################################
                   2005: 
                   2006: =pod
                   2007: 
1.1075.2.56  raeburn  2008: =over 4
                   2009: 
1.648     raeburn  2010: =item * &csv_translate($text) 
1.37      matthew  2011: 
1.185     www      2012: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2013: format.
                   2014: 
                   2015: =cut
                   2016: 
1.180     matthew  2017: ###############################################################
                   2018: ###############################################################
1.37      matthew  2019: sub csv_translate {
                   2020:     my $text = shift;
                   2021:     $text =~ s/\"/\"\"/g;
1.209     albertel 2022:     $text =~ s/\n/ /g;
1.37      matthew  2023:     return $text;
                   2024: }
1.180     matthew  2025: 
                   2026: ###############################################################
                   2027: ###############################################################
                   2028: 
                   2029: =pod
                   2030: 
1.648     raeburn  2031: =item * &define_excel_formats()
1.180     matthew  2032: 
                   2033: Define some commonly used Excel cell formats.
                   2034: 
                   2035: Currently supported formats:
                   2036: 
                   2037: =over 4
                   2038: 
                   2039: =item header
                   2040: 
                   2041: =item bold
                   2042: 
                   2043: =item h1
                   2044: 
                   2045: =item h2
                   2046: 
                   2047: =item h3
                   2048: 
1.256     matthew  2049: =item h4
                   2050: 
                   2051: =item i
                   2052: 
1.180     matthew  2053: =item date
                   2054: 
                   2055: =back
                   2056: 
                   2057: Inputs: $workbook
                   2058: 
                   2059: Returns: $format, a hash reference.
                   2060: 
1.1057    foxr     2061: 
1.180     matthew  2062: =cut
                   2063: 
                   2064: ###############################################################
                   2065: ###############################################################
                   2066: sub define_excel_formats {
                   2067:     my ($workbook) = @_;
                   2068:     my $format;
                   2069:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2070:                                                 bottom    => 1,
                   2071:                                                 align     => 'center');
                   2072:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2073:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2074:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2075:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2076:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2077:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2078:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2079:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2080:     return $format;
                   2081: }
                   2082: 
                   2083: ###############################################################
                   2084: ###############################################################
1.113     bowersj2 2085: 
                   2086: =pod
                   2087: 
1.648     raeburn  2088: =item * &create_workbook()
1.255     matthew  2089: 
                   2090: Create an Excel worksheet.  If it fails, output message on the
                   2091: request object and return undefs.
                   2092: 
                   2093: Inputs: Apache request object
                   2094: 
                   2095: Returns (undef) on failure, 
                   2096:     Excel worksheet object, scalar with filename, and formats 
                   2097:     from &Apache::loncommon::define_excel_formats on success
                   2098: 
                   2099: =cut
                   2100: 
                   2101: ###############################################################
                   2102: ###############################################################
                   2103: sub create_workbook {
                   2104:     my ($r) = @_;
                   2105:         #
                   2106:     # Create the excel spreadsheet
                   2107:     my $filename = '/prtspool/'.
1.258     albertel 2108:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2109:         time.'_'.rand(1000000000).'.xls';
                   2110:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2111:     if (! defined($workbook)) {
                   2112:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2113:         $r->print(
                   2114:             '<p class="LC_error">'
                   2115:            .&mt('Problems occurred in creating the new Excel file.')
                   2116:            .' '.&mt('This error has been logged.')
                   2117:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2118:            .'</p>'
                   2119:         );
1.255     matthew  2120:         return (undef);
                   2121:     }
                   2122:     #
1.1014    foxr     2123:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2124:     #
                   2125:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2126:     return ($workbook,$filename,$format);
                   2127: }
                   2128: 
                   2129: ###############################################################
                   2130: ###############################################################
                   2131: 
                   2132: =pod
                   2133: 
1.648     raeburn  2134: =item * &create_text_file()
1.113     bowersj2 2135: 
1.542     raeburn  2136: Create a file to write to and eventually make available to the user.
1.256     matthew  2137: If file creation fails, outputs an error message on the request object and 
                   2138: return undefs.
1.113     bowersj2 2139: 
1.256     matthew  2140: Inputs: Apache request object, and file suffix
1.113     bowersj2 2141: 
1.256     matthew  2142: Returns (undef) on failure, 
                   2143:     Filehandle and filename on success.
1.113     bowersj2 2144: 
                   2145: =cut
                   2146: 
1.256     matthew  2147: ###############################################################
                   2148: ###############################################################
                   2149: sub create_text_file {
                   2150:     my ($r,$suffix) = @_;
                   2151:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2152:     my $fh;
                   2153:     my $filename = '/prtspool/'.
1.258     albertel 2154:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2155:         time.'_'.rand(1000000000).'.'.$suffix;
                   2156:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2157:     if (! defined($fh)) {
                   2158:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2159:         $r->print(
                   2160:             '<p class="LC_error">'
                   2161:            .&mt('Problems occurred in creating the output file.')
                   2162:            .' '.&mt('This error has been logged.')
                   2163:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2164:            .'</p>'
                   2165:         );
1.113     bowersj2 2166:     }
1.256     matthew  2167:     return ($fh,$filename)
1.113     bowersj2 2168: }
                   2169: 
                   2170: 
1.256     matthew  2171: =pod 
1.113     bowersj2 2172: 
                   2173: =back
                   2174: 
                   2175: =cut
1.37      matthew  2176: 
                   2177: ###############################################################
1.33      matthew  2178: ##        Home server <option> list generating code          ##
                   2179: ###############################################################
1.35      matthew  2180: 
1.169     www      2181: # ------------------------------------------
                   2182: 
                   2183: sub domain_select {
                   2184:     my ($name,$value,$multiple)=@_;
                   2185:     my %domains=map { 
1.514     albertel 2186: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2187:     } &Apache::lonnet::all_domains();
1.169     www      2188:     if ($multiple) {
                   2189: 	$domains{''}=&mt('Any domain');
1.550     albertel 2190: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2191: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2192:     } else {
1.550     albertel 2193: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2194: 	return &select_form($name,$value,\%domains);
1.169     www      2195:     }
                   2196: }
                   2197: 
1.282     albertel 2198: #-------------------------------------------
                   2199: 
                   2200: =pod
                   2201: 
1.519     raeburn  2202: =head1 Routines for form select boxes
                   2203: 
                   2204: =over 4
                   2205: 
1.648     raeburn  2206: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2207: 
                   2208: Returns a string containing a <select> element int multiple mode
                   2209: 
                   2210: 
                   2211: Args:
                   2212:   $name - name of the <select> element
1.506     raeburn  2213:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2214:   $size - number of rows long the select element is
1.283     albertel 2215:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2216:           (shown text should already have been &mt())
1.506     raeburn  2217:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2218: 
1.282     albertel 2219: =cut
                   2220: 
                   2221: #-------------------------------------------
1.169     www      2222: sub multiple_select_form {
1.284     albertel 2223:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2224:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2225:     my $output='';
1.191     matthew  2226:     if (! defined($size)) {
                   2227:         $size = 4;
1.283     albertel 2228:         if (scalar(keys(%$hash))<4) {
                   2229:             $size = scalar(keys(%$hash));
1.191     matthew  2230:         }
                   2231:     }
1.734     bisitz   2232:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2233:     my @order;
1.506     raeburn  2234:     if (ref($order) eq 'ARRAY')  {
                   2235:         @order = @{$order};
                   2236:     } else {
                   2237:         @order = sort(keys(%$hash));
1.501     banghart 2238:     }
                   2239:     if (exists($$hash{'select_form_order'})) {
                   2240:         @order = @{$$hash{'select_form_order'}};
                   2241:     }
                   2242:         
1.284     albertel 2243:     foreach my $key (@order) {
1.356     albertel 2244:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2245:         $output.='selected="selected" ' if ($selected{$key});
                   2246:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2247:     }
                   2248:     $output.="</select>\n";
                   2249:     return $output;
                   2250: }
                   2251: 
1.88      www      2252: #-------------------------------------------
                   2253: 
                   2254: =pod
                   2255: 
1.1075.2.115  raeburn  2256: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2257: 
                   2258: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2259: allow a user to select options from a ref to a hash containing:
                   2260: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2261: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2262: An optional arg -- $readonly -- if true will cause the select form
                   2263: to be disabled, e.g., for the case where an instructor has a section-
                   2264: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2265: 
1.88      www      2266: See lonrights.pm for an example invocation and use.
                   2267: 
                   2268: =cut
                   2269: 
                   2270: #-------------------------------------------
                   2271: sub select_form {
1.1075.2.115  raeburn  2272:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2273:     return unless (ref($hashref) eq 'HASH');
                   2274:     if ($onchange) {
                   2275:         $onchange = ' onchange="'.$onchange.'"';
                   2276:     }
1.1075.2.129  raeburn  2277:     my $disabled;
                   2278:     if ($readonly) {
                   2279:         $disabled = ' disabled="disabled"';
                   2280:     }
                   2281:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2282:     my @keys;
1.970     raeburn  2283:     if (exists($hashref->{'select_form_order'})) {
                   2284: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2285:     } else {
1.970     raeburn  2286: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2287:     }
1.356     albertel 2288:     foreach my $key (@keys) {
                   2289:         $selectform.=
                   2290: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2291:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2292:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2293:     }
                   2294:     $selectform.="</select>";
                   2295:     return $selectform;
                   2296: }
                   2297: 
1.475     www      2298: # For display filters
                   2299: 
                   2300: sub display_filter {
1.1074    raeburn  2301:     my ($context) = @_;
1.475     www      2302:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2303:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2304:     my $phraseinput = 'hidden';
                   2305:     my $includeinput = 'hidden';
                   2306:     my ($checked,$includetypestext);
                   2307:     if ($env{'form.displayfilter'} eq 'containing') {
                   2308:         $phraseinput = 'text'; 
                   2309:         if ($context eq 'parmslog') {
                   2310:             $includeinput = 'checkbox';
                   2311:             if ($env{'form.includetypes'}) {
                   2312:                 $checked = ' checked="checked"';
                   2313:             }
                   2314:             $includetypestext = &mt('Include parameter types');
                   2315:         }
                   2316:     } else {
                   2317:         $includetypestext = '&nbsp;';
                   2318:     }
                   2319:     my ($additional,$secondid,$thirdid);
                   2320:     if ($context eq 'parmslog') {
                   2321:         $additional = 
                   2322:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2323:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2324:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2325:             '</label>';
                   2326:         $secondid = 'includetypes';
                   2327:         $thirdid = 'includetypestext';
                   2328:     }
                   2329:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2330:                                                     '$secondid','$thirdid')";
                   2331:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2332: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2333: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2334: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2335:            &mt('Filter: [_1]',
1.477     www      2336: 	   &select_form($env{'form.displayfilter'},
                   2337: 			'displayfilter',
1.970     raeburn  2338: 			{'currentfolder' => 'Current folder/page',
1.477     www      2339: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2340: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2341: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2342:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2343:                          '" />'.$additional;
                   2344: }
                   2345: 
                   2346: sub display_filter_js {
                   2347:     my $includetext = &mt('Include parameter types');
                   2348:     return <<"ENDJS";
                   2349:   
                   2350: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2351:     var firstType = 'hidden';
                   2352:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2353:         firstType = 'text';
                   2354:     }
                   2355:     firstObject = document.getElementById(firstid);
                   2356:     if (typeof(firstObject) == 'object') {
                   2357:         if (firstObject.type != firstType) {
                   2358:             changeInputType(firstObject,firstType);
                   2359:         }
                   2360:     }
                   2361:     if (context == 'parmslog') {
                   2362:         var secondType = 'hidden';
                   2363:         if (firstType == 'text') {
                   2364:             secondType = 'checkbox';
                   2365:         }
                   2366:         secondObject = document.getElementById(secondid);  
                   2367:         if (typeof(secondObject) == 'object') {
                   2368:             if (secondObject.type != secondType) {
                   2369:                 changeInputType(secondObject,secondType);
                   2370:             }
                   2371:         }
                   2372:         var textItem = document.getElementById(thirdid);
                   2373:         var currtext = textItem.innerHTML;
                   2374:         var newtext;
                   2375:         if (firstType == 'text') {
                   2376:             newtext = '$includetext';
                   2377:         } else {
                   2378:             newtext = '&nbsp;';
                   2379:         }
                   2380:         if (currtext != newtext) {
                   2381:             textItem.innerHTML = newtext;
                   2382:         }
                   2383:     }
                   2384:     return;
                   2385: }
                   2386: 
                   2387: function changeInputType(oldObject,newType) {
                   2388:     var newObject = document.createElement('input');
                   2389:     newObject.type = newType;
                   2390:     if (oldObject.size) {
                   2391:         newObject.size = oldObject.size;
                   2392:     }
                   2393:     if (oldObject.value) {
                   2394:         newObject.value = oldObject.value;
                   2395:     }
                   2396:     if (oldObject.name) {
                   2397:         newObject.name = oldObject.name;
                   2398:     }
                   2399:     if (oldObject.id) {
                   2400:         newObject.id = oldObject.id;
                   2401:     }
                   2402:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2403:     return;
                   2404: }
                   2405: 
                   2406: ENDJS
1.475     www      2407: }
                   2408: 
1.167     www      2409: sub gradeleveldescription {
                   2410:     my $gradelevel=shift;
                   2411:     my %gradelevels=(0 => 'Not specified',
                   2412: 		     1 => 'Grade 1',
                   2413: 		     2 => 'Grade 2',
                   2414: 		     3 => 'Grade 3',
                   2415: 		     4 => 'Grade 4',
                   2416: 		     5 => 'Grade 5',
                   2417: 		     6 => 'Grade 6',
                   2418: 		     7 => 'Grade 7',
                   2419: 		     8 => 'Grade 8',
                   2420: 		     9 => 'Grade 9',
                   2421: 		     10 => 'Grade 10',
                   2422: 		     11 => 'Grade 11',
                   2423: 		     12 => 'Grade 12',
                   2424: 		     13 => 'Grade 13',
                   2425: 		     14 => '100 Level',
                   2426: 		     15 => '200 Level',
                   2427: 		     16 => '300 Level',
                   2428: 		     17 => '400 Level',
                   2429: 		     18 => 'Graduate Level');
                   2430:     return &mt($gradelevels{$gradelevel});
                   2431: }
                   2432: 
1.163     www      2433: sub select_level_form {
                   2434:     my ($deflevel,$name)=@_;
                   2435:     unless ($deflevel) { $deflevel=0; }
1.167     www      2436:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2437:     for (my $i=0; $i<=18; $i++) {
                   2438:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2439:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2440:                 ">".&gradeleveldescription($i)."</option>\n";
                   2441:     }
                   2442:     $selectform.="</select>";
                   2443:     return $selectform;
1.163     www      2444: }
1.167     www      2445: 
1.35      matthew  2446: #-------------------------------------------
                   2447: 
1.45      matthew  2448: =pod
                   2449: 
1.1075.2.115  raeburn  2450: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2451: 
                   2452: Returns a string containing a <select name='$name' size='1'> form to 
                   2453: allow a user to select the domain to preform an operation in.  
                   2454: See loncreateuser.pm for an example invocation and use.
                   2455: 
1.90      www      2456: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2457: selected");
                   2458: 
1.743     raeburn  2459: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2460: 
1.910     raeburn  2461: 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.
                   2462: 
1.1075.2.36  raeburn  2463: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2464: 
1.1075.2.115  raeburn  2465: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2466: 
                   2467: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2468: 
1.35      matthew  2469: =cut
                   2470: 
                   2471: #-------------------------------------------
1.34      matthew  2472: sub select_dom_form {
1.1075.2.115  raeburn  2473:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2474:     if ($onchange) {
1.874     raeburn  2475:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2476:     }
1.1075.2.115  raeburn  2477:     if ($disabled) {
                   2478:         $disabled = ' disabled="disabled"';
                   2479:     }
1.1075.2.36  raeburn  2480:     my (@domains,%exclude);
1.910     raeburn  2481:     if (ref($incdoms) eq 'ARRAY') {
                   2482:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2483:     } else {
                   2484:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2485:     }
1.90      www      2486:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2487:     if (ref($excdoms) eq 'ARRAY') {
                   2488:         map { $exclude{$_} = 1; } @{$excdoms};
                   2489:     }
1.1075.2.115  raeburn  2490:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2491:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2492:         next if ($exclude{$dom});
1.356     albertel 2493:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2494:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2495:         if ($showdomdesc) {
                   2496:             if ($dom ne '') {
                   2497:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2498:                 if ($domdesc ne '') {
                   2499:                     $selectdomain .= ' ('.$domdesc.')';
                   2500:                 }
                   2501:             } 
                   2502:         }
                   2503:         $selectdomain .= "</option>\n";
1.34      matthew  2504:     }
                   2505:     $selectdomain.="</select>";
                   2506:     return $selectdomain;
                   2507: }
                   2508: 
1.35      matthew  2509: #-------------------------------------------
                   2510: 
1.45      matthew  2511: =pod
                   2512: 
1.648     raeburn  2513: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2514: 
1.586     raeburn  2515: input: 4 arguments (two required, two optional) - 
                   2516:     $domain - domain of new user
                   2517:     $name - name of form element
                   2518:     $default - Value of 'default' causes a default item to be first 
                   2519:                             option, and selected by default. 
                   2520:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2521:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2522: output: returns 2 items: 
1.586     raeburn  2523: (a) form element which contains either:
                   2524:    (i) <select name="$name">
                   2525:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2526:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2527:        </select>
                   2528:        form item if there are multiple library servers in $domain, or
                   2529:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2530:        if there is only one library server in $domain.
                   2531: 
                   2532: (b) number of library servers found.
                   2533: 
                   2534: See loncreateuser.pm for example of use.
1.35      matthew  2535: 
                   2536: =cut
                   2537: 
                   2538: #-------------------------------------------
1.586     raeburn  2539: sub home_server_form_item {
                   2540:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2541:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2542:     my $result;
                   2543:     my $numlib = keys(%servers);
                   2544:     if ($numlib > 1) {
                   2545:         $result .= '<select name="'.$name.'" />'."\n";
                   2546:         if ($default) {
1.804     bisitz   2547:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2548:                        '</option>'."\n";
                   2549:         }
                   2550:         foreach my $hostid (sort(keys(%servers))) {
                   2551:             $result.= '<option value="'.$hostid.'">'.
                   2552: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2553:         }
                   2554:         $result .= '</select>'."\n";
                   2555:     } elsif ($numlib == 1) {
                   2556:         my $hostid;
                   2557:         foreach my $item (keys(%servers)) {
                   2558:             $hostid = $item;
                   2559:         }
                   2560:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2561:                    $hostid.'" />';
                   2562:                    if (!$hide) {
                   2563:                        $result .= $hostid.' '.$servers{$hostid};
                   2564:                    }
                   2565:                    $result .= "\n";
                   2566:     } elsif ($default) {
                   2567:         $result .= '<input type="hidden" name="'.$name.
                   2568:                    '" value="default" />';
                   2569:                    if (!$hide) {
                   2570:                        $result .= &mt('default');
                   2571:                    }
                   2572:                    $result .= "\n";
1.33      matthew  2573:     }
1.586     raeburn  2574:     return ($result,$numlib);
1.33      matthew  2575: }
1.112     bowersj2 2576: 
                   2577: =pod
                   2578: 
1.534     albertel 2579: =back 
                   2580: 
1.112     bowersj2 2581: =cut
1.87      matthew  2582: 
                   2583: ###############################################################
1.112     bowersj2 2584: ##                  Decoding User Agent                      ##
1.87      matthew  2585: ###############################################################
                   2586: 
                   2587: =pod
                   2588: 
1.112     bowersj2 2589: =head1 Decoding the User Agent
                   2590: 
                   2591: =over 4
                   2592: 
                   2593: =item * &decode_user_agent()
1.87      matthew  2594: 
                   2595: Inputs: $r
                   2596: 
                   2597: Outputs:
                   2598: 
                   2599: =over 4
                   2600: 
1.112     bowersj2 2601: =item * $httpbrowser
1.87      matthew  2602: 
1.112     bowersj2 2603: =item * $clientbrowser
1.87      matthew  2604: 
1.112     bowersj2 2605: =item * $clientversion
1.87      matthew  2606: 
1.112     bowersj2 2607: =item * $clientmathml
1.87      matthew  2608: 
1.112     bowersj2 2609: =item * $clientunicode
1.87      matthew  2610: 
1.112     bowersj2 2611: =item * $clientos
1.87      matthew  2612: 
1.1075.2.42  raeburn  2613: =item * $clientmobile
                   2614: 
                   2615: =item * $clientinfo
                   2616: 
1.1075.2.77  raeburn  2617: =item * $clientosversion
                   2618: 
1.87      matthew  2619: =back
                   2620: 
1.157     matthew  2621: =back 
                   2622: 
1.87      matthew  2623: =cut
                   2624: 
                   2625: ###############################################################
                   2626: ###############################################################
                   2627: sub decode_user_agent {
1.247     albertel 2628:     my ($r)=@_;
1.87      matthew  2629:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2630:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2631:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2632:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2633:     my $clientbrowser='unknown';
                   2634:     my $clientversion='0';
                   2635:     my $clientmathml='';
                   2636:     my $clientunicode='0';
1.1075.2.42  raeburn  2637:     my $clientmobile=0;
1.1075.2.77  raeburn  2638:     my $clientosversion='';
1.87      matthew  2639:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2640:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2641: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2642: 	    $clientbrowser=$bname;
                   2643:             $httpbrowser=~/$vreg/i;
                   2644: 	    $clientversion=$1;
                   2645:             $clientmathml=($clientversion>=$minv);
                   2646:             $clientunicode=($clientversion>=$univ);
                   2647: 	}
                   2648:     }
                   2649:     my $clientos='unknown';
1.1075.2.42  raeburn  2650:     my $clientinfo;
1.87      matthew  2651:     if (($httpbrowser=~/linux/i) ||
                   2652:         ($httpbrowser=~/unix/i) ||
                   2653:         ($httpbrowser=~/ux/i) ||
                   2654:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2655:     if (($httpbrowser=~/vax/i) ||
                   2656:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2657:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2658:     if (($httpbrowser=~/mac/i) ||
                   2659:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2660:     if ($httpbrowser=~/win/i) {
                   2661:         $clientos='win';
                   2662:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2663:             $clientosversion = $1;
                   2664:         }
                   2665:     }
1.87      matthew  2666:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2667:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2668:         $clientmobile=lc($1);
                   2669:     }
                   2670:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2671:         $clientinfo = 'firefox-'.$1;
                   2672:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2673:         $clientinfo = 'chromeframe-'.$1;
                   2674:     }
1.87      matthew  2675:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2676:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2677:             $clientosversion);
1.87      matthew  2678: }
                   2679: 
1.32      matthew  2680: ###############################################################
                   2681: ##    Authentication changing form generation subroutines    ##
                   2682: ###############################################################
                   2683: ##
                   2684: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2685: ## hash, and have reasonable default values.
                   2686: ##
                   2687: ##    formname = the name given in the <form> tag.
1.35      matthew  2688: #-------------------------------------------
                   2689: 
1.45      matthew  2690: =pod
                   2691: 
1.112     bowersj2 2692: =head1 Authentication Routines
                   2693: 
                   2694: =over 4
                   2695: 
1.648     raeburn  2696: =item * &authform_xxxxxx()
1.35      matthew  2697: 
                   2698: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2699: handle some of the conveniences required for authentication forms.  
                   2700: This is not an optimal method, but it works.  
                   2701: 
                   2702: =over 4
                   2703: 
1.112     bowersj2 2704: =item * authform_header
1.35      matthew  2705: 
1.112     bowersj2 2706: =item * authform_authorwarning
1.35      matthew  2707: 
1.112     bowersj2 2708: =item * authform_nochange
1.35      matthew  2709: 
1.112     bowersj2 2710: =item * authform_kerberos
1.35      matthew  2711: 
1.112     bowersj2 2712: =item * authform_internal
1.35      matthew  2713: 
1.112     bowersj2 2714: =item * authform_filesystem
1.35      matthew  2715: 
                   2716: =back
                   2717: 
1.648     raeburn  2718: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2719: 
1.35      matthew  2720: =cut
                   2721: 
                   2722: #-------------------------------------------
1.32      matthew  2723: sub authform_header{  
                   2724:     my %in = (
                   2725:         formname => 'cu',
1.80      albertel 2726:         kerb_def_dom => '',
1.32      matthew  2727:         @_,
                   2728:     );
                   2729:     $in{'formname'} = 'document.' . $in{'formname'};
                   2730:     my $result='';
1.80      albertel 2731: 
                   2732: #---------------------------------------------- Code for upper case translation
                   2733:     my $Javascript_toUpperCase;
                   2734:     unless ($in{kerb_def_dom}) {
                   2735:         $Javascript_toUpperCase =<<"END";
                   2736:         switch (choice) {
                   2737:            case 'krb': currentform.elements[choicearg].value =
                   2738:                currentform.elements[choicearg].value.toUpperCase();
                   2739:                break;
                   2740:            default:
                   2741:         }
                   2742: END
                   2743:     } else {
                   2744:         $Javascript_toUpperCase = "";
                   2745:     }
                   2746: 
1.165     raeburn  2747:     my $radioval = "'nochange'";
1.591     raeburn  2748:     if (defined($in{'curr_authtype'})) {
                   2749:         if ($in{'curr_authtype'} ne '') {
                   2750:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2751:         }
1.174     matthew  2752:     }
1.165     raeburn  2753:     my $argfield = 'null';
1.591     raeburn  2754:     if (defined($in{'mode'})) {
1.165     raeburn  2755:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2756:             if (defined($in{'curr_autharg'})) {
                   2757:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2758:                     $argfield = "'$in{'curr_autharg'}'";
                   2759:                 }
                   2760:             }
                   2761:         }
                   2762:     }
                   2763: 
1.32      matthew  2764:     $result.=<<"END";
                   2765: var current = new Object();
1.165     raeburn  2766: current.radiovalue = $radioval;
                   2767: current.argfield = $argfield;
1.32      matthew  2768: 
                   2769: function changed_radio(choice,currentform) {
                   2770:     var choicearg = choice + 'arg';
                   2771:     // If a radio button in changed, we need to change the argfield
                   2772:     if (current.radiovalue != choice) {
                   2773:         current.radiovalue = choice;
                   2774:         if (current.argfield != null) {
                   2775:             currentform.elements[current.argfield].value = '';
                   2776:         }
                   2777:         if (choice == 'nochange') {
                   2778:             current.argfield = null;
                   2779:         } else {
                   2780:             current.argfield = choicearg;
                   2781:             switch(choice) {
                   2782:                 case 'krb': 
                   2783:                     currentform.elements[current.argfield].value = 
                   2784:                         "$in{'kerb_def_dom'}";
                   2785:                 break;
                   2786:               default:
                   2787:                 break;
                   2788:             }
                   2789:         }
                   2790:     }
                   2791:     return;
                   2792: }
1.22      www      2793: 
1.32      matthew  2794: function changed_text(choice,currentform) {
                   2795:     var choicearg = choice + 'arg';
                   2796:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2797:         $Javascript_toUpperCase
1.32      matthew  2798:         // clear old field
                   2799:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2800:             currentform.elements[current.argfield].value = '';
                   2801:         }
                   2802:         current.argfield = choicearg;
                   2803:     }
                   2804:     set_auth_radio_buttons(choice,currentform);
                   2805:     return;
1.20      www      2806: }
1.32      matthew  2807: 
                   2808: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2809:     var numauthchoices = currentform.login.length;
                   2810:     if (typeof numauthchoices  == "undefined") {
                   2811:         return;
                   2812:     } 
1.32      matthew  2813:     var i=0;
1.986     raeburn  2814:     while (i < numauthchoices) {
1.32      matthew  2815:         if (currentform.login[i].value == newvalue) { break; }
                   2816:         i++;
                   2817:     }
1.986     raeburn  2818:     if (i == numauthchoices) {
1.32      matthew  2819:         return;
                   2820:     }
                   2821:     current.radiovalue = newvalue;
                   2822:     currentform.login[i].checked = true;
                   2823:     return;
                   2824: }
                   2825: END
                   2826:     return $result;
                   2827: }
                   2828: 
1.1075.2.20  raeburn  2829: sub authform_authorwarning {
1.32      matthew  2830:     my $result='';
1.144     matthew  2831:     $result='<i>'.
                   2832:         &mt('As a general rule, only authors or co-authors should be '.
                   2833:             'filesystem authenticated '.
                   2834:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2835:     return $result;
                   2836: }
                   2837: 
1.1075.2.20  raeburn  2838: sub authform_nochange {
1.32      matthew  2839:     my %in = (
                   2840:               formname => 'document.cu',
                   2841:               kerb_def_dom => 'MSU.EDU',
                   2842:               @_,
                   2843:           );
1.1075.2.20  raeburn  2844:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2845:     my $result;
1.1075.2.20  raeburn  2846:     if (!$authnum) {
                   2847:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2848:     } else {
                   2849:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2850:                   '<input type="radio" name="login" value="nochange" '.
                   2851:                   'checked="checked" onclick="'.
1.281     albertel 2852:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2853: 	    '</label>';
1.586     raeburn  2854:     }
1.32      matthew  2855:     return $result;
                   2856: }
                   2857: 
1.591     raeburn  2858: sub authform_kerberos {
1.32      matthew  2859:     my %in = (
                   2860:               formname => 'document.cu',
                   2861:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2862:               kerb_def_auth => 'krb4',
1.32      matthew  2863:               @_,
                   2864:               );
1.586     raeburn  2865:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2866:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2867:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2868:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2869:        $check5 = ' checked="checked"';
1.80      albertel 2870:     } else {
1.772     bisitz   2871:        $check4 = ' checked="checked"';
1.80      albertel 2872:     }
1.1075.2.117  raeburn  2873:     if ($in{'readonly'}) {
                   2874:         $disabled = ' disabled="disabled"';
                   2875:     }
1.165     raeburn  2876:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2877:     if (defined($in{'curr_authtype'})) {
                   2878:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2879:             $krbcheck = ' checked="checked"';
1.623     raeburn  2880:             if (defined($in{'mode'})) {
                   2881:                 if ($in{'mode'} eq 'modifyuser') {
                   2882:                     $krbcheck = '';
                   2883:                 }
                   2884:             }
1.591     raeburn  2885:             if (defined($in{'curr_kerb_ver'})) {
                   2886:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2887:                     $check5 = ' checked="checked"';
1.591     raeburn  2888:                     $check4 = '';
                   2889:                 } else {
1.772     bisitz   2890:                     $check4 = ' checked="checked"';
1.591     raeburn  2891:                     $check5 = '';
                   2892:                 }
1.586     raeburn  2893:             }
1.591     raeburn  2894:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2895:                 $krbarg = $in{'curr_autharg'};
                   2896:             }
1.586     raeburn  2897:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2898:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2899:                     $result = 
                   2900:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2901:         $in{'curr_autharg'},$krbver);
                   2902:                 } else {
                   2903:                     $result =
                   2904:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2905:                 }
                   2906:                 return $result; 
                   2907:             }
                   2908:         }
                   2909:     } else {
                   2910:         if ($authnum == 1) {
1.784     bisitz   2911:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2912:         }
                   2913:     }
1.586     raeburn  2914:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2915:         return;
1.587     raeburn  2916:     } elsif ($authtype eq '') {
1.591     raeburn  2917:         if (defined($in{'mode'})) {
1.587     raeburn  2918:             if ($in{'mode'} eq 'modifycourse') {
                   2919:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2920:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2921:                 }
                   2922:             }
                   2923:         }
1.586     raeburn  2924:     }
                   2925:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2926:     if ($authtype eq '') {
                   2927:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2928:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2929:                     $krbcheck.$disabled.' />';
1.586     raeburn  2930:     }
                   2931:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2932:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2933:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2934:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2935:          $in{'curr_authtype'} eq 'krb4')) {
                   2936:         $result .= &mt
1.144     matthew  2937:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2938:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2939:          '<label>'.$authtype,
1.281     albertel 2940:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2941:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2942:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2943:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2944:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2945: 	 '</label>');
1.586     raeburn  2946:     } elsif ($can_assign{'krb4'}) {
                   2947:         $result .= &mt
                   2948:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2949:          '[_3] Version 4 [_4]',
                   2950:          '<label>'.$authtype,
                   2951:          '</label><input type="text" size="10" name="krbarg" '.
                   2952:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2953:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2954:          '<label><input type="hidden" name="krbver" value="4" />',
                   2955:          '</label>');
                   2956:     } elsif ($can_assign{'krb5'}) {
                   2957:         $result .= &mt
                   2958:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2959:          '[_3] Version 5 [_4]',
                   2960:          '<label>'.$authtype,
                   2961:          '</label><input type="text" size="10" name="krbarg" '.
                   2962:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2963:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2964:          '<label><input type="hidden" name="krbver" value="5" />',
                   2965:          '</label>');
                   2966:     }
1.32      matthew  2967:     return $result;
                   2968: }
                   2969: 
1.1075.2.20  raeburn  2970: sub authform_internal {
1.586     raeburn  2971:     my %in = (
1.32      matthew  2972:                 formname => 'document.cu',
                   2973:                 kerb_def_dom => 'MSU.EDU',
                   2974:                 @_,
                   2975:                 );
1.1075.2.117  raeburn  2976:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2977:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2978:     if ($in{'readonly'}) {
                   2979:         $disabled = ' disabled="disabled"';
                   2980:     }
1.591     raeburn  2981:     if (defined($in{'curr_authtype'})) {
                   2982:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2983:             if ($can_assign{'int'}) {
1.772     bisitz   2984:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2985:                 if (defined($in{'mode'})) {
                   2986:                     if ($in{'mode'} eq 'modifyuser') {
                   2987:                         $intcheck = '';
                   2988:                     }
                   2989:                 }
1.591     raeburn  2990:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2991:                     $intarg = $in{'curr_autharg'};
                   2992:                 }
                   2993:             } else {
                   2994:                 $result = &mt('Currently internally authenticated.');
                   2995:                 return $result;
1.165     raeburn  2996:             }
                   2997:         }
1.586     raeburn  2998:     } else {
                   2999:         if ($authnum == 1) {
1.784     bisitz   3000:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  3001:         }
                   3002:     }
                   3003:     if (!$can_assign{'int'}) {
                   3004:         return;
1.587     raeburn  3005:     } elsif ($authtype eq '') {
1.591     raeburn  3006:         if (defined($in{'mode'})) {
1.587     raeburn  3007:             if ($in{'mode'} eq 'modifycourse') {
                   3008:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3009:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3010:                 }
                   3011:             }
                   3012:         }
1.165     raeburn  3013:     }
1.586     raeburn  3014:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3015:     if ($authtype eq '') {
                   3016:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3017:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3018:     }
1.605     bisitz   3019:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3020:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3021:     $result = &mt
1.144     matthew  3022:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3023:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3024:     $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  3025:     return $result;
                   3026: }
                   3027: 
1.1075.2.20  raeburn  3028: sub authform_local {
1.32      matthew  3029:     my %in = (
                   3030:               formname => 'document.cu',
                   3031:               kerb_def_dom => 'MSU.EDU',
                   3032:               @_,
                   3033:               );
1.1075.2.117  raeburn  3034:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3035:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3036:     if ($in{'readonly'}) {
                   3037:         $disabled = ' disabled="disabled"';
                   3038:     }
1.591     raeburn  3039:     if (defined($in{'curr_authtype'})) {
                   3040:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3041:             if ($can_assign{'loc'}) {
1.772     bisitz   3042:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3043:                 if (defined($in{'mode'})) {
                   3044:                     if ($in{'mode'} eq 'modifyuser') {
                   3045:                         $loccheck = '';
                   3046:                     }
                   3047:                 }
1.591     raeburn  3048:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3049:                     $locarg = $in{'curr_autharg'};
                   3050:                 }
                   3051:             } else {
                   3052:                 $result = &mt('Currently using local (institutional) authentication.');
                   3053:                 return $result;
1.165     raeburn  3054:             }
                   3055:         }
1.586     raeburn  3056:     } else {
                   3057:         if ($authnum == 1) {
1.784     bisitz   3058:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3059:         }
                   3060:     }
                   3061:     if (!$can_assign{'loc'}) {
                   3062:         return;
1.587     raeburn  3063:     } elsif ($authtype eq '') {
1.591     raeburn  3064:         if (defined($in{'mode'})) {
1.587     raeburn  3065:             if ($in{'mode'} eq 'modifycourse') {
                   3066:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3067:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3068:                 }
                   3069:             }
                   3070:         }
1.165     raeburn  3071:     }
1.586     raeburn  3072:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3073:     if ($authtype eq '') {
                   3074:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3075:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3076:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3077:     }
                   3078:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3079:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3080:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3081:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3082:     return $result;
                   3083: }
                   3084: 
1.1075.2.20  raeburn  3085: sub authform_filesystem {
1.32      matthew  3086:     my %in = (
                   3087:               formname => 'document.cu',
                   3088:               kerb_def_dom => 'MSU.EDU',
                   3089:               @_,
                   3090:               );
1.1075.2.117  raeburn  3091:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3092:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3093:     if ($in{'readonly'}) {
                   3094:         $disabled = ' disabled="disabled"';
                   3095:     }
1.591     raeburn  3096:     if (defined($in{'curr_authtype'})) {
                   3097:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3098:             if ($can_assign{'fsys'}) {
1.772     bisitz   3099:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3100:                 if (defined($in{'mode'})) {
                   3101:                     if ($in{'mode'} eq 'modifyuser') {
                   3102:                         $fsyscheck = '';
                   3103:                     }
                   3104:                 }
1.586     raeburn  3105:             } else {
                   3106:                 $result = &mt('Currently Filesystem Authenticated.');
                   3107:                 return $result;
                   3108:             }           
                   3109:         }
                   3110:     } else {
                   3111:         if ($authnum == 1) {
1.784     bisitz   3112:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3113:         }
                   3114:     }
                   3115:     if (!$can_assign{'fsys'}) {
                   3116:         return;
1.587     raeburn  3117:     } elsif ($authtype eq '') {
1.591     raeburn  3118:         if (defined($in{'mode'})) {
1.587     raeburn  3119:             if ($in{'mode'} eq 'modifycourse') {
                   3120:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3121:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3122:                 }
                   3123:             }
                   3124:         }
1.586     raeburn  3125:     }
                   3126:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3127:     if ($authtype eq '') {
                   3128:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3129:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3130:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3131:     }
                   3132:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3133:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3134:     $result = &mt
1.144     matthew  3135:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 3136:          '<label><input type="radio" name="login" value="fsys" '.
1.1075.2.117  raeburn  3137:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605     bisitz   3138:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1075.2.117  raeburn  3139:                   'onchange="'.$jscall.'"'.$disabled.' />');
1.32      matthew  3140:     return $result;
                   3141: }
                   3142: 
1.586     raeburn  3143: sub get_assignable_auth {
                   3144:     my ($dom) = @_;
                   3145:     if ($dom eq '') {
                   3146:         $dom = $env{'request.role.domain'};
                   3147:     }
                   3148:     my %can_assign = (
                   3149:                           krb4 => 1,
                   3150:                           krb5 => 1,
                   3151:                           int  => 1,
                   3152:                           loc  => 1,
                   3153:                      );
                   3154:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3155:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3156:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3157:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3158:             my $context;
                   3159:             if ($env{'request.role'} =~ /^au/) {
                   3160:                 $context = 'author';
1.1075.2.117  raeburn  3161:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3162:                 $context = 'domain';
                   3163:             } elsif ($env{'request.course.id'}) {
                   3164:                 $context = 'course';
                   3165:             }
                   3166:             if ($context) {
                   3167:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3168:                    %can_assign = %{$authhash->{$context}}; 
                   3169:                 }
                   3170:             }
                   3171:         }
                   3172:     }
                   3173:     my $authnum = 0;
                   3174:     foreach my $key (keys(%can_assign)) {
                   3175:         if ($can_assign{$key}) {
                   3176:             $authnum ++;
                   3177:         }
                   3178:     }
                   3179:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3180:         $authnum --;
                   3181:     }
                   3182:     return ($authnum,%can_assign);
                   3183: }
                   3184: 
1.1075.2.137  raeburn  3185: sub check_passwd_rules {
                   3186:     my ($domain,$plainpass) = @_;
                   3187:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3188:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3189:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3190:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3191:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3192:             if ($passwdconf{'min'} > $min) {
                   3193:                 $min = $passwdconf{'min'};
                   3194:             }
1.1075.2.137  raeburn  3195:         }
                   3196:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3197:             $max = $passwdconf{'max'};
                   3198:         }
                   3199:         @chars = @{$passwdconf{'chars'}};
                   3200:     }
                   3201:     if (($min) && (length($plainpass) < $min)) {
                   3202:         push(@brokerule,'min');
                   3203:     }
                   3204:     if (($max) && (length($plainpass) > $max)) {
                   3205:         push(@brokerule,'max');
                   3206:     }
                   3207:     if (@chars) {
                   3208:         my %rules;
                   3209:         map { $rules{$_} = 1; } @chars;
                   3210:         if ($rules{'uc'}) {
                   3211:             unless ($plainpass =~ /[A-Z]/) {
                   3212:                 push(@brokerule,'uc');
                   3213:             }
                   3214:         }
                   3215:         if ($rules{'lc'}) {
                   3216:             unless ($plainpass =~ /[a-z]/) {
                   3217:                 push(@brokerule,'lc');
                   3218:             }
                   3219:         }
                   3220:         if ($rules{'num'}) {
                   3221:             unless ($plainpass =~ /\d/) {
                   3222:                 push(@brokerule,'num');
                   3223:             }
                   3224:         }
                   3225:         if ($rules{'spec'}) {
                   3226:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3227:                 push(@brokerule,'spec');
                   3228:             }
                   3229:         }
                   3230:     }
                   3231:     if (@brokerule) {
                   3232:         my %rulenames = &Apache::lonlocal::texthash(
                   3233:             uc   => 'At least one upper case letter',
                   3234:             lc   => 'At least one lower case letter',
                   3235:             num  => 'At least one number',
                   3236:             spec => 'At least one non-alphanumeric',
                   3237:         );
                   3238:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3239:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3240:         $rulenames{'num'} .= ': 0123456789';
                   3241:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3242:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3243:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3244:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.141.  .3(raebu 3245:20):         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3246:             if (grep(/^$rule$/,@brokerule)) {
                   3247:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3248:             }
                   3249:         }
                   3250:         $warning .= '</ul>';
                   3251:     }
                   3252:     if (wantarray) {
                   3253:         return @brokerule;
                   3254:     }
                   3255:     return $warning;
                   3256: }
                   3257: 
1.80      albertel 3258: ###############################################################
                   3259: ##    Get Kerberos Defaults for Domain                 ##
                   3260: ###############################################################
                   3261: ##
                   3262: ## Returns default kerberos version and an associated argument
                   3263: ## as listed in file domain.tab. If not listed, provides
                   3264: ## appropriate default domain and kerberos version.
                   3265: ##
                   3266: #-------------------------------------------
                   3267: 
                   3268: =pod
                   3269: 
1.648     raeburn  3270: =item * &get_kerberos_defaults()
1.80      albertel 3271: 
                   3272: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3273: version and domain. If not found, it defaults to version 4 and the 
                   3274: domain of the server.
1.80      albertel 3275: 
1.648     raeburn  3276: =over 4
                   3277: 
1.80      albertel 3278: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3279: 
1.648     raeburn  3280: =back
                   3281: 
                   3282: =back
                   3283: 
1.80      albertel 3284: =cut
                   3285: 
                   3286: #-------------------------------------------
                   3287: sub get_kerberos_defaults {
                   3288:     my $domain=shift;
1.641     raeburn  3289:     my ($krbdef,$krbdefdom);
                   3290:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3291:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3292:         $krbdef = $domdefaults{'auth_def'};
                   3293:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3294:     } else {
1.80      albertel 3295:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3296:         my $krbdefdom=$1;
                   3297:         $krbdefdom=~tr/a-z/A-Z/;
                   3298:         $krbdef = "krb4";
                   3299:     }
                   3300:     return ($krbdef,$krbdefdom);
                   3301: }
1.112     bowersj2 3302: 
1.32      matthew  3303: 
1.46      matthew  3304: ###############################################################
                   3305: ##                Thesaurus Functions                        ##
                   3306: ###############################################################
1.20      www      3307: 
1.46      matthew  3308: =pod
1.20      www      3309: 
1.112     bowersj2 3310: =head1 Thesaurus Functions
                   3311: 
                   3312: =over 4
                   3313: 
1.648     raeburn  3314: =item * &initialize_keywords()
1.46      matthew  3315: 
                   3316: Initializes the package variable %Keywords if it is empty.  Uses the
                   3317: package variable $thesaurus_db_file.
                   3318: 
                   3319: =cut
                   3320: 
                   3321: ###################################################
                   3322: 
                   3323: sub initialize_keywords {
                   3324:     return 1 if (scalar keys(%Keywords));
                   3325:     # If we are here, %Keywords is empty, so fill it up
                   3326:     #   Make sure the file we need exists...
                   3327:     if (! -e $thesaurus_db_file) {
                   3328:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3329:                                  " failed because it does not exist");
                   3330:         return 0;
                   3331:     }
                   3332:     #   Set up the hash as a database
                   3333:     my %thesaurus_db;
                   3334:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3335:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3336:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3337:                                  $thesaurus_db_file);
                   3338:         return 0;
                   3339:     } 
                   3340:     #  Get the average number of appearances of a word.
                   3341:     my $avecount = $thesaurus_db{'average.count'};
                   3342:     #  Put keywords (those that appear > average) into %Keywords
                   3343:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3344:         my ($count,undef) = split /:/,$data;
                   3345:         $Keywords{$word}++ if ($count > $avecount);
                   3346:     }
                   3347:     untie %thesaurus_db;
                   3348:     # Remove special values from %Keywords.
1.356     albertel 3349:     foreach my $value ('total.count','average.count') {
                   3350:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3351:   }
1.46      matthew  3352:     return 1;
                   3353: }
                   3354: 
                   3355: ###################################################
                   3356: 
                   3357: =pod
                   3358: 
1.648     raeburn  3359: =item * &keyword($word)
1.46      matthew  3360: 
                   3361: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3362: than the average number of times in the thesaurus database.  Calls 
                   3363: &initialize_keywords
                   3364: 
                   3365: =cut
                   3366: 
                   3367: ###################################################
1.20      www      3368: 
                   3369: sub keyword {
1.46      matthew  3370:     return if (!&initialize_keywords());
                   3371:     my $word=lc(shift());
                   3372:     $word=~s/\W//g;
                   3373:     return exists($Keywords{$word});
1.20      www      3374: }
1.46      matthew  3375: 
                   3376: ###############################################################
                   3377: 
                   3378: =pod 
1.20      www      3379: 
1.648     raeburn  3380: =item * &get_related_words()
1.46      matthew  3381: 
1.160     matthew  3382: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3383: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3384: will be returned.  The order of the words returned is determined by the
                   3385: database which holds them.
                   3386: 
                   3387: Uses global $thesaurus_db_file.
                   3388: 
1.1057    foxr     3389: 
1.46      matthew  3390: =cut
                   3391: 
                   3392: ###############################################################
                   3393: sub get_related_words {
                   3394:     my $keyword = shift;
                   3395:     my %thesaurus_db;
                   3396:     if (! -e $thesaurus_db_file) {
                   3397:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3398:                                  "failed because the file does not exist");
                   3399:         return ();
                   3400:     }
                   3401:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3402:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3403:         return ();
                   3404:     } 
                   3405:     my @Words=();
1.429     www      3406:     my $count=0;
1.46      matthew  3407:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3408: 	# The first element is the number of times
                   3409: 	# the word appears.  We do not need it now.
1.429     www      3410: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3411: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3412: 	my $threshold=$mostfrequentcount/10;
                   3413:         foreach my $possibleword (@RelatedWords) {
                   3414:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3415:             if ($wordcount>$threshold) {
                   3416: 		push(@Words,$word);
                   3417:                 $count++;
                   3418:                 if ($count>10) { last; }
                   3419: 	    }
1.20      www      3420:         }
                   3421:     }
1.46      matthew  3422:     untie %thesaurus_db;
                   3423:     return @Words;
1.14      harris41 3424: }
1.46      matthew  3425: 
1.112     bowersj2 3426: =pod
                   3427: 
                   3428: =back
                   3429: 
                   3430: =cut
1.61      www      3431: 
                   3432: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3433: =pod
                   3434: 
1.112     bowersj2 3435: =head1 User Name Functions
                   3436: 
                   3437: =over 4
                   3438: 
1.648     raeburn  3439: =item * &plainname($uname,$udom,$first)
1.81      albertel 3440: 
1.112     bowersj2 3441: Takes a users logon name and returns it as a string in
1.226     albertel 3442: "first middle last generation" form 
                   3443: if $first is set to 'lastname' then it returns it as
                   3444: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3445: 
                   3446: =cut
1.61      www      3447: 
1.295     www      3448: 
1.81      albertel 3449: ###############################################################
1.61      www      3450: sub plainname {
1.226     albertel 3451:     my ($uname,$udom,$first)=@_;
1.537     albertel 3452:     return if (!defined($uname) || !defined($udom));
1.295     www      3453:     my %names=&getnames($uname,$udom);
1.226     albertel 3454:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3455: 					  $names{'middlename'},
                   3456: 					  $names{'lastname'},
                   3457: 					  $names{'generation'},$first);
                   3458:     $name=~s/^\s+//;
1.62      www      3459:     $name=~s/\s+$//;
                   3460:     $name=~s/\s+/ /g;
1.353     albertel 3461:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3462:     return $name;
1.61      www      3463: }
1.66      www      3464: 
                   3465: # -------------------------------------------------------------------- Nickname
1.81      albertel 3466: =pod
                   3467: 
1.648     raeburn  3468: =item * &nickname($uname,$udom)
1.81      albertel 3469: 
                   3470: Gets a users name and returns it as a string as
                   3471: 
                   3472: "&quot;nickname&quot;"
1.66      www      3473: 
1.81      albertel 3474: if the user has a nickname or
                   3475: 
                   3476: "first middle last generation"
                   3477: 
                   3478: if the user does not
                   3479: 
                   3480: =cut
1.66      www      3481: 
                   3482: sub nickname {
                   3483:     my ($uname,$udom)=@_;
1.537     albertel 3484:     return if (!defined($uname) || !defined($udom));
1.295     www      3485:     my %names=&getnames($uname,$udom);
1.68      albertel 3486:     my $name=$names{'nickname'};
1.66      www      3487:     if ($name) {
                   3488:        $name='&quot;'.$name.'&quot;'; 
                   3489:     } else {
                   3490:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3491: 	     $names{'lastname'}.' '.$names{'generation'};
                   3492:        $name=~s/\s+$//;
                   3493:        $name=~s/\s+/ /g;
                   3494:     }
                   3495:     return $name;
                   3496: }
                   3497: 
1.295     www      3498: sub getnames {
                   3499:     my ($uname,$udom)=@_;
1.537     albertel 3500:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3501:     if ($udom eq 'public' && $uname eq 'public') {
                   3502: 	return ('lastname' => &mt('Public'));
                   3503:     }
1.295     www      3504:     my $id=$uname.':'.$udom;
                   3505:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3506:     if ($cached) {
                   3507: 	return %{$names};
                   3508:     } else {
                   3509: 	my %loadnames=&Apache::lonnet::get('environment',
                   3510:                     ['firstname','middlename','lastname','generation','nickname'],
                   3511: 					 $udom,$uname);
                   3512: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3513: 	return %loadnames;
                   3514:     }
                   3515: }
1.61      www      3516: 
1.542     raeburn  3517: # -------------------------------------------------------------------- getemails
1.648     raeburn  3518: 
1.542     raeburn  3519: =pod
                   3520: 
1.648     raeburn  3521: =item * &getemails($uname,$udom)
1.542     raeburn  3522: 
                   3523: Gets a user's email information and returns it as a hash with keys:
                   3524: notification, critnotification, permanentemail
                   3525: 
                   3526: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3527: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3528:  
1.648     raeburn  3529: 
1.542     raeburn  3530: =cut
                   3531: 
1.648     raeburn  3532: 
1.466     albertel 3533: sub getemails {
                   3534:     my ($uname,$udom)=@_;
                   3535:     if ($udom eq 'public' && $uname eq 'public') {
                   3536: 	return;
                   3537:     }
1.467     www      3538:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3539:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3540:     my $id=$uname.':'.$udom;
                   3541:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3542:     if ($cached) {
                   3543: 	return %{$names};
                   3544:     } else {
                   3545: 	my %loadnames=&Apache::lonnet::get('environment',
                   3546:                     			   ['notification','critnotification',
                   3547: 					    'permanentemail'],
                   3548: 					   $udom,$uname);
                   3549: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3550: 	return %loadnames;
                   3551:     }
                   3552: }
                   3553: 
1.551     albertel 3554: sub flush_email_cache {
                   3555:     my ($uname,$udom)=@_;
                   3556:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3557:     if (!$uname) { $uname=$env{'user.name'};   }
                   3558:     return if ($udom eq 'public' && $uname eq 'public');
                   3559:     my $id=$uname.':'.$udom;
                   3560:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3561: }
                   3562: 
1.728     raeburn  3563: # -------------------------------------------------------------------- getlangs
                   3564: 
                   3565: =pod
                   3566: 
                   3567: =item * &getlangs($uname,$udom)
                   3568: 
                   3569: Gets a user's language preference and returns it as a hash with key:
                   3570: language.
                   3571: 
                   3572: =cut
                   3573: 
                   3574: 
                   3575: sub getlangs {
                   3576:     my ($uname,$udom) = @_;
                   3577:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3578:     if (!$uname) { $uname=$env{'user.name'};   }
                   3579:     my $id=$uname.':'.$udom;
                   3580:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3581:     if ($cached) {
                   3582:         return %{$langs};
                   3583:     } else {
                   3584:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3585:                                            $udom,$uname);
                   3586:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3587:         return %loadlangs;
                   3588:     }
                   3589: }
                   3590: 
                   3591: sub flush_langs_cache {
                   3592:     my ($uname,$udom)=@_;
                   3593:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3594:     if (!$uname) { $uname=$env{'user.name'};   }
                   3595:     return if ($udom eq 'public' && $uname eq 'public');
                   3596:     my $id=$uname.':'.$udom;
                   3597:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3598: }
                   3599: 
1.61      www      3600: # ------------------------------------------------------------------ Screenname
1.81      albertel 3601: 
                   3602: =pod
                   3603: 
1.648     raeburn  3604: =item * &screenname($uname,$udom)
1.81      albertel 3605: 
                   3606: Gets a users screenname and returns it as a string
                   3607: 
                   3608: =cut
1.61      www      3609: 
                   3610: sub screenname {
                   3611:     my ($uname,$udom)=@_;
1.258     albertel 3612:     if ($uname eq $env{'user.name'} &&
                   3613: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3614:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3615:     return $names{'screenname'};
1.62      www      3616: }
                   3617: 
1.212     albertel 3618: 
1.802     bisitz   3619: # ------------------------------------------------------------- Confirm Wrapper
                   3620: =pod
                   3621: 
1.1075.2.42  raeburn  3622: =item * &confirmwrapper($message)
1.802     bisitz   3623: 
                   3624: Wrap messages about completion of operation in box
                   3625: 
                   3626: =cut
                   3627: 
                   3628: sub confirmwrapper {
                   3629:     my ($message)=@_;
                   3630:     if ($message) {
                   3631:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3632:                .$message."\n"
                   3633:                .'</div>'."\n";
                   3634:     } else {
                   3635:         return $message;
                   3636:     }
                   3637: }
                   3638: 
1.62      www      3639: # ------------------------------------------------------------- Message Wrapper
                   3640: 
                   3641: sub messagewrapper {
1.369     www      3642:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3643:     return 
1.441     albertel 3644:         '<a href="/adm/email?compose=individual&amp;'.
                   3645:         'recname='.$username.'&amp;recdom='.$domain.
                   3646: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3647:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3648: }
1.802     bisitz   3649: 
1.74      www      3650: # --------------------------------------------------------------- Notes Wrapper
                   3651: 
                   3652: sub noteswrapper {
                   3653:     my ($link,$un,$do)=@_;
                   3654:     return 
1.896     amueller 3655: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3656: }
1.802     bisitz   3657: 
1.62      www      3658: # ------------------------------------------------------------- Aboutme Wrapper
                   3659: 
                   3660: sub aboutmewrapper {
1.1070    raeburn  3661:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3662:     if (!defined($username)  && !defined($domain)) {
                   3663:         return;
                   3664:     }
1.1075.2.15  raeburn  3665:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3666: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3667: }
                   3668: 
                   3669: # ------------------------------------------------------------ Syllabus Wrapper
                   3670: 
                   3671: sub syllabuswrapper {
1.707     bisitz   3672:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3673:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3674: }
1.14      harris41 3675: 
1.802     bisitz   3676: # -----------------------------------------------------------------------------
                   3677: 
1.208     matthew  3678: sub track_student_link {
1.887     raeburn  3679:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3680:     my $link ="/adm/trackstudent?";
1.208     matthew  3681:     my $title = 'View recent activity';
                   3682:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3683:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3684:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3685:         $title .= ' of this student';
1.268     albertel 3686:     } 
1.208     matthew  3687:     if (defined($target) && $target !~ /^\s*$/) {
                   3688:         $target = qq{target="$target"};
                   3689:     } else {
                   3690:         $target = '';
                   3691:     }
1.268     albertel 3692:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3693:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3694:     $title = &mt($title);
                   3695:     $linktext = &mt($linktext);
1.448     albertel 3696:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3697: 	&help_open_topic('View_recent_activity');
1.208     matthew  3698: }
                   3699: 
1.781     raeburn  3700: sub slot_reservations_link {
                   3701:     my ($linktext,$sname,$sdom,$target) = @_;
                   3702:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3703:     my $title = 'View slot reservation history';
                   3704:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3705:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3706:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3707:         $title .= ' of this student';
                   3708:     }
                   3709:     if (defined($target) && $target !~ /^\s*$/) {
                   3710:         $target = qq{target="$target"};
                   3711:     } else {
                   3712:         $target = '';
                   3713:     }
                   3714:     $title = &mt($title);
                   3715:     $linktext = &mt($linktext);
                   3716:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3717: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3718: 
                   3719: }
                   3720: 
1.508     www      3721: # ===================================================== Display a student photo
                   3722: 
                   3723: 
1.509     albertel 3724: sub student_image_tag {
1.508     www      3725:     my ($domain,$user)=@_;
                   3726:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3727:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3728: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3729:     } else {
                   3730: 	return '';
                   3731:     }
                   3732: }
                   3733: 
1.112     bowersj2 3734: =pod
                   3735: 
                   3736: =back
                   3737: 
                   3738: =head1 Access .tab File Data
                   3739: 
                   3740: =over 4
                   3741: 
1.648     raeburn  3742: =item * &languageids() 
1.112     bowersj2 3743: 
                   3744: returns list of all language ids
                   3745: 
                   3746: =cut
                   3747: 
1.14      harris41 3748: sub languageids {
1.16      harris41 3749:     return sort(keys(%language));
1.14      harris41 3750: }
                   3751: 
1.112     bowersj2 3752: =pod
                   3753: 
1.648     raeburn  3754: =item * &languagedescription() 
1.112     bowersj2 3755: 
                   3756: returns description of a specified language id
                   3757: 
                   3758: =cut
                   3759: 
1.14      harris41 3760: sub languagedescription {
1.125     www      3761:     my $code=shift;
                   3762:     return  ($supported_language{$code}?'* ':'').
                   3763:             $language{$code}.
1.126     www      3764: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3765: }
                   3766: 
1.1048    foxr     3767: =pod
                   3768: 
                   3769: =item * &plainlanguagedescription
                   3770: 
                   3771: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3772: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3773: 
                   3774: =cut
                   3775: 
1.145     www      3776: sub plainlanguagedescription {
                   3777:     my $code=shift;
                   3778:     return $language{$code};
                   3779: }
                   3780: 
1.1048    foxr     3781: =pod
                   3782: 
                   3783: =item * &supportedlanguagecode
                   3784: 
                   3785: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3786: code.
                   3787: 
                   3788: =cut
                   3789: 
1.145     www      3790: sub supportedlanguagecode {
                   3791:     my $code=shift;
                   3792:     return $supported_language{$code};
1.97      www      3793: }
                   3794: 
1.112     bowersj2 3795: =pod
                   3796: 
1.1048    foxr     3797: =item * &latexlanguage()
                   3798: 
                   3799: Given a language key code returns the correspondnig language to use
                   3800: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3801: is no supported hyphenation for the language code.
                   3802: 
                   3803: =cut
                   3804: 
                   3805: sub latexlanguage {
                   3806:     my $code = shift;
                   3807:     return $latex_language{$code};
                   3808: }
                   3809: 
                   3810: =pod
                   3811: 
                   3812: =item * &latexhyphenation()
                   3813: 
                   3814: Same as above but what's supplied is the language as it might be stored
                   3815: in the metadata.
                   3816: 
                   3817: =cut
                   3818: 
                   3819: sub latexhyphenation {
                   3820:     my $key = shift;
                   3821:     return $latex_language_bykey{$key};
                   3822: }
                   3823: 
                   3824: =pod
                   3825: 
1.648     raeburn  3826: =item * &copyrightids() 
1.112     bowersj2 3827: 
                   3828: returns list of all copyrights
                   3829: 
                   3830: =cut
                   3831: 
                   3832: sub copyrightids {
                   3833:     return sort(keys(%cprtag));
                   3834: }
                   3835: 
                   3836: =pod
                   3837: 
1.648     raeburn  3838: =item * &copyrightdescription() 
1.112     bowersj2 3839: 
                   3840: returns description of a specified copyright id
                   3841: 
                   3842: =cut
                   3843: 
                   3844: sub copyrightdescription {
1.166     www      3845:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3846: }
1.197     matthew  3847: 
                   3848: =pod
                   3849: 
1.648     raeburn  3850: =item * &source_copyrightids() 
1.192     taceyjo1 3851: 
                   3852: returns list of all source copyrights
                   3853: 
                   3854: =cut
                   3855: 
                   3856: sub source_copyrightids {
                   3857:     return sort(keys(%scprtag));
                   3858: }
                   3859: 
                   3860: =pod
                   3861: 
1.648     raeburn  3862: =item * &source_copyrightdescription() 
1.192     taceyjo1 3863: 
                   3864: returns description of a specified source copyright id
                   3865: 
                   3866: =cut
                   3867: 
                   3868: sub source_copyrightdescription {
                   3869:     return &mt($scprtag{shift(@_)});
                   3870: }
1.112     bowersj2 3871: 
                   3872: =pod
                   3873: 
1.648     raeburn  3874: =item * &filecategories() 
1.112     bowersj2 3875: 
                   3876: returns list of all file categories
                   3877: 
                   3878: =cut
                   3879: 
                   3880: sub filecategories {
                   3881:     return sort(keys(%category_extensions));
                   3882: }
                   3883: 
                   3884: =pod
                   3885: 
1.648     raeburn  3886: =item * &filecategorytypes() 
1.112     bowersj2 3887: 
                   3888: returns list of file types belonging to a given file
                   3889: category
                   3890: 
                   3891: =cut
                   3892: 
                   3893: sub filecategorytypes {
1.356     albertel 3894:     my ($cat) = @_;
                   3895:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3896: }
                   3897: 
                   3898: =pod
                   3899: 
1.648     raeburn  3900: =item * &fileembstyle() 
1.112     bowersj2 3901: 
                   3902: returns embedding style for a specified file type
                   3903: 
                   3904: =cut
                   3905: 
                   3906: sub fileembstyle {
                   3907:     return $fe{lc(shift(@_))};
1.169     www      3908: }
                   3909: 
1.351     www      3910: sub filemimetype {
                   3911:     return $fm{lc(shift(@_))};
                   3912: }
                   3913: 
1.169     www      3914: 
                   3915: sub filecategoryselect {
                   3916:     my ($name,$value)=@_;
1.189     matthew  3917:     return &select_form($value,$name,
1.970     raeburn  3918:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3919: }
                   3920: 
                   3921: =pod
                   3922: 
1.648     raeburn  3923: =item * &filedescription() 
1.112     bowersj2 3924: 
                   3925: returns description for a specified file type
                   3926: 
                   3927: =cut
                   3928: 
                   3929: sub filedescription {
1.188     matthew  3930:     my $file_description = $fd{lc(shift())};
                   3931:     $file_description =~ s:([\[\]]):~$1:g;
                   3932:     return &mt($file_description);
1.112     bowersj2 3933: }
                   3934: 
                   3935: =pod
                   3936: 
1.648     raeburn  3937: =item * &filedescriptionex() 
1.112     bowersj2 3938: 
                   3939: returns description for a specified file type with
                   3940: extra formatting
                   3941: 
                   3942: =cut
                   3943: 
                   3944: sub filedescriptionex {
                   3945:     my $ex=shift;
1.188     matthew  3946:     my $file_description = $fd{lc($ex)};
                   3947:     $file_description =~ s:([\[\]]):~$1:g;
                   3948:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3949: }
                   3950: 
                   3951: # End of .tab access
                   3952: =pod
                   3953: 
                   3954: =back
                   3955: 
                   3956: =cut
                   3957: 
                   3958: # ------------------------------------------------------------------ File Types
                   3959: sub fileextensions {
                   3960:     return sort(keys(%fe));
                   3961: }
                   3962: 
1.97      www      3963: # ----------------------------------------------------------- Display Languages
                   3964: # returns a hash with all desired display languages
                   3965: #
                   3966: 
                   3967: sub display_languages {
                   3968:     my %languages=();
1.695     raeburn  3969:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3970: 	$languages{$lang}=1;
1.97      www      3971:     }
                   3972:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3973:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3974: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3975: 	    $languages{$lang}=1;
1.97      www      3976:         }
                   3977:     }
                   3978:     return %languages;
1.14      harris41 3979: }
                   3980: 
1.582     albertel 3981: sub languages {
                   3982:     my ($possible_langs) = @_;
1.695     raeburn  3983:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3984:     if (!ref($possible_langs)) {
                   3985: 	if( wantarray ) {
                   3986: 	    return @preferred_langs;
                   3987: 	} else {
                   3988: 	    return $preferred_langs[0];
                   3989: 	}
                   3990:     }
                   3991:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3992:     my @preferred_possibilities;
                   3993:     foreach my $preferred_lang (@preferred_langs) {
                   3994: 	if (exists($possibilities{$preferred_lang})) {
                   3995: 	    push(@preferred_possibilities, $preferred_lang);
                   3996: 	}
                   3997:     }
                   3998:     if( wantarray ) {
                   3999: 	return @preferred_possibilities;
                   4000:     }
                   4001:     return $preferred_possibilities[0];
                   4002: }
                   4003: 
1.742     raeburn  4004: sub user_lang {
                   4005:     my ($touname,$toudom,$fromcid) = @_;
                   4006:     my @userlangs;
                   4007:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4008:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4009:                     $env{'course.'.$fromcid.'.languages'}));
                   4010:     } else {
                   4011:         my %langhash = &getlangs($touname,$toudom);
                   4012:         if ($langhash{'languages'} ne '') {
                   4013:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4014:         } else {
                   4015:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4016:             if ($domdefs{'lang_def'} ne '') {
                   4017:                 @userlangs = ($domdefs{'lang_def'});
                   4018:             }
                   4019:         }
                   4020:     }
                   4021:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4022:     my $user_lh = Apache::localize->get_handle(@languages);
                   4023:     return $user_lh;
                   4024: }
                   4025: 
                   4026: 
1.112     bowersj2 4027: ###############################################################
                   4028: ##               Student Answer Attempts                     ##
                   4029: ###############################################################
                   4030: 
                   4031: =pod
                   4032: 
                   4033: =head1 Alternate Problem Views
                   4034: 
                   4035: =over 4
                   4036: 
1.648     raeburn  4037: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4038:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4039: 
                   4040: Return string with previous attempt on problem. Arguments:
                   4041: 
                   4042: =over 4
                   4043: 
                   4044: =item * $symb: Problem, including path
                   4045: 
                   4046: =item * $username: username of the desired student
                   4047: 
                   4048: =item * $domain: domain of the desired student
1.14      harris41 4049: 
1.112     bowersj2 4050: =item * $course: Course ID
1.14      harris41 4051: 
1.112     bowersj2 4052: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4053:     something
1.14      harris41 4054: 
1.112     bowersj2 4055: =item * $regexp: if string matches this regexp, the string will be
                   4056:     sent to $gradesub
1.14      harris41 4057: 
1.112     bowersj2 4058: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4059: 
1.1075.2.86  raeburn  4060: =item * $usec: section of the desired student
                   4061: 
                   4062: =item * $identifier: counter for student (multiple students one problem) or
                   4063:     problem (one student; whole sequence).
                   4064: 
1.112     bowersj2 4065: =back
1.14      harris41 4066: 
1.112     bowersj2 4067: The output string is a table containing all desired attempts, if any.
1.16      harris41 4068: 
1.112     bowersj2 4069: =cut
1.1       albertel 4070: 
                   4071: sub get_previous_attempt {
1.1075.2.86  raeburn  4072:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4073:   my $prevattempts='';
1.43      ng       4074:   no strict 'refs';
1.1       albertel 4075:   if ($symb) {
1.3       albertel 4076:     my (%returnhash)=
                   4077:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4078:     if ($returnhash{'version'}) {
                   4079:       my %lasthash=();
                   4080:       my $version;
                   4081:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4082:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4083:             if ($key =~ /\.rawrndseed$/) {
                   4084:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4085:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4086:             } else {
                   4087:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4088:             }
1.19      harris41 4089:         }
1.1       albertel 4090:       }
1.596     albertel 4091:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4092:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4093:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4094:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4095:       foreach my $key (sort(keys(%lasthash))) {
                   4096: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4097: 	if ($#parts > 0) {
1.31      albertel 4098: 	  my $data=$parts[-1];
1.989     raeburn  4099:           next if ($data eq 'foilorder');
1.31      albertel 4100: 	  pop(@parts);
1.1010    www      4101:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4102:           if ($data eq 'type') {
                   4103:               unless ($showsurv) {
                   4104:                   my $id = join(',',@parts);
                   4105:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4106:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4107:                       $lasthidden{$ign.'.'.$id} = 1;
                   4108:                   }
1.945     raeburn  4109:               }
1.1075.2.86  raeburn  4110:               if ($identifier ne '') {
                   4111:                   my $id = join(',',@parts);
                   4112:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4113:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4114:                       $hidestatus{$ign.'.'.$id} = 1;
                   4115:                   }
                   4116:               }
                   4117:           } elsif ($data eq 'regrader') {
                   4118:               if (($identifier ne '') && (@parts)) {
                   4119:                   my $id = join(',',@parts);
                   4120:                   $regraded{$ign.'.'.$id} = 1;
                   4121:               }
1.1010    www      4122:           } 
1.31      albertel 4123: 	} else {
1.41      ng       4124: 	  if ($#parts == 0) {
                   4125: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4126: 	  } else {
                   4127: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4128: 	  }
1.31      albertel 4129: 	}
1.16      harris41 4130:       }
1.596     albertel 4131:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4132:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4133:         my (%solved,%resets,%probstatus);
                   4134:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4135:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4136:                 foreach my $id (keys(%regraded)) {
                   4137:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4138:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4139:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4140:                         push(@{$resets{$id}},$version);
                   4141:                     }
                   4142:                 }
                   4143:             }
                   4144:         }
1.40      ng       4145: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4146:             my (@hidden,@unsolved);
1.945     raeburn  4147:             if (%typeparts) {
                   4148:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4149:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4150:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4151:                         push(@hidden,$id);
1.1075.2.86  raeburn  4152:                     } elsif ($identifier ne '') {
                   4153:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4154:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4155:                                 ($hidestatus{$id})) {
                   4156:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4157:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4158:                                 push(@{$solved{$id}},$version);
                   4159:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4160:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4161:                                 my $skip;
                   4162:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4163:                                     foreach my $reset (@{$resets{$id}}) {
                   4164:                                         if ($reset > $solved{$id}[-1]) {
                   4165:                                             $skip=1;
                   4166:                                             last;
                   4167:                                         }
                   4168:                                     }
                   4169:                                 }
                   4170:                                 unless ($skip) {
                   4171:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4172:                                     push(@unsolved,$partslist);
                   4173:                                 }
                   4174:                             }
                   4175:                         }
1.945     raeburn  4176:                     }
                   4177:                 }
                   4178:             }
                   4179:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4180:                            '<td>'.&mt('Transaction [_1]',$version);
                   4181:             if (@unsolved) {
                   4182:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4183:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4184:                                  &mt('Hide').'</label></span>';
                   4185:             }
                   4186:             $prevattempts .= '</td>';
1.945     raeburn  4187:             if (@hidden) {
                   4188:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4189:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4190:                     my $hide;
                   4191:                     foreach my $id (@hidden) {
                   4192:                         if ($key =~ /^\Q$id\E/) {
                   4193:                             $hide = 1;
                   4194:                             last;
                   4195:                         }
                   4196:                     }
                   4197:                     if ($hide) {
                   4198:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4199:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4200:                             my $value = &format_previous_attempt_value($key,
                   4201:                                              $returnhash{$version.':'.$key});
                   4202:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4203:                         } else {
                   4204:                             $prevattempts.='<td>&nbsp;</td>';
                   4205:                         }
                   4206:                     } else {
                   4207:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4208:                             my $value = $returnhash{$version.':'.$key};
                   4209:                             if ($key =~ /\.rndseed$/) {
                   4210:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4211:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4212:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4213:                                 }
                   4214:                             }
                   4215:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4216:                                            '&nbsp;</td>';
1.945     raeburn  4217:                         } else {
                   4218:                             $prevattempts.='<td>&nbsp;</td>';
                   4219:                         }
                   4220:                     }
                   4221:                 }
                   4222:             } else {
                   4223: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4224:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4225:                     my $value = $returnhash{$version.':'.$key};
                   4226:                     if ($key =~ /\.rndseed$/) {
                   4227:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4228:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4229:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4230:                         }
                   4231:                     }
                   4232:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4233:                                    '&nbsp;</td>';
1.945     raeburn  4234: 	        }
                   4235:             }
                   4236: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4237: 	 }
1.1       albertel 4238:       }
1.945     raeburn  4239:       my @currhidden = keys(%lasthidden);
1.596     albertel 4240:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4241:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4242:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4243:           if (%typeparts) {
                   4244:               my $hidden;
                   4245:               foreach my $id (@currhidden) {
                   4246:                   if ($key =~ /^\Q$id\E/) {
                   4247:                       $hidden = 1;
                   4248:                       last;
                   4249:                   }
                   4250:               }
                   4251:               if ($hidden) {
                   4252:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4253:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4254:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4255:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4256:                           $value = &$gradesub($value);
                   4257:                       }
                   4258:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4259:                   } else {
                   4260:                       $prevattempts.='<td>&nbsp;</td>';
                   4261:                   }
                   4262:               } else {
                   4263:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4264:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4265:                       $value = &$gradesub($value);
                   4266:                   }
                   4267:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4268:               }
                   4269:           } else {
                   4270: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4271: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4272:                   $value = &$gradesub($value);
                   4273:               }
                   4274: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4275:           }
1.16      harris41 4276:       }
1.596     albertel 4277:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4278:     } else {
1.596     albertel 4279:       $prevattempts=
                   4280: 	  &start_data_table().&start_data_table_row().
                   4281: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4282: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4283:     }
                   4284:   } else {
1.596     albertel 4285:     $prevattempts=
                   4286: 	  &start_data_table().&start_data_table_row().
                   4287: 	  '<td>'.&mt('No data.').'</td>'.
                   4288: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4289:   }
1.10      albertel 4290: }
                   4291: 
1.581     albertel 4292: sub format_previous_attempt_value {
                   4293:     my ($key,$value) = @_;
1.1011    www      4294:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4295: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4296:     } elsif (ref($value) eq 'ARRAY') {
                   4297: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4298:     } elsif ($key =~ /answerstring$/) {
                   4299:         my %answers = &Apache::lonnet::str2hash($value);
                   4300:         my @anskeys = sort(keys(%answers));
                   4301:         if (@anskeys == 1) {
                   4302:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4303:             if ($answer =~ m{\0}) {
                   4304:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4305:             }
                   4306:             my $tag_internal_answer_name = 'INTERNAL';
                   4307:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4308:                 $value = $answer; 
                   4309:             } else {
                   4310:                 $value = $anskeys[0].'='.$answer;
                   4311:             }
                   4312:         } else {
                   4313:             foreach my $ans (@anskeys) {
                   4314:                 my $answer = $answers{$ans};
1.1001    raeburn  4315:                 if ($answer =~ m{\0}) {
                   4316:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4317:                 }
                   4318:                 $value .=  $ans.'='.$answer.'<br />';;
                   4319:             } 
                   4320:         }
1.581     albertel 4321:     } else {
                   4322: 	$value = &unescape($value);
                   4323:     }
                   4324:     return $value;
                   4325: }
                   4326: 
                   4327: 
1.107     albertel 4328: sub relative_to_absolute {
                   4329:     my ($url,$output)=@_;
                   4330:     my $parser=HTML::TokeParser->new(\$output);
                   4331:     my $token;
                   4332:     my $thisdir=$url;
                   4333:     my @rlinks=();
                   4334:     while ($token=$parser->get_token) {
                   4335: 	if ($token->[0] eq 'S') {
                   4336: 	    if ($token->[1] eq 'a') {
                   4337: 		if ($token->[2]->{'href'}) {
                   4338: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4339: 		}
                   4340: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4341: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4342: 	    } elsif ($token->[1] eq 'base') {
                   4343: 		$thisdir=$token->[2]->{'href'};
                   4344: 	    }
                   4345: 	}
                   4346:     }
                   4347:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4348:     foreach my $link (@rlinks) {
1.726     raeburn  4349: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4350: 		($link=~/^\//) ||
                   4351: 		($link=~/^javascript:/i) ||
                   4352: 		($link=~/^mailto:/i) ||
                   4353: 		($link=~/^\#/)) {
                   4354: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4355: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4356: 	}
                   4357:     }
                   4358: # -------------------------------------------------- Deal with Applet codebases
                   4359:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4360:     return $output;
                   4361: }
                   4362: 
1.112     bowersj2 4363: =pod
                   4364: 
1.648     raeburn  4365: =item * &get_student_view()
1.112     bowersj2 4366: 
                   4367: show a snapshot of what student was looking at
                   4368: 
                   4369: =cut
                   4370: 
1.10      albertel 4371: sub get_student_view {
1.186     albertel 4372:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4373:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4374:   my (%form);
1.10      albertel 4375:   my @elements=('symb','courseid','domain','username');
                   4376:   foreach my $element (@elements) {
1.186     albertel 4377:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4378:   }
1.186     albertel 4379:   if (defined($moreenv)) {
                   4380:       %form=(%form,%{$moreenv});
                   4381:   }
1.236     albertel 4382:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4383:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4384:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4385:   $userview=~s/\<body[^\>]*\>//gi;
                   4386:   $userview=~s/\<\/body\>//gi;
                   4387:   $userview=~s/\<html\>//gi;
                   4388:   $userview=~s/\<\/html\>//gi;
                   4389:   $userview=~s/\<head\>//gi;
                   4390:   $userview=~s/\<\/head\>//gi;
                   4391:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4392:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4393:   if (wantarray) {
                   4394:      return ($userview,$response);
                   4395:   } else {
                   4396:      return $userview;
                   4397:   }
                   4398: }
                   4399: 
                   4400: sub get_student_view_with_retries {
                   4401:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4402: 
                   4403:     my $ok = 0;                 # True if we got a good response.
                   4404:     my $content;
                   4405:     my $response;
                   4406: 
                   4407:     # Try to get the student_view done. within the retries count:
                   4408:     
                   4409:     do {
                   4410:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4411:          $ok      = $response->is_success;
                   4412:          if (!$ok) {
                   4413:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4414:          }
                   4415:          $retries--;
                   4416:     } while (!$ok && ($retries > 0));
                   4417:     
                   4418:     if (!$ok) {
                   4419:        $content = '';          # On error return an empty content.
                   4420:     }
1.651     www      4421:     if (wantarray) {
                   4422:        return ($content, $response);
                   4423:     } else {
                   4424:        return $content;
                   4425:     }
1.11      albertel 4426: }
                   4427: 
1.1075.2.141.  .10(raeb 4428:-20): sub css_links {
                   4429:-20):     my ($currsymb,$level) = @_;
                   4430:-20):     my ($links,@symbs,%cssrefs,%httpref);
                   4431:-20):     if ($level eq 'map') {
                   4432:-20):         my $navmap = Apache::lonnavmaps::navmap->new();
                   4433:-20):         if (ref($navmap)) {
                   4434:-20):             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   4435:-20):             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   4436:-20):             foreach my $res (@resources) {
                   4437:-20):                 if (ref($res) && $res->symb()) {
                   4438:-20):                     push(@symbs,$res->symb());
                   4439:-20):                 }
                   4440:-20):             }
                   4441:-20):         }
                   4442:-20):     } else {
                   4443:-20):         @symbs = ($currsymb);
                   4444:-20):     }
                   4445:-20):     foreach my $symb (@symbs) {
                   4446:-20):         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   4447:-20):         if ($css_href =~ /\S/) {
                   4448:-20):             unless ($css_href =~ m{https?://}) {
                   4449:-20):                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   4450:-20):                 my $proburl =  &Apache::lonnet::clutter($url);
                   4451:-20):                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   4452:-20):                 unless ($css_href =~ m{^/}) {
                   4453:-20):                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   4454:-20):                 }
                   4455:-20):                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   4456:-20):                     unless (($httpref{'httpref.'.$css_href}) ||
                   4457:-20):                             (&Apache::lonnet::is_on_map($css_href))) {
                   4458:-20):                         my $thisurl = $proburl;
                   4459:-20):                         if ($env{'httpref.'.$proburl}) {
                   4460:-20):                             $thisurl = $env{'httpref.'.$proburl};
                   4461:-20):                         }
                   4462:-20):                         $httpref{'httpref.'.$css_href} = $thisurl;
                   4463:-20):                     }
                   4464:-20):                 }
                   4465:-20):             }
                   4466:-20):             $cssrefs{$css_href} = 1;
                   4467:-20):         }
                   4468:-20):     }
                   4469:-20):     if (keys(%httpref)) {
                   4470:-20):         &Apache::lonnet::appenv(\%httpref);
                   4471:-20):     }
                   4472:-20):     if (keys(%cssrefs)) {
                   4473:-20):         foreach my $css_href (keys(%cssrefs)) {
                   4474:-20):             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   4475:-20):             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   4476:-20):         }
                   4477:-20):     }
                   4478:-20):     return $links;
                   4479:-20): }
                   4480:-20): 
1.112     bowersj2 4481: =pod
                   4482: 
1.648     raeburn  4483: =item * &get_student_answers() 
1.112     bowersj2 4484: 
                   4485: show a snapshot of how student was answering problem
                   4486: 
                   4487: =cut
                   4488: 
1.11      albertel 4489: sub get_student_answers {
1.100     sakharuk 4490:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4491:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4492:   my (%moreenv);
1.11      albertel 4493:   my @elements=('symb','courseid','domain','username');
                   4494:   foreach my $element (@elements) {
1.186     albertel 4495:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4496:   }
1.186     albertel 4497:   $moreenv{'grade_target'}='answer';
                   4498:   %moreenv=(%form,%moreenv);
1.497     raeburn  4499:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4500:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4501:   return $userview;
1.1       albertel 4502: }
1.116     albertel 4503: 
                   4504: =pod
                   4505: 
                   4506: =item * &submlink()
                   4507: 
1.242     albertel 4508: Inputs: $text $uname $udom $symb $target
1.116     albertel 4509: 
                   4510: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4511: 
                   4512: =cut
                   4513: 
                   4514: ###############################################
                   4515: sub submlink {
1.242     albertel 4516:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4517:     if (!($uname && $udom)) {
                   4518: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4519: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4520: 	if (!$symb) { $symb=$cursymb; }
                   4521:     }
1.254     matthew  4522:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4523:     $symb=&escape($symb);
1.960     bisitz   4524:     if ($target) { $target=" target=\"$target\""; }
                   4525:     return
                   4526:         '<a href="/adm/grades?command=submission'.
                   4527:         '&amp;symb='.$symb.
                   4528:         '&amp;student='.$uname.
                   4529:         '&amp;userdom='.$udom.'"'.
                   4530:         $target.'>'.$text.'</a>';
1.242     albertel 4531: }
                   4532: ##############################################
                   4533: 
                   4534: =pod
                   4535: 
                   4536: =item * &pgrdlink()
                   4537: 
                   4538: Inputs: $text $uname $udom $symb $target
                   4539: 
                   4540: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4541: 
                   4542: =cut
                   4543: 
                   4544: ###############################################
                   4545: sub pgrdlink {
                   4546:     my $link=&submlink(@_);
                   4547:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4548:     return $link;
                   4549: }
                   4550: ##############################################
                   4551: 
                   4552: =pod
                   4553: 
                   4554: =item * &pprmlink()
                   4555: 
                   4556: Inputs: $text $uname $udom $symb $target
                   4557: 
                   4558: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4559: student and a specific resource
1.242     albertel 4560: 
                   4561: =cut
                   4562: 
                   4563: ###############################################
                   4564: sub pprmlink {
                   4565:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4566:     if (!($uname && $udom)) {
                   4567: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4568: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4569: 	if (!$symb) { $symb=$cursymb; }
                   4570:     }
1.254     matthew  4571:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4572:     $symb=&escape($symb);
1.242     albertel 4573:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4574:     return '<a href="/adm/parmset?command=set&amp;'.
                   4575: 	'symb='.$symb.'&amp;uname='.$uname.
                   4576: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4577: }
                   4578: ##############################################
1.37      matthew  4579: 
1.112     bowersj2 4580: =pod
                   4581: 
                   4582: =back
                   4583: 
                   4584: =cut
                   4585: 
1.37      matthew  4586: ###############################################
1.51      www      4587: 
                   4588: 
                   4589: sub timehash {
1.687     raeburn  4590:     my ($thistime) = @_;
                   4591:     my $timezone = &Apache::lonlocal::gettimezone();
                   4592:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4593:                      ->set_time_zone($timezone);
                   4594:     my $wday = $dt->day_of_week();
                   4595:     if ($wday == 7) { $wday = 0; }
                   4596:     return ( 'second' => $dt->second(),
                   4597:              'minute' => $dt->minute(),
                   4598:              'hour'   => $dt->hour(),
                   4599:              'day'     => $dt->day_of_month(),
                   4600:              'month'   => $dt->month(),
                   4601:              'year'    => $dt->year(),
                   4602:              'weekday' => $wday,
                   4603:              'dayyear' => $dt->day_of_year(),
                   4604:              'dlsav'   => $dt->is_dst() );
1.51      www      4605: }
                   4606: 
1.370     www      4607: sub utc_string {
                   4608:     my ($date)=@_;
1.371     www      4609:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4610: }
                   4611: 
1.51      www      4612: sub maketime {
                   4613:     my %th=@_;
1.687     raeburn  4614:     my ($epoch_time,$timezone,$dt);
                   4615:     $timezone = &Apache::lonlocal::gettimezone();
                   4616:     eval {
                   4617:         $dt = DateTime->new( year   => $th{'year'},
                   4618:                              month  => $th{'month'},
                   4619:                              day    => $th{'day'},
                   4620:                              hour   => $th{'hour'},
                   4621:                              minute => $th{'minute'},
                   4622:                              second => $th{'second'},
                   4623:                              time_zone => $timezone,
                   4624:                          );
                   4625:     };
                   4626:     if (!$@) {
                   4627:         $epoch_time = $dt->epoch;
                   4628:         if ($epoch_time) {
                   4629:             return $epoch_time;
                   4630:         }
                   4631:     }
1.51      www      4632:     return POSIX::mktime(
                   4633:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4634:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4635: }
                   4636: 
                   4637: #########################################
1.51      www      4638: 
                   4639: sub findallcourses {
1.482     raeburn  4640:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4641:     my %roles;
                   4642:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4643:     my %courses;
1.51      www      4644:     my $now=time;
1.482     raeburn  4645:     if (!defined($uname)) {
                   4646:         $uname = $env{'user.name'};
                   4647:     }
                   4648:     if (!defined($udom)) {
                   4649:         $udom = $env{'user.domain'};
                   4650:     }
                   4651:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4652:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4653:         if (!%roles) {
                   4654:             %roles = (
                   4655:                        cc => 1,
1.907     raeburn  4656:                        co => 1,
1.482     raeburn  4657:                        in => 1,
                   4658:                        ep => 1,
                   4659:                        ta => 1,
                   4660:                        cr => 1,
                   4661:                        st => 1,
                   4662:              );
                   4663:         }
                   4664:         foreach my $entry (keys(%roleshash)) {
                   4665:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4666:             if ($trole =~ /^cr/) { 
                   4667:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4668:             } else {
                   4669:                 next if (!exists($roles{$trole}));
                   4670:             }
                   4671:             if ($tend) {
                   4672:                 next if ($tend < $now);
                   4673:             }
                   4674:             if ($tstart) {
                   4675:                 next if ($tstart > $now);
                   4676:             }
1.1058    raeburn  4677:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4678:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4679:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4680:             if ($secpart eq '') {
                   4681:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4682:                 $sec = 'none';
1.1058    raeburn  4683:                 $value .= $cnum.'/';
1.482     raeburn  4684:             } else {
                   4685:                 $cnum = $cnumpart;
                   4686:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4687:                 $value .= $cnum.'/'.$sec;
                   4688:             }
                   4689:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4690:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4691:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4692:                 }
                   4693:             } else {
                   4694:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4695:             }
1.482     raeburn  4696:         }
                   4697:     } else {
                   4698:         foreach my $key (keys(%env)) {
1.483     albertel 4699: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4700:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4701: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4702: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4703: 	        next if (%roles && !exists($roles{$role}));
                   4704: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4705:                 my $active=1;
                   4706:                 if ($starttime) {
                   4707: 		    if ($now<$starttime) { $active=0; }
                   4708:                 }
                   4709:                 if ($endtime) {
                   4710:                     if ($now>$endtime) { $active=0; }
                   4711:                 }
                   4712:                 if ($active) {
1.1058    raeburn  4713:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4714:                     if ($sec eq '') {
                   4715:                         $sec = 'none';
1.1058    raeburn  4716:                     } else {
                   4717:                         $value .= $sec;
                   4718:                     }
                   4719:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4720:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4721:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4722:                         }
                   4723:                     } else {
                   4724:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4725:                     }
1.474     raeburn  4726:                 }
                   4727:             }
1.51      www      4728:         }
                   4729:     }
1.474     raeburn  4730:     return %courses;
1.51      www      4731: }
1.37      matthew  4732: 
1.54      www      4733: ###############################################
1.474     raeburn  4734: 
                   4735: sub blockcheck {
1.1075.2.141.  .7(raebu 4736:20):     my ($setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4737: 
1.1075.2.73  raeburn  4738:     if (defined($udom) && defined($uname)) {
                   4739:         # If uname and udom are for a course, check for blocks in the course.
                   4740:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4741:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.141.  .7(raebu 4742:20):                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4743:             return ($startblock,$endblock,$triggerblock);
                   4744:         }
                   4745:     } else {
1.490     raeburn  4746:         $udom = $env{'user.domain'};
                   4747:         $uname = $env{'user.name'};
                   4748:     }
                   4749: 
1.502     raeburn  4750:     my $startblock = 0;
                   4751:     my $endblock = 0;
1.1062    raeburn  4752:     my $triggerblock = '';
1.482     raeburn  4753:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4754: 
1.490     raeburn  4755:     # If uname is for a user, and activity is course-specific, i.e.,
                   4756:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4757: 
1.490     raeburn  4758:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.141.  .6(raebu 4759:20):          $activity eq 'groups' || $activity eq 'printout' ||
          .8(raebu 4760:20):          $activity eq 'search' || $activity eq 'reinit' ||
                   4761:20):          $activity eq 'alert') &&
1.1075.2.73  raeburn  4762:         ($env{'request.course.id'})) {
1.490     raeburn  4763:         foreach my $key (keys(%live_courses)) {
                   4764:             if ($key ne $env{'request.course.id'}) {
                   4765:                 delete($live_courses{$key});
                   4766:             }
                   4767:         }
                   4768:     }
                   4769: 
                   4770:     my $otheruser = 0;
                   4771:     my %own_courses;
                   4772:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4773:         # Resource belongs to user other than current user.
                   4774:         $otheruser = 1;
                   4775:         # Gather courses for current user
                   4776:         %own_courses = 
                   4777:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4778:     }
                   4779: 
                   4780:     # Gather active course roles - course coordinator, instructor, 
                   4781:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4782: 
                   4783:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4784:         my ($cdom,$cnum);
                   4785:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4786:             $cdom = $env{'course.'.$course.'.domain'};
                   4787:             $cnum = $env{'course.'.$course.'.num'};
                   4788:         } else {
1.490     raeburn  4789:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4790:         }
                   4791:         my $no_ownblock = 0;
                   4792:         my $no_userblock = 0;
1.533     raeburn  4793:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4794:             # Check if current user has 'evb' priv for this
                   4795:             if (defined($own_courses{$course})) {
                   4796:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4797:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4798:                     if ($sec ne 'none') {
                   4799:                         $checkrole .= '/'.$sec;
                   4800:                     }
                   4801:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4802:                         $no_ownblock = 1;
                   4803:                         last;
                   4804:                     }
                   4805:                 }
                   4806:             }
                   4807:             # if they have 'evb' priv and are currently not playing student
                   4808:             next if (($no_ownblock) &&
                   4809:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4810:         }
1.474     raeburn  4811:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4812:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4813:             if ($sec ne 'none') {
1.482     raeburn  4814:                 $checkrole .= '/'.$sec;
1.474     raeburn  4815:             }
1.490     raeburn  4816:             if ($otheruser) {
                   4817:                 # Resource belongs to user other than current user.
                   4818:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4819:                 my (%allroles,%userroles);
                   4820:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4821:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4822:                         my ($trole,$tdom,$tnum,$tsec);
                   4823:                         if ($entry =~ /^cr/) {
                   4824:                             ($trole,$tdom,$tnum,$tsec) = 
                   4825:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4826:                         } else {
                   4827:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4828:                         }
                   4829:                         my ($spec,$area,$trest);
                   4830:                         $area = '/'.$tdom.'/'.$tnum;
                   4831:                         $trest = $tnum;
                   4832:                         if ($tsec ne '') {
                   4833:                             $area .= '/'.$tsec;
                   4834:                             $trest .= '/'.$tsec;
                   4835:                         }
                   4836:                         $spec = $trole.'.'.$area;
                   4837:                         if ($trole =~ /^cr/) {
                   4838:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4839:                                                               $tdom,$spec,$trest,$area);
                   4840:                         } else {
                   4841:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4842:                                                                 $tdom,$spec,$trest,$area);
                   4843:                         }
                   4844:                     }
1.1075.2.124  raeburn  4845:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4846:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4847:                         if ($1) {
                   4848:                             $no_userblock = 1;
                   4849:                             last;
                   4850:                         }
1.486     raeburn  4851:                     }
                   4852:                 }
1.490     raeburn  4853:             } else {
                   4854:                 # Resource belongs to current user
                   4855:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4856:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4857:                     $no_ownblock = 1;
                   4858:                     last;
                   4859:                 }
1.474     raeburn  4860:             }
                   4861:         }
                   4862:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4863:         next if (($no_ownblock) &&
1.491     albertel 4864:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4865:         next if ($no_userblock);
1.474     raeburn  4866: 
1.1075.2.128  raeburn  4867:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4868:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4869:         
1.1062    raeburn  4870:         my ($start,$end,$trigger) = 
1.1075.2.141.  .7(raebu 4871:20):             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  4872:         if (($start != 0) && 
                   4873:             (($startblock == 0) || ($startblock > $start))) {
                   4874:             $startblock = $start;
1.1062    raeburn  4875:             if ($trigger ne '') {
                   4876:                 $triggerblock = $trigger;
                   4877:             }
1.502     raeburn  4878:         }
                   4879:         if (($end != 0)  &&
                   4880:             (($endblock == 0) || ($endblock < $end))) {
                   4881:             $endblock = $end;
1.1062    raeburn  4882:             if ($trigger ne '') {
                   4883:                 $triggerblock = $trigger;
                   4884:             }
1.502     raeburn  4885:         }
1.490     raeburn  4886:     }
1.1062    raeburn  4887:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4888: }
                   4889: 
                   4890: sub get_blocks {
1.1075.2.141.  .7(raebu 4891:20):     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  4892:     my $startblock = 0;
                   4893:     my $endblock = 0;
1.1062    raeburn  4894:     my $triggerblock = '';
1.490     raeburn  4895:     my $course = $cdom.'_'.$cnum;
                   4896:     $setters->{$course} = {};
                   4897:     $setters->{$course}{'staff'} = [];
                   4898:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4899:     $setters->{$course}{'triggers'} = [];
                   4900:     my (@blockers,%triggered);
                   4901:     my $now = time;
                   4902:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4903:     if ($activity eq 'docs') {
1.1075.2.141.  .9(raebu 4904:20):         my ($blocked,$nosymbcache,$noenccheck);
          .7(raebu 4905:20):         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   4906:20):             $blocked = 1;
                   4907:20):             $nosymbcache = 1;
          .9(raebu 4908:20):             $noenccheck = 1;
          .7(raebu 4909:20):         }
          .9(raebu 4910:20):         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  4911:         foreach my $block (@blockers) {
                   4912:             if ($block =~ /^firstaccess____(.+)$/) {
                   4913:                 my $item = $1;
                   4914:                 my $type = 'map';
                   4915:                 my $timersymb = $item;
                   4916:                 if ($item eq 'course') {
                   4917:                     $type = 'course';
                   4918:                 } elsif ($item =~ /___\d+___/) {
                   4919:                     $type = 'resource';
                   4920:                 } else {
                   4921:                     $timersymb = &Apache::lonnet::symbread($item);
                   4922:                 }
                   4923:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4924:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4925:                 $triggered{$block} = {
                   4926:                                        start => $start,
                   4927:                                        end   => $end,
                   4928:                                        type  => $type,
                   4929:                                      };
                   4930:             }
                   4931:         }
                   4932:     } else {
                   4933:         foreach my $block (keys(%commblocks)) {
                   4934:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4935:                 my ($start,$end) = ($1,$2);
                   4936:                 if ($start <= time && $end >= time) {
                   4937:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4938:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4939:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4940:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4941:                                     push(@blockers,$block);
                   4942:                                 }
                   4943:                             }
                   4944:                         }
                   4945:                     }
                   4946:                 }
                   4947:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4948:                 my $item = $1;
                   4949:                 my $timersymb = $item; 
                   4950:                 my $type = 'map';
                   4951:                 if ($item eq 'course') {
                   4952:                     $type = 'course';
                   4953:                 } elsif ($item =~ /___\d+___/) {
                   4954:                     $type = 'resource';
                   4955:                 } else {
                   4956:                     $timersymb = &Apache::lonnet::symbread($item);
                   4957:                 }
                   4958:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4959:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4960:                 if ($start && $end) {
                   4961:                     if (($start <= time) && ($end >= time)) {
                   4962:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4963:                             push(@blockers,$block);
                   4964:                             $triggered{$block} = {
                   4965:                                                    start => $start,
                   4966:                                                    end   => $end,
                   4967:                                                    type  => $type,
                   4968:                                                  };
                   4969:                         }
                   4970:                     }
1.490     raeburn  4971:                 }
1.1062    raeburn  4972:             }
                   4973:         }
                   4974:     }
                   4975:     foreach my $blocker (@blockers) {
                   4976:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4977:             &parse_block_record($commblocks{$blocker});
                   4978:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4979:         my ($start,$end,$triggertype);
                   4980:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4981:             ($start,$end) = ($1,$2);
                   4982:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4983:             $start = $triggered{$blocker}{'start'};
                   4984:             $end = $triggered{$blocker}{'end'};
                   4985:             $triggertype = $triggered{$blocker}{'type'};
                   4986:         }
                   4987:         if ($start) {
                   4988:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4989:             if ($triggertype) {
                   4990:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4991:             } else {
                   4992:                 push(@{$$setters{$course}{'triggers'}},0);
                   4993:             }
                   4994:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4995:                 $startblock = $start;
                   4996:                 if ($triggertype) {
                   4997:                     $triggerblock = $blocker;
1.474     raeburn  4998:                 }
                   4999:             }
1.1062    raeburn  5000:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   5001:                $endblock = $end;
                   5002:                if ($triggertype) {
                   5003:                    $triggerblock = $blocker;
                   5004:                }
                   5005:             }
1.474     raeburn  5006:         }
                   5007:     }
1.1062    raeburn  5008:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  5009: }
                   5010: 
                   5011: sub parse_block_record {
                   5012:     my ($record) = @_;
                   5013:     my ($setuname,$setudom,$title,$blocks);
                   5014:     if (ref($record) eq 'HASH') {
                   5015:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   5016:         $title = &unescape($record->{'event'});
                   5017:         $blocks = $record->{'blocks'};
                   5018:     } else {
                   5019:         my @data = split(/:/,$record,3);
                   5020:         if (scalar(@data) eq 2) {
                   5021:             $title = $data[1];
                   5022:             ($setuname,$setudom) = split(/@/,$data[0]);
                   5023:         } else {
                   5024:             ($setuname,$setudom,$title) = @data;
                   5025:         }
                   5026:         $blocks = { 'com' => 'on' };
                   5027:     }
                   5028:     return ($setuname,$setudom,$title,$blocks);
                   5029: }
                   5030: 
1.854     kalberla 5031: sub blocking_status {
1.1075.2.141.  .7(raebu 5032:20):     my ($activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  5033:     my %setters;
1.890     droeschl 5034: 
1.1061    raeburn  5035: # check for active blocking
1.1062    raeburn  5036:     my ($startblock,$endblock,$triggerblock) = 
1.1075.2.141.  .7(raebu 5037:20):         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  5038:     my $blocked = 0;
                   5039:     if ($startblock && $endblock) {
                   5040:         $blocked = 1;
                   5041:     }
1.890     droeschl 5042: 
1.1061    raeburn  5043: # caller just wants to know whether a block is active
                   5044:     if (!wantarray) { return $blocked; }
                   5045: 
                   5046: # build a link to a popup window containing the details
                   5047:     my $querystring  = "?activity=$activity";
                   5048: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97  raeburn  5049:     if (($activity eq 'port') || ($activity eq 'passwd')) {
                   5050:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   5051:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  5052:     } elsif ($activity eq 'docs') {
1.1075.2.141.  .7(raebu 5053:20):         my $showurl = &Apache::lonenc::check_encrypt($url);
                   5054:20):         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5055:20):         if ($symb) {
                   5056:20):             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5057:20):             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5058:20):         }
1.1062    raeburn  5059:     }
1.1061    raeburn  5060: 
                   5061:     my $output .= <<'END_MYBLOCK';
                   5062: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5063:     var options = "width=" + w + ",height=" + h + ",";
                   5064:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5065:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5066:     var newWin = window.open(url, wdwName, options);
                   5067:     newWin.focus();
                   5068: }
1.890     droeschl 5069: END_MYBLOCK
1.854     kalberla 5070: 
1.1061    raeburn  5071:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5072:   
1.1061    raeburn  5073:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5074:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5075:     my $class = 'LC_comblock';
1.1062    raeburn  5076:     if ($activity eq 'docs') {
                   5077:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5078:         $class = '';
1.1063    raeburn  5079:     } elsif ($activity eq 'printout') {
                   5080:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5081:     } elsif ($activity eq 'passwd') {
                   5082:         $text = &mt('Password Changing Blocked');
1.1075.2.141.  .6(raebu 5083:20):     } elsif ($activity eq 'grades') {
                   5084:20):         $text = &mt('Gradebook Blocked');
          .8(raebu 5085:20):     } elsif ($activity eq 'search') {
                   5086:20):         $text = &mt('Search Blocked');
          .6(raebu 5087:20):     } elsif ($activity eq 'alert') {
                   5088:20):         $text = &mt('Checking Critical Messages Blocked');
                   5089:20):     } elsif ($activity eq 'reinit') {
                   5090:20):         $text = &mt('Checking Course Update Blocked');
1.1062    raeburn  5091:     }
1.1061    raeburn  5092:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5093: <div class='$class'>
1.869     kalberla 5094:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5095:   title='$text'>
                   5096:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5097:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5098:   title='$text'>$text</a>
1.867     kalberla 5099: </div>
                   5100: 
                   5101: END_BLOCK
1.474     raeburn  5102: 
1.1061    raeburn  5103:     return ($blocked, $output);
1.854     kalberla 5104: }
1.490     raeburn  5105: 
1.60      matthew  5106: ###############################################
                   5107: 
1.682     raeburn  5108: sub check_ip_acc {
1.1075.2.105  raeburn  5109:     my ($acc,$clientip)=@_;
1.682     raeburn  5110:     &Apache::lonxml::debug("acc is $acc");
                   5111:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5112:         return 1;
                   5113:     }
1.1075.2.141.  .4(raebu 5114:20):     my ($ip,$allowed);
                   5115:20):     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5116:20):         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5117:20):         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5118:20):     } else {
                   5119:20):         $ip = $ENV{'REMOTE_ADDR'} || $env{'request.host'} || $clientip;
                   5120:20):     }
1.682     raeburn  5121: 
                   5122:     my $name;
1.1075.2.141.  .1(raebu 5123:20):     my %access = (
                   5124:20):                      allowfrom => 1,
                   5125:20):                      denyfrom  => 0,
                   5126:20):                  );
                   5127:20):     my @allows;
                   5128:20):     my @denies;
                   5129:20):     foreach my $item (split(',',$acc)) {
                   5130:20):         $item =~ s/^\s*//;
                   5131:20):         $item =~ s/\s*$//;
                   5132:20):         if ($item =~ /^\!(.+)$/) {
                   5133:20):             push(@denies,$1);
                   5134:20):         } else {
                   5135:20):             push(@allows,$item);
                   5136:20):         }
                   5137:20):     }
                   5138:20):     my $numdenies = scalar(@denies);
                   5139:20):     my $numallows = scalar(@allows);
                   5140:20):     my $count = 0;
                   5141:20):     foreach my $pattern (@denies,@allows) {
                   5142:20):         $count ++;
                   5143:20):         my $acctype = 'allowfrom';
                   5144:20):         if ($count <= $numdenies) {
                   5145:20):             $acctype = 'denyfrom';
                   5146:20):         }
1.682     raeburn  5147:         if ($pattern =~ /\*$/) {
                   5148:             #35.8.*
                   5149:             $pattern=~s/\*//;
1.1075.2.141.  .1(raebu 5150:20):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5151:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5152:             #35.8.3.[34-56]
                   5153:             my $low=$2;
                   5154:             my $high=$3;
                   5155:             $pattern=$1;
                   5156:             if ($ip =~ /^\Q$pattern\E/) {
                   5157:                 my $last=(split(/\./,$ip))[3];
1.1075.2.141.  .1(raebu 5158:20):                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  5159:             }
                   5160:         } elsif ($pattern =~ /^\*/) {
                   5161:             #*.msu.edu
                   5162:             $pattern=~s/\*//;
                   5163:             if (!defined($name)) {
                   5164:                 use Socket;
                   5165:                 my $netaddr=inet_aton($ip);
                   5166:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5167:             }
1.1075.2.141.  .1(raebu 5168:20):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  5169:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5170:             #127.0.0.1
1.1075.2.141.  .1(raebu 5171:20):             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  5172:         } else {
                   5173:             #some.name.com
                   5174:             if (!defined($name)) {
                   5175:                 use Socket;
                   5176:                 my $netaddr=inet_aton($ip);
                   5177:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5178:             }
1.1075.2.141.  .1(raebu 5179:20):             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   5180:20):         }
                   5181:20):         if ($allowed =~ /^(0|1)$/) { last; }
                   5182:20):     }
                   5183:20):     if ($allowed eq '') {
                   5184:20):         if ($numdenies && !$numallows) {
                   5185:20):             $allowed = 1;
                   5186:20):         } else {
                   5187:20):             $allowed = 0;
1.682     raeburn  5188:         }
                   5189:     }
                   5190:     return $allowed;
                   5191: }
                   5192: 
                   5193: ###############################################
                   5194: 
1.60      matthew  5195: =pod
                   5196: 
1.112     bowersj2 5197: =head1 Domain Template Functions
                   5198: 
                   5199: =over 4
                   5200: 
                   5201: =item * &determinedomain()
1.60      matthew  5202: 
                   5203: Inputs: $domain (usually will be undef)
                   5204: 
1.63      www      5205: Returns: Determines which domain should be used for designs
1.60      matthew  5206: 
                   5207: =cut
1.54      www      5208: 
1.60      matthew  5209: ###############################################
1.63      www      5210: sub determinedomain {
                   5211:     my $domain=shift;
1.531     albertel 5212:     if (! $domain) {
1.60      matthew  5213:         # Determine domain if we have not been given one
1.893     raeburn  5214:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5215:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5216:         if ($env{'request.role.domain'}) { 
                   5217:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5218:         }
                   5219:     }
1.63      www      5220:     return $domain;
                   5221: }
                   5222: ###############################################
1.517     raeburn  5223: 
1.518     albertel 5224: sub devalidate_domconfig_cache {
                   5225:     my ($udom)=@_;
                   5226:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5227: }
                   5228: 
                   5229: # ---------------------- Get domain configuration for a domain
                   5230: sub get_domainconf {
                   5231:     my ($udom) = @_;
                   5232:     my $cachetime=1800;
                   5233:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5234:     if (defined($cached)) { return %{$result}; }
                   5235: 
                   5236:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5237: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5238:     my (%designhash,%legacy);
1.518     albertel 5239:     if (keys(%domconfig) > 0) {
                   5240:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5241:             if (keys(%{$domconfig{'login'}})) {
                   5242:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5243:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5244:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5245:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5246:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5247:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5248:                                         if ($key eq 'loginvia') {
                   5249:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5250:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5251:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5252:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5253:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5254:                                                 } else {
                   5255:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5256:                                                 }
1.948     raeburn  5257:                                             }
1.1075.2.87  raeburn  5258:                                         } elsif ($key eq 'headtag') {
                   5259:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5260:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5261:                                             }
1.946     raeburn  5262:                                         }
1.1075.2.87  raeburn  5263:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5264:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5265:                                         }
1.946     raeburn  5266:                                     }
                   5267:                                 }
                   5268:                             }
                   5269:                         } else {
                   5270:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5271:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5272:                                     $domconfig{'login'}{$key}{$img};
                   5273:                             }
1.699     raeburn  5274:                         }
                   5275:                     } else {
                   5276:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5277:                     }
1.632     raeburn  5278:                 }
                   5279:             } else {
                   5280:                 $legacy{'login'} = 1;
1.518     albertel 5281:             }
1.632     raeburn  5282:         } else {
                   5283:             $legacy{'login'} = 1;
1.518     albertel 5284:         }
                   5285:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5286:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5287:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5288:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5289:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5290:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5291:                         }
1.518     albertel 5292:                     }
                   5293:                 }
1.632     raeburn  5294:             } else {
                   5295:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5296:             }
1.632     raeburn  5297:         } else {
                   5298:             $legacy{'rolecolors'} = 1;
1.518     albertel 5299:         }
1.948     raeburn  5300:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5301:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5302:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5303:             }
                   5304:         }
1.632     raeburn  5305:         if (keys(%legacy) > 0) {
                   5306:             my %legacyhash = &get_legacy_domconf($udom);
                   5307:             foreach my $item (keys(%legacyhash)) {
                   5308:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5309:                     if ($legacy{'login'}) { 
                   5310:                         $designhash{$item} = $legacyhash{$item};
                   5311:                     }
                   5312:                 } else {
                   5313:                     if ($legacy{'rolecolors'}) {
                   5314:                         $designhash{$item} = $legacyhash{$item};
                   5315:                     }
1.518     albertel 5316:                 }
                   5317:             }
                   5318:         }
1.632     raeburn  5319:     } else {
                   5320:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5321:     }
                   5322:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5323: 				  $cachetime);
                   5324:     return %designhash;
                   5325: }
                   5326: 
1.632     raeburn  5327: sub get_legacy_domconf {
                   5328:     my ($udom) = @_;
                   5329:     my %legacyhash;
                   5330:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5331:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5332:     if (-e $designfile) {
1.1075.2.128  raeburn  5333:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5334:             while (my $line = <$fh>) {
                   5335:                 next if ($line =~ /^\#/);
                   5336:                 chomp($line);
                   5337:                 my ($key,$val)=(split(/\=/,$line));
                   5338:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5339:             }
                   5340:             close($fh);
                   5341:         }
                   5342:     }
1.1026    raeburn  5343:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5344:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5345:     }
                   5346:     return %legacyhash;
                   5347: }
                   5348: 
1.63      www      5349: =pod
                   5350: 
1.112     bowersj2 5351: =item * &domainlogo()
1.63      www      5352: 
                   5353: Inputs: $domain (usually will be undef)
                   5354: 
                   5355: Returns: A link to a domain logo, if the domain logo exists.
                   5356: If the domain logo does not exist, a description of the domain.
                   5357: 
                   5358: =cut
1.112     bowersj2 5359: 
1.63      www      5360: ###############################################
                   5361: sub domainlogo {
1.517     raeburn  5362:     my $domain = &determinedomain(shift);
1.518     albertel 5363:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5364:     # See if there is a logo
                   5365:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5366:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5367:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5368: 	    if ($imgsrc =~ m{^/res/}) {
                   5369: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5370: 		&Apache::lonnet::repcopy($local_name);
                   5371: 	    }
                   5372: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5373:         } 
                   5374:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5375:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5376:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5377:     } else {
1.60      matthew  5378:         return '';
1.59      www      5379:     }
                   5380: }
1.63      www      5381: ##############################################
                   5382: 
                   5383: =pod
                   5384: 
1.112     bowersj2 5385: =item * &designparm()
1.63      www      5386: 
                   5387: Inputs: $which parameter; $domain (usually will be undef)
                   5388: 
                   5389: Returns: value of designparamter $which
                   5390: 
                   5391: =cut
1.112     bowersj2 5392: 
1.397     albertel 5393: 
1.400     albertel 5394: ##############################################
1.397     albertel 5395: sub designparm {
                   5396:     my ($which,$domain)=@_;
                   5397:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5398:         return $env{'environment.color.'.$which};
1.96      www      5399:     }
1.63      www      5400:     $domain=&determinedomain($domain);
1.1016    raeburn  5401:     my %domdesign;
                   5402:     unless ($domain eq 'public') {
                   5403:         %domdesign = &get_domainconf($domain);
                   5404:     }
1.520     raeburn  5405:     my $output;
1.517     raeburn  5406:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5407:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5408:     } else {
1.520     raeburn  5409:         $output = $defaultdesign{$which};
                   5410:     }
                   5411:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5412:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5413:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5414:             if ($output =~ m{^/res/}) {
                   5415:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5416:                 &Apache::lonnet::repcopy($local_name);
                   5417:             }
1.520     raeburn  5418:             $output = &lonhttpdurl($output);
                   5419:         }
1.63      www      5420:     }
1.520     raeburn  5421:     return $output;
1.63      www      5422: }
1.59      www      5423: 
1.822     bisitz   5424: ##############################################
                   5425: =pod
                   5426: 
1.832     bisitz   5427: =item * &authorspace()
                   5428: 
1.1028    raeburn  5429: Inputs: $url (usually will be undef).
1.832     bisitz   5430: 
1.1075.2.40  raeburn  5431: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5432:          directory being viewed (or for which action is being taken). 
                   5433:          If $url is provided, and begins /priv/<domain>/<uname>
                   5434:          the path will be that portion of the $context argument.
                   5435:          Otherwise the path will be for the author space of the current
                   5436:          user when the current role is author, or for that of the 
                   5437:          co-author/assistant co-author space when the current role 
                   5438:          is co-author or assistant co-author.
1.832     bisitz   5439: 
                   5440: =cut
                   5441: 
                   5442: sub authorspace {
1.1028    raeburn  5443:     my ($url) = @_;
                   5444:     if ($url ne '') {
                   5445:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5446:            return $1;
                   5447:         }
                   5448:     }
1.832     bisitz   5449:     my $caname = '';
1.1024    www      5450:     my $cadom = '';
1.1028    raeburn  5451:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5452:         ($cadom,$caname) =
1.832     bisitz   5453:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5454:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5455:         $caname = $env{'user.name'};
1.1024    www      5456:         $cadom = $env{'user.domain'};
1.832     bisitz   5457:     }
1.1028    raeburn  5458:     if (($caname ne '') && ($cadom ne '')) {
                   5459:         return "/priv/$cadom/$caname/";
                   5460:     }
                   5461:     return;
1.832     bisitz   5462: }
                   5463: 
                   5464: ##############################################
                   5465: =pod
                   5466: 
1.822     bisitz   5467: =item * &head_subbox()
                   5468: 
                   5469: Inputs: $content (contains HTML code with page functions, etc.)
                   5470: 
                   5471: Returns: HTML div with $content
                   5472:          To be included in page header
                   5473: 
                   5474: =cut
                   5475: 
                   5476: sub head_subbox {
                   5477:     my ($content)=@_;
                   5478:     my $output =
1.993     raeburn  5479:         '<div class="LC_head_subbox">'
1.822     bisitz   5480:        .$content
                   5481:        .'</div>'
                   5482: }
                   5483: 
                   5484: ##############################################
                   5485: =pod
                   5486: 
                   5487: =item * &CSTR_pageheader()
                   5488: 
1.1026    raeburn  5489: Input: (optional) filename from which breadcrumb trail is built.
                   5490:        In most cases no input as needed, as $env{'request.filename'}
                   5491:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5492: 
                   5493: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5494:          To be included on Authoring Space pages
1.822     bisitz   5495: 
                   5496: =cut
                   5497: 
                   5498: sub CSTR_pageheader {
1.1026    raeburn  5499:     my ($trailfile) = @_;
                   5500:     if ($trailfile eq '') {
                   5501:         $trailfile = $env{'request.filename'};
                   5502:     }
                   5503: 
                   5504: # this is for resources; directories have customtitle, and crumbs
                   5505: # and select recent are created in lonpubdir.pm
                   5506: 
                   5507:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5508:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5509:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5510:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5511:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5512: 
                   5513:     my $parentpath = '';
                   5514:     my $lastitem = '';
                   5515:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5516:         $parentpath = $1;
                   5517:         $lastitem = $2;
                   5518:     } else {
                   5519:         $lastitem = $thisdisfn;
                   5520:     }
1.921     bisitz   5521: 
                   5522:     my $output =
1.822     bisitz   5523:          '<div>'
                   5524:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5525:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5526:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5527:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5528:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5529: 
                   5530:     if ($lastitem) {
                   5531:         $output .=
                   5532:              '<span class="LC_filename">'
                   5533:             .$lastitem
                   5534:             .'</span>';
                   5535:     }
                   5536:     $output .=
                   5537:          '<br />'
1.822     bisitz   5538:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5539:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5540:         .'</form>'
                   5541:         .&Apache::lonmenu::constspaceform()
                   5542:         .'</div>';
1.921     bisitz   5543: 
                   5544:     return $output;
1.822     bisitz   5545: }
                   5546: 
1.60      matthew  5547: ###############################################
                   5548: ###############################################
                   5549: 
                   5550: =pod
                   5551: 
1.112     bowersj2 5552: =back
                   5553: 
1.549     albertel 5554: =head1 HTML Helpers
1.112     bowersj2 5555: 
                   5556: =over 4
                   5557: 
                   5558: =item * &bodytag()
1.60      matthew  5559: 
                   5560: Returns a uniform header for LON-CAPA web pages.
                   5561: 
                   5562: Inputs: 
                   5563: 
1.112     bowersj2 5564: =over 4
                   5565: 
                   5566: =item * $title, A title to be displayed on the page.
                   5567: 
                   5568: =item * $function, the current role (can be undef).
                   5569: 
                   5570: =item * $addentries, extra parameters for the <body> tag.
                   5571: 
                   5572: =item * $bodyonly, if defined, only return the <body> tag.
                   5573: 
                   5574: =item * $domain, if defined, force a given domain.
                   5575: 
                   5576: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5577:             text interface only)
1.60      matthew  5578: 
1.814     bisitz   5579: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5580:                      navigational links
1.317     albertel 5581: 
1.338     albertel 5582: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5583: 
1.1075.2.12  raeburn  5584: =item * $no_inline_link, if true and in remote mode, don't show the
                   5585:          'Switch To Inline Menu' link
                   5586: 
1.460     albertel 5587: =item * $args, optional argument valid values are
                   5588:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5589:             use_absolute     -> for external resource or syllabus, this will
                   5590:                                 contain https://<hostname> if server uses
                   5591:                                 https (as per hosts.tab), but request is for http
                   5592:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5593: 
1.1075.2.15  raeburn  5594: =item * $advtoolsref, optional argument, ref to an array containing
                   5595:             inlineremote items to be added in "Functions" menu below
                   5596:             breadcrumbs.
                   5597: 
1.112     bowersj2 5598: =back
                   5599: 
1.60      matthew  5600: Returns: A uniform header for LON-CAPA web pages.  
                   5601: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5602: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5603: other decorations will be returned.
                   5604: 
                   5605: =cut
                   5606: 
1.54      www      5607: sub bodytag {
1.831     bisitz   5608:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5609:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5610: 
1.954     raeburn  5611:     my $public;
                   5612:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5613:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5614:         $public = 1;
                   5615:     }
1.460     albertel 5616:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5617:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5618:     my $hostname = $args->{'hostname'};
1.339     albertel 5619: 
1.183     matthew  5620:     $function = &get_users_function() if (!$function);
1.339     albertel 5621:     my $img =    &designparm($function.'.img',$domain);
                   5622:     my $font =   &designparm($function.'.font',$domain);
                   5623:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5624: 
1.803     bisitz   5625:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5626: 		   'bgcolor' => $pgbg,
1.339     albertel 5627: 		   'text'    => $font,
                   5628:                    'alink'   => &designparm($function.'.alink',$domain),
                   5629: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5630: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5631:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5632: 
1.63      www      5633:  # role and realm
1.1075.2.68  raeburn  5634:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5635:     if ($realm) {
                   5636:         $realm = '/'.$realm;
                   5637:     }
1.378     raeburn  5638:     if ($role  eq 'ca') {
1.479     albertel 5639:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5640:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5641:     } 
1.55      www      5642: # realm
1.258     albertel 5643:     if ($env{'request.course.id'}) {
1.378     raeburn  5644:         if ($env{'request.role'} !~ /^cr/) {
                   5645:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5646:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5647:             if ($env{'request.role.desc'}) {
                   5648:                 $role = $env{'request.role.desc'};
                   5649:             } else {
                   5650:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5651:             }
1.1075.2.115  raeburn  5652:         } else {
                   5653:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5654:         }
1.898     raeburn  5655:         if ($env{'request.course.sec'}) {
                   5656:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5657:         }   
1.359     albertel 5658: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5659:     } else {
                   5660:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5661:     }
1.433     albertel 5662: 
1.359     albertel 5663:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5664: 
1.438     albertel 5665:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5666: 
1.101     www      5667: # construct main body tag
1.359     albertel 5668:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5669: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5670: 
1.1075.2.38  raeburn  5671:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5672: 
                   5673:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5674:         return $bodytag;
1.1075.2.38  raeburn  5675:     }
1.359     albertel 5676: 
1.954     raeburn  5677:     if ($public) {
1.433     albertel 5678: 	undef($role);
                   5679:     }
1.359     albertel 5680:     
1.762     bisitz   5681:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5682:     #
                   5683:     # Extra info if you are the DC
                   5684:     my $dc_info = '';
                   5685:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5686:                         $env{'course.'.$env{'request.course.id'}.
                   5687:                                  '.domain'}.'/'})) {
                   5688:         my $cid = $env{'request.course.id'};
1.917     raeburn  5689:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5690:         $dc_info =~ s/\s+$//;
1.359     albertel 5691:     }
                   5692: 
1.1075.2.108  raeburn  5693:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5694: 
1.1075.2.13  raeburn  5695:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5696: 
1.1075.2.38  raeburn  5697: 
                   5698: 
1.1075.2.21  raeburn  5699:     my $funclist;
                   5700:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5701:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5702:                     Apache::lonmenu::serverform();
                   5703:         my $forbodytag;
                   5704:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5705:                                             $forcereg,$args->{'group'},
                   5706:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5707:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5708:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5709:             $funclist = $forbodytag;
                   5710:         }
                   5711:     } else {
1.903     droeschl 5712: 
                   5713:         #    if ($env{'request.state'} eq 'construct') {
                   5714:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5715:         #    }
                   5716: 
1.1075.2.38  raeburn  5717:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5718:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5719: 
1.1075.2.38  raeburn  5720:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2  raeburn  5721: 
1.916     droeschl 5722:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5723:             if ($dc_info) {
                   5724:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5725:             }
1.1075.2.38  raeburn  5726:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5727:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5728:             return $bodytag;
                   5729:         }
1.894     droeschl 5730: 
1.927     raeburn  5731:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5732:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5733:         }
1.916     droeschl 5734: 
1.1075.2.38  raeburn  5735:         $bodytag .= $right;
1.852     droeschl 5736: 
1.917     raeburn  5737:         if ($dc_info) {
                   5738:             $dc_info = &dc_courseid_toggle($dc_info);
                   5739:         }
                   5740:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5741: 
1.1075.2.61  raeburn  5742:         #if directed to not display the secondary menu, don't.
                   5743:         if ($args->{'no_secondary_menu'}) {
                   5744:             return $bodytag;
                   5745:         }
1.903     droeschl 5746:         #don't show menus for public users
1.954     raeburn  5747:         if (!$public){
1.1075.2.52  raeburn  5748:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5749:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5750:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5751:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5752:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5753:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5754:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5755:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5756:                                                             $args->{'group'},
1.1075.2.133  raeburn  5757:                                                             $args->{'hide_buttons',
                   5758:                                                             $hostname});
1.1075.2.15  raeburn  5759:             } else {
1.1075.2.21  raeburn  5760:                 my $forbodytag;
                   5761:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5762:                                                     $forcereg,$args->{'group'},
                   5763:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5764:                                                     $advtoolsref,'',$hostname,
                   5765:                                                     \$forbodytag);
1.1075.2.21  raeburn  5766:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5767:                     $bodytag .= $forbodytag;
                   5768:                 }
1.920     raeburn  5769:             }
1.903     droeschl 5770:         }else{
                   5771:             # this is to seperate menu from content when there's no secondary
                   5772:             # menu. Especially needed for public accessible ressources.
                   5773:             $bodytag .= '<hr style="clear:both" />';
                   5774:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5775:         }
1.903     droeschl 5776: 
1.235     raeburn  5777:         return $bodytag;
1.1075.2.12  raeburn  5778:     }
                   5779: 
                   5780: #
                   5781: # Top frame rendering, Remote is up
                   5782: #
                   5783: 
                   5784:     my $imgsrc = $img;
                   5785:     if ($img =~ /^\/adm/) {
                   5786:         $imgsrc = &lonhttpdurl($img);
                   5787:     }
                   5788:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5789: 
1.1075.2.60  raeburn  5790:     my $help=($no_inline_link?''
                   5791:               :&Apache::loncommon::top_nav_help('Help'));
                   5792: 
1.1075.2.12  raeburn  5793:     # Explicit link to get inline menu
                   5794:     my $menu= ($no_inline_link?''
                   5795:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5796: 
                   5797:     if ($dc_info) {
                   5798:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5799:     }
                   5800: 
1.1075.2.38  raeburn  5801:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5802:     unless ($public) {
                   5803:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5804:                                 undef,'LC_menubuttons_link');
                   5805:     }
                   5806: 
1.1075.2.12  raeburn  5807:     unless ($env{'form.inhibitmenu'}) {
                   5808:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5809:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5810:                        <li>$help</li>
1.1075.2.12  raeburn  5811:                        <li>$menu</li>
                   5812:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5813:     }
1.1075.2.13  raeburn  5814:     if ($env{'request.state'} eq 'construct') {
                   5815:         if (!$public){
                   5816:             if ($env{'request.state'} eq 'construct') {
                   5817:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5818:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5819:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5820:                             &Apache::lonmenu::innerregister($forcereg,
                   5821:                                                             $args->{'bread_crumbs'});
                   5822:             }
                   5823:         }
                   5824:     }
1.1075.2.21  raeburn  5825:     return $bodytag."\n".$funclist;
1.182     matthew  5826: }
                   5827: 
1.917     raeburn  5828: sub dc_courseid_toggle {
                   5829:     my ($dc_info) = @_;
1.980     raeburn  5830:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5831:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5832:            &mt('(More ...)').'</a></span>'.
                   5833:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5834: }
                   5835: 
1.330     albertel 5836: sub make_attr_string {
                   5837:     my ($register,$attr_ref) = @_;
                   5838: 
                   5839:     if ($attr_ref && !ref($attr_ref)) {
                   5840: 	die("addentries Must be a hash ref ".
                   5841: 	    join(':',caller(1))." ".
                   5842: 	    join(':',caller(0))." ");
                   5843:     }
                   5844: 
                   5845:     if ($register) {
1.339     albertel 5846: 	my ($on_load,$on_unload);
                   5847: 	foreach my $key (keys(%{$attr_ref})) {
                   5848: 	    if      (lc($key) eq 'onload') {
                   5849: 		$on_load.=$attr_ref->{$key}.';';
                   5850: 		delete($attr_ref->{$key});
                   5851: 
                   5852: 	    } elsif (lc($key) eq 'onunload') {
                   5853: 		$on_unload.=$attr_ref->{$key}.';';
                   5854: 		delete($attr_ref->{$key});
                   5855: 	    }
                   5856: 	}
1.1075.2.12  raeburn  5857:         if ($env{'environment.remote'} eq 'on') {
                   5858:             $attr_ref->{'onload'}  =
                   5859:                 &Apache::lonmenu::loadevents().  $on_load;
                   5860:             $attr_ref->{'onunload'}=
                   5861:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5862:         } else {  
                   5863: 	    $attr_ref->{'onload'}  = $on_load;
                   5864: 	    $attr_ref->{'onunload'}= $on_unload;
                   5865:         }
1.330     albertel 5866:     }
1.339     albertel 5867: 
1.330     albertel 5868:     my $attr_string;
1.1075.2.56  raeburn  5869:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5870: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5871:     }
                   5872:     return $attr_string;
                   5873: }
                   5874: 
                   5875: 
1.182     matthew  5876: ###############################################
1.251     albertel 5877: ###############################################
                   5878: 
                   5879: =pod
                   5880: 
                   5881: =item * &endbodytag()
                   5882: 
                   5883: Returns a uniform footer for LON-CAPA web pages.
                   5884: 
1.635     raeburn  5885: Inputs: 1 - optional reference to an args hash
                   5886: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5887: a 'Continue' link is not displayed if the page contains an
                   5888: internal redirect in the <head></head> section,
                   5889: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5890: 
                   5891: =cut
                   5892: 
                   5893: sub endbodytag {
1.635     raeburn  5894:     my ($args) = @_;
1.1075.2.6  raeburn  5895:     my $endbodytag;
                   5896:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5897:         $endbodytag='</body>';
                   5898:     }
1.315     albertel 5899:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5900:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5901: 	    $endbodytag=
                   5902: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5903: 	        &mt('Continue').'</a>'.
                   5904: 	        $endbodytag;
                   5905:         }
1.315     albertel 5906:     }
1.251     albertel 5907:     return $endbodytag;
                   5908: }
                   5909: 
1.352     albertel 5910: =pod
                   5911: 
                   5912: =item * &standard_css()
                   5913: 
                   5914: Returns a style sheet
                   5915: 
                   5916: Inputs: (all optional)
                   5917:             domain         -> force to color decorate a page for a specific
                   5918:                                domain
                   5919:             function       -> force usage of a specific rolish color scheme
                   5920:             bgcolor        -> override the default page bgcolor
                   5921: 
                   5922: =cut
                   5923: 
1.343     albertel 5924: sub standard_css {
1.345     albertel 5925:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5926:     $function  = &get_users_function() if (!$function);
                   5927:     my $img    = &designparm($function.'.img',   $domain);
                   5928:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5929:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5930:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5931: #second colour for later usage
1.345     albertel 5932:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5933:     my $pgbg_or_bgcolor =
                   5934: 	         $bgcolor ||
1.352     albertel 5935: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5936:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5937:     my $alink  = &designparm($function.'.alink', $domain);
                   5938:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5939:     my $link   = &designparm($function.'.link',  $domain);
                   5940: 
1.602     albertel 5941:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5942:     my $mono                 = 'monospace';
1.850     bisitz   5943:     my $data_table_head      = $sidebg;
                   5944:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5945:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5946:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5947:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5948:     my $mail_new             = '#FFBB77';
                   5949:     my $mail_new_hover       = '#DD9955';
                   5950:     my $mail_read            = '#BBBB77';
                   5951:     my $mail_read_hover      = '#999944';
                   5952:     my $mail_replied         = '#AAAA88';
                   5953:     my $mail_replied_hover   = '#888855';
                   5954:     my $mail_other           = '#99BBBB';
                   5955:     my $mail_other_hover     = '#669999';
1.391     albertel 5956:     my $table_header         = '#DDDDDD';
1.489     raeburn  5957:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5958:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5959:     my $button_hover         = '#BF2317';
1.392     albertel 5960: 
1.608     albertel 5961:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5962:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5963:                                              : '0 3px 0 4px';
1.448     albertel 5964: 
1.523     albertel 5965: 
1.343     albertel 5966:     return <<END;
1.947     droeschl 5967: 
                   5968: /* needed for iframe to allow 100% height in FF */
                   5969: body, html { 
                   5970:     margin: 0;
                   5971:     padding: 0 0.5%;
                   5972:     height: 99%; /* to avoid scrollbars */
                   5973: }
                   5974: 
1.795     www      5975: body {
1.911     bisitz   5976:   font-family: $sans;
                   5977:   line-height:130%;
                   5978:   font-size:0.83em;
                   5979:   color:$font;
1.795     www      5980: }
                   5981: 
1.959     onken    5982: a:focus,
                   5983: a:focus img {
1.795     www      5984:   color: red;
                   5985: }
1.698     harmsja  5986: 
1.911     bisitz   5987: form, .inline {
                   5988:   display: inline;
1.795     www      5989: }
1.721     harmsja  5990: 
1.795     www      5991: .LC_right {
1.911     bisitz   5992:   text-align:right;
1.795     www      5993: }
                   5994: 
                   5995: .LC_middle {
1.911     bisitz   5996:   vertical-align:middle;
1.795     www      5997: }
1.721     harmsja  5998: 
1.1075.2.38  raeburn  5999: .LC_floatleft {
                   6000:   float: left;
                   6001: }
                   6002: 
                   6003: .LC_floatright {
                   6004:   float: right;
                   6005: }
                   6006: 
1.911     bisitz   6007: .LC_400Box {
                   6008:   width:400px;
                   6009: }
1.721     harmsja  6010: 
1.947     droeschl 6011: .LC_iframecontainer {
                   6012:     width: 98%;
                   6013:     margin: 0;
                   6014:     position: fixed;
                   6015:     top: 8.5em;
                   6016:     bottom: 0;
                   6017: }
                   6018: 
                   6019: .LC_iframecontainer iframe{
                   6020:     border: none;
                   6021:     width: 100%;
                   6022:     height: 100%;
                   6023: }
                   6024: 
1.778     bisitz   6025: .LC_filename {
                   6026:   font-family: $mono;
                   6027:   white-space:pre;
1.921     bisitz   6028:   font-size: 120%;
1.778     bisitz   6029: }
                   6030: 
                   6031: .LC_fileicon {
                   6032:   border: none;
                   6033:   height: 1.3em;
                   6034:   vertical-align: text-bottom;
                   6035:   margin-right: 0.3em;
                   6036:   text-decoration:none;
                   6037: }
                   6038: 
1.1008    www      6039: .LC_setting {
                   6040:   text-decoration:underline;
                   6041: }
                   6042: 
1.350     albertel 6043: .LC_error {
                   6044:   color: red;
                   6045: }
1.795     www      6046: 
1.1075.2.15  raeburn  6047: .LC_warning {
                   6048:   color: darkorange;
                   6049: }
                   6050: 
1.457     albertel 6051: .LC_diff_removed {
1.733     bisitz   6052:   color: red;
1.394     albertel 6053: }
1.532     albertel 6054: 
                   6055: .LC_info,
1.457     albertel 6056: .LC_success,
                   6057: .LC_diff_added {
1.350     albertel 6058:   color: green;
                   6059: }
1.795     www      6060: 
1.802     bisitz   6061: div.LC_confirm_box {
                   6062:   background-color: #FAFAFA;
                   6063:   border: 1px solid $lg_border_color;
                   6064:   margin-right: 0;
                   6065:   padding: 5px;
                   6066: }
                   6067: 
                   6068: div.LC_confirm_box .LC_error img,
                   6069: div.LC_confirm_box .LC_success img {
                   6070:   vertical-align: middle;
                   6071: }
                   6072: 
1.1075.2.108  raeburn  6073: .LC_maxwidth {
                   6074:   max-width: 100%;
                   6075:   height: auto;
                   6076: }
                   6077: 
                   6078: .LC_textsize_mobile {
                   6079:   \@media only screen and (max-device-width: 480px) {
                   6080:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6081:   }
                   6082: }
                   6083: 
1.440     albertel 6084: .LC_icon {
1.771     droeschl 6085:   border: none;
1.790     droeschl 6086:   vertical-align: middle;
1.771     droeschl 6087: }
                   6088: 
1.543     albertel 6089: .LC_docs_spacer {
                   6090:   width: 25px;
                   6091:   height: 1px;
1.771     droeschl 6092:   border: none;
1.543     albertel 6093: }
1.346     albertel 6094: 
1.532     albertel 6095: .LC_internal_info {
1.735     bisitz   6096:   color: #999999;
1.532     albertel 6097: }
                   6098: 
1.794     www      6099: .LC_discussion {
1.1050    www      6100:   background: $data_table_dark;
1.911     bisitz   6101:   border: 1px solid black;
                   6102:   margin: 2px;
1.794     www      6103: }
                   6104: 
                   6105: .LC_disc_action_left {
1.1050    www      6106:   background: $sidebg;
1.911     bisitz   6107:   text-align: left;
1.1050    www      6108:   padding: 4px;
                   6109:   margin: 2px;
1.794     www      6110: }
                   6111: 
                   6112: .LC_disc_action_right {
1.1050    www      6113:   background: $sidebg;
1.911     bisitz   6114:   text-align: right;
1.1050    www      6115:   padding: 4px;
                   6116:   margin: 2px;
1.794     www      6117: }
                   6118: 
                   6119: .LC_disc_new_item {
1.911     bisitz   6120:   background: white;
                   6121:   border: 2px solid red;
1.1050    www      6122:   margin: 4px;
                   6123:   padding: 4px;
1.794     www      6124: }
                   6125: 
                   6126: .LC_disc_old_item {
1.911     bisitz   6127:   background: white;
1.1050    www      6128:   margin: 4px;
                   6129:   padding: 4px;
1.794     www      6130: }
                   6131: 
1.458     albertel 6132: table.LC_pastsubmission {
                   6133:   border: 1px solid black;
                   6134:   margin: 2px;
                   6135: }
                   6136: 
1.924     bisitz   6137: table#LC_menubuttons {
1.345     albertel 6138:   width: 100%;
                   6139:   background: $pgbg;
1.392     albertel 6140:   border: 2px;
1.402     albertel 6141:   border-collapse: separate;
1.803     bisitz   6142:   padding: 0;
1.345     albertel 6143: }
1.392     albertel 6144: 
1.801     tempelho 6145: table#LC_title_bar a {
                   6146:   color: $fontmenu;
                   6147: }
1.836     bisitz   6148: 
1.807     droeschl 6149: table#LC_title_bar {
1.819     tempelho 6150:   clear: both;
1.836     bisitz   6151:   display: none;
1.807     droeschl 6152: }
                   6153: 
1.795     www      6154: table#LC_title_bar,
1.933     droeschl 6155: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6156: table#LC_title_bar.LC_with_remote {
1.359     albertel 6157:   width: 100%;
1.392     albertel 6158:   border-color: $pgbg;
                   6159:   border-style: solid;
                   6160:   border-width: $border;
1.379     albertel 6161:   background: $pgbg;
1.801     tempelho 6162:   color: $fontmenu;
1.392     albertel 6163:   border-collapse: collapse;
1.803     bisitz   6164:   padding: 0;
1.819     tempelho 6165:   margin: 0;
1.359     albertel 6166: }
1.795     www      6167: 
1.933     droeschl 6168: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6169:     margin: 0;
                   6170:     padding: 0;
1.933     droeschl 6171:     position: relative;
                   6172:     list-style: none;
1.913     droeschl 6173: }
1.933     droeschl 6174: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6175:     display: inline;
                   6176: }
1.933     droeschl 6177: 
                   6178: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6179:     padding: 0;
1.933     droeschl 6180:     margin: 0;
                   6181:     float: left;
1.913     droeschl 6182: }
1.933     droeschl 6183: .LC_breadcrumb_tools_tools {
                   6184:     padding: 0;
                   6185:     margin: 0;
1.913     droeschl 6186:     float: right;
                   6187: }
                   6188: 
1.359     albertel 6189: table#LC_title_bar td {
                   6190:   background: $tabbg;
                   6191: }
1.795     www      6192: 
1.911     bisitz   6193: table#LC_menubuttons img {
1.803     bisitz   6194:   border: none;
1.346     albertel 6195: }
1.795     www      6196: 
1.842     droeschl 6197: .LC_breadcrumbs_component {
1.911     bisitz   6198:   float: right;
                   6199:   margin: 0 1em;
1.357     albertel 6200: }
1.842     droeschl 6201: .LC_breadcrumbs_component img {
1.911     bisitz   6202:   vertical-align: middle;
1.777     tempelho 6203: }
1.795     www      6204: 
1.1075.2.108  raeburn  6205: .LC_breadcrumbs_hoverable {
                   6206:   background: $sidebg;
                   6207: }
                   6208: 
1.383     albertel 6209: td.LC_table_cell_checkbox {
                   6210:   text-align: center;
                   6211: }
1.795     www      6212: 
                   6213: .LC_fontsize_small {
1.911     bisitz   6214:   font-size: 70%;
1.705     tempelho 6215: }
                   6216: 
1.844     bisitz   6217: #LC_breadcrumbs {
1.911     bisitz   6218:   clear:both;
                   6219:   background: $sidebg;
                   6220:   border-bottom: 1px solid $lg_border_color;
                   6221:   line-height: 2.5em;
1.933     droeschl 6222:   overflow: hidden;
1.911     bisitz   6223:   margin: 0;
                   6224:   padding: 0;
1.995     raeburn  6225:   text-align: left;
1.819     tempelho 6226: }
1.862     bisitz   6227: 
1.1075.2.16  raeburn  6228: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6229:   clear:both;
                   6230:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6231:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6232:   margin: 0 0 10px 0;
1.966     bisitz   6233:   padding: 3px;
1.995     raeburn  6234:   text-align: left;
1.822     bisitz   6235: }
                   6236: 
1.795     www      6237: .LC_fontsize_medium {
1.911     bisitz   6238:   font-size: 85%;
1.705     tempelho 6239: }
                   6240: 
1.795     www      6241: .LC_fontsize_large {
1.911     bisitz   6242:   font-size: 120%;
1.705     tempelho 6243: }
                   6244: 
1.346     albertel 6245: .LC_menubuttons_inline_text {
                   6246:   color: $font;
1.698     harmsja  6247:   font-size: 90%;
1.701     harmsja  6248:   padding-left:3px;
1.346     albertel 6249: }
                   6250: 
1.934     droeschl 6251: .LC_menubuttons_inline_text img{
                   6252:   vertical-align: middle;
                   6253: }
                   6254: 
1.1051    www      6255: li.LC_menubuttons_inline_text img {
1.951     onken    6256:   cursor:pointer;
1.1002    droeschl 6257:   text-decoration: none;
1.951     onken    6258: }
                   6259: 
1.526     www      6260: .LC_menubuttons_link {
                   6261:   text-decoration: none;
                   6262: }
1.795     www      6263: 
1.522     albertel 6264: .LC_menubuttons_category {
1.521     www      6265:   color: $font;
1.526     www      6266:   background: $pgbg;
1.521     www      6267:   font-size: larger;
                   6268:   font-weight: bold;
                   6269: }
                   6270: 
1.346     albertel 6271: td.LC_menubuttons_text {
1.911     bisitz   6272:   color: $font;
1.346     albertel 6273: }
1.706     harmsja  6274: 
1.346     albertel 6275: .LC_current_location {
                   6276:   background: $tabbg;
                   6277: }
1.795     www      6278: 
1.1075.2.134  raeburn  6279: td.LC_zero_height {
                   6280:   line-height: 0;
                   6281:   cellpadding: 0;
                   6282: }
                   6283: 
1.938     bisitz   6284: table.LC_data_table {
1.347     albertel 6285:   border: 1px solid #000000;
1.402     albertel 6286:   border-collapse: separate;
1.426     albertel 6287:   border-spacing: 1px;
1.610     albertel 6288:   background: $pgbg;
1.347     albertel 6289: }
1.795     www      6290: 
1.422     albertel 6291: .LC_data_table_dense {
                   6292:   font-size: small;
                   6293: }
1.795     www      6294: 
1.507     raeburn  6295: table.LC_nested_outer {
                   6296:   border: 1px solid #000000;
1.589     raeburn  6297:   border-collapse: collapse;
1.803     bisitz   6298:   border-spacing: 0;
1.507     raeburn  6299:   width: 100%;
                   6300: }
1.795     www      6301: 
1.879     raeburn  6302: table.LC_innerpickbox,
1.507     raeburn  6303: table.LC_nested {
1.803     bisitz   6304:   border: none;
1.589     raeburn  6305:   border-collapse: collapse;
1.803     bisitz   6306:   border-spacing: 0;
1.507     raeburn  6307:   width: 100%;
                   6308: }
1.795     www      6309: 
1.911     bisitz   6310: table.LC_data_table tr th,
                   6311: table.LC_calendar tr th,
1.879     raeburn  6312: table.LC_prior_tries tr th,
                   6313: table.LC_innerpickbox tr th {
1.349     albertel 6314:   font-weight: bold;
                   6315:   background-color: $data_table_head;
1.801     tempelho 6316:   color:$fontmenu;
1.701     harmsja  6317:   font-size:90%;
1.347     albertel 6318: }
1.795     www      6319: 
1.879     raeburn  6320: table.LC_innerpickbox tr th,
                   6321: table.LC_innerpickbox tr td {
                   6322:   vertical-align: top;
                   6323: }
                   6324: 
1.711     raeburn  6325: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6326:   background-color: #CCCCCC;
1.711     raeburn  6327:   font-weight: bold;
                   6328:   text-align: left;
                   6329: }
1.795     www      6330: 
1.912     bisitz   6331: table.LC_data_table tr.LC_odd_row > td {
                   6332:   background-color: $data_table_light;
                   6333:   padding: 2px;
                   6334:   vertical-align: top;
                   6335: }
                   6336: 
1.809     bisitz   6337: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6338:   background-color: $data_table_light;
1.912     bisitz   6339:   vertical-align: top;
                   6340: }
                   6341: 
                   6342: table.LC_data_table tr.LC_even_row > td {
                   6343:   background-color: $data_table_dark;
1.425     albertel 6344:   padding: 2px;
1.900     bisitz   6345:   vertical-align: top;
1.347     albertel 6346: }
1.795     www      6347: 
1.809     bisitz   6348: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6349:   background-color: $data_table_dark;
1.900     bisitz   6350:   vertical-align: top;
1.347     albertel 6351: }
1.795     www      6352: 
1.425     albertel 6353: table.LC_data_table tr.LC_data_table_highlight td {
                   6354:   background-color: $data_table_darker;
                   6355: }
1.795     www      6356: 
1.639     raeburn  6357: table.LC_data_table tr td.LC_leftcol_header {
                   6358:   background-color: $data_table_head;
                   6359:   font-weight: bold;
                   6360: }
1.795     www      6361: 
1.451     albertel 6362: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6363: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6364:   font-weight: bold;
                   6365:   font-style: italic;
                   6366:   text-align: center;
                   6367:   padding: 8px;
1.347     albertel 6368: }
1.795     www      6369: 
1.1075.2.30  raeburn  6370: table.LC_data_table tr.LC_empty_row td,
                   6371: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6372:   background-color: $sidebg;
                   6373: }
                   6374: 
                   6375: table.LC_nested tr.LC_empty_row td {
                   6376:   background-color: #FFFFFF;
                   6377: }
                   6378: 
1.890     droeschl 6379: table.LC_caption {
                   6380: }
                   6381: 
1.507     raeburn  6382: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6383:   padding: 4ex
                   6384: }
1.795     www      6385: 
1.507     raeburn  6386: table.LC_nested_outer tr th {
                   6387:   font-weight: bold;
1.801     tempelho 6388:   color:$fontmenu;
1.507     raeburn  6389:   background-color: $data_table_head;
1.701     harmsja  6390:   font-size: small;
1.507     raeburn  6391:   border-bottom: 1px solid #000000;
                   6392: }
1.795     www      6393: 
1.507     raeburn  6394: table.LC_nested_outer tr td.LC_subheader {
                   6395:   background-color: $data_table_head;
                   6396:   font-weight: bold;
                   6397:   font-size: small;
                   6398:   border-bottom: 1px solid #000000;
                   6399:   text-align: right;
1.451     albertel 6400: }
1.795     www      6401: 
1.507     raeburn  6402: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6403:   background-color: #CCCCCC;
1.451     albertel 6404:   font-weight: bold;
                   6405:   font-size: small;
1.507     raeburn  6406:   text-align: center;
                   6407: }
1.795     www      6408: 
1.589     raeburn  6409: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6410: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6411:   text-align: left;
1.451     albertel 6412: }
1.795     www      6413: 
1.507     raeburn  6414: table.LC_nested td {
1.735     bisitz   6415:   background-color: #FFFFFF;
1.451     albertel 6416:   font-size: small;
1.507     raeburn  6417: }
1.795     www      6418: 
1.507     raeburn  6419: table.LC_nested_outer tr th.LC_right_item,
                   6420: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6421: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6422: table.LC_nested tr td.LC_right_item {
1.451     albertel 6423:   text-align: right;
                   6424: }
                   6425: 
1.507     raeburn  6426: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6427:   background-color: #EEEEEE;
1.451     albertel 6428: }
                   6429: 
1.473     raeburn  6430: table.LC_createuser {
                   6431: }
                   6432: 
                   6433: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6434:   font-size: small;
1.473     raeburn  6435: }
                   6436: 
                   6437: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6438:   background-color: #CCCCCC;
1.473     raeburn  6439:   font-weight: bold;
                   6440:   text-align: center;
                   6441: }
                   6442: 
1.349     albertel 6443: table.LC_calendar {
                   6444:   border: 1px solid #000000;
                   6445:   border-collapse: collapse;
1.917     raeburn  6446:   width: 98%;
1.349     albertel 6447: }
1.795     www      6448: 
1.349     albertel 6449: table.LC_calendar_pickdate {
                   6450:   font-size: xx-small;
                   6451: }
1.795     www      6452: 
1.349     albertel 6453: table.LC_calendar tr td {
                   6454:   border: 1px solid #000000;
                   6455:   vertical-align: top;
1.917     raeburn  6456:   width: 14%;
1.349     albertel 6457: }
1.795     www      6458: 
1.349     albertel 6459: table.LC_calendar tr td.LC_calendar_day_empty {
                   6460:   background-color: $data_table_dark;
                   6461: }
1.795     www      6462: 
1.779     bisitz   6463: table.LC_calendar tr td.LC_calendar_day_current {
                   6464:   background-color: $data_table_highlight;
1.777     tempelho 6465: }
1.795     www      6466: 
1.938     bisitz   6467: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6468:   background-color: $mail_new;
                   6469: }
1.795     www      6470: 
1.938     bisitz   6471: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6472:   background-color: $mail_new_hover;
                   6473: }
1.795     www      6474: 
1.938     bisitz   6475: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6476:   background-color: $mail_read;
                   6477: }
1.795     www      6478: 
1.938     bisitz   6479: /*
                   6480: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6481:   background-color: $mail_read_hover;
                   6482: }
1.938     bisitz   6483: */
1.795     www      6484: 
1.938     bisitz   6485: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6486:   background-color: $mail_replied;
                   6487: }
1.795     www      6488: 
1.938     bisitz   6489: /*
                   6490: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6491:   background-color: $mail_replied_hover;
                   6492: }
1.938     bisitz   6493: */
1.795     www      6494: 
1.938     bisitz   6495: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6496:   background-color: $mail_other;
                   6497: }
1.795     www      6498: 
1.938     bisitz   6499: /*
                   6500: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6501:   background-color: $mail_other_hover;
                   6502: }
1.938     bisitz   6503: */
1.494     raeburn  6504: 
1.777     tempelho 6505: table.LC_data_table tr > td.LC_browser_file,
                   6506: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6507:   background: #AAEE77;
1.389     albertel 6508: }
1.795     www      6509: 
1.777     tempelho 6510: table.LC_data_table tr > td.LC_browser_file_locked,
                   6511: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6512:   background: #FFAA99;
1.387     albertel 6513: }
1.795     www      6514: 
1.777     tempelho 6515: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6516:   background: #888888;
1.779     bisitz   6517: }
1.795     www      6518: 
1.777     tempelho 6519: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6520: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6521:   background: #F8F866;
1.777     tempelho 6522: }
1.795     www      6523: 
1.696     bisitz   6524: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6525:   background: #E0E8FF;
1.387     albertel 6526: }
1.696     bisitz   6527: 
1.707     bisitz   6528: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6529:   /* background: #77FF77; */
1.707     bisitz   6530: }
1.795     www      6531: 
1.707     bisitz   6532: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6533:   border-right: 8px solid #FFFF77;
1.707     bisitz   6534: }
1.795     www      6535: 
1.707     bisitz   6536: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6537:   border-right: 8px solid #FFAA77;
1.707     bisitz   6538: }
1.795     www      6539: 
1.707     bisitz   6540: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6541:   border-right: 8px solid #FF7777;
1.707     bisitz   6542: }
1.795     www      6543: 
1.707     bisitz   6544: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6545:   border-right: 8px solid #AAFF77;
1.707     bisitz   6546: }
1.795     www      6547: 
1.707     bisitz   6548: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6549:   border-right: 8px solid #11CC55;
1.707     bisitz   6550: }
                   6551: 
1.388     albertel 6552: span.LC_current_location {
1.701     harmsja  6553:   font-size:larger;
1.388     albertel 6554:   background: $pgbg;
                   6555: }
1.387     albertel 6556: 
1.1029    www      6557: span.LC_current_nav_location {
                   6558:   font-weight:bold;
                   6559:   background: $sidebg;
                   6560: }
                   6561: 
1.395     albertel 6562: span.LC_parm_menu_item {
                   6563:   font-size: larger;
                   6564: }
1.795     www      6565: 
1.395     albertel 6566: span.LC_parm_scope_all {
                   6567:   color: red;
                   6568: }
1.795     www      6569: 
1.395     albertel 6570: span.LC_parm_scope_folder {
                   6571:   color: green;
                   6572: }
1.795     www      6573: 
1.395     albertel 6574: span.LC_parm_scope_resource {
                   6575:   color: orange;
                   6576: }
1.795     www      6577: 
1.395     albertel 6578: span.LC_parm_part {
                   6579:   color: blue;
                   6580: }
1.795     www      6581: 
1.911     bisitz   6582: span.LC_parm_folder,
                   6583: span.LC_parm_symb {
1.395     albertel 6584:   font-size: x-small;
                   6585:   font-family: $mono;
                   6586:   color: #AAAAAA;
                   6587: }
                   6588: 
1.977     bisitz   6589: ul.LC_parm_parmlist li {
                   6590:   display: inline-block;
                   6591:   padding: 0.3em 0.8em;
                   6592:   vertical-align: top;
                   6593:   width: 150px;
                   6594:   border-top:1px solid $lg_border_color;
                   6595: }
                   6596: 
1.795     www      6597: td.LC_parm_overview_level_menu,
                   6598: td.LC_parm_overview_map_menu,
                   6599: td.LC_parm_overview_parm_selectors,
                   6600: td.LC_parm_overview_restrictions  {
1.396     albertel 6601:   border: 1px solid black;
                   6602:   border-collapse: collapse;
                   6603: }
1.795     www      6604: 
1.396     albertel 6605: table.LC_parm_overview_restrictions td {
                   6606:   border-width: 1px 4px 1px 4px;
                   6607:   border-style: solid;
                   6608:   border-color: $pgbg;
                   6609:   text-align: center;
                   6610: }
1.795     www      6611: 
1.396     albertel 6612: table.LC_parm_overview_restrictions th {
                   6613:   background: $tabbg;
                   6614:   border-width: 1px 4px 1px 4px;
                   6615:   border-style: solid;
                   6616:   border-color: $pgbg;
                   6617: }
1.795     www      6618: 
1.398     albertel 6619: table#LC_helpmenu {
1.803     bisitz   6620:   border: none;
1.398     albertel 6621:   height: 55px;
1.803     bisitz   6622:   border-spacing: 0;
1.398     albertel 6623: }
                   6624: 
                   6625: table#LC_helpmenu fieldset legend {
                   6626:   font-size: larger;
                   6627: }
1.795     www      6628: 
1.397     albertel 6629: table#LC_helpmenu_links {
                   6630:   width: 100%;
                   6631:   border: 1px solid black;
                   6632:   background: $pgbg;
1.803     bisitz   6633:   padding: 0;
1.397     albertel 6634:   border-spacing: 1px;
                   6635: }
1.795     www      6636: 
1.397     albertel 6637: table#LC_helpmenu_links tr td {
                   6638:   padding: 1px;
                   6639:   background: $tabbg;
1.399     albertel 6640:   text-align: center;
                   6641:   font-weight: bold;
1.397     albertel 6642: }
1.396     albertel 6643: 
1.795     www      6644: table#LC_helpmenu_links a:link,
                   6645: table#LC_helpmenu_links a:visited,
1.397     albertel 6646: table#LC_helpmenu_links a:active {
                   6647:   text-decoration: none;
                   6648:   color: $font;
                   6649: }
1.795     www      6650: 
1.397     albertel 6651: table#LC_helpmenu_links a:hover {
                   6652:   text-decoration: underline;
                   6653:   color: $vlink;
                   6654: }
1.396     albertel 6655: 
1.417     albertel 6656: .LC_chrt_popup_exists {
                   6657:   border: 1px solid #339933;
                   6658:   margin: -1px;
                   6659: }
1.795     www      6660: 
1.417     albertel 6661: .LC_chrt_popup_up {
                   6662:   border: 1px solid yellow;
                   6663:   margin: -1px;
                   6664: }
1.795     www      6665: 
1.417     albertel 6666: .LC_chrt_popup {
                   6667:   border: 1px solid #8888FF;
                   6668:   background: #CCCCFF;
                   6669: }
1.795     www      6670: 
1.421     albertel 6671: table.LC_pick_box {
                   6672:   border-collapse: separate;
                   6673:   background: white;
                   6674:   border: 1px solid black;
                   6675:   border-spacing: 1px;
                   6676: }
1.795     www      6677: 
1.421     albertel 6678: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6679:   background: $sidebg;
1.421     albertel 6680:   font-weight: bold;
1.900     bisitz   6681:   text-align: left;
1.740     bisitz   6682:   vertical-align: top;
1.421     albertel 6683:   width: 184px;
                   6684:   padding: 8px;
                   6685: }
1.795     www      6686: 
1.579     raeburn  6687: table.LC_pick_box td.LC_pick_box_value {
                   6688:   text-align: left;
                   6689:   padding: 8px;
                   6690: }
1.795     www      6691: 
1.579     raeburn  6692: table.LC_pick_box td.LC_pick_box_select {
                   6693:   text-align: left;
                   6694:   padding: 8px;
                   6695: }
1.795     www      6696: 
1.424     albertel 6697: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6698:   padding: 0;
1.421     albertel 6699:   height: 1px;
                   6700:   background: black;
                   6701: }
1.795     www      6702: 
1.421     albertel 6703: table.LC_pick_box td.LC_pick_box_submit {
                   6704:   text-align: right;
                   6705: }
1.795     www      6706: 
1.579     raeburn  6707: table.LC_pick_box td.LC_evenrow_value {
                   6708:   text-align: left;
                   6709:   padding: 8px;
                   6710:   background-color: $data_table_light;
                   6711: }
1.795     www      6712: 
1.579     raeburn  6713: table.LC_pick_box td.LC_oddrow_value {
                   6714:   text-align: left;
                   6715:   padding: 8px;
                   6716:   background-color: $data_table_light;
                   6717: }
1.795     www      6718: 
1.579     raeburn  6719: span.LC_helpform_receipt_cat {
                   6720:   font-weight: bold;
                   6721: }
1.795     www      6722: 
1.424     albertel 6723: table.LC_group_priv_box {
                   6724:   background: white;
                   6725:   border: 1px solid black;
                   6726:   border-spacing: 1px;
                   6727: }
1.795     www      6728: 
1.424     albertel 6729: table.LC_group_priv_box td.LC_pick_box_title {
                   6730:   background: $tabbg;
                   6731:   font-weight: bold;
                   6732:   text-align: right;
                   6733:   width: 184px;
                   6734: }
1.795     www      6735: 
1.424     albertel 6736: table.LC_group_priv_box td.LC_groups_fixed {
                   6737:   background: $data_table_light;
                   6738:   text-align: center;
                   6739: }
1.795     www      6740: 
1.424     albertel 6741: table.LC_group_priv_box td.LC_groups_optional {
                   6742:   background: $data_table_dark;
                   6743:   text-align: center;
                   6744: }
1.795     www      6745: 
1.424     albertel 6746: table.LC_group_priv_box td.LC_groups_functionality {
                   6747:   background: $data_table_darker;
                   6748:   text-align: center;
                   6749:   font-weight: bold;
                   6750: }
1.795     www      6751: 
1.424     albertel 6752: table.LC_group_priv td {
                   6753:   text-align: left;
1.803     bisitz   6754:   padding: 0;
1.424     albertel 6755: }
                   6756: 
                   6757: .LC_navbuttons {
                   6758:   margin: 2ex 0ex 2ex 0ex;
                   6759: }
1.795     www      6760: 
1.423     albertel 6761: .LC_topic_bar {
                   6762:   font-weight: bold;
                   6763:   background: $tabbg;
1.918     wenzelju 6764:   margin: 1em 0em 1em 2em;
1.805     bisitz   6765:   padding: 3px;
1.918     wenzelju 6766:   font-size: 1.2em;
1.423     albertel 6767: }
1.795     www      6768: 
1.423     albertel 6769: .LC_topic_bar span {
1.918     wenzelju 6770:   left: 0.5em;
                   6771:   position: absolute;
1.423     albertel 6772:   vertical-align: middle;
1.918     wenzelju 6773:   font-size: 1.2em;
1.423     albertel 6774: }
1.795     www      6775: 
1.423     albertel 6776: table.LC_course_group_status {
                   6777:   margin: 20px;
                   6778: }
1.795     www      6779: 
1.423     albertel 6780: table.LC_status_selector td {
                   6781:   vertical-align: top;
                   6782:   text-align: center;
1.424     albertel 6783:   padding: 4px;
                   6784: }
1.795     www      6785: 
1.599     albertel 6786: div.LC_feedback_link {
1.616     albertel 6787:   clear: both;
1.829     kalberla 6788:   background: $sidebg;
1.779     bisitz   6789:   width: 100%;
1.829     kalberla 6790:   padding-bottom: 10px;
                   6791:   border: 1px $tabbg solid;
1.833     kalberla 6792:   height: 22px;
                   6793:   line-height: 22px;
                   6794:   padding-top: 5px;
                   6795: }
                   6796: 
                   6797: div.LC_feedback_link img {
                   6798:   height: 22px;
1.867     kalberla 6799:   vertical-align:middle;
1.829     kalberla 6800: }
                   6801: 
1.911     bisitz   6802: div.LC_feedback_link a {
1.829     kalberla 6803:   text-decoration: none;
1.489     raeburn  6804: }
1.795     www      6805: 
1.867     kalberla 6806: div.LC_comblock {
1.911     bisitz   6807:   display:inline;
1.867     kalberla 6808:   color:$font;
                   6809:   font-size:90%;
                   6810: }
                   6811: 
                   6812: div.LC_feedback_link div.LC_comblock {
                   6813:   padding-left:5px;
                   6814: }
                   6815: 
                   6816: div.LC_feedback_link div.LC_comblock a {
                   6817:   color:$font;
                   6818: }
                   6819: 
1.489     raeburn  6820: span.LC_feedback_link {
1.858     bisitz   6821:   /* background: $feedback_link_bg; */
1.599     albertel 6822:   font-size: larger;
                   6823: }
1.795     www      6824: 
1.599     albertel 6825: span.LC_message_link {
1.858     bisitz   6826:   /* background: $feedback_link_bg; */
1.599     albertel 6827:   font-size: larger;
                   6828:   position: absolute;
                   6829:   right: 1em;
1.489     raeburn  6830: }
1.421     albertel 6831: 
1.515     albertel 6832: table.LC_prior_tries {
1.524     albertel 6833:   border: 1px solid #000000;
                   6834:   border-collapse: separate;
                   6835:   border-spacing: 1px;
1.515     albertel 6836: }
1.523     albertel 6837: 
1.515     albertel 6838: table.LC_prior_tries td {
1.524     albertel 6839:   padding: 2px;
1.515     albertel 6840: }
1.523     albertel 6841: 
                   6842: .LC_answer_correct {
1.795     www      6843:   background: lightgreen;
                   6844:   color: darkgreen;
                   6845:   padding: 6px;
1.523     albertel 6846: }
1.795     www      6847: 
1.523     albertel 6848: .LC_answer_charged_try {
1.797     www      6849:   background: #FFAAAA;
1.795     www      6850:   color: darkred;
                   6851:   padding: 6px;
1.523     albertel 6852: }
1.795     www      6853: 
1.779     bisitz   6854: .LC_answer_not_charged_try,
1.523     albertel 6855: .LC_answer_no_grade,
                   6856: .LC_answer_late {
1.795     www      6857:   background: lightyellow;
1.523     albertel 6858:   color: black;
1.795     www      6859:   padding: 6px;
1.523     albertel 6860: }
1.795     www      6861: 
1.523     albertel 6862: .LC_answer_previous {
1.795     www      6863:   background: lightblue;
                   6864:   color: darkblue;
                   6865:   padding: 6px;
1.523     albertel 6866: }
1.795     www      6867: 
1.779     bisitz   6868: .LC_answer_no_message {
1.777     tempelho 6869:   background: #FFFFFF;
                   6870:   color: black;
1.795     www      6871:   padding: 6px;
1.779     bisitz   6872: }
1.795     www      6873: 
1.1075.2.140  raeburn  6874: .LC_answer_unknown,
                   6875: .LC_answer_warning {
1.779     bisitz   6876:   background: orange;
                   6877:   color: black;
1.795     www      6878:   padding: 6px;
1.777     tempelho 6879: }
1.795     www      6880: 
1.529     albertel 6881: span.LC_prior_numerical,
                   6882: span.LC_prior_string,
                   6883: span.LC_prior_custom,
                   6884: span.LC_prior_reaction,
                   6885: span.LC_prior_math {
1.925     bisitz   6886:   font-family: $mono;
1.523     albertel 6887:   white-space: pre;
                   6888: }
                   6889: 
1.525     albertel 6890: span.LC_prior_string {
1.925     bisitz   6891:   font-family: $mono;
1.525     albertel 6892:   white-space: pre;
                   6893: }
                   6894: 
1.523     albertel 6895: table.LC_prior_option {
                   6896:   width: 100%;
                   6897:   border-collapse: collapse;
                   6898: }
1.795     www      6899: 
1.911     bisitz   6900: table.LC_prior_rank,
1.795     www      6901: table.LC_prior_match {
1.528     albertel 6902:   border-collapse: collapse;
                   6903: }
1.795     www      6904: 
1.528     albertel 6905: table.LC_prior_option tr td,
                   6906: table.LC_prior_rank tr td,
                   6907: table.LC_prior_match tr td {
1.524     albertel 6908:   border: 1px solid #000000;
1.515     albertel 6909: }
                   6910: 
1.855     bisitz   6911: .LC_nobreak {
1.544     albertel 6912:   white-space: nowrap;
1.519     raeburn  6913: }
                   6914: 
1.576     raeburn  6915: span.LC_cusr_emph {
                   6916:   font-style: italic;
                   6917: }
                   6918: 
1.633     raeburn  6919: span.LC_cusr_subheading {
                   6920:   font-weight: normal;
                   6921:   font-size: 85%;
                   6922: }
                   6923: 
1.861     bisitz   6924: div.LC_docs_entry_move {
1.859     bisitz   6925:   border: 1px solid #BBBBBB;
1.545     albertel 6926:   background: #DDDDDD;
1.861     bisitz   6927:   width: 22px;
1.859     bisitz   6928:   padding: 1px;
                   6929:   margin: 0;
1.545     albertel 6930: }
                   6931: 
1.861     bisitz   6932: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6933: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6934:   font-size: x-small;
                   6935: }
1.795     www      6936: 
1.861     bisitz   6937: .LC_docs_entry_parameter {
                   6938:   white-space: nowrap;
                   6939: }
                   6940: 
1.544     albertel 6941: .LC_docs_copy {
1.545     albertel 6942:   color: #000099;
1.544     albertel 6943: }
1.795     www      6944: 
1.544     albertel 6945: .LC_docs_cut {
1.545     albertel 6946:   color: #550044;
1.544     albertel 6947: }
1.795     www      6948: 
1.544     albertel 6949: .LC_docs_rename {
1.545     albertel 6950:   color: #009900;
1.544     albertel 6951: }
1.795     www      6952: 
1.544     albertel 6953: .LC_docs_remove {
1.545     albertel 6954:   color: #990000;
                   6955: }
                   6956: 
1.1075.2.134  raeburn  6957: .LC_domprefs_email,
1.547     albertel 6958: .LC_docs_reinit_warn,
                   6959: .LC_docs_ext_edit {
                   6960:   font-size: x-small;
                   6961: }
                   6962: 
1.545     albertel 6963: table.LC_docs_adddocs td,
                   6964: table.LC_docs_adddocs th {
                   6965:   border: 1px solid #BBBBBB;
                   6966:   padding: 4px;
                   6967:   background: #DDDDDD;
1.543     albertel 6968: }
                   6969: 
1.584     albertel 6970: table.LC_sty_begin {
                   6971:   background: #BBFFBB;
                   6972: }
1.795     www      6973: 
1.584     albertel 6974: table.LC_sty_end {
                   6975:   background: #FFBBBB;
                   6976: }
                   6977: 
1.589     raeburn  6978: table.LC_double_column {
1.803     bisitz   6979:   border-width: 0;
1.589     raeburn  6980:   border-collapse: collapse;
                   6981:   width: 100%;
                   6982:   padding: 2px;
                   6983: }
                   6984: 
                   6985: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6986:   top: 2px;
1.589     raeburn  6987:   left: 2px;
                   6988:   width: 47%;
                   6989:   vertical-align: top;
                   6990: }
                   6991: 
                   6992: table.LC_double_column tr td.LC_right_col {
                   6993:   top: 2px;
1.779     bisitz   6994:   right: 2px;
1.589     raeburn  6995:   width: 47%;
                   6996:   vertical-align: top;
                   6997: }
                   6998: 
1.591     raeburn  6999: div.LC_left_float {
                   7000:   float: left;
                   7001:   padding-right: 5%;
1.597     albertel 7002:   padding-bottom: 4px;
1.591     raeburn  7003: }
                   7004: 
                   7005: div.LC_clear_float_header {
1.597     albertel 7006:   padding-bottom: 2px;
1.591     raeburn  7007: }
                   7008: 
                   7009: div.LC_clear_float_footer {
1.597     albertel 7010:   padding-top: 10px;
1.591     raeburn  7011:   clear: both;
                   7012: }
                   7013: 
1.597     albertel 7014: div.LC_grade_show_user {
1.941     bisitz   7015: /*  border-left: 5px solid $sidebg; */
                   7016:   border-top: 5px solid #000000;
                   7017:   margin: 50px 0 0 0;
1.936     bisitz   7018:   padding: 15px 0 5px 10px;
1.597     albertel 7019: }
1.795     www      7020: 
1.936     bisitz   7021: div.LC_grade_show_user_odd_row {
1.941     bisitz   7022: /*  border-left: 5px solid #000000; */
                   7023: }
                   7024: 
                   7025: div.LC_grade_show_user div.LC_Box {
                   7026:   margin-right: 50px;
1.597     albertel 7027: }
                   7028: 
                   7029: div.LC_grade_submissions,
                   7030: div.LC_grade_message_center,
1.936     bisitz   7031: div.LC_grade_info_links {
1.597     albertel 7032:   margin: 5px;
                   7033:   width: 99%;
                   7034:   background: #FFFFFF;
                   7035: }
1.795     www      7036: 
1.597     albertel 7037: div.LC_grade_submissions_header,
1.936     bisitz   7038: div.LC_grade_message_center_header {
1.705     tempelho 7039:   font-weight: bold;
                   7040:   font-size: large;
1.597     albertel 7041: }
1.795     www      7042: 
1.597     albertel 7043: div.LC_grade_submissions_body,
1.936     bisitz   7044: div.LC_grade_message_center_body {
1.597     albertel 7045:   border: 1px solid black;
                   7046:   width: 99%;
                   7047:   background: #FFFFFF;
                   7048: }
1.795     www      7049: 
1.613     albertel 7050: table.LC_scantron_action {
                   7051:   width: 100%;
                   7052: }
1.795     www      7053: 
1.613     albertel 7054: table.LC_scantron_action tr th {
1.698     harmsja  7055:   font-weight:bold;
                   7056:   font-style:normal;
1.613     albertel 7057: }
1.795     www      7058: 
1.779     bisitz   7059: .LC_edit_problem_header,
1.614     albertel 7060: div.LC_edit_problem_footer {
1.705     tempelho 7061:   font-weight: normal;
                   7062:   font-size:  medium;
1.602     albertel 7063:   margin: 2px;
1.1060    bisitz   7064:   background-color: $sidebg;
1.600     albertel 7065: }
1.795     www      7066: 
1.600     albertel 7067: div.LC_edit_problem_header,
1.602     albertel 7068: div.LC_edit_problem_header div,
1.614     albertel 7069: div.LC_edit_problem_footer,
                   7070: div.LC_edit_problem_footer div,
1.602     albertel 7071: div.LC_edit_problem_editxml_header,
                   7072: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7073:   z-index: 100;
1.600     albertel 7074: }
1.795     www      7075: 
1.600     albertel 7076: div.LC_edit_problem_header_title {
1.705     tempelho 7077:   font-weight: bold;
                   7078:   font-size: larger;
1.602     albertel 7079:   background: $tabbg;
                   7080:   padding: 3px;
1.1060    bisitz   7081:   margin: 0 0 5px 0;
1.602     albertel 7082: }
1.795     www      7083: 
1.602     albertel 7084: table.LC_edit_problem_header_title {
                   7085:   width: 100%;
1.600     albertel 7086:   background: $tabbg;
1.602     albertel 7087: }
                   7088: 
1.1075.2.112  raeburn  7089: div.LC_edit_actionbar {
                   7090:     background-color: $sidebg;
                   7091:     margin: 0;
                   7092:     padding: 0;
                   7093:     line-height: 200%;
1.602     albertel 7094: }
1.795     www      7095: 
1.1075.2.112  raeburn  7096: div.LC_edit_actionbar div{
                   7097:     padding: 0;
                   7098:     margin: 0;
                   7099:     display: inline-block;
1.600     albertel 7100: }
1.795     www      7101: 
1.1075.2.34  raeburn  7102: .LC_edit_opt {
                   7103:   padding-left: 1em;
                   7104:   white-space: nowrap;
                   7105: }
                   7106: 
1.1075.2.57  raeburn  7107: .LC_edit_problem_latexhelper{
                   7108:     text-align: right;
                   7109: }
                   7110: 
                   7111: #LC_edit_problem_colorful div{
                   7112:     margin-left: 40px;
                   7113: }
                   7114: 
1.1075.2.112  raeburn  7115: #LC_edit_problem_codemirror div{
                   7116:     margin-left: 0px;
                   7117: }
                   7118: 
1.911     bisitz   7119: img.stift {
1.803     bisitz   7120:   border-width: 0;
                   7121:   vertical-align: middle;
1.677     riegler  7122: }
1.680     riegler  7123: 
1.923     bisitz   7124: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7125:   vertical-align: top;
1.777     tempelho 7126: }
1.795     www      7127: 
1.716     raeburn  7128: div.LC_createcourse {
1.911     bisitz   7129:   margin: 10px 10px 10px 10px;
1.716     raeburn  7130: }
                   7131: 
1.917     raeburn  7132: .LC_dccid {
1.1075.2.38  raeburn  7133:   float: right;
1.917     raeburn  7134:   margin: 0.2em 0 0 0;
                   7135:   padding: 0;
                   7136:   font-size: 90%;
                   7137:   display:none;
                   7138: }
                   7139: 
1.897     wenzelju 7140: ol.LC_primary_menu a:hover,
1.721     harmsja  7141: ol#LC_MenuBreadcrumbs a:hover,
                   7142: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7143: ul#LC_secondary_menu a:hover,
1.721     harmsja  7144: .LC_FormSectionClearButton input:hover
1.795     www      7145: ul.LC_TabContent   li:hover a {
1.952     onken    7146:   color:$button_hover;
1.911     bisitz   7147:   text-decoration:none;
1.693     droeschl 7148: }
                   7149: 
1.779     bisitz   7150: h1 {
1.911     bisitz   7151:   padding: 0;
                   7152:   line-height:130%;
1.693     droeschl 7153: }
1.698     harmsja  7154: 
1.911     bisitz   7155: h2,
                   7156: h3,
                   7157: h4,
                   7158: h5,
                   7159: h6 {
                   7160:   margin: 5px 0 5px 0;
                   7161:   padding: 0;
                   7162:   line-height:130%;
1.693     droeschl 7163: }
1.795     www      7164: 
                   7165: .LC_hcell {
1.911     bisitz   7166:   padding:3px 15px 3px 15px;
                   7167:   margin: 0;
                   7168:   background-color:$tabbg;
                   7169:   color:$fontmenu;
                   7170:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7171: }
1.795     www      7172: 
1.840     bisitz   7173: .LC_Box > .LC_hcell {
1.911     bisitz   7174:   margin: 0 -10px 10px -10px;
1.835     bisitz   7175: }
                   7176: 
1.721     harmsja  7177: .LC_noBorder {
1.911     bisitz   7178:   border: 0;
1.698     harmsja  7179: }
1.693     droeschl 7180: 
1.721     harmsja  7181: .LC_FormSectionClearButton input {
1.911     bisitz   7182:   background-color:transparent;
                   7183:   border: none;
                   7184:   cursor:pointer;
                   7185:   text-decoration:underline;
1.693     droeschl 7186: }
1.763     bisitz   7187: 
                   7188: .LC_help_open_topic {
1.911     bisitz   7189:   color: #FFFFFF;
                   7190:   background-color: #EEEEFF;
                   7191:   margin: 1px;
                   7192:   padding: 4px;
                   7193:   border: 1px solid #000033;
                   7194:   white-space: nowrap;
                   7195:   /* vertical-align: middle; */
1.759     neumanie 7196: }
1.693     droeschl 7197: 
1.911     bisitz   7198: dl,
                   7199: ul,
                   7200: div,
                   7201: fieldset {
                   7202:   margin: 10px 10px 10px 0;
                   7203:   /* overflow: hidden; */
1.693     droeschl 7204: }
1.795     www      7205: 
1.1075.2.90  raeburn  7206: article.geogebraweb div {
                   7207:     margin: 0;
                   7208: }
                   7209: 
1.838     bisitz   7210: fieldset > legend {
1.911     bisitz   7211:   font-weight: bold;
                   7212:   padding: 0 5px 0 5px;
1.838     bisitz   7213: }
                   7214: 
1.813     bisitz   7215: #LC_nav_bar {
1.911     bisitz   7216:   float: left;
1.995     raeburn  7217:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7218:   margin: 0 0 2px 0;
1.807     droeschl 7219: }
                   7220: 
1.916     droeschl 7221: #LC_realm {
                   7222:   margin: 0.2em 0 0 0;
                   7223:   padding: 0;
                   7224:   font-weight: bold;
                   7225:   text-align: center;
1.995     raeburn  7226:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7227: }
                   7228: 
1.911     bisitz   7229: #LC_nav_bar em {
                   7230:   font-weight: bold;
                   7231:   font-style: normal;
1.807     droeschl 7232: }
                   7233: 
1.897     wenzelju 7234: ol.LC_primary_menu {
1.934     droeschl 7235:   margin: 0;
1.1075.2.2  raeburn  7236:   padding: 0;
1.807     droeschl 7237: }
                   7238: 
1.852     droeschl 7239: ol#LC_PathBreadcrumbs {
1.911     bisitz   7240:   margin: 0;
1.693     droeschl 7241: }
                   7242: 
1.897     wenzelju 7243: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7244:   color: RGB(80, 80, 80);
                   7245:   vertical-align: middle;
                   7246:   text-align: left;
                   7247:   list-style: none;
1.1075.2.112  raeburn  7248:   position: relative;
1.1075.2.2  raeburn  7249:   float: left;
1.1075.2.112  raeburn  7250:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7251:   line-height: 1.5em;
1.1075.2.2  raeburn  7252: }
                   7253: 
1.1075.2.113  raeburn  7254: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7255: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7256:   display: block;
                   7257:   margin: 0;
                   7258:   padding: 0 5px 0 10px;
                   7259:   text-decoration: none;
                   7260: }
                   7261: 
1.1075.2.112  raeburn  7262: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7263:   display: inline-block;
                   7264:   width: 95%;
                   7265:   text-align: left;
                   7266: }
                   7267: 
                   7268: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7269:   display: inline-block;
                   7270:   width: 5%;
                   7271:   float: right;
                   7272:   text-align: right;
                   7273:   font-size: 70%;
                   7274: }
                   7275: 
                   7276: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7277:   display: none;
1.1075.2.112  raeburn  7278:   width: 15em;
1.1075.2.2  raeburn  7279:   background-color: $data_table_light;
1.1075.2.112  raeburn  7280:   position: absolute;
                   7281:   top: 100%;
                   7282: }
                   7283: 
                   7284: ol.LC_primary_menu ul ul {
                   7285:   left: 100%;
                   7286:   top: 0;
1.1075.2.2  raeburn  7287: }
                   7288: 
1.1075.2.112  raeburn  7289: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7290:   display: block;
                   7291:   position: absolute;
                   7292:   margin: 0;
                   7293:   padding: 0;
1.1075.2.5  raeburn  7294:   z-index: 2;
1.1075.2.2  raeburn  7295: }
                   7296: 
                   7297: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7298: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7299:   font-size: 90%;
1.911     bisitz   7300:   vertical-align: top;
1.1075.2.2  raeburn  7301:   float: none;
1.1075.2.5  raeburn  7302:   border-left: 1px solid black;
                   7303:   border-right: 1px solid black;
1.1075.2.112  raeburn  7304: /* A dark bottom border to visualize different menu options;
                   7305: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7306:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7307: }
                   7308: 
1.1075.2.112  raeburn  7309: ol.LC_primary_menu li li p:hover {
                   7310:   color:$button_hover;
                   7311:   text-decoration:none;
                   7312:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7313: }
                   7314: 
                   7315: ol.LC_primary_menu li li a:hover {
                   7316:    color:$button_hover;
                   7317:    background-color:$data_table_dark;
1.693     droeschl 7318: }
                   7319: 
1.1075.2.112  raeburn  7320: /* Font-size equal to the size of the predecessors*/
                   7321: ol.LC_primary_menu li:hover li li {
                   7322:   font-size: 100%;
                   7323: }
                   7324: 
1.897     wenzelju 7325: ol.LC_primary_menu li img {
1.911     bisitz   7326:   vertical-align: bottom;
1.934     droeschl 7327:   height: 1.1em;
1.1075.2.3  raeburn  7328:   margin: 0.2em 0 0 0;
1.693     droeschl 7329: }
                   7330: 
1.897     wenzelju 7331: ol.LC_primary_menu a {
1.911     bisitz   7332:   color: RGB(80, 80, 80);
                   7333:   text-decoration: none;
1.693     droeschl 7334: }
1.795     www      7335: 
1.949     droeschl 7336: ol.LC_primary_menu a.LC_new_message {
                   7337:   font-weight:bold;
                   7338:   color: darkred;
                   7339: }
                   7340: 
1.975     raeburn  7341: ol.LC_docs_parameters {
                   7342:   margin-left: 0;
                   7343:   padding: 0;
                   7344:   list-style: none;
                   7345: }
                   7346: 
                   7347: ol.LC_docs_parameters li {
                   7348:   margin: 0;
                   7349:   padding-right: 20px;
                   7350:   display: inline;
                   7351: }
                   7352: 
1.976     raeburn  7353: ol.LC_docs_parameters li:before {
                   7354:   content: "\\002022 \\0020";
                   7355: }
                   7356: 
                   7357: li.LC_docs_parameters_title {
                   7358:   font-weight: bold;
                   7359: }
                   7360: 
                   7361: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7362:   content: "";
                   7363: }
                   7364: 
1.897     wenzelju 7365: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7366:   clear: right;
1.911     bisitz   7367:   color: $fontmenu;
                   7368:   background: $tabbg;
                   7369:   list-style: none;
                   7370:   padding: 0;
                   7371:   margin: 0;
                   7372:   width: 100%;
1.995     raeburn  7373:   text-align: left;
1.1075.2.4  raeburn  7374:   float: left;
1.808     droeschl 7375: }
                   7376: 
1.897     wenzelju 7377: ul#LC_secondary_menu li {
1.911     bisitz   7378:   font-weight: bold;
                   7379:   line-height: 1.8em;
                   7380:   border-right: 1px solid black;
1.1075.2.4  raeburn  7381:   float: left;
                   7382: }
                   7383: 
                   7384: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7385:   background-color: $data_table_light;
                   7386: }
                   7387: 
                   7388: ul#LC_secondary_menu li a {
                   7389:   padding: 0 0.8em;
                   7390: }
                   7391: 
                   7392: ul#LC_secondary_menu li ul {
                   7393:   display: none;
                   7394: }
                   7395: 
                   7396: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7397:   display: block;
                   7398:   position: absolute;
                   7399:   margin: 0;
                   7400:   padding: 0;
                   7401:   list-style:none;
                   7402:   float: none;
                   7403:   background-color: $data_table_light;
1.1075.2.5  raeburn  7404:   z-index: 2;
1.1075.2.10  raeburn  7405:   margin-left: -1px;
1.1075.2.4  raeburn  7406: }
                   7407: 
                   7408: ul#LC_secondary_menu li ul li {
                   7409:   font-size: 90%;
                   7410:   vertical-align: top;
                   7411:   border-left: 1px solid black;
                   7412:   border-right: 1px solid black;
1.1075.2.33  raeburn  7413:   background-color: $data_table_light;
1.1075.2.4  raeburn  7414:   list-style:none;
                   7415:   float: none;
                   7416: }
                   7417: 
                   7418: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7419:   background-color: $data_table_dark;
1.807     droeschl 7420: }
                   7421: 
1.847     tempelho 7422: ul.LC_TabContent {
1.911     bisitz   7423:   display:block;
                   7424:   background: $sidebg;
                   7425:   border-bottom: solid 1px $lg_border_color;
                   7426:   list-style:none;
1.1020    raeburn  7427:   margin: -1px -10px 0 -10px;
1.911     bisitz   7428:   padding: 0;
1.693     droeschl 7429: }
                   7430: 
1.795     www      7431: ul.LC_TabContent li,
                   7432: ul.LC_TabContentBigger li {
1.911     bisitz   7433:   float:left;
1.741     harmsja  7434: }
1.795     www      7435: 
1.897     wenzelju 7436: ul#LC_secondary_menu li a {
1.911     bisitz   7437:   color: $fontmenu;
                   7438:   text-decoration: none;
1.693     droeschl 7439: }
1.795     www      7440: 
1.721     harmsja  7441: ul.LC_TabContent {
1.952     onken    7442:   min-height:20px;
1.721     harmsja  7443: }
1.795     www      7444: 
                   7445: ul.LC_TabContent li {
1.911     bisitz   7446:   vertical-align:middle;
1.959     onken    7447:   padding: 0 16px 0 10px;
1.911     bisitz   7448:   background-color:$tabbg;
                   7449:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7450:   border-left: solid 1px $font;
1.721     harmsja  7451: }
1.795     www      7452: 
1.847     tempelho 7453: ul.LC_TabContent .right {
1.911     bisitz   7454:   float:right;
1.847     tempelho 7455: }
                   7456: 
1.911     bisitz   7457: ul.LC_TabContent li a,
                   7458: ul.LC_TabContent li {
                   7459:   color:rgb(47,47,47);
                   7460:   text-decoration:none;
                   7461:   font-size:95%;
                   7462:   font-weight:bold;
1.952     onken    7463:   min-height:20px;
                   7464: }
                   7465: 
1.959     onken    7466: ul.LC_TabContent li a:hover,
                   7467: ul.LC_TabContent li a:focus {
1.952     onken    7468:   color: $button_hover;
1.959     onken    7469:   background:none;
                   7470:   outline:none;
1.952     onken    7471: }
                   7472: 
                   7473: ul.LC_TabContent li:hover {
                   7474:   color: $button_hover;
                   7475:   cursor:pointer;
1.721     harmsja  7476: }
1.795     www      7477: 
1.911     bisitz   7478: ul.LC_TabContent li.active {
1.952     onken    7479:   color: $font;
1.911     bisitz   7480:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7481:   border-bottom:solid 1px #FFFFFF;
                   7482:   cursor: default;
1.744     ehlerst  7483: }
1.795     www      7484: 
1.959     onken    7485: ul.LC_TabContent li.active a {
                   7486:   color:$font;
                   7487:   background:#FFFFFF;
                   7488:   outline: none;
                   7489: }
1.1047    raeburn  7490: 
                   7491: ul.LC_TabContent li.goback {
                   7492:   float: left;
                   7493:   border-left: none;
                   7494: }
                   7495: 
1.870     tempelho 7496: #maincoursedoc {
1.911     bisitz   7497:   clear:both;
1.870     tempelho 7498: }
                   7499: 
                   7500: ul.LC_TabContentBigger {
1.911     bisitz   7501:   display:block;
                   7502:   list-style:none;
                   7503:   padding: 0;
1.870     tempelho 7504: }
                   7505: 
1.795     www      7506: ul.LC_TabContentBigger li {
1.911     bisitz   7507:   vertical-align:bottom;
                   7508:   height: 30px;
                   7509:   font-size:110%;
                   7510:   font-weight:bold;
                   7511:   color: #737373;
1.841     tempelho 7512: }
                   7513: 
1.957     onken    7514: ul.LC_TabContentBigger li.active {
                   7515:   position: relative;
                   7516:   top: 1px;
                   7517: }
                   7518: 
1.870     tempelho 7519: ul.LC_TabContentBigger li a {
1.911     bisitz   7520:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7521:   height: 30px;
                   7522:   line-height: 30px;
                   7523:   text-align: center;
                   7524:   display: block;
                   7525:   text-decoration: none;
1.958     onken    7526:   outline: none;  
1.741     harmsja  7527: }
1.795     www      7528: 
1.870     tempelho 7529: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7530:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7531:   color:$font;
1.744     ehlerst  7532: }
1.795     www      7533: 
1.870     tempelho 7534: ul.LC_TabContentBigger li b {
1.911     bisitz   7535:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7536:   display: block;
                   7537:   float: left;
                   7538:   padding: 0 30px;
1.957     onken    7539:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7540: }
                   7541: 
1.956     onken    7542: ul.LC_TabContentBigger li:hover b {
                   7543:   color:$button_hover;
                   7544: }
                   7545: 
1.870     tempelho 7546: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7547:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7548:   color:$font;
1.957     onken    7549:   border: 0;
1.741     harmsja  7550: }
1.693     droeschl 7551: 
1.870     tempelho 7552: 
1.862     bisitz   7553: ul.LC_CourseBreadcrumbs {
                   7554:   background: $sidebg;
1.1020    raeburn  7555:   height: 2em;
1.862     bisitz   7556:   padding-left: 10px;
1.1020    raeburn  7557:   margin: 0;
1.862     bisitz   7558:   list-style-position: inside;
                   7559: }
                   7560: 
1.911     bisitz   7561: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7562: ol#LC_PathBreadcrumbs {
1.911     bisitz   7563:   padding-left: 10px;
                   7564:   margin: 0;
1.933     droeschl 7565:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7566: }
                   7567: 
1.911     bisitz   7568: ol#LC_MenuBreadcrumbs li,
                   7569: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7570: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7571:   display: inline;
1.933     droeschl 7572:   white-space: normal;  
1.693     droeschl 7573: }
                   7574: 
1.823     bisitz   7575: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7576: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7577:   text-decoration: none;
                   7578:   font-size:90%;
1.693     droeschl 7579: }
1.795     www      7580: 
1.969     droeschl 7581: ol#LC_MenuBreadcrumbs h1 {
                   7582:   display: inline;
                   7583:   font-size: 90%;
                   7584:   line-height: 2.5em;
                   7585:   margin: 0;
                   7586:   padding: 0;
                   7587: }
                   7588: 
1.795     www      7589: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7590:   text-decoration:none;
                   7591:   font-size:100%;
                   7592:   font-weight:bold;
1.693     droeschl 7593: }
1.795     www      7594: 
1.840     bisitz   7595: .LC_Box {
1.911     bisitz   7596:   border: solid 1px $lg_border_color;
                   7597:   padding: 0 10px 10px 10px;
1.746     neumanie 7598: }
1.795     www      7599: 
1.1020    raeburn  7600: .LC_DocsBox {
                   7601:   border: solid 1px $lg_border_color;
                   7602:   padding: 0 0 10px 10px;
                   7603: }
                   7604: 
1.795     www      7605: .LC_AboutMe_Image {
1.911     bisitz   7606:   float:left;
                   7607:   margin-right:10px;
1.747     neumanie 7608: }
1.795     www      7609: 
                   7610: .LC_Clear_AboutMe_Image {
1.911     bisitz   7611:   clear:left;
1.747     neumanie 7612: }
1.795     www      7613: 
1.721     harmsja  7614: dl.LC_ListStyleClean dt {
1.911     bisitz   7615:   padding-right: 5px;
                   7616:   display: table-header-group;
1.693     droeschl 7617: }
                   7618: 
1.721     harmsja  7619: dl.LC_ListStyleClean dd {
1.911     bisitz   7620:   display: table-row;
1.693     droeschl 7621: }
                   7622: 
1.721     harmsja  7623: .LC_ListStyleClean,
                   7624: .LC_ListStyleSimple,
                   7625: .LC_ListStyleNormal,
1.795     www      7626: .LC_ListStyleSpecial {
1.911     bisitz   7627:   /* display:block; */
                   7628:   list-style-position: inside;
                   7629:   list-style-type: none;
                   7630:   overflow: hidden;
                   7631:   padding: 0;
1.693     droeschl 7632: }
                   7633: 
1.721     harmsja  7634: .LC_ListStyleSimple li,
                   7635: .LC_ListStyleSimple dd,
                   7636: .LC_ListStyleNormal li,
                   7637: .LC_ListStyleNormal dd,
                   7638: .LC_ListStyleSpecial li,
1.795     www      7639: .LC_ListStyleSpecial dd {
1.911     bisitz   7640:   margin: 0;
                   7641:   padding: 5px 5px 5px 10px;
                   7642:   clear: both;
1.693     droeschl 7643: }
                   7644: 
1.721     harmsja  7645: .LC_ListStyleClean li,
                   7646: .LC_ListStyleClean dd {
1.911     bisitz   7647:   padding-top: 0;
                   7648:   padding-bottom: 0;
1.693     droeschl 7649: }
                   7650: 
1.721     harmsja  7651: .LC_ListStyleSimple dd,
1.795     www      7652: .LC_ListStyleSimple li {
1.911     bisitz   7653:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7654: }
                   7655: 
1.721     harmsja  7656: .LC_ListStyleSpecial li,
                   7657: .LC_ListStyleSpecial dd {
1.911     bisitz   7658:   list-style-type: none;
                   7659:   background-color: RGB(220, 220, 220);
                   7660:   margin-bottom: 4px;
1.693     droeschl 7661: }
                   7662: 
1.721     harmsja  7663: table.LC_SimpleTable {
1.911     bisitz   7664:   margin:5px;
                   7665:   border:solid 1px $lg_border_color;
1.795     www      7666: }
1.693     droeschl 7667: 
1.721     harmsja  7668: table.LC_SimpleTable tr {
1.911     bisitz   7669:   padding: 0;
                   7670:   border:solid 1px $lg_border_color;
1.693     droeschl 7671: }
1.795     www      7672: 
                   7673: table.LC_SimpleTable thead {
1.911     bisitz   7674:   background:rgb(220,220,220);
1.693     droeschl 7675: }
                   7676: 
1.721     harmsja  7677: div.LC_columnSection {
1.911     bisitz   7678:   display: block;
                   7679:   clear: both;
                   7680:   overflow: hidden;
                   7681:   margin: 0;
1.693     droeschl 7682: }
                   7683: 
1.721     harmsja  7684: div.LC_columnSection>* {
1.911     bisitz   7685:   float: left;
                   7686:   margin: 10px 20px 10px 0;
                   7687:   overflow:hidden;
1.693     droeschl 7688: }
1.721     harmsja  7689: 
1.795     www      7690: table em {
1.911     bisitz   7691:   font-weight: bold;
                   7692:   font-style: normal;
1.748     schulted 7693: }
1.795     www      7694: 
1.779     bisitz   7695: table.LC_tableBrowseRes,
1.795     www      7696: table.LC_tableOfContent {
1.911     bisitz   7697:   border:none;
                   7698:   border-spacing: 1px;
                   7699:   padding: 3px;
                   7700:   background-color: #FFFFFF;
                   7701:   font-size: 90%;
1.753     droeschl 7702: }
1.789     droeschl 7703: 
1.911     bisitz   7704: table.LC_tableOfContent {
                   7705:   border-collapse: collapse;
1.789     droeschl 7706: }
                   7707: 
1.771     droeschl 7708: table.LC_tableBrowseRes a,
1.768     schulted 7709: table.LC_tableOfContent a {
1.911     bisitz   7710:   background-color: transparent;
                   7711:   text-decoration: none;
1.753     droeschl 7712: }
                   7713: 
1.795     www      7714: table.LC_tableOfContent img {
1.911     bisitz   7715:   border: none;
                   7716:   height: 1.3em;
                   7717:   vertical-align: text-bottom;
                   7718:   margin-right: 0.3em;
1.753     droeschl 7719: }
1.757     schulted 7720: 
1.795     www      7721: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7722:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7723: }
                   7724: 
1.795     www      7725: a#LC_content_toolbar_everything {
1.911     bisitz   7726:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7727: }
                   7728: 
1.795     www      7729: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7730:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7731: }
                   7732: 
1.795     www      7733: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7734:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7735: }
                   7736: 
1.795     www      7737: a#LC_content_toolbar_changefolder {
1.911     bisitz   7738:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7739: }
                   7740: 
1.795     www      7741: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7742:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7743: }
                   7744: 
1.1043    raeburn  7745: a#LC_content_toolbar_edittoplevel {
                   7746:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7747: }
                   7748: 
1.795     www      7749: ul#LC_toolbar li a:hover {
1.911     bisitz   7750:   background-position: bottom center;
1.757     schulted 7751: }
                   7752: 
1.795     www      7753: ul#LC_toolbar {
1.911     bisitz   7754:   padding: 0;
                   7755:   margin: 2px;
                   7756:   list-style:none;
                   7757:   position:relative;
                   7758:   background-color:white;
1.1075.2.9  raeburn  7759:   overflow: auto;
1.757     schulted 7760: }
                   7761: 
1.795     www      7762: ul#LC_toolbar li {
1.911     bisitz   7763:   border:1px solid white;
                   7764:   padding: 0;
                   7765:   margin: 0;
                   7766:   float: left;
                   7767:   display:inline;
                   7768:   vertical-align:middle;
1.1075.2.9  raeburn  7769:   white-space: nowrap;
1.911     bisitz   7770: }
1.757     schulted 7771: 
1.783     amueller 7772: 
1.795     www      7773: a.LC_toolbarItem {
1.911     bisitz   7774:   display:block;
                   7775:   padding: 0;
                   7776:   margin: 0;
                   7777:   height: 32px;
                   7778:   width: 32px;
                   7779:   color:white;
                   7780:   border: none;
                   7781:   background-repeat:no-repeat;
                   7782:   background-color:transparent;
1.757     schulted 7783: }
                   7784: 
1.915     droeschl 7785: ul.LC_funclist {
                   7786:     margin: 0;
                   7787:     padding: 0.5em 1em 0.5em 0;
                   7788: }
                   7789: 
1.933     droeschl 7790: ul.LC_funclist > li:first-child {
                   7791:     font-weight:bold; 
                   7792:     margin-left:0.8em;
                   7793: }
                   7794: 
1.915     droeschl 7795: ul.LC_funclist + ul.LC_funclist {
                   7796:     /* 
                   7797:        left border as a seperator if we have more than
                   7798:        one list 
                   7799:     */
                   7800:     border-left: 1px solid $sidebg;
                   7801:     /* 
                   7802:        this hides the left border behind the border of the 
                   7803:        outer box if element is wrapped to the next 'line' 
                   7804:     */
                   7805:     margin-left: -1px;
                   7806: }
                   7807: 
1.843     bisitz   7808: ul.LC_funclist li {
1.915     droeschl 7809:   display: inline;
1.782     bisitz   7810:   white-space: nowrap;
1.915     droeschl 7811:   margin: 0 0 0 25px;
                   7812:   line-height: 150%;
1.782     bisitz   7813: }
                   7814: 
1.974     wenzelju 7815: .LC_hidden {
                   7816:   display: none;
                   7817: }
                   7818: 
1.1030    www      7819: .LCmodal-overlay {
                   7820: 		position:fixed;
                   7821: 		top:0;
                   7822: 		right:0;
                   7823: 		bottom:0;
                   7824: 		left:0;
                   7825: 		height:100%;
                   7826: 		width:100%;
                   7827: 		margin:0;
                   7828: 		padding:0;
                   7829: 		background:#999;
                   7830: 		opacity:.75;
                   7831: 		filter: alpha(opacity=75);
                   7832: 		-moz-opacity: 0.75;
                   7833: 		z-index:101;
                   7834: }
                   7835: 
                   7836: * html .LCmodal-overlay {   
                   7837: 		position: absolute;
                   7838: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7839: }
                   7840: 
                   7841: .LCmodal-window {
                   7842: 		position:fixed;
                   7843: 		top:50%;
                   7844: 		left:50%;
                   7845: 		margin:0;
                   7846: 		padding:0;
                   7847: 		z-index:102;
                   7848: 	}
                   7849: 
                   7850: * html .LCmodal-window {
                   7851: 		position:absolute;
                   7852: }
                   7853: 
                   7854: .LCclose-window {
                   7855: 		position:absolute;
                   7856: 		width:32px;
                   7857: 		height:32px;
                   7858: 		right:8px;
                   7859: 		top:8px;
                   7860: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7861: 		text-indent:-99999px;
                   7862: 		overflow:hidden;
                   7863: 		cursor:pointer;
                   7864: }
                   7865: 
1.1075.2.141  raeburn  7866: pre.LC_wordwrap {
                   7867:   white-space: pre-wrap;
                   7868:   white-space: -moz-pre-wrap;
                   7869:   white-space: -pre-wrap;
                   7870:   white-space: -o-pre-wrap;
                   7871:   word-wrap: break-word;
                   7872: }
                   7873: 
1.1075.2.17  raeburn  7874: /*
                   7875:   styles used by TTH when "Default set of options to pass to tth/m
                   7876:   when converting TeX" in course settings has been set
                   7877: 
                   7878:   option passed: -t
                   7879: 
                   7880: */
                   7881: 
                   7882: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7883: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7884: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7885: td div.norm {line-height:normal;}
                   7886: 
                   7887: /*
                   7888:   option passed -y3
                   7889: */
                   7890: 
                   7891: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7892: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7893: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7894: 
1.1075.2.121  raeburn  7895: #LC_minitab_header {
                   7896:   float:left;
                   7897:   width:100%;
                   7898:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   7899:   font-size:93%;
                   7900:   line-height:normal;
                   7901:   margin: 0.5em 0 0.5em 0;
                   7902: }
                   7903: #LC_minitab_header ul {
                   7904:   margin:0;
                   7905:   padding:10px 10px 0;
                   7906:   list-style:none;
                   7907: }
                   7908: #LC_minitab_header li {
                   7909:   float:left;
                   7910:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   7911:   margin:0;
                   7912:   padding:0 0 0 9px;
                   7913: }
                   7914: #LC_minitab_header a {
                   7915:   display:block;
                   7916:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   7917:   padding:5px 15px 4px 6px;
                   7918: }
                   7919: #LC_minitab_header #LC_current_minitab {
                   7920:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   7921: }
                   7922: #LC_minitab_header #LC_current_minitab a {
                   7923:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   7924:   padding-bottom:5px;
                   7925: }
                   7926: 
                   7927: 
1.343     albertel 7928: END
                   7929: }
                   7930: 
1.306     albertel 7931: =pod
                   7932: 
                   7933: =item * &headtag()
                   7934: 
                   7935: Returns a uniform footer for LON-CAPA web pages.
                   7936: 
1.307     albertel 7937: Inputs: $title - optional title for the head
                   7938:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7939:         $args - optional arguments
1.319     albertel 7940:             force_register - if is true call registerurl so the remote is 
                   7941:                              informed
1.415     albertel 7942:             redirect       -> array ref of
                   7943:                                    1- seconds before redirect occurs
                   7944:                                    2- url to redirect to
                   7945:                                    3- whether the side effect should occur
1.315     albertel 7946:                            (side effect of setting 
                   7947:                                $env{'internal.head.redirect'} to the url 
                   7948:                                redirected too)
1.352     albertel 7949:             domain         -> force to color decorate a page for a specific
                   7950:                                domain
                   7951:             function       -> force usage of a specific rolish color scheme
                   7952:             bgcolor        -> override the default page bgcolor
1.460     albertel 7953:             no_auto_mt_title
                   7954:                            -> prevent &mt()ing the title arg
1.464     albertel 7955: 
1.306     albertel 7956: =cut
                   7957: 
                   7958: sub headtag {
1.313     albertel 7959:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7960:     
1.363     albertel 7961:     my $function = $args->{'function'} || &get_users_function();
                   7962:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7963:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  7964:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7965:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7966: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7967: 		   #time(),
1.418     albertel 7968: 		   $env{'environment.color.timestamp'},
1.363     albertel 7969: 		   $function,$domain,$bgcolor);
                   7970: 
1.369     www      7971:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7972: 
1.308     albertel 7973:     my $result =
                   7974: 	'<head>'.
1.1075.2.56  raeburn  7975: 	&font_settings($args);
1.319     albertel 7976: 
1.1075.2.72  raeburn  7977:     my $inhibitprint;
                   7978:     if ($args->{'print_suppress'}) {
                   7979:         $inhibitprint = &print_suppression();
                   7980:     }
1.1064    raeburn  7981: 
1.461     albertel 7982:     if (!$args->{'frameset'}) {
                   7983: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7984:     }
1.1075.2.12  raeburn  7985:     if ($args->{'force_register'}) {
                   7986:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 7987:     }
1.436     albertel 7988:     if (!$args->{'no_nav_bar'} 
                   7989: 	&& !$args->{'only_body'}
                   7990: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  7991: 	$result .= &help_menu_js($httphost);
1.1032    www      7992:         $result.=&modal_window();
1.1038    www      7993:         $result.=&togglebox_script();
1.1034    www      7994:         $result.=&wishlist_window();
1.1041    www      7995:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7996:     } else {
                   7997:         if ($args->{'add_modal'}) {
                   7998:            $result.=&modal_window();
                   7999:         }
                   8000:         if ($args->{'add_wishlist'}) {
                   8001:            $result.=&wishlist_window();
                   8002:         }
1.1038    www      8003:         if ($args->{'add_togglebox'}) {
                   8004:            $result.=&togglebox_script();
                   8005:         }
1.1041    www      8006:         if ($args->{'add_progressbar'}) {
                   8007:            $result.=&LCprogressbarUpdate_script();
                   8008:         }
1.436     albertel 8009:     }
1.314     albertel 8010:     if (ref($args->{'redirect'})) {
1.414     albertel 8011: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 8012: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 8013: 	if (!$inhibit_continue) {
                   8014: 	    $env{'internal.head.redirect'} = $url;
                   8015: 	}
1.313     albertel 8016: 	$result.=<<ADDMETA
                   8017: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8018: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8019: ADDMETA
1.1075.2.89  raeburn  8020:     } else {
                   8021:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8022:             my $requrl = $env{'request.uri'};
                   8023:             if ($requrl eq '') {
                   8024:                 $requrl = $ENV{'REQUEST_URI'};
                   8025:                 $requrl =~ s/\?.+$//;
                   8026:             }
                   8027:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8028:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8029:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8030:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8031:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8032:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.141.  .4(raebu 8033:20):                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   8034:20):                     my $offload;
1.1075.2.89  raeburn  8035:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8036:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.141.  .4(raebu 8037:20):                             $offload = 1;
                   8038:20):                         }
                   8039:20):                     }
                   8040:20):                     unless ($offload) {
                   8041:20):                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8042:20):                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8043:20):                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8044:20):                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8045:20):                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8046:20):                                         $offload = 1;
                   8047:20):                                         $dom_in_use = $env{'user.domain'};
                   8048:20):                                     }
1.1075.2.89  raeburn  8049:                                 }
1.1075.2.141.  .4(raebu 8050:20):                             }
                   8051:20):                         }
                   8052:20):                     }
                   8053:20):                     if ($offload) {
                   8054:20):                         my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
                   8055:20):                         if (($newserver) && ($newserver ne $lonhost)) {
                   8056:20):                             my $numsec = 5;
                   8057:20):                             my $timeout = $numsec * 1000;
                   8058:20):                             my ($newurl,$locknum,%locks,$msg);
                   8059:20):                             if ($env{'request.role.adv'}) {
                   8060:20):                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8061:20):                             }
                   8062:20):                             my $disable_submit = 0;
                   8063:20):                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8064:20):                                 $disable_submit = 1;
                   8065:20):                             }
                   8066:20):                             if ($locknum) {
                   8067:20):                                 my @lockinfo = sort(values(%locks));
                   8068:20):                                 $msg = &mt('Once the following tasks are complete: ')."\n".
                   8069:20):                                        join(", ",sort(values(%locks)))."\n";
                   8070:20):                                 if (&show_course()) {
                   8071:20):                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8072:                                 } else {
1.1075.2.141.  .4(raebu 8073:20):                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8074:20):                                 }
                   8075:20):                             } else {
                   8076:20):                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8077:20):                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8078:20):                                 }
                   8079:20):                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8080:20):                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8081:20):                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8082:20):                                     $newurl .= '&role='.$env{'request.role'};
                   8083:20):                                 }
                   8084:20):                                 if ($env{'request.symb'}) {
                   8085:20):                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8086:20):                                     if ($shownsymb =~ m{^/enc/}) {
                   8087:20):                                         my $reqdmajor = 2;
                   8088:20):                                         my $reqdminor = 11;
                   8089:20):                                         my $reqdsubminor = 3;
                   8090:20):                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8091:20):                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8092:20):                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8093:20):                                         if (($major eq '' && $minor eq '') ||
                   8094:20):                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8095:20):                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8096:20):                                              ($reqdsubminor > $subminor))))) {
                   8097:20):                                             undef($shownsymb);
                   8098:20):                                         }
1.1075.2.89  raeburn  8099:                                     }
1.1075.2.141.  .4(raebu 8100:20):                                     if ($shownsymb) {
                   8101:20):                                         &js_escape(\$shownsymb);
                   8102:20):                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8103:                                     }
1.1075.2.141.  .4(raebu 8104:20):                                 } else {
                   8105:20):                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8106:20):                                     &js_escape(\$shownurl);
                   8107:20):                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8108:                                 }
1.1075.2.141.  .4(raebu 8109:20):                             }
                   8110:20):                             &js_escape(\$msg);
                   8111:20):                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8112: <meta http-equiv="pragma" content="no-cache" />
                   8113: <script type="text/javascript">
1.1075.2.92  raeburn  8114: // <![CDATA[
1.1075.2.89  raeburn  8115: function LC_Offload_Now() {
                   8116:     var dest = "$newurl";
                   8117:     if (dest != '') {
                   8118:         window.location.href="$newurl";
                   8119:     }
                   8120: }
1.1075.2.92  raeburn  8121: \$(document).ready(function () {
                   8122:     window.alert('$msg');
                   8123:     if ($disable_submit) {
1.1075.2.89  raeburn  8124:         \$(".LC_hwk_submit").prop("disabled", true);
                   8125:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8126:     }
                   8127:     setTimeout('LC_Offload_Now()', $timeout);
                   8128: });
                   8129: // ]]>
1.1075.2.89  raeburn  8130: </script>
                   8131: OFFLOAD
                   8132:                         }
                   8133:                     }
                   8134:                 }
                   8135:             }
                   8136:         }
1.313     albertel 8137:     }
1.306     albertel 8138:     if (!defined($title)) {
                   8139: 	$title = 'The LearningOnline Network with CAPA';
                   8140:     }
1.460     albertel 8141:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8142:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8143: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8144:     if (!$args->{'frameset'}) {
                   8145:         $result .= ' /';
                   8146:     }
                   8147:     $result .= '>'
1.1064    raeburn  8148:         .$inhibitprint
1.414     albertel 8149: 	.$head_extra;
1.1075.2.108  raeburn  8150:     my $clientmobile;
                   8151:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8152:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8153:     } else {
                   8154:         $clientmobile = $env{'browser.mobile'};
                   8155:     }
                   8156:     if ($clientmobile) {
1.1075.2.42  raeburn  8157:         $result .= '
                   8158: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8159: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8160:     }
1.1075.2.126  raeburn  8161:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8162:     return $result.'</head>';
1.306     albertel 8163: }
                   8164: 
                   8165: =pod
                   8166: 
1.340     albertel 8167: =item * &font_settings()
                   8168: 
                   8169: Returns neccessary <meta> to set the proper encoding
                   8170: 
1.1075.2.56  raeburn  8171: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8172: 
                   8173: =cut
                   8174: 
                   8175: sub font_settings {
1.1075.2.56  raeburn  8176:     my ($args) = @_;
1.340     albertel 8177:     my $headerstring='';
1.1075.2.56  raeburn  8178:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8179:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8180: 	$headerstring.=
1.1075.2.61  raeburn  8181: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8182:         if (!$args->{'frameset'}) {
                   8183:             $headerstring.= ' /';
                   8184:         }
                   8185:         $headerstring .= '>'."\n";
1.340     albertel 8186:     }
                   8187:     return $headerstring;
                   8188: }
                   8189: 
1.341     albertel 8190: =pod
                   8191: 
1.1064    raeburn  8192: =item * &print_suppression()
                   8193: 
                   8194: In course context returns css which causes the body to be blank when media="print",
                   8195: if printout generation is unavailable for the current resource.
                   8196: 
                   8197: This could be because:
                   8198: 
                   8199: (a) printstartdate is in the future
                   8200: 
                   8201: (b) printenddate is in the past
                   8202: 
                   8203: (c) there is an active exam block with "printout"
                   8204: functionality blocked
                   8205: 
                   8206: Users with pav, pfo or evb privileges are exempt.
                   8207: 
                   8208: Inputs: none
                   8209: 
                   8210: =cut
                   8211: 
                   8212: 
                   8213: sub print_suppression {
                   8214:     my $noprint;
                   8215:     if ($env{'request.course.id'}) {
                   8216:         my $scope = $env{'request.course.id'};
                   8217:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8218:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8219:             return;
                   8220:         }
                   8221:         if ($env{'request.course.sec'} ne '') {
                   8222:             $scope .= "/$env{'request.course.sec'}";
                   8223:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8224:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8225:                 return;
1.1064    raeburn  8226:             }
                   8227:         }
                   8228:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8229:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73  raeburn  8230:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  8231:         if ($blocked) {
                   8232:             my $checkrole = "cm./$cdom/$cnum";
                   8233:             if ($env{'request.course.sec'} ne '') {
                   8234:                 $checkrole .= "/$env{'request.course.sec'}";
                   8235:             }
                   8236:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8237:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8238:                 $noprint = 1;
                   8239:             }
                   8240:         }
                   8241:         unless ($noprint) {
                   8242:             my $symb = &Apache::lonnet::symbread();
                   8243:             if ($symb ne '') {
                   8244:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8245:                 if (ref($navmap)) {
                   8246:                     my $res = $navmap->getBySymb($symb);
                   8247:                     if (ref($res)) {
                   8248:                         if (!$res->resprintable()) {
                   8249:                             $noprint = 1;
                   8250:                         }
                   8251:                     }
                   8252:                 }
                   8253:             }
                   8254:         }
                   8255:         if ($noprint) {
                   8256:             return <<"ENDSTYLE";
                   8257: <style type="text/css" media="print">
                   8258:     body { display:none }
                   8259: </style>
                   8260: ENDSTYLE
                   8261:         }
                   8262:     }
                   8263:     return;
                   8264: }
                   8265: 
                   8266: =pod
                   8267: 
1.341     albertel 8268: =item * &xml_begin()
                   8269: 
                   8270: Returns the needed doctype and <html>
                   8271: 
                   8272: Inputs: none
                   8273: 
                   8274: =cut
                   8275: 
                   8276: sub xml_begin {
1.1075.2.61  raeburn  8277:     my ($is_frameset) = @_;
1.341     albertel 8278:     my $output='';
                   8279: 
                   8280:     if ($env{'browser.mathml'}) {
                   8281: 	$output='<?xml version="1.0"?>'
                   8282:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8283: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8284:             
                   8285: #	    .'<!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">] >'
                   8286: 	    .'<!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">'
                   8287:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8288: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8289:     } elsif ($is_frameset) {
                   8290:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8291:                 '<html>'."\n";
1.341     albertel 8292:     } else {
1.1075.2.61  raeburn  8293: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8294:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8295:     }
                   8296:     return $output;
                   8297: }
1.340     albertel 8298: 
                   8299: =pod
                   8300: 
1.306     albertel 8301: =item * &start_page()
                   8302: 
                   8303: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8304: 
1.648     raeburn  8305: Inputs:
                   8306: 
                   8307: =over 4
                   8308: 
                   8309: $title - optional title for the page
                   8310: 
                   8311: $head_extra - optional extra HTML to incude inside the <head>
                   8312: 
                   8313: $args - additional optional args supported are:
                   8314: 
                   8315: =over 8
                   8316: 
                   8317:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8318:                                     arg on
1.814     bisitz   8319:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8320:              add_entries    -> additional attributes to add to the  <body>
                   8321:              domain         -> force to color decorate a page for a 
1.317     albertel 8322:                                     specific domain
1.648     raeburn  8323:              function       -> force usage of a specific rolish color
1.317     albertel 8324:                                     scheme
1.648     raeburn  8325:              redirect       -> see &headtag()
                   8326:              bgcolor        -> override the default page bg color
                   8327:              js_ready       -> return a string ready for being used in 
1.317     albertel 8328:                                     a javascript writeln
1.648     raeburn  8329:              html_encode    -> return a string ready for being used in 
1.320     albertel 8330:                                     a html attribute
1.648     raeburn  8331:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8332:                                     $forcereg arg
1.648     raeburn  8333:              frameset       -> if true will start with a <frameset>
1.330     albertel 8334:                                     rather than <body>
1.648     raeburn  8335:              skip_phases    -> hash ref of 
1.338     albertel 8336:                                     head -> skip the <html><head> generation
                   8337:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8338:              no_inline_link -> if true and in remote mode, don't show the
                   8339:                                     'Switch To Inline Menu' link
1.648     raeburn  8340:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8341:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8342:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8343:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8344:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8345:              group          -> includes the current group, if page is for a
                   8346:                                specific group
1.1075.2.133  raeburn  8347:              use_absolute   -> for request for external resource or syllabus, this
                   8348:                                will contain https://<hostname> if server uses
                   8349:                                https (as per hosts.tab), but request is for http
                   8350:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.361     albertel 8351: 
1.648     raeburn  8352: =back
1.460     albertel 8353: 
1.648     raeburn  8354: =back
1.562     albertel 8355: 
1.306     albertel 8356: =cut
                   8357: 
                   8358: sub start_page {
1.309     albertel 8359:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8360:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8361: 
1.315     albertel 8362:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8363:     my ($result,@advtools);
1.964     droeschl 8364: 
1.338     albertel 8365:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8366:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8367:     }
                   8368:     
                   8369:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8370: 	if ($args->{'frameset'}) {
                   8371: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8372: 						$args->{'add_entries'});
                   8373: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8374:         } else {
                   8375:             $result .=
                   8376:                 &bodytag($title, 
                   8377:                          $args->{'function'},       $args->{'add_entries'},
                   8378:                          $args->{'only_body'},      $args->{'domain'},
                   8379:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8380:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8381:                          $args,                     \@advtools);
1.831     bisitz   8382:         }
1.330     albertel 8383:     }
1.338     albertel 8384: 
1.315     albertel 8385:     if ($args->{'js_ready'}) {
1.713     kaisler  8386: 		$result = &js_ready($result);
1.315     albertel 8387:     }
1.320     albertel 8388:     if ($args->{'html_encode'}) {
1.713     kaisler  8389: 		$result = &html_encode($result);
                   8390:     }
                   8391: 
1.813     bisitz   8392:     # Preparation for new and consistent functionlist at top of screen
                   8393:     # if ($args->{'functionlist'}) {
                   8394:     #            $result .= &build_functionlist();
                   8395:     #}
                   8396: 
1.964     droeschl 8397:     # Don't add anything more if only_body wanted or in const space
                   8398:     return $result if    $args->{'only_body'} 
                   8399:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8400: 
                   8401:     #Breadcrumbs
1.758     kaisler  8402:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8403: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8404: 		#if any br links exists, add them to the breadcrumbs
                   8405: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8406: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8407: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8408: 			}
                   8409: 		}
1.1075.2.19  raeburn  8410:                 # if @advtools array contains items add then to the breadcrumbs
                   8411:                 if (@advtools > 0) {
                   8412:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8413:                 }
1.1075.2.123  raeburn  8414:                 my $menulink;
                   8415:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8416:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8417:                     $menulink = 0;
                   8418:                 } else {
                   8419:                     undef($menulink);
                   8420:                 }
1.758     kaisler  8421: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8422: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8423: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8424: 		}else{
1.1075.2.123  raeburn  8425: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8426: 		}
1.1075.2.24  raeburn  8427:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8428:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8429:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8430:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8431:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8432:     }
1.315     albertel 8433:     return $result;
1.306     albertel 8434: }
                   8435: 
                   8436: sub end_page {
1.315     albertel 8437:     my ($args) = @_;
                   8438:     $env{'internal.end_page'}++;
1.330     albertel 8439:     my $result;
1.335     albertel 8440:     if ($args->{'discussion'}) {
                   8441: 	my ($target,$parser);
                   8442: 	if (ref($args->{'discussion'})) {
                   8443: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8444: 				$args->{'discussion'}{'parser'});
                   8445: 	}
                   8446: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8447:     }
1.330     albertel 8448:     if ($args->{'frameset'}) {
                   8449: 	$result .= '</frameset>';
                   8450:     } else {
1.635     raeburn  8451: 	$result .= &endbodytag($args);
1.330     albertel 8452:     }
1.1075.2.6  raeburn  8453:     unless ($args->{'notbody'}) {
                   8454:         $result .= "\n</html>";
                   8455:     }
1.330     albertel 8456: 
1.315     albertel 8457:     if ($args->{'js_ready'}) {
1.317     albertel 8458: 	$result = &js_ready($result);
1.315     albertel 8459:     }
1.335     albertel 8460: 
1.320     albertel 8461:     if ($args->{'html_encode'}) {
                   8462: 	$result = &html_encode($result);
                   8463:     }
1.335     albertel 8464: 
1.315     albertel 8465:     return $result;
                   8466: }
                   8467: 
1.1034    www      8468: sub wishlist_window {
                   8469:     return(<<'ENDWISHLIST');
1.1046    raeburn  8470: <script type="text/javascript">
1.1034    www      8471: // <![CDATA[
                   8472: // <!-- BEGIN LON-CAPA Internal
                   8473: function set_wishlistlink(title, path) {
                   8474:     if (!title) {
                   8475:         title = document.title;
                   8476:         title = title.replace(/^LON-CAPA /,'');
                   8477:     }
1.1075.2.65  raeburn  8478:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8479:     title = title.replace("'","\\\'");
1.1034    www      8480:     if (!path) {
                   8481:         path = location.pathname;
                   8482:     }
1.1075.2.65  raeburn  8483:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8484:     path = path.replace("'","\\\'");
1.1034    www      8485:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8486:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8487: }
                   8488: // END LON-CAPA Internal -->
                   8489: // ]]>
                   8490: </script>
                   8491: ENDWISHLIST
                   8492: }
                   8493: 
1.1030    www      8494: sub modal_window {
                   8495:     return(<<'ENDMODAL');
1.1046    raeburn  8496: <script type="text/javascript">
1.1030    www      8497: // <![CDATA[
                   8498: // <!-- BEGIN LON-CAPA Internal
                   8499: var modalWindow = {
                   8500: 	parent:"body",
                   8501: 	windowId:null,
                   8502: 	content:null,
                   8503: 	width:null,
                   8504: 	height:null,
                   8505: 	close:function()
                   8506: 	{
                   8507: 	        $(".LCmodal-window").remove();
                   8508: 	        $(".LCmodal-overlay").remove();
                   8509: 	},
                   8510: 	open:function()
                   8511: 	{
                   8512: 		var modal = "";
                   8513: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8514: 		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;\">";
                   8515: 		modal += this.content;
                   8516: 		modal += "</div>";	
                   8517: 
                   8518: 		$(this.parent).append(modal);
                   8519: 
                   8520: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8521: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8522: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8523: 	}
                   8524: };
1.1075.2.42  raeburn  8525: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8526: 	{
1.1075.2.119  raeburn  8527:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8528: 		modalWindow.windowId = "myModal";
                   8529: 		modalWindow.width = width;
                   8530: 		modalWindow.height = height;
1.1075.2.80  raeburn  8531: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8532: 		modalWindow.open();
1.1075.2.87  raeburn  8533: 	};
1.1030    www      8534: // END LON-CAPA Internal -->
                   8535: // ]]>
                   8536: </script>
                   8537: ENDMODAL
                   8538: }
                   8539: 
                   8540: sub modal_link {
1.1075.2.42  raeburn  8541:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8542:     unless ($width) { $width=480; }
                   8543:     unless ($height) { $height=400; }
1.1031    www      8544:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8545:     unless ($transparency) { $transparency='true'; }
                   8546: 
1.1074    raeburn  8547:     my $target_attr;
                   8548:     if (defined($target)) {
                   8549:         $target_attr = 'target="'.$target.'"';
                   8550:     }
                   8551:     return <<"ENDLINK";
1.1075.2.141.  .3(raebu 8552:20): <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8553: ENDLINK
1.1030    www      8554: }
                   8555: 
1.1032    www      8556: sub modal_adhoc_script {
                   8557:     my ($funcname,$width,$height,$content)=@_;
                   8558:     return (<<ENDADHOC);
1.1046    raeburn  8559: <script type="text/javascript">
1.1032    www      8560: // <![CDATA[
                   8561:         var $funcname = function()
                   8562:         {
                   8563:                 modalWindow.windowId = "myModal";
                   8564:                 modalWindow.width = $width;
                   8565:                 modalWindow.height = $height;
                   8566:                 modalWindow.content = '$content';
                   8567:                 modalWindow.open();
                   8568:         };  
                   8569: // ]]>
                   8570: </script>
                   8571: ENDADHOC
                   8572: }
                   8573: 
1.1041    www      8574: sub modal_adhoc_inner {
                   8575:     my ($funcname,$width,$height,$content)=@_;
                   8576:     my $innerwidth=$width-20;
                   8577:     $content=&js_ready(
1.1042    www      8578:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8579:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8580:                  $content.
1.1041    www      8581:                  &end_scrollbox().
1.1075.2.42  raeburn  8582:                  &end_page()
1.1041    www      8583:              );
                   8584:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8585: }
                   8586: 
                   8587: sub modal_adhoc_window {
                   8588:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8589:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8590:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8591: }
                   8592: 
                   8593: sub modal_adhoc_launch {
                   8594:     my ($funcname,$width,$height,$content)=@_;
                   8595:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8596: <script type="text/javascript">
                   8597: // <![CDATA[
                   8598: $funcname();
                   8599: // ]]>
                   8600: </script>
                   8601: ENDLAUNCH
                   8602: }
                   8603: 
                   8604: sub modal_adhoc_close {
                   8605:     return (<<ENDCLOSE);
                   8606: <script type="text/javascript">
                   8607: // <![CDATA[
                   8608: modalWindow.close();
                   8609: // ]]>
                   8610: </script>
                   8611: ENDCLOSE
                   8612: }
                   8613: 
1.1038    www      8614: sub togglebox_script {
                   8615:    return(<<ENDTOGGLE);
                   8616: <script type="text/javascript"> 
                   8617: // <![CDATA[
                   8618: function LCtoggleDisplay(id,hidetext,showtext) {
                   8619:    link = document.getElementById(id + "link").childNodes[0];
                   8620:    with (document.getElementById(id).style) {
                   8621:       if (display == "none" ) {
                   8622:           display = "inline";
                   8623:           link.nodeValue = hidetext;
                   8624:         } else {
                   8625:           display = "none";
                   8626:           link.nodeValue = showtext;
                   8627:        }
                   8628:    }
                   8629: }
                   8630: // ]]>
                   8631: </script>
                   8632: ENDTOGGLE
                   8633: }
                   8634: 
1.1039    www      8635: sub start_togglebox {
                   8636:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8637:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8638:     unless ($showtext) { $showtext=&mt('show'); }
                   8639:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8640:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8641:     return &start_data_table().
                   8642:            &start_data_table_header_row().
                   8643:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8644:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8645:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8646:            &end_data_table_header_row().
                   8647:            '<tr id="'.$id.'" style="display:none""><td>';
                   8648: }
                   8649: 
                   8650: sub end_togglebox {
                   8651:     return '</td></tr>'.&end_data_table();
                   8652: }
                   8653: 
1.1041    www      8654: sub LCprogressbar_script {
1.1075.2.130  raeburn  8655:    my ($id,$number_to_do)=@_;
                   8656:    if ($number_to_do) {
                   8657:        return(<<ENDPROGRESS);
1.1041    www      8658: <script type="text/javascript">
                   8659: // <![CDATA[
1.1045    www      8660: \$('#progressbar$id').progressbar({
1.1041    www      8661:   value: 0,
                   8662:   change: function(event, ui) {
                   8663:     var newVal = \$(this).progressbar('option', 'value');
                   8664:     \$('.pblabel', this).text(LCprogressTxt);
                   8665:   }
                   8666: });
                   8667: // ]]>
                   8668: </script>
                   8669: ENDPROGRESS
1.1075.2.130  raeburn  8670:    } else {
                   8671:        return(<<ENDPROGRESS);
                   8672: <script type="text/javascript">
                   8673: // <![CDATA[
                   8674: \$('#progressbar$id').progressbar({
                   8675:   value: false,
                   8676:   create: function(event, ui) {
                   8677:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8678:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8679:   }
                   8680: });
                   8681: // ]]>
                   8682: </script>
                   8683: ENDPROGRESS
                   8684:    }
1.1041    www      8685: }
                   8686: 
                   8687: sub LCprogressbarUpdate_script {
                   8688:    return(<<ENDPROGRESSUPDATE);
                   8689: <style type="text/css">
                   8690: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8691: .progress-label {position: absolute; width: 100%; text-align: center; top: 1px; font-weight: bold; text-shadow: 1px 1px 0 #fff;margin: 0; line-height: 200%; }
1.1041    www      8692: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8693: </style>
                   8694: <script type="text/javascript">
                   8695: // <![CDATA[
1.1045    www      8696: var LCprogressTxt='---';
                   8697: 
1.1075.2.130  raeburn  8698: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8699:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8700:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8701:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8702:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8703:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8704:    } else {
                   8705:        \$('#progressbar'+id).progressbar('value',percent);
                   8706:    }
1.1041    www      8707: }
                   8708: // ]]>
                   8709: </script>
                   8710: ENDPROGRESSUPDATE
                   8711: }
                   8712: 
1.1042    www      8713: my $LClastpercent;
1.1045    www      8714: my $LCidcnt;
                   8715: my $LCcurrentid;
1.1042    www      8716: 
1.1041    www      8717: sub LCprogressbar {
1.1075.2.130  raeburn  8718:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8719:     $LClastpercent=0;
1.1045    www      8720:     $LCidcnt++;
                   8721:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8722:     my ($starting,$content);
                   8723:     if ($number_to_do) {
                   8724:         $starting=&mt('Starting');
                   8725:         $content=(<<ENDPROGBAR);
                   8726: $preamble
1.1045    www      8727:   <div id="progressbar$LCcurrentid">
1.1041    www      8728:     <span class="pblabel">$starting</span>
                   8729:   </div>
                   8730: ENDPROGBAR
1.1075.2.130  raeburn  8731:     } else {
                   8732:         $starting=&mt('Loading...');
                   8733:         $LClastpercent='false';
                   8734:         $content=(<<ENDPROGBAR);
                   8735: $preamble
                   8736:   <div id="progressbar$LCcurrentid">
                   8737:       <div class="progress-label">$starting</div>
                   8738:   </div>
                   8739: ENDPROGBAR
                   8740:     }
                   8741:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8742: }
                   8743: 
                   8744: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8745:     my ($r,$val,$text,$number_to_do)=@_;
                   8746:     if ($number_to_do) {
                   8747:         unless ($val) { 
                   8748:             if ($LClastpercent) {
                   8749:                 $val=$LClastpercent;
                   8750:             } else {
                   8751:                 $val=0;
                   8752:             }
                   8753:         }
                   8754:         if ($val<0) { $val=0; }
                   8755:         if ($val>100) { $val=0; }
                   8756:         $LClastpercent=$val;
                   8757:         unless ($text) { $text=$val.'%'; }
                   8758:     } else {
                   8759:         $val = 'false';
1.1042    www      8760:     }
1.1041    www      8761:     $text=&js_ready($text);
1.1044    www      8762:     &r_print($r,<<ENDUPDATE);
1.1041    www      8763: <script type="text/javascript">
                   8764: // <![CDATA[
1.1075.2.130  raeburn  8765: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8766: // ]]>
                   8767: </script>
                   8768: ENDUPDATE
1.1035    www      8769: }
                   8770: 
1.1042    www      8771: sub LCprogressbarClose {
                   8772:     my ($r)=@_;
                   8773:     $LClastpercent=0;
1.1044    www      8774:     &r_print($r,<<ENDCLOSE);
1.1042    www      8775: <script type="text/javascript">
                   8776: // <![CDATA[
1.1045    www      8777: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8778: // ]]>
                   8779: </script>
                   8780: ENDCLOSE
1.1044    www      8781: }
                   8782: 
                   8783: sub r_print {
                   8784:     my ($r,$to_print)=@_;
                   8785:     if ($r) {
                   8786:       $r->print($to_print);
                   8787:       $r->rflush();
                   8788:     } else {
                   8789:       print($to_print);
                   8790:     }
1.1042    www      8791: }
                   8792: 
1.320     albertel 8793: sub html_encode {
                   8794:     my ($result) = @_;
                   8795: 
1.322     albertel 8796:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8797:     
                   8798:     return $result;
                   8799: }
1.1044    www      8800: 
1.317     albertel 8801: sub js_ready {
                   8802:     my ($result) = @_;
                   8803: 
1.323     albertel 8804:     $result =~ s/[\n\r]/ /xmsg;
                   8805:     $result =~ s/\\/\\\\/xmsg;
                   8806:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8807:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8808:     
                   8809:     return $result;
                   8810: }
                   8811: 
1.315     albertel 8812: sub validate_page {
                   8813:     if (  exists($env{'internal.start_page'})
1.316     albertel 8814: 	  &&     $env{'internal.start_page'} > 1) {
                   8815: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8816: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8817: 				 $ENV{'request.filename'});
1.315     albertel 8818:     }
                   8819:     if (  exists($env{'internal.end_page'})
1.316     albertel 8820: 	  &&     $env{'internal.end_page'} > 1) {
                   8821: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8822: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8823: 				 $env{'request.filename'});
1.315     albertel 8824:     }
                   8825:     if (     exists($env{'internal.start_page'})
                   8826: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8827: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8828: 				 $env{'request.filename'});
1.315     albertel 8829:     }
                   8830:     if (   ! exists($env{'internal.start_page'})
                   8831: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8832: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8833: 				 $env{'request.filename'});
1.315     albertel 8834:     }
1.306     albertel 8835: }
1.315     albertel 8836: 
1.996     www      8837: 
                   8838: sub start_scrollbox {
1.1075.2.56  raeburn  8839:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8840:     unless ($outerwidth) { $outerwidth='520px'; }
                   8841:     unless ($width) { $width='500px'; }
                   8842:     unless ($height) { $height='200px'; }
1.1075    raeburn  8843:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8844:     if ($id ne '') {
1.1075.2.42  raeburn  8845:         $table_id = ' id="table_'.$id.'"';
                   8846:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8847:     }
1.1075    raeburn  8848:     if ($bgcolor ne '') {
                   8849:         $tdcol = "background-color: $bgcolor;";
                   8850:     }
1.1075.2.42  raeburn  8851:     my $nicescroll_js;
                   8852:     if ($env{'browser.mobile'}) {
                   8853:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8854:     }
1.1075    raeburn  8855:     return <<"END";
1.1075.2.42  raeburn  8856: $nicescroll_js
                   8857: 
                   8858: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8859: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8860: END
1.996     www      8861: }
                   8862: 
                   8863: sub end_scrollbox {
1.1036    www      8864:     return '</div></td></tr></table>';
1.996     www      8865: }
                   8866: 
1.1075.2.42  raeburn  8867: sub nicescroll_javascript {
                   8868:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8869:     my %options;
                   8870:     if (ref($cursor) eq 'HASH') {
                   8871:         %options = %{$cursor};
                   8872:     }
                   8873:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8874:         $options{'railalign'} = 'left';
                   8875:     }
                   8876:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8877:         my $function  = &get_users_function();
                   8878:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8879:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8880:             $options{'cursorcolor'} = '#00F';
                   8881:         }
                   8882:     }
                   8883:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8884:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8885:             $options{'cursoropacity'}='1.0';
                   8886:         }
                   8887:     } else {
                   8888:         $options{'cursoropacity'}='1.0';
                   8889:     }
                   8890:     if ($options{'cursorfixedheight'} eq 'none') {
                   8891:         delete($options{'cursorfixedheight'});
                   8892:     } else {
                   8893:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8894:     }
                   8895:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8896:         delete($options{'railoffset'});
                   8897:     }
                   8898:     my @niceoptions;
                   8899:     while (my($key,$value) = each(%options)) {
                   8900:         if ($value =~ /^\{.+\}$/) {
                   8901:             push(@niceoptions,$key.':'.$value);
                   8902:         } else {
                   8903:             push(@niceoptions,$key.':"'.$value.'"');
                   8904:         }
                   8905:     }
                   8906:     my $nicescroll_js = '
                   8907: $(document).ready(
                   8908:       function() {
                   8909:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8910:       }
                   8911: );
                   8912: ';
                   8913:     if ($framecheck) {
                   8914:         $nicescroll_js .= '
                   8915: function expand_div(caller) {
                   8916:     if (top === self) {
                   8917:         document.getElementById("'.$id.'").style.width = "auto";
                   8918:         document.getElementById("'.$id.'").style.height = "auto";
                   8919:     } else {
                   8920:         try {
                   8921:             if (parent.frames) {
                   8922:                 if (parent.frames.length > 1) {
                   8923:                     var framesrc = parent.frames[1].location.href;
                   8924:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8925:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8926:                         document.getElementById("'.$id.'").style.width = "auto";
                   8927:                         document.getElementById("'.$id.'").style.height = "auto";
                   8928:                     }
                   8929:                 }
                   8930:             }
                   8931:         } catch (e) {
                   8932:             return;
                   8933:         }
                   8934:     }
                   8935:     return;
                   8936: }
                   8937: ';
                   8938:     }
                   8939:     if ($needjsready) {
                   8940:         $nicescroll_js = '
                   8941: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8942:     } else {
                   8943:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8944:     }
                   8945:     return $nicescroll_js;
                   8946: }
                   8947: 
1.318     albertel 8948: sub simple_error_page {
1.1075.2.49  raeburn  8949:     my ($r,$title,$msg,$args) = @_;
                   8950:     if (ref($args) eq 'HASH') {
                   8951:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8952:     } else {
                   8953:         $msg = &mt($msg);
                   8954:     }
                   8955: 
1.318     albertel 8956:     my $page =
                   8957: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8958: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8959: 	&Apache::loncommon::end_page();
                   8960:     if (ref($r)) {
                   8961: 	$r->print($page);
1.327     albertel 8962: 	return;
1.318     albertel 8963:     }
                   8964:     return $page;
                   8965: }
1.347     albertel 8966: 
                   8967: {
1.610     albertel 8968:     my @row_count;
1.961     onken    8969: 
                   8970:     sub start_data_table_count {
                   8971:         unshift(@row_count, 0);
                   8972:         return;
                   8973:     }
                   8974: 
                   8975:     sub end_data_table_count {
                   8976:         shift(@row_count);
                   8977:         return;
                   8978:     }
                   8979: 
1.347     albertel 8980:     sub start_data_table {
1.1018    raeburn  8981: 	my ($add_class,$id) = @_;
1.422     albertel 8982: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8983:         my $table_id;
                   8984:         if (defined($id)) {
                   8985:             $table_id = ' id="'.$id.'"';
                   8986:         }
1.961     onken    8987: 	&start_data_table_count();
1.1018    raeburn  8988: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8989:     }
                   8990: 
                   8991:     sub end_data_table {
1.961     onken    8992: 	&end_data_table_count();
1.389     albertel 8993: 	return '</table>'."\n";;
1.347     albertel 8994:     }
                   8995: 
                   8996:     sub start_data_table_row {
1.974     wenzelju 8997: 	my ($add_class, $id) = @_;
1.610     albertel 8998: 	$row_count[0]++;
                   8999: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9000: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9001:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9002:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9003:     }
1.471     banghart 9004:     
                   9005:     sub continue_data_table_row {
1.974     wenzelju 9006: 	my ($add_class, $id) = @_;
1.610     albertel 9007: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9008: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9009:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9010:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9011:     }
1.347     albertel 9012: 
                   9013:     sub end_data_table_row {
1.389     albertel 9014: 	return '</tr>'."\n";;
1.347     albertel 9015:     }
1.367     www      9016: 
1.421     albertel 9017:     sub start_data_table_empty_row {
1.707     bisitz   9018: #	$row_count[0]++;
1.421     albertel 9019: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9020:     }
                   9021: 
                   9022:     sub end_data_table_empty_row {
                   9023: 	return '</tr>'."\n";;
                   9024:     }
                   9025: 
1.367     www      9026:     sub start_data_table_header_row {
1.389     albertel 9027: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9028:     }
                   9029: 
                   9030:     sub end_data_table_header_row {
1.389     albertel 9031: 	return '</tr>'."\n";;
1.367     www      9032:     }
1.890     droeschl 9033: 
                   9034:     sub data_table_caption {
                   9035:         my $caption = shift;
                   9036:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9037:     }
1.347     albertel 9038: }
                   9039: 
1.548     albertel 9040: =pod
                   9041: 
                   9042: =item * &inhibit_menu_check($arg)
                   9043: 
                   9044: Checks for a inhibitmenu state and generates output to preserve it
                   9045: 
                   9046: Inputs:         $arg - can be any of
                   9047:                      - undef - in which case the return value is a string 
                   9048:                                to add  into arguments list of a uri
                   9049:                      - 'input' - in which case the return value is a HTML
                   9050:                                  <form> <input> field of type hidden to
                   9051:                                  preserve the value
                   9052:                      - a url - in which case the return value is the url with
                   9053:                                the neccesary cgi args added to preserve the
                   9054:                                inhibitmenu state
                   9055:                      - a ref to a url - no return value, but the string is
                   9056:                                         updated to include the neccessary cgi
                   9057:                                         args to preserve the inhibitmenu state
                   9058: 
                   9059: =cut
                   9060: 
                   9061: sub inhibit_menu_check {
                   9062:     my ($arg) = @_;
                   9063:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9064:     if ($arg eq 'input') {
                   9065: 	if ($env{'form.inhibitmenu'}) {
                   9066: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9067: 	} else {
                   9068: 	    return
                   9069: 	}
                   9070:     }
                   9071:     if ($env{'form.inhibitmenu'}) {
                   9072: 	if (ref($arg)) {
                   9073: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9074: 	} elsif ($arg eq '') {
                   9075: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9076: 	} else {
                   9077: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9078: 	}
                   9079:     }
                   9080:     if (!ref($arg)) {
                   9081: 	return $arg;
                   9082:     }
                   9083: }
                   9084: 
1.251     albertel 9085: ###############################################
1.182     matthew  9086: 
                   9087: =pod
                   9088: 
1.549     albertel 9089: =back
                   9090: 
                   9091: =head1 User Information Routines
                   9092: 
                   9093: =over 4
                   9094: 
1.405     albertel 9095: =item * &get_users_function()
1.182     matthew  9096: 
                   9097: Used by &bodytag to determine the current users primary role.
                   9098: Returns either 'student','coordinator','admin', or 'author'.
                   9099: 
                   9100: =cut
                   9101: 
                   9102: ###############################################
                   9103: sub get_users_function {
1.815     tempelho 9104:     my $function = 'norole';
1.818     tempelho 9105:     if ($env{'request.role'}=~/^(st)/) {
                   9106:         $function='student';
                   9107:     }
1.907     raeburn  9108:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9109:         $function='coordinator';
                   9110:     }
1.258     albertel 9111:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9112:         $function='admin';
                   9113:     }
1.826     bisitz   9114:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9115:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9116:         $function='author';
                   9117:     }
                   9118:     return $function;
1.54      www      9119: }
1.99      www      9120: 
                   9121: ###############################################
                   9122: 
1.233     raeburn  9123: =pod
                   9124: 
1.821     raeburn  9125: =item * &show_course()
                   9126: 
                   9127: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9128: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9129: 
                   9130: Inputs:
                   9131: None
                   9132: 
                   9133: Outputs:
                   9134: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9135: 
                   9136: =cut
                   9137: 
                   9138: ###############################################
                   9139: sub show_course {
                   9140:     my $course = !$env{'user.adv'};
                   9141:     if (!$env{'user.adv'}) {
                   9142:         foreach my $env (keys(%env)) {
                   9143:             next if ($env !~ m/^user\.priv\./);
                   9144:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9145:                 $course = 0;
                   9146:                 last;
                   9147:             }
                   9148:         }
                   9149:     }
                   9150:     return $course;
                   9151: }
                   9152: 
                   9153: ###############################################
                   9154: 
                   9155: =pod
                   9156: 
1.542     raeburn  9157: =item * &check_user_status()
1.274     raeburn  9158: 
                   9159: Determines current status of supplied role for a
                   9160: specific user. Roles can be active, previous or future.
                   9161: 
                   9162: Inputs: 
                   9163: user's domain, user's username, course's domain,
1.375     raeburn  9164: course's number, optional section ID.
1.274     raeburn  9165: 
                   9166: Outputs:
                   9167: role status: active, previous or future. 
                   9168: 
                   9169: =cut
                   9170: 
                   9171: sub check_user_status {
1.412     raeburn  9172:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9173:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9174:     my @uroles = keys(%userinfo);
1.274     raeburn  9175:     my $srchstr;
                   9176:     my $active_chk = 'none';
1.412     raeburn  9177:     my $now = time;
1.274     raeburn  9178:     if (@uroles > 0) {
1.908     raeburn  9179:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9180:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9181:         } else {
1.412     raeburn  9182:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9183:         }
                   9184:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9185:             my $role_end = 0;
                   9186:             my $role_start = 0;
                   9187:             $active_chk = 'active';
1.412     raeburn  9188:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9189:                 $role_end = $1;
                   9190:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9191:                     $role_start = $1;
1.274     raeburn  9192:                 }
                   9193:             }
                   9194:             if ($role_start > 0) {
1.412     raeburn  9195:                 if ($now < $role_start) {
1.274     raeburn  9196:                     $active_chk = 'future';
                   9197:                 }
                   9198:             }
                   9199:             if ($role_end > 0) {
1.412     raeburn  9200:                 if ($now > $role_end) {
1.274     raeburn  9201:                     $active_chk = 'previous';
                   9202:                 }
                   9203:             }
                   9204:         }
                   9205:     }
                   9206:     return $active_chk;
                   9207: }
                   9208: 
                   9209: ###############################################
                   9210: 
                   9211: =pod
                   9212: 
1.405     albertel 9213: =item * &get_sections()
1.233     raeburn  9214: 
                   9215: Determines all the sections for a course including
                   9216: sections with students and sections containing other roles.
1.419     raeburn  9217: Incoming parameters: 
                   9218: 
                   9219: 1. domain
                   9220: 2. course number 
                   9221: 3. reference to array containing roles for which sections should 
                   9222: be gathered (optional).
                   9223: 4. reference to array containing status types for which sections 
                   9224: should be gathered (optional).
                   9225: 
                   9226: If the third argument is undefined, sections are gathered for any role. 
                   9227: If the fourth argument is undefined, sections are gathered for any status.
                   9228: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9229:  
1.374     raeburn  9230: Returns section hash (keys are section IDs, values are
                   9231: number of users in each section), subject to the
1.419     raeburn  9232: optional roles filter, optional status filter 
1.233     raeburn  9233: 
                   9234: =cut
                   9235: 
                   9236: ###############################################
                   9237: sub get_sections {
1.419     raeburn  9238:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9239:     if (!defined($cdom) || !defined($cnum)) {
                   9240:         my $cid =  $env{'request.course.id'};
                   9241: 
                   9242: 	return if (!defined($cid));
                   9243: 
                   9244:         $cdom = $env{'course.'.$cid.'.domain'};
                   9245:         $cnum = $env{'course.'.$cid.'.num'};
                   9246:     }
                   9247: 
                   9248:     my %sectioncount;
1.419     raeburn  9249:     my $now = time;
1.240     albertel 9250: 
1.1075.2.33  raeburn  9251:     my $check_students = 1;
                   9252:     my $only_students = 0;
                   9253:     if (ref($possible_roles) eq 'ARRAY') {
                   9254:         if (grep(/^st$/,@{$possible_roles})) {
                   9255:             if (@{$possible_roles} == 1) {
                   9256:                 $only_students = 1;
                   9257:             }
                   9258:         } else {
                   9259:             $check_students = 0;
                   9260:         }
                   9261:     }
                   9262: 
                   9263:     if ($check_students) {
1.276     albertel 9264: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9265: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9266: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9267:         my $start_index = &Apache::loncoursedata::CL_START();
                   9268:         my $end_index = &Apache::loncoursedata::CL_END();
                   9269:         my $status;
1.366     albertel 9270: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9271: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9272: 				                     $data->[$status_index],
                   9273:                                                      $data->[$start_index],
                   9274:                                                      $data->[$end_index]);
                   9275:             if ($stu_status eq 'Active') {
                   9276:                 $status = 'active';
                   9277:             } elsif ($end < $now) {
                   9278:                 $status = 'previous';
                   9279:             } elsif ($start > $now) {
                   9280:                 $status = 'future';
                   9281:             } 
                   9282: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9283:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9284:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9285: 		    $sectioncount{$section}++;
                   9286:                 }
1.240     albertel 9287: 	    }
                   9288: 	}
                   9289:     }
1.1075.2.33  raeburn  9290:     if ($only_students) {
                   9291:         return %sectioncount;
                   9292:     }
1.240     albertel 9293:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9294:     foreach my $user (sort(keys(%courseroles))) {
                   9295: 	if ($user !~ /^(\w{2})/) { next; }
                   9296: 	my ($role) = ($user =~ /^(\w{2})/);
                   9297: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9298: 	my ($section,$status);
1.240     albertel 9299: 	if ($role eq 'cr' &&
                   9300: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9301: 	    $section=$1;
                   9302: 	}
                   9303: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9304: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9305:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9306:         if ($end == -1 && $start == -1) {
                   9307:             next; #deleted role
                   9308:         }
                   9309:         if (!defined($possible_status)) { 
                   9310:             $sectioncount{$section}++;
                   9311:         } else {
                   9312:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9313:                 $status = 'active';
                   9314:             } elsif ($end < $now) {
                   9315:                 $status = 'future';
                   9316:             } elsif ($start > $now) {
                   9317:                 $status = 'previous';
                   9318:             }
                   9319:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9320:                 $sectioncount{$section}++;
                   9321:             }
                   9322:         }
1.233     raeburn  9323:     }
1.366     albertel 9324:     return %sectioncount;
1.233     raeburn  9325: }
                   9326: 
1.274     raeburn  9327: ###############################################
1.294     raeburn  9328: 
                   9329: =pod
1.405     albertel 9330: 
                   9331: =item * &get_course_users()
                   9332: 
1.275     raeburn  9333: Retrieves usernames:domains for users in the specified course
                   9334: with specific role(s), and access status. 
                   9335: 
                   9336: Incoming parameters:
1.277     albertel 9337: 1. course domain
                   9338: 2. course number
                   9339: 3. access status: users must have - either active, 
1.275     raeburn  9340: previous, future, or all.
1.277     albertel 9341: 4. reference to array of permissible roles
1.288     raeburn  9342: 5. reference to array of section restrictions (optional)
                   9343: 6. reference to results object (hash of hashes).
                   9344: 7. reference to optional userdata hash
1.609     raeburn  9345: 8. reference to optional statushash
1.630     raeburn  9346: 9. flag if privileged users (except those set to unhide in
                   9347:    course settings) should be excluded    
1.609     raeburn  9348: Keys of top level results hash are roles.
1.275     raeburn  9349: Keys of inner hashes are username:domain, with 
                   9350: values set to access type.
1.288     raeburn  9351: Optional userdata hash returns an array with arguments in the 
                   9352: same order as loncoursedata::get_classlist() for student data.
                   9353: 
1.609     raeburn  9354: Optional statushash returns
                   9355: 
1.288     raeburn  9356: Entries for end, start, section and status are blank because
                   9357: of the possibility of multiple values for non-student roles.
                   9358: 
1.275     raeburn  9359: =cut
1.405     albertel 9360: 
1.275     raeburn  9361: ###############################################
1.405     albertel 9362: 
1.275     raeburn  9363: sub get_course_users {
1.630     raeburn  9364:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9365:     my %idx = ();
1.419     raeburn  9366:     my %seclists;
1.288     raeburn  9367: 
                   9368:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9369:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9370:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9371:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9372:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9373:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9374:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9375:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9376: 
1.290     albertel 9377:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9378:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9379:         my $now = time;
1.277     albertel 9380:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9381:             my $match = 0;
1.412     raeburn  9382:             my $secmatch = 0;
1.419     raeburn  9383:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9384:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9385:             if ($section eq '') {
                   9386:                 $section = 'none';
                   9387:             }
1.291     albertel 9388:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9389:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9390:                     $secmatch = 1;
                   9391:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9392:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9393:                         $secmatch = 1;
                   9394:                     }
                   9395:                 } else {  
1.419     raeburn  9396: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9397: 		        $secmatch = 1;
                   9398:                     }
1.290     albertel 9399: 		}
1.412     raeburn  9400:                 if (!$secmatch) {
                   9401:                     next;
                   9402:                 }
1.419     raeburn  9403:             }
1.275     raeburn  9404:             if (defined($$types{'active'})) {
1.288     raeburn  9405:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9406:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9407:                     $match = 1;
1.275     raeburn  9408:                 }
                   9409:             }
                   9410:             if (defined($$types{'previous'})) {
1.609     raeburn  9411:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9412:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9413:                     $match = 1;
1.275     raeburn  9414:                 }
                   9415:             }
                   9416:             if (defined($$types{'future'})) {
1.609     raeburn  9417:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9418:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9419:                     $match = 1;
1.275     raeburn  9420:                 }
                   9421:             }
1.609     raeburn  9422:             if ($match) {
                   9423:                 push(@{$seclists{$student}},$section);
                   9424:                 if (ref($userdata) eq 'HASH') {
                   9425:                     $$userdata{$student} = $$classlist{$student};
                   9426:                 }
                   9427:                 if (ref($statushash) eq 'HASH') {
                   9428:                     $statushash->{$student}{'st'}{$section} = $status;
                   9429:                 }
1.288     raeburn  9430:             }
1.275     raeburn  9431:         }
                   9432:     }
1.412     raeburn  9433:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9434:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9435:         my $now = time;
1.609     raeburn  9436:         my %displaystatus = ( previous => 'Expired',
                   9437:                               active   => 'Active',
                   9438:                               future   => 'Future',
                   9439:                             );
1.1075.2.36  raeburn  9440:         my (%nothide,@possdoms);
1.630     raeburn  9441:         if ($hidepriv) {
                   9442:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9443:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9444:                 if ($user !~ /:/) {
                   9445:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9446:                 } else {
                   9447:                     $nothide{$user} = 1;
                   9448:                 }
                   9449:             }
1.1075.2.36  raeburn  9450:             my @possdoms = ($cdom);
                   9451:             if ($coursehash{'checkforpriv'}) {
                   9452:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9453:             }
1.630     raeburn  9454:         }
1.439     raeburn  9455:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9456:             my $match = 0;
1.412     raeburn  9457:             my $secmatch = 0;
1.439     raeburn  9458:             my $status;
1.412     raeburn  9459:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9460:             $user =~ s/:$//;
1.439     raeburn  9461:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9462:             if ($end == -1 || $start == -1) {
                   9463:                 next;
                   9464:             }
                   9465:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9466:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9467:                 my ($uname,$udom) = split(/:/,$user);
                   9468:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9469:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9470:                         $secmatch = 1;
                   9471:                     } elsif ($usec eq '') {
1.420     albertel 9472:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9473:                             $secmatch = 1;
                   9474:                         }
                   9475:                     } else {
                   9476:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9477:                             $secmatch = 1;
                   9478:                         }
                   9479:                     }
                   9480:                     if (!$secmatch) {
                   9481:                         next;
                   9482:                     }
1.288     raeburn  9483:                 }
1.419     raeburn  9484:                 if ($usec eq '') {
                   9485:                     $usec = 'none';
                   9486:                 }
1.275     raeburn  9487:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9488:                     if ($hidepriv) {
1.1075.2.36  raeburn  9489:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9490:                             (!$nothide{$uname.':'.$udom})) {
                   9491:                             next;
                   9492:                         }
                   9493:                     }
1.503     raeburn  9494:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9495:                         $status = 'previous';
                   9496:                     } elsif ($start > $now) {
                   9497:                         $status = 'future';
                   9498:                     } else {
                   9499:                         $status = 'active';
                   9500:                     }
1.277     albertel 9501:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9502:                         if ($status eq $type) {
1.420     albertel 9503:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9504:                                 push(@{$$users{$role}{$user}},$type);
                   9505:                             }
1.288     raeburn  9506:                             $match = 1;
                   9507:                         }
                   9508:                     }
1.419     raeburn  9509:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9510:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9511: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9512:                         }
1.420     albertel 9513:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9514:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9515:                         }
1.609     raeburn  9516:                         if (ref($statushash) eq 'HASH') {
                   9517:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9518:                         }
1.275     raeburn  9519:                     }
                   9520:                 }
                   9521:             }
                   9522:         }
1.290     albertel 9523:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9524:             if ((defined($cdom)) && (defined($cnum))) {
                   9525:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9526:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9527:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9528:                     next if ($owner eq '');
                   9529:                     my ($ownername,$ownerdom);
                   9530:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9531:                         $ownername = $1;
                   9532:                         $ownerdom = $2;
                   9533:                     } else {
                   9534:                         $ownername = $owner;
                   9535:                         $ownerdom = $cdom;
                   9536:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9537:                     }
                   9538:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9539:                     if (defined($userdata) && 
1.609     raeburn  9540: 			!exists($$userdata{$owner})) {
                   9541: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9542:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9543:                             push(@{$seclists{$owner}},'none');
                   9544:                         }
                   9545:                         if (ref($statushash) eq 'HASH') {
                   9546:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9547:                         }
1.290     albertel 9548: 		    }
1.279     raeburn  9549:                 }
                   9550:             }
                   9551:         }
1.419     raeburn  9552:         foreach my $user (keys(%seclists)) {
                   9553:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9554:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9555:         }
1.275     raeburn  9556:     }
                   9557:     return;
                   9558: }
                   9559: 
1.288     raeburn  9560: sub get_user_info {
                   9561:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9562:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9563: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9564:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9565:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9566:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9567:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9568:     return;
                   9569: }
1.275     raeburn  9570: 
1.472     raeburn  9571: ###############################################
                   9572: 
                   9573: =pod
                   9574: 
                   9575: =item * &get_user_quota()
                   9576: 
1.1075.2.41  raeburn  9577: Retrieves quota assigned for storage of user files.
                   9578: Default is to report quota for portfolio files.
1.472     raeburn  9579: 
                   9580: Incoming parameters:
                   9581: 1. user's username
                   9582: 2. user's domain
1.1075.2.41  raeburn  9583: 3. quota name - portfolio, author, or course
                   9584:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9585: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9586:    course
1.472     raeburn  9587: 
                   9588: Returns:
1.1075.2.58  raeburn  9589: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9590: 2. (Optional) Type of setting: custom or default
                   9591:    (individually assigned or default for user's 
                   9592:    institutional status).
                   9593: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9594:    or student - types as defined in localenroll::inst_usertypes 
                   9595:    for user's domain, which determines default quota for user.
                   9596: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9597: 
                   9598: If a value has been stored in the user's environment, 
1.536     raeburn  9599: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9600: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9601: 
                   9602: =cut
                   9603: 
                   9604: ###############################################
                   9605: 
                   9606: 
                   9607: sub get_user_quota {
1.1075.2.42  raeburn  9608:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9609:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9610:     if (!defined($udom)) {
                   9611:         $udom = $env{'user.domain'};
                   9612:     }
                   9613:     if (!defined($uname)) {
                   9614:         $uname = $env{'user.name'};
                   9615:     }
                   9616:     if (($udom eq '' || $uname eq '') ||
                   9617:         ($udom eq 'public') && ($uname eq 'public')) {
                   9618:         $quota = 0;
1.536     raeburn  9619:         $quotatype = 'default';
                   9620:         $defquota = 0; 
1.472     raeburn  9621:     } else {
1.536     raeburn  9622:         my $inststatus;
1.1075.2.41  raeburn  9623:         if ($quotaname eq 'course') {
                   9624:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9625:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9626:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9627:             } else {
                   9628:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9629:                 $quota = $cenv{'internal.uploadquota'};
                   9630:             }
1.536     raeburn  9631:         } else {
1.1075.2.41  raeburn  9632:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9633:                 if ($quotaname eq 'author') {
                   9634:                     $quota = $env{'environment.authorquota'};
                   9635:                 } else {
                   9636:                     $quota = $env{'environment.portfolioquota'};
                   9637:                 }
                   9638:                 $inststatus = $env{'environment.inststatus'};
                   9639:             } else {
                   9640:                 my %userenv = 
                   9641:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9642:                                          'authorquota','inststatus'],$udom,$uname);
                   9643:                 my ($tmp) = keys(%userenv);
                   9644:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9645:                     if ($quotaname eq 'author') {
                   9646:                         $quota = $userenv{'authorquota'};
                   9647:                     } else {
                   9648:                         $quota = $userenv{'portfolioquota'};
                   9649:                     }
                   9650:                     $inststatus = $userenv{'inststatus'};
                   9651:                 } else {
                   9652:                     undef(%userenv);
                   9653:                 }
                   9654:             }
                   9655:         }
                   9656:         if ($quota eq '' || wantarray) {
                   9657:             if ($quotaname eq 'course') {
                   9658:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9659:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9660:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9661:                     $defquota = $domdefs{$crstype.'quota'};
                   9662:                 }
                   9663:                 if ($defquota eq '') {
                   9664:                     $defquota = 500;
                   9665:                 }
1.1075.2.41  raeburn  9666:             } else {
                   9667:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9668:             }
                   9669:             if ($quota eq '') {
                   9670:                 $quota = $defquota;
                   9671:                 $quotatype = 'default';
                   9672:             } else {
                   9673:                 $quotatype = 'custom';
                   9674:             }
1.472     raeburn  9675:         }
                   9676:     }
1.536     raeburn  9677:     if (wantarray) {
                   9678:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9679:     } else {
                   9680:         return $quota;
                   9681:     }
1.472     raeburn  9682: }
                   9683: 
                   9684: ###############################################
                   9685: 
                   9686: =pod
                   9687: 
                   9688: =item * &default_quota()
                   9689: 
1.536     raeburn  9690: Retrieves default quota assigned for storage of user portfolio files,
                   9691: given an (optional) user's institutional status.
1.472     raeburn  9692: 
                   9693: Incoming parameters:
1.1075.2.42  raeburn  9694: 
1.472     raeburn  9695: 1. domain
1.536     raeburn  9696: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9697:    status types (e.g., faculty, staff, student etc.)
                   9698:    which apply to the user for whom the default is being retrieved.
                   9699:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9700:    default quota will be returned.
                   9701: 3.  quota name - portfolio, author, or course
                   9702:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9703: 
                   9704: Returns:
1.1075.2.42  raeburn  9705: 
1.1075.2.58  raeburn  9706: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9707: 2. (Optional) institutional type which determined the value of the
                   9708:    default quota.
1.472     raeburn  9709: 
                   9710: If a value has been stored in the domain's configuration db,
                   9711: it will return that, otherwise it returns 20 (for backwards 
                   9712: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9713: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9714: 
1.536     raeburn  9715: If the user's status includes multiple types (e.g., staff and student),
                   9716: the largest default quota which applies to the user determines the
                   9717: default quota returned.
                   9718: 
1.472     raeburn  9719: =cut
                   9720: 
                   9721: ###############################################
                   9722: 
                   9723: 
                   9724: sub default_quota {
1.1075.2.41  raeburn  9725:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9726:     my ($defquota,$settingstatus);
                   9727:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9728:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9729:     my $key = 'defaultquota';
                   9730:     if ($quotaname eq 'author') {
                   9731:         $key = 'authorquota';
                   9732:     }
1.622     raeburn  9733:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9734:         if ($inststatus ne '') {
1.765     raeburn  9735:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9736:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9737:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9738:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9739:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9740:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9741:                             $settingstatus = $item;
1.1075.2.41  raeburn  9742:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9743:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9744:                             $settingstatus = $item;
                   9745:                         }
                   9746:                     }
1.1075.2.41  raeburn  9747:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9748:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9749:                         if ($defquota eq '') {
                   9750:                             $defquota = $quotahash{'quotas'}{$item};
                   9751:                             $settingstatus = $item;
                   9752:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9753:                             $defquota = $quotahash{'quotas'}{$item};
                   9754:                             $settingstatus = $item;
                   9755:                         }
1.536     raeburn  9756:                     }
                   9757:                 }
                   9758:             }
                   9759:         }
                   9760:         if ($defquota eq '') {
1.1075.2.41  raeburn  9761:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9762:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9763:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9764:                 $defquota = $quotahash{'quotas'}{'default'};
                   9765:             }
1.536     raeburn  9766:             $settingstatus = 'default';
1.1075.2.42  raeburn  9767:             if ($defquota eq '') {
                   9768:                 if ($quotaname eq 'author') {
                   9769:                     $defquota = 500;
                   9770:                 }
                   9771:             }
1.536     raeburn  9772:         }
                   9773:     } else {
                   9774:         $settingstatus = 'default';
1.1075.2.41  raeburn  9775:         if ($quotaname eq 'author') {
                   9776:             $defquota = 500;
                   9777:         } else {
                   9778:             $defquota = 20;
                   9779:         }
1.536     raeburn  9780:     }
                   9781:     if (wantarray) {
                   9782:         return ($defquota,$settingstatus);
1.472     raeburn  9783:     } else {
1.536     raeburn  9784:         return $defquota;
1.472     raeburn  9785:     }
                   9786: }
                   9787: 
1.1075.2.41  raeburn  9788: ###############################################
                   9789: 
                   9790: =pod
                   9791: 
1.1075.2.42  raeburn  9792: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9793: 
                   9794: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9795: of existing file within authoring space will cause quota for the authoring
                   9796: space to be exceeded.
                   9797: 
                   9798: Same, if upload of a file directly to a course/community via Course Editor
                   9799: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9800: 
1.1075.2.61  raeburn  9801: Inputs: 7 
1.1075.2.42  raeburn  9802: 1. username or coursenum
1.1075.2.41  raeburn  9803: 2. domain
1.1075.2.42  raeburn  9804: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9805: 4. filename of file for which action is being requested
                   9806: 5. filesize (kB) of file
                   9807: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9808: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9809: 
                   9810: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9811:          otherwise return null.
                   9812: 
1.1075.2.42  raeburn  9813: =back
                   9814: 
1.1075.2.41  raeburn  9815: =cut
                   9816: 
1.1075.2.42  raeburn  9817: sub excess_filesize_warning {
1.1075.2.59  raeburn  9818:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9819:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9820:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9821:     if ($context eq 'author') {
                   9822:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9823:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9824:     } else {
                   9825:         foreach my $subdir ('docs','supplemental') {
                   9826:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9827:         }
                   9828:     }
1.1075.2.41  raeburn  9829:     $disk_quota = int($disk_quota * 1000);
                   9830:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9831:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9832:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9833:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9834:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9835:                             $disk_quota,$current_disk_usage).
                   9836:                '</p>';
                   9837:     }
                   9838:     return;
                   9839: }
                   9840: 
                   9841: ###############################################
                   9842: 
                   9843: 
1.384     raeburn  9844: sub get_secgrprole_info {
                   9845:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9846:     my %sections_count = &get_sections($cdom,$cnum);
                   9847:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9848:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9849:     my @groups = sort(keys(%curr_groups));
                   9850:     my $allroles = [];
                   9851:     my $rolehash;
                   9852:     my $accesshash = {
                   9853:                      active => 'Currently has access',
                   9854:                      future => 'Will have future access',
                   9855:                      previous => 'Previously had access',
                   9856:                   };
                   9857:     if ($needroles) {
                   9858:         $rolehash = {'all' => 'all'};
1.385     albertel 9859:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9860: 	if (&Apache::lonnet::error(%user_roles)) {
                   9861: 	    undef(%user_roles);
                   9862: 	}
                   9863:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9864:             my ($role)=split(/\:/,$item,2);
                   9865:             if ($role eq 'cr') { next; }
                   9866:             if ($role =~ /^cr/) {
                   9867:                 $$rolehash{$role} = (split('/',$role))[3];
                   9868:             } else {
                   9869:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9870:             }
                   9871:         }
                   9872:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9873:             push(@{$allroles},$key);
                   9874:         }
                   9875:         push (@{$allroles},'st');
                   9876:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9877:     }
                   9878:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9879: }
                   9880: 
1.555     raeburn  9881: sub user_picker {
1.1075.2.127  raeburn  9882:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9883:     my $currdom = $dom;
1.1075.2.114  raeburn  9884:     my @alldoms = &Apache::lonnet::all_domains();
                   9885:     if (@alldoms == 1) {
                   9886:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9887:                                                ['directorysrch'],$alldoms[0]);
                   9888:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9889:         my $showdom = $domdesc;
                   9890:         if ($showdom eq '') {
                   9891:             $showdom = $dom;
                   9892:         }
                   9893:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9894:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9895:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9896:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9897:             }
                   9898:         }
                   9899:     }
1.555     raeburn  9900:     my %curr_selected = (
                   9901:                         srchin => 'dom',
1.580     raeburn  9902:                         srchby => 'lastname',
1.555     raeburn  9903:                       );
                   9904:     my $srchterm;
1.625     raeburn  9905:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9906:         if ($srch->{'srchby'} ne '') {
                   9907:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9908:         }
                   9909:         if ($srch->{'srchin'} ne '') {
                   9910:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9911:         }
                   9912:         if ($srch->{'srchtype'} ne '') {
                   9913:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9914:         }
                   9915:         if ($srch->{'srchdomain'} ne '') {
                   9916:             $currdom = $srch->{'srchdomain'};
                   9917:         }
                   9918:         $srchterm = $srch->{'srchterm'};
                   9919:     }
1.1075.2.98  raeburn  9920:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9921:                     'usr'       => 'Search criteria',
1.563     raeburn  9922:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9923:                     'uname'     => 'username',
                   9924:                     'lastname'  => 'last name',
1.555     raeburn  9925:                     'lastfirst' => 'last name, first name',
1.558     albertel 9926:                     'crs'       => 'in this course',
1.576     raeburn  9927:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9928:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9929:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9930:                     'exact'     => 'is',
                   9931:                     'contains'  => 'contains',
1.569     raeburn  9932:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9933:                                        );
                   9934:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9935:                     'youm'      => "You must include some text to search for.",
                   9936:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9937:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9938:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9939:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9940:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9941:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9942:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9943:                                        );
1.1075.2.98  raeburn  9944:     &html_escape(\%html_lt);
                   9945:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9946:     my $domform;
1.1075.2.126  raeburn  9947:     my $allow_blank = 1;
1.1075.2.115  raeburn  9948:     if ($fixeddom) {
1.1075.2.126  raeburn  9949:         $allow_blank = 0;
                   9950:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9951:     } else {
1.1075.2.126  raeburn  9952:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9953:     }
1.563     raeburn  9954:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9955: 
                   9956:     my @srchins = ('crs','dom','alc','instd');
                   9957: 
                   9958:     foreach my $option (@srchins) {
                   9959:         # FIXME 'alc' option unavailable until 
                   9960:         #       loncreateuser::print_user_query_page()
                   9961:         #       has been completed.
                   9962:         next if ($option eq 'alc');
1.880     raeburn  9963:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9964:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9965:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9966:         if ($curr_selected{'srchin'} eq $option) {
                   9967:             $srchinsel .= ' 
1.1075.2.98  raeburn  9968:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9969:         } else {
                   9970:             $srchinsel .= '
1.1075.2.98  raeburn  9971:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9972:         }
1.555     raeburn  9973:     }
1.563     raeburn  9974:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9975: 
                   9976:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9977:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9978:         if ($curr_selected{'srchby'} eq $option) {
                   9979:             $srchbysel .= '
1.1075.2.98  raeburn  9980:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9981:         } else {
                   9982:             $srchbysel .= '
1.1075.2.98  raeburn  9983:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9984:          }
                   9985:     }
                   9986:     $srchbysel .= "\n  </select>\n";
                   9987: 
                   9988:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9989:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9990:         if ($curr_selected{'srchtype'} eq $option) {
                   9991:             $srchtypesel .= '
1.1075.2.98  raeburn  9992:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9993:         } else {
                   9994:             $srchtypesel .= '
1.1075.2.98  raeburn  9995:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9996:         }
                   9997:     }
                   9998:     $srchtypesel .= "\n  </select>\n";
                   9999: 
1.558     albertel 10000:     my ($newuserscript,$new_user_create);
1.994     raeburn  10001:     my $context_dom = $env{'request.role.domain'};
                   10002:     if ($context eq 'requestcrs') {
                   10003:         if ($env{'form.coursedom'} ne '') { 
                   10004:             $context_dom = $env{'form.coursedom'};
                   10005:         }
                   10006:     }
1.556     raeburn  10007:     if ($forcenewuser) {
1.576     raeburn  10008:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10009:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10010:                 if ($cancreate) {
                   10011:                     $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>';
                   10012:                 } else {
1.799     bisitz   10013:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10014:                     my %usertypetext = (
                   10015:                         official   => 'institutional',
                   10016:                         unofficial => 'non-institutional',
                   10017:                     );
1.799     bisitz   10018:                     $new_user_create = '<p class="LC_warning">'
                   10019:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10020:                                       .' '
                   10021:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10022:                                           ,'<a href="'.$helplink.'">','</a>')
                   10023:                                       .'</p><br />';
1.627     raeburn  10024:                 }
1.576     raeburn  10025:             }
                   10026:         }
                   10027: 
1.556     raeburn  10028:         $newuserscript = <<"ENDSCRIPT";
                   10029: 
1.570     raeburn  10030: function setSearch(createnew,callingForm) {
1.556     raeburn  10031:     if (createnew == 1) {
1.570     raeburn  10032:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10033:             if (callingForm.srchby.options[i].value == 'uname') {
                   10034:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10035:             }
                   10036:         }
1.570     raeburn  10037:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10038:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10039: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10040:             }
                   10041:         }
1.570     raeburn  10042:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10043:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10044:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10045:             }
                   10046:         }
1.570     raeburn  10047:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10048:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10049:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10050:             }
                   10051:         }
                   10052:     }
                   10053: }
                   10054: ENDSCRIPT
1.558     albertel 10055: 
1.556     raeburn  10056:     }
                   10057: 
1.555     raeburn  10058:     my $output = <<"END_BLOCK";
1.556     raeburn  10059: <script type="text/javascript">
1.824     bisitz   10060: // <![CDATA[
1.570     raeburn  10061: function validateEntry(callingForm) {
1.558     albertel 10062: 
1.556     raeburn  10063:     var checkok = 1;
1.558     albertel 10064:     var srchin;
1.570     raeburn  10065:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10066: 	if ( callingForm.srchin[i].checked ) {
                   10067: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10068: 	}
                   10069:     }
                   10070: 
1.570     raeburn  10071:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10072:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10073:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10074:     var srchterm =  callingForm.srchterm.value;
                   10075:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10076:     var msg = "";
                   10077: 
                   10078:     if (srchterm == "") {
                   10079:         checkok = 0;
1.1075.2.98  raeburn  10080:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10081:     }
                   10082: 
1.569     raeburn  10083:     if (srchtype== 'begins') {
                   10084:         if (srchterm.length < 2) {
                   10085:             checkok = 0;
1.1075.2.98  raeburn  10086:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10087:         }
                   10088:     }
                   10089: 
1.556     raeburn  10090:     if (srchtype== 'contains') {
                   10091:         if (srchterm.length < 3) {
                   10092:             checkok = 0;
1.1075.2.98  raeburn  10093:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10094:         }
                   10095:     }
                   10096:     if (srchin == 'instd') {
                   10097:         if (srchdomain == '') {
                   10098:             checkok = 0;
1.1075.2.98  raeburn  10099:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10100:         }
                   10101:     }
                   10102:     if (srchin == 'dom') {
                   10103:         if (srchdomain == '') {
                   10104:             checkok = 0;
1.1075.2.98  raeburn  10105:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10106:         }
                   10107:     }
                   10108:     if (srchby == 'lastfirst') {
                   10109:         if (srchterm.indexOf(",") == -1) {
                   10110:             checkok = 0;
1.1075.2.98  raeburn  10111:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10112:         }
                   10113:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10114:             checkok = 0;
1.1075.2.98  raeburn  10115:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10116:         }
                   10117:     }
                   10118:     if (checkok == 0) {
1.1075.2.98  raeburn  10119:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10120:         return;
                   10121:     }
                   10122:     if (checkok == 1) {
1.570     raeburn  10123:         callingForm.submit();
1.556     raeburn  10124:     }
                   10125: }
                   10126: 
                   10127: $newuserscript
                   10128: 
1.824     bisitz   10129: // ]]>
1.556     raeburn  10130: </script>
1.558     albertel 10131: 
                   10132: $new_user_create
                   10133: 
1.555     raeburn  10134: END_BLOCK
1.558     albertel 10135: 
1.876     raeburn  10136:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10137:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10138:                $domform.
                   10139:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10140:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10141:                $srchbysel.
                   10142:                $srchtypesel. 
                   10143:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10144:                $srchinsel.
                   10145:                &Apache::lonhtmlcommon::row_closure(1). 
                   10146:                &Apache::lonhtmlcommon::end_pick_box().
                   10147:                '<br />';
1.1075.2.114  raeburn  10148:     return ($output,1);
1.555     raeburn  10149: }
                   10150: 
1.612     raeburn  10151: sub user_rule_check {
1.615     raeburn  10152:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10153:     my ($response,%inst_response);
1.612     raeburn  10154:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10155:         if (keys(%{$usershash}) > 1) {
                   10156:             my (%by_username,%by_id,%userdoms);
                   10157:             my $checkid;
1.612     raeburn  10158:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10159:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10160:                     $checkid = 1;
                   10161:                 }
                   10162:             }
                   10163:             foreach my $user (keys(%{$usershash})) {
                   10164:                 my ($uname,$udom) = split(/:/,$user);
                   10165:                 if ($checkid) {
                   10166:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10167:                         if ($usershash->{$user}->{'id'} ne '') {
                   10168:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10169:                             $userdoms{$udom} = 1;
                   10170:                             if (ref($inst_results) eq 'HASH') {
                   10171:                                 $inst_results->{$uname.':'.$udom} = {};
                   10172:                             }
                   10173:                         }
                   10174:                     }
                   10175:                 } else {
                   10176:                     $by_username{$udom}{$uname} = 1;
                   10177:                     $userdoms{$udom} = 1;
                   10178:                     if (ref($inst_results) eq 'HASH') {
                   10179:                         $inst_results->{$uname.':'.$udom} = {};
                   10180:                     }
                   10181:                 }
                   10182:             }
                   10183:             foreach my $udom (keys(%userdoms)) {
                   10184:                 if (!$got_rules->{$udom}) {
                   10185:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10186:                                                              ['usercreation'],$udom);
                   10187:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10188:                         foreach my $item ('username','id') {
                   10189:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10190:                                 $$curr_rules{$udom}{$item} =
                   10191:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10192:                             }
                   10193:                         }
                   10194:                     }
                   10195:                     $got_rules->{$udom} = 1;
                   10196:                 }
                   10197:             }
                   10198:             if ($checkid) {
                   10199:                 foreach my $udom (keys(%by_id)) {
                   10200:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10201:                     if ($outcome eq 'ok') {
                   10202:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10203:                             my $uname = $by_id{$udom}{$id};
                   10204:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10205:                         }
                   10206:                         if (ref($results) eq 'HASH') {
                   10207:                             foreach my $uname (keys(%{$results})) {
                   10208:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10209:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10210:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10211:                                 }
                   10212:                             }
                   10213:                         }
                   10214:                     }
1.612     raeburn  10215:                 }
1.615     raeburn  10216:             } else {
1.1075.2.99  raeburn  10217:                 foreach my $udom (keys(%by_username)) {
                   10218:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10219:                     if ($outcome eq 'ok') {
                   10220:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10221:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10222:                         }
                   10223:                         if (ref($results) eq 'HASH') {
                   10224:                             foreach my $uname (keys(%{$results})) {
                   10225:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10226:                             }
                   10227:                         }
                   10228:                     }
                   10229:                 }
1.612     raeburn  10230:             }
1.1075.2.99  raeburn  10231:         } elsif (keys(%{$usershash}) == 1) {
                   10232:             my $user = (keys(%{$usershash}))[0];
                   10233:             my ($uname,$udom) = split(/:/,$user);
                   10234:             if (($udom ne '') && ($uname ne '')) {
                   10235:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10236:                     if (ref($checks) eq 'HASH') {
                   10237:                         if (defined($checks->{'username'})) {
                   10238:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10239:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10240:                         } elsif (defined($checks->{'id'})) {
                   10241:                             if ($usershash->{$user}->{'id'} ne '') {
                   10242:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10243:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10244:                                                                   $usershash->{$user}->{'id'});
                   10245:                             } else {
                   10246:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10247:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10248:                             }
                   10249:                         }
                   10250:                     } else {
                   10251:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10252:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10253:                        return;
                   10254:                     }
                   10255:                     if (!$got_rules->{$udom}) {
                   10256:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10257:                                                                  ['usercreation'],$udom);
                   10258:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10259:                             foreach my $item ('username','id') {
                   10260:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10261:                                    $$curr_rules{$udom}{$item} =
                   10262:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10263:                                 }
                   10264:                             }
1.585     raeburn  10265:                         }
1.1075.2.99  raeburn  10266:                         $got_rules->{$udom} = 1;
1.585     raeburn  10267:                     }
                   10268:                 }
1.1075.2.99  raeburn  10269:             } else {
                   10270:                 return;
                   10271:             }
                   10272:         } else {
                   10273:             return;
                   10274:         }
                   10275:         foreach my $user (keys(%{$usershash})) {
                   10276:             my ($uname,$udom) = split(/:/,$user);
                   10277:             next if (($udom eq '') || ($uname eq ''));
                   10278:             my $id;
                   10279:             if (ref($inst_results) eq 'HASH') {
                   10280:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10281:                     $id = $inst_results->{$user}->{'id'};
                   10282:                 }
                   10283:             }
                   10284:             if ($id eq '') {
                   10285:                 if (ref($usershash->{$user})) {
                   10286:                     $id = $usershash->{$user}->{'id'};
                   10287:                 }
1.585     raeburn  10288:             }
1.612     raeburn  10289:             foreach my $item (keys(%{$checks})) {
                   10290:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10291:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10292:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10293:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10294:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10295:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10296:                                 if ($rule_check{$rule}) {
                   10297:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10298:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10299:                                         if (ref($inst_results) eq 'HASH') {
                   10300:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10301:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10302:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10303:                                                 } elsif ($item eq 'id') {
                   10304:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10305:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10306:                                                     }
1.615     raeburn  10307:                                                 }
1.612     raeburn  10308:                                             }
                   10309:                                         }
1.615     raeburn  10310:                                     }
                   10311:                                     last;
1.585     raeburn  10312:                                 }
                   10313:                             }
                   10314:                         }
                   10315:                     }
                   10316:                 }
                   10317:             }
                   10318:         }
                   10319:     }
1.612     raeburn  10320:     return;
                   10321: }
                   10322: 
                   10323: sub user_rule_formats {
                   10324:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10325:     my %text = ( 
                   10326:                  'username' => 'Usernames',
                   10327:                  'id'       => 'IDs',
                   10328:                );
                   10329:     my $output;
                   10330:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10331:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10332:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10333:             $output = '<br />'.
                   10334:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10335:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10336:                       ' <ul>';
1.612     raeburn  10337:             foreach my $rule (@{$ruleorder}) {
                   10338:                 if (ref($curr_rules) eq 'ARRAY') {
                   10339:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10340:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10341:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10342:                                         $rules->{$rule}{'desc'}.'</li>';
                   10343:                         }
                   10344:                     }
                   10345:                 }
                   10346:             }
                   10347:             $output .= '</ul>';
                   10348:         }
                   10349:     }
                   10350:     return $output;
                   10351: }
                   10352: 
                   10353: sub instrule_disallow_msg {
1.615     raeburn  10354:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10355:     my $response;
                   10356:     my %text = (
                   10357:                   item   => 'username',
                   10358:                   items  => 'usernames',
                   10359:                   match  => 'matches',
                   10360:                   do     => 'does',
                   10361:                   action => 'a username',
                   10362:                   one    => 'one',
                   10363:                );
                   10364:     if ($count > 1) {
                   10365:         $text{'item'} = 'usernames';
                   10366:         $text{'match'} ='match';
                   10367:         $text{'do'} = 'do';
                   10368:         $text{'action'} = 'usernames',
                   10369:         $text{'one'} = 'ones';
                   10370:     }
                   10371:     if ($checkitem eq 'id') {
                   10372:         $text{'items'} = 'IDs';
                   10373:         $text{'item'} = 'ID';
                   10374:         $text{'action'} = 'an ID';
1.615     raeburn  10375:         if ($count > 1) {
                   10376:             $text{'item'} = 'IDs';
                   10377:             $text{'action'} = 'IDs';
                   10378:         }
1.612     raeburn  10379:     }
1.674     bisitz   10380:     $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  10381:     if ($mode eq 'upload') {
                   10382:         if ($checkitem eq 'username') {
                   10383:             $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'}.");
                   10384:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10385:             $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  10386:         }
1.669     raeburn  10387:     } elsif ($mode eq 'selfcreate') {
                   10388:         if ($checkitem eq 'id') {
                   10389:             $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.");
                   10390:         }
1.615     raeburn  10391:     } else {
                   10392:         if ($checkitem eq 'username') {
                   10393:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10394:         } elsif ($checkitem eq 'id') {
                   10395:             $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.");
                   10396:         }
1.612     raeburn  10397:     }
                   10398:     return $response;
1.585     raeburn  10399: }
                   10400: 
1.624     raeburn  10401: sub personal_data_fieldtitles {
                   10402:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10403:                         id => 'Student/Employee ID',
                   10404:                         permanentemail => 'E-mail address',
                   10405:                         lastname => 'Last Name',
                   10406:                         firstname => 'First Name',
                   10407:                         middlename => 'Middle Name',
                   10408:                         generation => 'Generation',
                   10409:                         gen => 'Generation',
1.765     raeburn  10410:                         inststatus => 'Affiliation',
1.624     raeburn  10411:                    );
                   10412:     return %fieldtitles;
                   10413: }
                   10414: 
1.642     raeburn  10415: sub sorted_inst_types {
                   10416:     my ($dom) = @_;
1.1075.2.70  raeburn  10417:     my ($usertypes,$order);
                   10418:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10419:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10420:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10421:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10422:     } else {
                   10423:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10424:     }
1.642     raeburn  10425:     my $othertitle = &mt('All users');
                   10426:     if ($env{'request.course.id'}) {
1.668     raeburn  10427:         $othertitle  = &mt('Any users');
1.642     raeburn  10428:     }
                   10429:     my @types;
                   10430:     if (ref($order) eq 'ARRAY') {
                   10431:         @types = @{$order};
                   10432:     }
                   10433:     if (@types == 0) {
                   10434:         if (ref($usertypes) eq 'HASH') {
                   10435:             @types = sort(keys(%{$usertypes}));
                   10436:         }
                   10437:     }
                   10438:     if (keys(%{$usertypes}) > 0) {
                   10439:         $othertitle = &mt('Other users');
                   10440:     }
                   10441:     return ($othertitle,$usertypes,\@types);
                   10442: }
                   10443: 
1.645     raeburn  10444: sub get_institutional_codes {
                   10445:     my ($settings,$allcourses,$LC_code) = @_;
                   10446: # Get complete list of course sections to update
                   10447:     my @currsections = ();
                   10448:     my @currxlists = ();
                   10449:     my $coursecode = $$settings{'internal.coursecode'};
                   10450: 
                   10451:     if ($$settings{'internal.sectionnums'} ne '') {
                   10452:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10453:     }
                   10454: 
                   10455:     if ($$settings{'internal.crosslistings'} ne '') {
                   10456:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10457:     }
                   10458: 
                   10459:     if (@currxlists > 0) {
                   10460:         foreach (@currxlists) {
                   10461:             if (m/^([^:]+):(\w*)$/) {
                   10462:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10463:                     push(@{$allcourses},$1);
1.645     raeburn  10464:                     $$LC_code{$1} = $2;
                   10465:                 }
                   10466:             }
                   10467:         }
                   10468:     }
                   10469:  
                   10470:     if (@currsections > 0) {
                   10471:         foreach (@currsections) {
                   10472:             if (m/^(\w+):(\w*)$/) {
                   10473:                 my $sec = $coursecode.$1;
                   10474:                 my $lc_sec = $2;
                   10475:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10476:                     push(@{$allcourses},$sec);
1.645     raeburn  10477:                     $$LC_code{$sec} = $lc_sec;
                   10478:                 }
                   10479:             }
                   10480:         }
                   10481:     }
                   10482:     return;
                   10483: }
                   10484: 
1.971     raeburn  10485: sub get_standard_codeitems {
                   10486:     return ('Year','Semester','Department','Number','Section');
                   10487: }
                   10488: 
1.112     bowersj2 10489: =pod
                   10490: 
1.780     raeburn  10491: =head1 Slot Helpers
                   10492: 
                   10493: =over 4
                   10494: 
                   10495: =item * sorted_slots()
                   10496: 
1.1040    raeburn  10497: Sorts an array of slot names in order of an optional sort key,
                   10498: default sort is by slot start time (earliest first). 
1.780     raeburn  10499: 
                   10500: Inputs:
                   10501: 
                   10502: =over 4
                   10503: 
                   10504: slotsarr  - Reference to array of unsorted slot names.
                   10505: 
                   10506: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10507: 
1.1040    raeburn  10508: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10509: 
1.549     albertel 10510: =back
                   10511: 
1.780     raeburn  10512: Returns:
                   10513: 
                   10514: =over 4
                   10515: 
1.1040    raeburn  10516: sorted   - An array of slot names sorted by a specified sort key 
                   10517:            (default sort key is start time of the slot).
1.780     raeburn  10518: 
                   10519: =back
                   10520: 
                   10521: =cut
                   10522: 
                   10523: 
                   10524: sub sorted_slots {
1.1040    raeburn  10525:     my ($slotsarr,$slots,$sortkey) = @_;
                   10526:     if ($sortkey eq '') {
                   10527:         $sortkey = 'starttime';
                   10528:     }
1.780     raeburn  10529:     my @sorted;
                   10530:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10531:         @sorted =
                   10532:             sort {
                   10533:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10534:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10535:                      }
                   10536:                      if (ref($slots->{$a})) { return -1;}
                   10537:                      if (ref($slots->{$b})) { return 1;}
                   10538:                      return 0;
                   10539:                  } @{$slotsarr};
                   10540:     }
                   10541:     return @sorted;
                   10542: }
                   10543: 
1.1040    raeburn  10544: =pod
                   10545: 
                   10546: =item * get_future_slots()
                   10547: 
                   10548: Inputs:
                   10549: 
                   10550: =over 4
                   10551: 
                   10552: cnum - course number
                   10553: 
                   10554: cdom - course domain
                   10555: 
                   10556: now - current UNIX time
                   10557: 
                   10558: symb - optional symb
                   10559: 
                   10560: =back
                   10561: 
                   10562: Returns:
                   10563: 
                   10564: =over 4
                   10565: 
                   10566: sorted_reservable - ref to array of student_schedulable slots currently 
                   10567:                     reservable, ordered by end date of reservation period.
                   10568: 
                   10569: reservable_now - ref to hash of student_schedulable slots currently
                   10570:                  reservable.
                   10571: 
                   10572:     Keys in inner hash are:
                   10573:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10574:     (b) endreserve: end date of reservation period.
                   10575:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10576:         selected.
1.1040    raeburn  10577: 
                   10578: sorted_future - ref to array of student_schedulable slots reservable in
                   10579:                 the future, ordered by start date of reservation period.
                   10580: 
                   10581: future_reservable - ref to hash of student_schedulable slots reservable
                   10582:                     in the future.
                   10583: 
                   10584:     Keys in inner hash are:
                   10585:     (a) symb: either blank or symb to which slot use is restricted.
                   10586:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10587:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10588:         selected.
1.1040    raeburn  10589: 
                   10590: =back
                   10591: 
                   10592: =cut
                   10593: 
                   10594: sub get_future_slots {
                   10595:     my ($cnum,$cdom,$now,$symb) = @_;
                   10596:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10597:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10598:     foreach my $slot (keys(%slots)) {
                   10599:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10600:         if ($symb) {
                   10601:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10602:                      ($slots{$slot}->{'symb'} ne $symb));
                   10603:         }
                   10604:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10605:             ($slots{$slot}->{'endtime'} > $now)) {
                   10606:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10607:                 my $userallowed = 0;
                   10608:                 if ($slots{$slot}->{'allowedsections'}) {
                   10609:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10610:                     if (!defined($env{'request.role.sec'})
                   10611:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10612:                         $userallowed=1;
                   10613:                     } else {
                   10614:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10615:                             $userallowed=1;
                   10616:                         }
                   10617:                     }
                   10618:                     unless ($userallowed) {
                   10619:                         if (defined($env{'request.course.groups'})) {
                   10620:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10621:                             foreach my $group (@groups) {
                   10622:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10623:                                     $userallowed=1;
                   10624:                                     last;
                   10625:                                 }
                   10626:                             }
                   10627:                         }
                   10628:                     }
                   10629:                 }
                   10630:                 if ($slots{$slot}->{'allowedusers'}) {
                   10631:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10632:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10633:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10634:                         $userallowed = 1;
                   10635:                     }
                   10636:                 }
                   10637:                 next unless($userallowed);
                   10638:             }
                   10639:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10640:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10641:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10642:             my $uniqueperiod;
                   10643:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10644:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10645:             }
1.1040    raeburn  10646:             if (($startreserve < $now) &&
                   10647:                 (!$endreserve || $endreserve > $now)) {
                   10648:                 my $lastres = $endreserve;
                   10649:                 if (!$lastres) {
                   10650:                     $lastres = $slots{$slot}->{'starttime'};
                   10651:                 }
                   10652:                 $reservable_now{$slot} = {
                   10653:                                            symb       => $symb,
1.1075.2.104  raeburn  10654:                                            endreserve => $lastres,
                   10655:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10656:                                          };
                   10657:             } elsif (($startreserve > $now) &&
                   10658:                      (!$endreserve || $endreserve > $startreserve)) {
                   10659:                 $future_reservable{$slot} = {
                   10660:                                               symb         => $symb,
1.1075.2.104  raeburn  10661:                                               startreserve => $startreserve,
                   10662:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10663:                                             };
                   10664:             }
                   10665:         }
                   10666:     }
                   10667:     my @unsorted_reservable = keys(%reservable_now);
                   10668:     if (@unsorted_reservable > 0) {
                   10669:         @sorted_reservable = 
                   10670:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10671:     }
                   10672:     my @unsorted_future = keys(%future_reservable);
                   10673:     if (@unsorted_future > 0) {
                   10674:         @sorted_future =
                   10675:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10676:     }
                   10677:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10678: }
1.780     raeburn  10679: 
                   10680: =pod
                   10681: 
1.1057    foxr     10682: =back
                   10683: 
1.549     albertel 10684: =head1 HTTP Helpers
                   10685: 
                   10686: =over 4
                   10687: 
1.648     raeburn  10688: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10689: 
1.258     albertel 10690: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10691: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10692: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10693: 
                   10694: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10695: $possible_names is an ref to an array of form element names.  As an example:
                   10696: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10697: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10698: 
                   10699: =cut
1.1       albertel 10700: 
1.6       albertel 10701: sub get_unprocessed_cgi {
1.25      albertel 10702:   my ($query,$possible_names)= @_;
1.26      matthew  10703:   # $Apache::lonxml::debug=1;
1.356     albertel 10704:   foreach my $pair (split(/&/,$query)) {
                   10705:     my ($name, $value) = split(/=/,$pair);
1.369     www      10706:     $name = &unescape($name);
1.25      albertel 10707:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10708:       $value =~ tr/+/ /;
                   10709:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10710:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10711:     }
1.16      harris41 10712:   }
1.6       albertel 10713: }
                   10714: 
1.112     bowersj2 10715: =pod
                   10716: 
1.648     raeburn  10717: =item * &cacheheader() 
1.112     bowersj2 10718: 
                   10719: returns cache-controlling header code
                   10720: 
                   10721: =cut
                   10722: 
1.7       albertel 10723: sub cacheheader {
1.258     albertel 10724:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10725:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10726:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10727:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10728:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10729:     return $output;
1.7       albertel 10730: }
                   10731: 
1.112     bowersj2 10732: =pod
                   10733: 
1.648     raeburn  10734: =item * &no_cache($r) 
1.112     bowersj2 10735: 
                   10736: specifies header code to not have cache
                   10737: 
                   10738: =cut
                   10739: 
1.9       albertel 10740: sub no_cache {
1.216     albertel 10741:     my ($r) = @_;
                   10742:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10743: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10744:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10745:     $r->no_cache(1);
                   10746:     $r->header_out("Expires" => $date);
                   10747:     $r->header_out("Pragma" => "no-cache");
1.123     www      10748: }
                   10749: 
                   10750: sub content_type {
1.181     albertel 10751:     my ($r,$type,$charset) = @_;
1.299     foxr     10752:     if ($r) {
                   10753: 	#  Note that printout.pl calls this with undef for $r.
                   10754: 	&no_cache($r);
                   10755:     }
1.258     albertel 10756:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10757:     unless ($charset) {
                   10758: 	$charset=&Apache::lonlocal::current_encoding;
                   10759:     }
                   10760:     if ($charset) { $type.='; charset='.$charset; }
                   10761:     if ($r) {
                   10762: 	$r->content_type($type);
                   10763:     } else {
                   10764: 	print("Content-type: $type\n\n");
                   10765:     }
1.9       albertel 10766: }
1.25      albertel 10767: 
1.112     bowersj2 10768: =pod
                   10769: 
1.648     raeburn  10770: =item * &add_to_env($name,$value) 
1.112     bowersj2 10771: 
1.258     albertel 10772: adds $name to the %env hash with value
1.112     bowersj2 10773: $value, if $name already exists, the entry is converted to an array
                   10774: reference and $value is added to the array.
                   10775: 
                   10776: =cut
                   10777: 
1.25      albertel 10778: sub add_to_env {
                   10779:   my ($name,$value)=@_;
1.258     albertel 10780:   if (defined($env{$name})) {
                   10781:     if (ref($env{$name})) {
1.25      albertel 10782:       #already have multiple values
1.258     albertel 10783:       push(@{ $env{$name} },$value);
1.25      albertel 10784:     } else {
                   10785:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10786:       my $first=$env{$name};
                   10787:       undef($env{$name});
                   10788:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10789:     }
                   10790:   } else {
1.258     albertel 10791:     $env{$name}=$value;
1.25      albertel 10792:   }
1.31      albertel 10793: }
1.149     albertel 10794: 
                   10795: =pod
                   10796: 
1.648     raeburn  10797: =item * &get_env_multiple($name) 
1.149     albertel 10798: 
1.258     albertel 10799: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10800: values may be defined and end up as an array ref.
                   10801: 
                   10802: returns an array of values
                   10803: 
                   10804: =cut
                   10805: 
                   10806: sub get_env_multiple {
                   10807:     my ($name) = @_;
                   10808:     my @values;
1.258     albertel 10809:     if (defined($env{$name})) {
1.149     albertel 10810:         # exists is it an array
1.258     albertel 10811:         if (ref($env{$name})) {
                   10812:             @values=@{ $env{$name} };
1.149     albertel 10813:         } else {
1.258     albertel 10814:             $values[0]=$env{$name};
1.149     albertel 10815:         }
                   10816:     }
                   10817:     return(@values);
                   10818: }
                   10819: 
1.660     raeburn  10820: sub ask_for_embedded_content {
                   10821:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10822:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10823:         %currsubfile,%unused,$rem);
1.1071    raeburn  10824:     my $counter = 0;
                   10825:     my $numnew = 0;
1.987     raeburn  10826:     my $numremref = 0;
                   10827:     my $numinvalid = 0;
                   10828:     my $numpathchg = 0;
                   10829:     my $numexisting = 0;
1.1071    raeburn  10830:     my $numunused = 0;
                   10831:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10832:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10833:     my $heading = &mt('Upload embedded files');
                   10834:     my $buttontext = &mt('Upload');
                   10835: 
1.1075.2.11  raeburn  10836:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10837:         if ($actionurl eq '/adm/dependencies') {
                   10838:             $navmap = Apache::lonnavmaps::navmap->new();
                   10839:         }
                   10840:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10841:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10842:     }
1.1075.2.35  raeburn  10843:     if (($actionurl eq '/adm/portfolio') ||
                   10844:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10845:         my $current_path='/';
                   10846:         if ($env{'form.currentpath'}) {
                   10847:             $current_path = $env{'form.currentpath'};
                   10848:         }
                   10849:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10850:             $udom = $cdom;
                   10851:             $uname = $cnum;
1.984     raeburn  10852:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10853:         } else {
                   10854:             $udom = $env{'user.domain'};
                   10855:             $uname = $env{'user.name'};
                   10856:             $url = '/userfiles/portfolio';
                   10857:         }
1.987     raeburn  10858:         $toplevel = $url.'/';
1.984     raeburn  10859:         $url .= $current_path;
                   10860:         $getpropath = 1;
1.987     raeburn  10861:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10862:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10863:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10864:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10865:         $toplevel = $url;
1.984     raeburn  10866:         if ($rest ne '') {
1.987     raeburn  10867:             $url .= $rest;
                   10868:         }
                   10869:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10870:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10871:             $url = $args->{'docs_url'};
                   10872:             $toplevel = $url;
1.1075.2.11  raeburn  10873:             if ($args->{'context'} eq 'paste') {
                   10874:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10875:                 ($path) =
                   10876:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10877:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10878:                 $fileloc =~ s{^/}{};
                   10879:             }
1.1071    raeburn  10880:         }
                   10881:     } elsif ($actionurl eq '/adm/dependencies') {
                   10882:         if ($env{'request.course.id'} ne '') {
                   10883:             if (ref($args) eq 'HASH') {
                   10884:                 $url = $args->{'docs_url'};
                   10885:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10886:                 $toplevel = $url;
                   10887:                 unless ($toplevel =~ m{^/}) {
                   10888:                     $toplevel = "/$url";
                   10889:                 }
1.1075.2.11  raeburn  10890:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10891:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10892:                     $path = $1;
                   10893:                 } else {
                   10894:                     ($path) =
                   10895:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10896:                 }
1.1075.2.79  raeburn  10897:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10898:                     $fileloc = $toplevel;
                   10899:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10900:                     my ($udom,$uname,$fname) =
                   10901:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10902:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10903:                 } else {
                   10904:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10905:                 }
1.1071    raeburn  10906:                 $fileloc =~ s{^/}{};
                   10907:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10908:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10909:             }
1.987     raeburn  10910:         }
1.1075.2.35  raeburn  10911:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10912:         $udom = $cdom;
                   10913:         $uname = $cnum;
                   10914:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10915:         $toplevel = $url;
                   10916:         $path = $url;
                   10917:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10918:         $fileloc =~ s{^/}{};
                   10919:     }
                   10920:     foreach my $file (keys(%{$allfiles})) {
                   10921:         my $embed_file;
                   10922:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10923:             $embed_file = $1;
                   10924:         } else {
                   10925:             $embed_file = $file;
                   10926:         }
1.1075.2.55  raeburn  10927:         my ($absolutepath,$cleaned_file);
                   10928:         if ($embed_file =~ m{^\w+://}) {
                   10929:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10930:             $newfiles{$cleaned_file} = 1;
                   10931:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10932:         } else {
1.1075.2.55  raeburn  10933:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10934:             if ($embed_file =~ m{^/}) {
                   10935:                 $absolutepath = $embed_file;
                   10936:             }
1.1075.2.47  raeburn  10937:             if ($cleaned_file =~ m{/}) {
                   10938:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10939:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10940:                 my $item = $fname;
                   10941:                 if ($path ne '') {
                   10942:                     $item = $path.'/'.$fname;
                   10943:                     $subdependencies{$path}{$fname} = 1;
                   10944:                 } else {
                   10945:                     $dependencies{$item} = 1;
                   10946:                 }
                   10947:                 if ($absolutepath) {
                   10948:                     $mapping{$item} = $absolutepath;
                   10949:                 } else {
                   10950:                     $mapping{$item} = $embed_file;
                   10951:                 }
                   10952:             } else {
                   10953:                 $dependencies{$embed_file} = 1;
                   10954:                 if ($absolutepath) {
1.1075.2.47  raeburn  10955:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10956:                 } else {
1.1075.2.47  raeburn  10957:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10958:                 }
                   10959:             }
1.984     raeburn  10960:         }
                   10961:     }
1.1071    raeburn  10962:     my $dirptr = 16384;
1.984     raeburn  10963:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10964:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10965:         if (($actionurl eq '/adm/portfolio') ||
                   10966:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10967:             my ($sublistref,$listerror) =
                   10968:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10969:             if (ref($sublistref) eq 'ARRAY') {
                   10970:                 foreach my $line (@{$sublistref}) {
                   10971:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10972:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10973:                 }
1.984     raeburn  10974:             }
1.987     raeburn  10975:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10976:             if (opendir(my $dir,$url.'/'.$path)) {
                   10977:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10978:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10979:             }
1.1075.2.11  raeburn  10980:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10981:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10982:                   ($args->{'context'} eq 'paste')) ||
                   10983:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10984:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10985:                 my $dir;
                   10986:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10987:                     $dir = $fileloc;
                   10988:                 } else {
                   10989:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10990:                 }
1.1071    raeburn  10991:                 if ($dir ne '') {
                   10992:                     my ($sublistref,$listerror) =
                   10993:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10994:                     if (ref($sublistref) eq 'ARRAY') {
                   10995:                         foreach my $line (@{$sublistref}) {
                   10996:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10997:                                 undef,$mtime)=split(/\&/,$line,12);
                   10998:                             unless (($testdir&$dirptr) ||
                   10999:                                     ($file_name =~ /^\.\.?$/)) {
                   11000:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11001:                             }
                   11002:                         }
                   11003:                     }
                   11004:                 }
1.984     raeburn  11005:             }
                   11006:         }
                   11007:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11008:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11009:                 my $item = $path.'/'.$file;
                   11010:                 unless ($mapping{$item} eq $item) {
                   11011:                     $pathchanges{$item} = 1;
                   11012:                 }
                   11013:                 $existing{$item} = 1;
                   11014:                 $numexisting ++;
                   11015:             } else {
                   11016:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11017:             }
                   11018:         }
1.1071    raeburn  11019:         if ($actionurl eq '/adm/dependencies') {
                   11020:             foreach my $path (keys(%currsubfile)) {
                   11021:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11022:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11023:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11024:                              next if (($rem ne '') &&
                   11025:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11026:                                        (ref($navmap) &&
                   11027:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11028:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11029:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11030:                              $unused{$path.'/'.$file} = 1; 
                   11031:                          }
                   11032:                     }
                   11033:                 }
                   11034:             }
                   11035:         }
1.984     raeburn  11036:     }
1.987     raeburn  11037:     my %currfile;
1.1075.2.35  raeburn  11038:     if (($actionurl eq '/adm/portfolio') ||
                   11039:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11040:         my ($dirlistref,$listerror) =
                   11041:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11042:         if (ref($dirlistref) eq 'ARRAY') {
                   11043:             foreach my $line (@{$dirlistref}) {
                   11044:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11045:                 $currfile{$file_name} = 1;
                   11046:             }
1.984     raeburn  11047:         }
1.987     raeburn  11048:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11049:         if (opendir(my $dir,$url)) {
1.987     raeburn  11050:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11051:             map {$currfile{$_} = 1;} @dir_list;
                   11052:         }
1.1075.2.11  raeburn  11053:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11054:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11055:               ($args->{'context'} eq 'paste')) ||
                   11056:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11057:         if ($env{'request.course.id'} ne '') {
                   11058:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11059:             if ($dir ne '') {
                   11060:                 my ($dirlistref,$listerror) =
                   11061:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11062:                 if (ref($dirlistref) eq 'ARRAY') {
                   11063:                     foreach my $line (@{$dirlistref}) {
                   11064:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11065:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11066:                         unless (($testdir&$dirptr) ||
                   11067:                                 ($file_name =~ /^\.\.?$/)) {
                   11068:                             $currfile{$file_name} = [$size,$mtime];
                   11069:                         }
                   11070:                     }
                   11071:                 }
                   11072:             }
                   11073:         }
1.984     raeburn  11074:     }
                   11075:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11076:         if (exists($currfile{$file})) {
1.987     raeburn  11077:             unless ($mapping{$file} eq $file) {
                   11078:                 $pathchanges{$file} = 1;
                   11079:             }
                   11080:             $existing{$file} = 1;
                   11081:             $numexisting ++;
                   11082:         } else {
1.984     raeburn  11083:             $newfiles{$file} = 1;
                   11084:         }
                   11085:     }
1.1071    raeburn  11086:     foreach my $file (keys(%currfile)) {
                   11087:         unless (($file eq $filename) ||
                   11088:                 ($file eq $filename.'.bak') ||
                   11089:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11090:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11091:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11092:                     next if (($rem ne '') &&
                   11093:                              (($env{"httpref.$rem".$file} ne '') ||
                   11094:                               (ref($navmap) &&
                   11095:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11096:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11097:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11098:                 }
1.1075.2.11  raeburn  11099:             }
1.1071    raeburn  11100:             $unused{$file} = 1;
                   11101:         }
                   11102:     }
1.1075.2.11  raeburn  11103:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11104:         ($args->{'context'} eq 'paste')) {
                   11105:         $counter = scalar(keys(%existing));
                   11106:         $numpathchg = scalar(keys(%pathchanges));
                   11107:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11108:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11109:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11110:         $counter = scalar(keys(%existing));
                   11111:         $numpathchg = scalar(keys(%pathchanges));
                   11112:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11113:     }
1.984     raeburn  11114:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11115:         if ($actionurl eq '/adm/dependencies') {
                   11116:             next if ($embed_file =~ m{^\w+://});
                   11117:         }
1.660     raeburn  11118:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11119:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11120:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11121:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11122:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11123:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11124:         }
1.1075.2.35  raeburn  11125:         $upload_output .= '</td>';
1.1071    raeburn  11126:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11127:             $upload_output.='<td align="right">'.
                   11128:                             '<span class="LC_info LC_fontsize_medium">'.
                   11129:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11130:             $numremref++;
1.660     raeburn  11131:         } elsif ($args->{'error_on_invalid_names'}
                   11132:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11133:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11134:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11135:             $numinvalid++;
1.660     raeburn  11136:         } else {
1.1075.2.35  raeburn  11137:             $upload_output .= '<td>'.
                   11138:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11139:                                                      $embed_file,\%mapping,
1.1071    raeburn  11140:                                                      $allfiles,$codebase,'upload');
                   11141:             $counter ++;
                   11142:             $numnew ++;
1.987     raeburn  11143:         }
                   11144:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11145:     }
                   11146:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11147:         if ($actionurl eq '/adm/dependencies') {
                   11148:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11149:             $modify_output .= &start_data_table_row().
                   11150:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11151:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11152:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11153:                               '<td>'.$size.'</td>'.
                   11154:                               '<td>'.$mtime.'</td>'.
                   11155:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11156:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11157:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11158:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11159:                               &embedded_file_element('upload_embedded',$counter,
                   11160:                                                      $embed_file,\%mapping,
                   11161:                                                      $allfiles,$codebase,'modify').
                   11162:                               '</div></td>'.
                   11163:                               &end_data_table_row()."\n";
                   11164:             $counter ++;
                   11165:         } else {
                   11166:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11167:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11168:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11169:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11170:                               &Apache::loncommon::end_data_table_row()."\n";
                   11171:         }
                   11172:     }
                   11173:     my $delidx = $counter;
                   11174:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11175:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11176:         $delete_output .= &start_data_table_row().
                   11177:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11178:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11179:                           '<td>'.$size.'</td>'.
                   11180:                           '<td>'.$mtime.'</td>'.
                   11181:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11182:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11183:                           &embedded_file_element('upload_embedded',$delidx,
                   11184:                                                  $oldfile,\%mapping,$allfiles,
                   11185:                                                  $codebase,'delete').'</td>'.
                   11186:                           &end_data_table_row()."\n"; 
                   11187:         $numunused ++;
                   11188:         $delidx ++;
1.987     raeburn  11189:     }
                   11190:     if ($upload_output) {
                   11191:         $upload_output = &start_data_table().
                   11192:                          $upload_output.
                   11193:                          &end_data_table()."\n";
                   11194:     }
1.1071    raeburn  11195:     if ($modify_output) {
                   11196:         $modify_output = &start_data_table().
                   11197:                          &start_data_table_header_row().
                   11198:                          '<th>'.&mt('File').'</th>'.
                   11199:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11200:                          '<th>'.&mt('Modified').'</th>'.
                   11201:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11202:                          &end_data_table_header_row().
                   11203:                          $modify_output.
                   11204:                          &end_data_table()."\n";
                   11205:     }
                   11206:     if ($delete_output) {
                   11207:         $delete_output = &start_data_table().
                   11208:                          &start_data_table_header_row().
                   11209:                          '<th>'.&mt('File').'</th>'.
                   11210:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11211:                          '<th>'.&mt('Modified').'</th>'.
                   11212:                          '<th>'.&mt('Delete?').'</th>'.
                   11213:                          &end_data_table_header_row().
                   11214:                          $delete_output.
                   11215:                          &end_data_table()."\n";
                   11216:     }
1.987     raeburn  11217:     my $applies = 0;
                   11218:     if ($numremref) {
                   11219:         $applies ++;
                   11220:     }
                   11221:     if ($numinvalid) {
                   11222:         $applies ++;
                   11223:     }
                   11224:     if ($numexisting) {
                   11225:         $applies ++;
                   11226:     }
1.1071    raeburn  11227:     if ($counter || $numunused) {
1.987     raeburn  11228:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11229:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11230:                   $state.'<h3>'.$heading.'</h3>'; 
                   11231:         if ($actionurl eq '/adm/dependencies') {
                   11232:             if ($numnew) {
                   11233:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11234:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11235:                            $upload_output.'<br />'."\n";
                   11236:             }
                   11237:             if ($numexisting) {
                   11238:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11239:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11240:                            $modify_output.'<br />'."\n";
                   11241:                            $buttontext = &mt('Save changes');
                   11242:             }
                   11243:             if ($numunused) {
                   11244:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11245:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11246:                            $delete_output.'<br />'."\n";
                   11247:                            $buttontext = &mt('Save changes');
                   11248:             }
                   11249:         } else {
                   11250:             $output .= $upload_output.'<br />'."\n";
                   11251:         }
                   11252:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11253:                    $counter.'" />'."\n";
                   11254:         if ($actionurl eq '/adm/dependencies') { 
                   11255:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11256:                        $numnew.'" />'."\n";
                   11257:         } elsif ($actionurl eq '') {
1.987     raeburn  11258:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11259:         }
                   11260:     } elsif ($applies) {
                   11261:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11262:         if ($applies > 1) {
                   11263:             $output .=  
1.1075.2.35  raeburn  11264:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11265:             if ($numremref) {
                   11266:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11267:             }
                   11268:             if ($numinvalid) {
                   11269:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11270:             }
                   11271:             if ($numexisting) {
                   11272:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11273:             }
                   11274:             $output .= '</ul><br />';
                   11275:         } elsif ($numremref) {
                   11276:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11277:         } elsif ($numinvalid) {
                   11278:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11279:         } elsif ($numexisting) {
                   11280:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11281:         }
                   11282:         $output .= $upload_output.'<br />';
                   11283:     }
                   11284:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11285:     $chgcount = $counter;
1.987     raeburn  11286:     if (keys(%pathchanges) > 0) {
                   11287:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11288:             if ($counter) {
1.987     raeburn  11289:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11290:                                                   $embed_file,\%mapping,
1.1071    raeburn  11291:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11292:             } else {
                   11293:                 $pathchange_output .= 
                   11294:                     &start_data_table_row().
                   11295:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11296:                     $chgcount.'" checked="checked" /></td>'.
                   11297:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11298:                     '<td>'.$embed_file.
                   11299:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11300:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11301:                     '</td>'.&end_data_table_row();
1.660     raeburn  11302:             }
1.987     raeburn  11303:             $numpathchg ++;
                   11304:             $chgcount ++;
1.660     raeburn  11305:         }
                   11306:     }
1.1075.2.35  raeburn  11307:     if (($counter) || ($numunused)) {
1.987     raeburn  11308:         if ($numpathchg) {
                   11309:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11310:                        $numpathchg.'" />'."\n";
                   11311:         }
                   11312:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11313:             ($actionurl eq '/adm/imsimport')) {
                   11314:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11315:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11316:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11317:         } elsif ($actionurl eq '/adm/dependencies') {
                   11318:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11319:         }
1.1075.2.35  raeburn  11320:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11321:     } elsif ($numpathchg) {
                   11322:         my %pathchange = ();
                   11323:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11324:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11325:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11326:         }
1.987     raeburn  11327:     }
1.1071    raeburn  11328:     return ($output,$counter,$numpathchg);
1.987     raeburn  11329: }
                   11330: 
1.1075.2.47  raeburn  11331: =pod
                   11332: 
                   11333: =item * clean_path($name)
                   11334: 
                   11335: Performs clean-up of directories, subdirectories and filename in an
                   11336: embedded object, referenced in an HTML file which is being uploaded
                   11337: to a course or portfolio, where
                   11338: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11339: checked.
                   11340: 
                   11341: Clean-up is similar to replacements in lonnet::clean_filename()
                   11342: except each / between sub-directory and next level is preserved.
                   11343: 
                   11344: =cut
                   11345: 
                   11346: sub clean_path {
                   11347:     my ($embed_file) = @_;
                   11348:     $embed_file =~s{^/+}{};
                   11349:     my @contents;
                   11350:     if ($embed_file =~ m{/}) {
                   11351:         @contents = split(/\//,$embed_file);
                   11352:     } else {
                   11353:         @contents = ($embed_file);
                   11354:     }
                   11355:     my $lastidx = scalar(@contents)-1;
                   11356:     for (my $i=0; $i<=$lastidx; $i++) {
                   11357:         $contents[$i]=~s{\\}{/}g;
                   11358:         $contents[$i]=~s/\s+/\_/g;
                   11359:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11360:         if ($i == $lastidx) {
                   11361:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11362:         }
                   11363:     }
                   11364:     if ($lastidx > 0) {
                   11365:         return join('/',@contents);
                   11366:     } else {
                   11367:         return $contents[0];
                   11368:     }
                   11369: }
                   11370: 
1.987     raeburn  11371: sub embedded_file_element {
1.1071    raeburn  11372:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11373:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11374:                    (ref($codebase) eq 'HASH'));
                   11375:     my $output;
1.1071    raeburn  11376:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11377:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11378:     }
                   11379:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11380:                &escape($embed_file).'" />';
                   11381:     unless (($context eq 'upload_embedded') && 
                   11382:             ($mapping->{$embed_file} eq $embed_file)) {
                   11383:         $output .='
                   11384:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11385:     }
                   11386:     my $attrib;
                   11387:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11388:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11389:     }
                   11390:     $output .=
                   11391:         "\n\t\t".
                   11392:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11393:         $attrib.'" />';
                   11394:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11395:         $output .=
                   11396:             "\n\t\t".
                   11397:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11398:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11399:     }
1.987     raeburn  11400:     return $output;
1.660     raeburn  11401: }
                   11402: 
1.1071    raeburn  11403: sub get_dependency_details {
                   11404:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11405:     my ($size,$mtime,$showsize,$showmtime);
                   11406:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11407:         if ($embed_file =~ m{/}) {
                   11408:             my ($path,$fname) = split(/\//,$embed_file);
                   11409:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11410:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11411:             }
                   11412:         } else {
                   11413:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11414:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11415:             }
                   11416:         }
                   11417:         $showsize = $size/1024.0;
                   11418:         $showsize = sprintf("%.1f",$showsize);
                   11419:         if ($mtime > 0) {
                   11420:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11421:         }
                   11422:     }
                   11423:     return ($showsize,$showmtime);
                   11424: }
                   11425: 
                   11426: sub ask_embedded_js {
                   11427:     return <<"END";
                   11428: <script type="text/javascript"">
                   11429: // <![CDATA[
                   11430: function toggleBrowse(counter) {
                   11431:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11432:     var fileid = document.getElementById('embedded_item_'+counter);
                   11433:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11434:     if (chkboxid.checked == true) {
                   11435:         uploaddivid.style.display='block';
                   11436:     } else {
                   11437:         uploaddivid.style.display='none';
                   11438:         fileid.value = '';
                   11439:     }
                   11440: }
                   11441: // ]]>
                   11442: </script>
                   11443: 
                   11444: END
                   11445: }
                   11446: 
1.661     raeburn  11447: sub upload_embedded {
                   11448:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11449:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11450:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11451:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11452:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11453:         my $orig_uploaded_filename =
                   11454:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11455:         foreach my $type ('orig','ref','attrib','codebase') {
                   11456:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11457:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11458:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11459:             }
                   11460:         }
1.661     raeburn  11461:         my ($path,$fname) =
                   11462:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11463:         # no path, whole string is fname
                   11464:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11465:         $fname = &Apache::lonnet::clean_filename($fname);
                   11466:         # See if there is anything left
                   11467:         next if ($fname eq '');
                   11468: 
                   11469:         # Check if file already exists as a file or directory.
                   11470:         my ($state,$msg);
                   11471:         if ($context eq 'portfolio') {
                   11472:             my $port_path = $dirpath;
                   11473:             if ($group ne '') {
                   11474:                 $port_path = "groups/$group/$port_path";
                   11475:             }
1.987     raeburn  11476:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11477:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11478:                                               $dir_root,$port_path,$disk_quota,
                   11479:                                               $current_disk_usage,$uname,$udom);
                   11480:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11481:                 || $state eq 'file_locked') {
1.661     raeburn  11482:                 $output .= $msg;
                   11483:                 next;
                   11484:             }
                   11485:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11486:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11487:             if ($state eq 'exists') {
                   11488:                 $output .= $msg;
                   11489:                 next;
                   11490:             }
                   11491:         }
                   11492:         # Check if extension is valid
                   11493:         if (($fname =~ /\.(\w+)$/) &&
                   11494:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11495:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11496:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11497:             next;
                   11498:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11499:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11500:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11501:             next;
                   11502:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11503:             $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  11504:             next;
                   11505:         }
                   11506:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11507:         my $subdir = $path;
                   11508:         $subdir =~ s{/+$}{};
1.661     raeburn  11509:         if ($context eq 'portfolio') {
1.984     raeburn  11510:             my $result;
                   11511:             if ($state eq 'existingfile') {
                   11512:                 $result=
                   11513:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11514:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11515:             } else {
1.984     raeburn  11516:                 $result=
                   11517:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11518:                                                     $dirpath.
1.1075.2.35  raeburn  11519:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11520:                 if ($result !~ m|^/uploaded/|) {
                   11521:                     $output .= '<span class="LC_error">'
                   11522:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11523:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11524:                                .'</span><br />';
                   11525:                     next;
                   11526:                 } else {
1.987     raeburn  11527:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11528:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11529:                 }
1.661     raeburn  11530:             }
1.1075.2.35  raeburn  11531:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11532:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11533:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11534:             my $result =
1.1075.2.35  raeburn  11535:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11536:             if ($result !~ m|^/uploaded/|) {
                   11537:                 $output .= '<span class="LC_error">'
                   11538:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11539:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11540:                            .'</span><br />';
                   11541:                     next;
                   11542:             } else {
                   11543:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11544:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11545:                 if ($context eq 'syllabus') {
                   11546:                     &Apache::lonnet::make_public_indefinitely($result);
                   11547:                 }
1.987     raeburn  11548:             }
1.661     raeburn  11549:         } else {
                   11550: # Save the file
                   11551:             my $target = $env{'form.embedded_item_'.$i};
                   11552:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11553:             my $dest = $fullpath.$fname;
                   11554:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11555:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11556:             my $count;
                   11557:             my $filepath = $dir_root;
1.1027    raeburn  11558:             foreach my $subdir (@parts) {
                   11559:                 $filepath .= "/$subdir";
                   11560:                 if (!-e $filepath) {
1.661     raeburn  11561:                     mkdir($filepath,0770);
                   11562:                 }
                   11563:             }
                   11564:             my $fh;
                   11565:             if (!open($fh,'>'.$dest)) {
                   11566:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11567:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11568:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11569:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11570:                            '</span><br />';
                   11571:             } else {
                   11572:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11573:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11574:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11575:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11576:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11577:                               '</span><br />';
                   11578:                 } else {
1.987     raeburn  11579:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11580:                                $url.'</span>').'<br />';
                   11581:                     unless ($context eq 'testbank') {
                   11582:                         $footer .= &mt('View embedded file: [_1]',
                   11583:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11584:                     }
                   11585:                 }
                   11586:                 close($fh);
                   11587:             }
                   11588:         }
                   11589:         if ($env{'form.embedded_ref_'.$i}) {
                   11590:             $pathchange{$i} = 1;
                   11591:         }
                   11592:     }
                   11593:     if ($output) {
                   11594:         $output = '<p>'.$output.'</p>';
                   11595:     }
                   11596:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11597:     $returnflag = 'ok';
1.1071    raeburn  11598:     my $numpathchgs = scalar(keys(%pathchange));
                   11599:     if ($numpathchgs > 0) {
1.987     raeburn  11600:         if ($context eq 'portfolio') {
                   11601:             $output .= '<p>'.&mt('or').'</p>';
                   11602:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11603:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11604:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11605:             $returnflag = 'modify_orightml';
                   11606:         }
                   11607:     }
1.1071    raeburn  11608:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11609: }
                   11610: 
                   11611: sub modify_html_form {
                   11612:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11613:     my $end = 0;
                   11614:     my $modifyform;
                   11615:     if ($context eq 'upload_embedded') {
                   11616:         return unless (ref($pathchange) eq 'HASH');
                   11617:         if ($env{'form.number_embedded_items'}) {
                   11618:             $end += $env{'form.number_embedded_items'};
                   11619:         }
                   11620:         if ($env{'form.number_pathchange_items'}) {
                   11621:             $end += $env{'form.number_pathchange_items'};
                   11622:         }
                   11623:         if ($end) {
                   11624:             for (my $i=0; $i<$end; $i++) {
                   11625:                 if ($i < $env{'form.number_embedded_items'}) {
                   11626:                     next unless($pathchange->{$i});
                   11627:                 }
                   11628:                 $modifyform .=
                   11629:                     &start_data_table_row().
                   11630:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11631:                     'checked="checked" /></td>'.
                   11632:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11633:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11634:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11635:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11636:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11637:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11638:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11639:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11640:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11641:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11642:                     &end_data_table_row();
1.1071    raeburn  11643:             }
1.987     raeburn  11644:         }
                   11645:     } else {
                   11646:         $modifyform = $pathchgtable;
                   11647:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11648:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11649:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11650:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11651:         }
                   11652:     }
                   11653:     if ($modifyform) {
1.1071    raeburn  11654:         if ($actionurl eq '/adm/dependencies') {
                   11655:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11656:         }
1.987     raeburn  11657:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11658:                '<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".
                   11659:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11660:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11661:                '</ol></p>'."\n".'<p>'.
                   11662:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11663:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11664:                &start_data_table()."\n".
                   11665:                &start_data_table_header_row().
                   11666:                '<th>'.&mt('Change?').'</th>'.
                   11667:                '<th>'.&mt('Current reference').'</th>'.
                   11668:                '<th>'.&mt('Required reference').'</th>'.
                   11669:                &end_data_table_header_row()."\n".
                   11670:                $modifyform.
                   11671:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11672:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11673:                '</form>'."\n";
                   11674:     }
                   11675:     return;
                   11676: }
                   11677: 
                   11678: sub modify_html_refs {
1.1075.2.35  raeburn  11679:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11680:     my $container;
                   11681:     if ($context eq 'portfolio') {
                   11682:         $container = $env{'form.container'};
                   11683:     } elsif ($context eq 'coursedoc') {
                   11684:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11685:     } elsif ($context eq 'manage_dependencies') {
                   11686:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11687:         $container = "/$container";
1.1075.2.35  raeburn  11688:     } elsif ($context eq 'syllabus') {
                   11689:         $container = $url;
1.987     raeburn  11690:     } else {
1.1027    raeburn  11691:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11692:     }
                   11693:     my (%allfiles,%codebase,$output,$content);
                   11694:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11695:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11696:         if (wantarray) {
                   11697:             return ('',0,0); 
                   11698:         } else {
                   11699:             return;
                   11700:         }
                   11701:     }
                   11702:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11703:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11704:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11705:             if (wantarray) {
                   11706:                 return ('',0,0);
                   11707:             } else {
                   11708:                 return;
                   11709:             }
                   11710:         } 
1.987     raeburn  11711:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11712:         if ($content eq '-1') {
                   11713:             if (wantarray) {
                   11714:                 return ('',0,0);
                   11715:             } else {
                   11716:                 return;
                   11717:             }
                   11718:         }
1.987     raeburn  11719:     } else {
1.1071    raeburn  11720:         unless ($container =~ /^\Q$dir_root\E/) {
                   11721:             if (wantarray) {
                   11722:                 return ('',0,0);
                   11723:             } else {
                   11724:                 return;
                   11725:             }
                   11726:         } 
1.1075.2.128  raeburn  11727:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11728:             $content = join('', <$fh>);
                   11729:             close($fh);
                   11730:         } else {
1.1071    raeburn  11731:             if (wantarray) {
                   11732:                 return ('',0,0);
                   11733:             } else {
                   11734:                 return;
                   11735:             }
1.987     raeburn  11736:         }
                   11737:     }
                   11738:     my ($count,$codebasecount) = (0,0);
                   11739:     my $mm = new File::MMagic;
                   11740:     my $mime_type = $mm->checktype_contents($content);
                   11741:     if ($mime_type eq 'text/html') {
                   11742:         my $parse_result = 
                   11743:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11744:                                                     \%codebase,\$content);
                   11745:         if ($parse_result eq 'ok') {
                   11746:             foreach my $i (@changes) {
                   11747:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11748:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11749:                 if ($allfiles{$ref}) {
                   11750:                     my $newname =  $orig;
                   11751:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11752:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11753:                     if ($attrib_regexp =~ /:/) {
                   11754:                         $attrib_regexp =~ s/\:/|/g;
                   11755:                     }
                   11756:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11757:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11758:                         $count += $numchg;
1.1075.2.35  raeburn  11759:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11760:                         delete($allfiles{$ref});
1.987     raeburn  11761:                     }
                   11762:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11763:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11764:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11765:                         $codebasecount ++;
                   11766:                     }
                   11767:                 }
                   11768:             }
1.1075.2.35  raeburn  11769:             my $skiprewrites;
1.987     raeburn  11770:             if ($count || $codebasecount) {
                   11771:                 my $saveresult;
1.1071    raeburn  11772:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11773:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11774:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11775:                     if ($url eq $container) {
                   11776:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11777:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11778:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11779:                                             $fname.'</span>').'</p>';
1.987     raeburn  11780:                     } else {
                   11781:                          $output = '<p class="LC_error">'.
                   11782:                                    &mt('Error: update failed for: [_1].',
                   11783:                                    '<span class="LC_filename">'.
                   11784:                                    $container.'</span>').'</p>';
                   11785:                     }
1.1075.2.35  raeburn  11786:                     if ($context eq 'syllabus') {
                   11787:                         unless ($saveresult eq 'ok') {
                   11788:                             $skiprewrites = 1;
                   11789:                         }
                   11790:                     }
1.987     raeburn  11791:                 } else {
1.1075.2.128  raeburn  11792:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11793:                         print $fh $content;
                   11794:                         close($fh);
                   11795:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11796:                                   $count,'<span class="LC_filename">'.
                   11797:                                   $container.'</span>').'</p>';
1.661     raeburn  11798:                     } else {
1.987     raeburn  11799:                          $output = '<p class="LC_error">'.
                   11800:                                    &mt('Error: could not update [_1].',
                   11801:                                    '<span class="LC_filename">'.
                   11802:                                    $container.'</span>').'</p>';
1.661     raeburn  11803:                     }
                   11804:                 }
                   11805:             }
1.1075.2.35  raeburn  11806:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11807:                 my ($actionurl,$state);
                   11808:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11809:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11810:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11811:                                               \%codebase,
                   11812:                                               {'context' => 'rewrites',
                   11813:                                                'ignore_remote_references' => 1,});
                   11814:                 if (ref($mapping) eq 'HASH') {
                   11815:                     my $rewrites = 0;
                   11816:                     foreach my $key (keys(%{$mapping})) {
                   11817:                         next if ($key =~ m{^https?://});
                   11818:                         my $ref = $mapping->{$key};
                   11819:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11820:                         my $attrib;
                   11821:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11822:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11823:                         }
                   11824:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11825:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11826:                             $rewrites += $numchg;
                   11827:                         }
                   11828:                     }
                   11829:                     if ($rewrites) {
                   11830:                         my $saveresult;
                   11831:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11832:                         if ($url eq $container) {
                   11833:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11834:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11835:                                             $count,'<span class="LC_filename">'.
                   11836:                                             $fname.'</span>').'</p>';
                   11837:                         } else {
                   11838:                             $output .= '<p class="LC_error">'.
                   11839:                                        &mt('Error: could not update links in [_1].',
                   11840:                                        '<span class="LC_filename">'.
                   11841:                                        $container.'</span>').'</p>';
                   11842: 
                   11843:                         }
                   11844:                     }
                   11845:                 }
                   11846:             }
1.987     raeburn  11847:         } else {
                   11848:             &logthis('Failed to parse '.$container.
                   11849:                      ' to modify references: '.$parse_result);
1.661     raeburn  11850:         }
                   11851:     }
1.1071    raeburn  11852:     if (wantarray) {
                   11853:         return ($output,$count,$codebasecount);
                   11854:     } else {
                   11855:         return $output;
                   11856:     }
1.661     raeburn  11857: }
                   11858: 
                   11859: sub check_for_existing {
                   11860:     my ($path,$fname,$element) = @_;
                   11861:     my ($state,$msg);
                   11862:     if (-d $path.'/'.$fname) {
                   11863:         $state = 'exists';
                   11864:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11865:     } elsif (-e $path.'/'.$fname) {
                   11866:         $state = 'exists';
                   11867:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11868:     }
                   11869:     if ($state eq 'exists') {
                   11870:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11871:     }
                   11872:     return ($state,$msg);
                   11873: }
                   11874: 
                   11875: sub check_for_upload {
                   11876:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11877:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11878:     my $filesize = length($env{'form.'.$element});
                   11879:     if (!$filesize) {
                   11880:         my $msg = '<span class="LC_error">'.
                   11881:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11882:                       '<span class="LC_filename">'.$fname.'</span>',
                   11883:                       $filesize).'<br />'.
1.1007    raeburn  11884:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11885:                   '</span>';
                   11886:         return ('zero_bytes',$msg);
                   11887:     }
                   11888:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11889:     my $getpropath = 1;
1.1021    raeburn  11890:     my ($dirlistref,$listerror) =
                   11891:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11892:     my $found_file = 0;
                   11893:     my $locked_file = 0;
1.991     raeburn  11894:     my @lockers;
                   11895:     my $navmap;
                   11896:     if ($env{'request.course.id'}) {
                   11897:         $navmap = Apache::lonnavmaps::navmap->new();
                   11898:     }
1.1021    raeburn  11899:     if (ref($dirlistref) eq 'ARRAY') {
                   11900:         foreach my $line (@{$dirlistref}) {
                   11901:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11902:             if ($file_name eq $fname){
                   11903:                 $file_name = $path.$file_name;
                   11904:                 if ($group ne '') {
                   11905:                     $file_name = $group.$file_name;
                   11906:                 }
                   11907:                 $found_file = 1;
                   11908:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11909:                     foreach my $lock (@lockers) {
                   11910:                         if (ref($lock) eq 'ARRAY') {
                   11911:                             my ($symb,$crsid) = @{$lock};
                   11912:                             if ($crsid eq $env{'request.course.id'}) {
                   11913:                                 if (ref($navmap)) {
                   11914:                                     my $res = $navmap->getBySymb($symb);
                   11915:                                     foreach my $part (@{$res->parts()}) { 
                   11916:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11917:                                         unless (($slot_status == $res->RESERVED) ||
                   11918:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11919:                                             $locked_file = 1;
                   11920:                                         }
1.991     raeburn  11921:                                     }
1.1021    raeburn  11922:                                 } else {
                   11923:                                     $locked_file = 1;
1.991     raeburn  11924:                                 }
                   11925:                             } else {
                   11926:                                 $locked_file = 1;
                   11927:                             }
                   11928:                         }
1.1021    raeburn  11929:                    }
                   11930:                 } else {
                   11931:                     my @info = split(/\&/,$rest);
                   11932:                     my $currsize = $info[6]/1000;
                   11933:                     if ($currsize < $filesize) {
                   11934:                         my $extra = $filesize - $currsize;
                   11935:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11936:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11937:                                       &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  11938:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11939:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11940:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11941:                             return ('will_exceed_quota',$msg);
                   11942:                         }
1.984     raeburn  11943:                     }
                   11944:                 }
1.661     raeburn  11945:             }
                   11946:         }
                   11947:     }
                   11948:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11949:         my $msg = '<p class="LC_warning">'.
                   11950:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11951:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11952:         return ('will_exceed_quota',$msg);
                   11953:     } elsif ($found_file) {
                   11954:         if ($locked_file) {
1.1075.2.69  raeburn  11955:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11956:             $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  11957:             $msg .= '</p>';
1.661     raeburn  11958:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11959:             return ('file_locked',$msg);
                   11960:         } else {
1.1075.2.69  raeburn  11961:             my $msg = '<p class="LC_error">';
1.984     raeburn  11962:             $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  11963:             $msg .= '</p>';
1.984     raeburn  11964:             return ('existingfile',$msg);
1.661     raeburn  11965:         }
                   11966:     }
                   11967: }
                   11968: 
1.987     raeburn  11969: sub check_for_traversal {
                   11970:     my ($path,$url,$toplevel) = @_;
                   11971:     my @parts=split(/\//,$path);
                   11972:     my $cleanpath;
                   11973:     my $fullpath = $url;
                   11974:     for (my $i=0;$i<@parts;$i++) {
                   11975:         next if ($parts[$i] eq '.');
                   11976:         if ($parts[$i] eq '..') {
                   11977:             $fullpath =~ s{([^/]+/)$}{};
                   11978:         } else {
                   11979:             $fullpath .= $parts[$i].'/';
                   11980:         }
                   11981:     }
                   11982:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11983:         $cleanpath = $1;
                   11984:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11985:         my $curr_toprel = $1;
                   11986:         my @parts = split(/\//,$curr_toprel);
                   11987:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11988:         my @urlparts = split(/\//,$url_toprel);
                   11989:         my $doubledots;
                   11990:         my $startdiff = -1;
                   11991:         for (my $i=0; $i<@urlparts; $i++) {
                   11992:             if ($startdiff == -1) {
                   11993:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11994:                     $startdiff = $i;
                   11995:                     $doubledots .= '../';
                   11996:                 }
                   11997:             } else {
                   11998:                 $doubledots .= '../';
                   11999:             }
                   12000:         }
                   12001:         if ($startdiff > -1) {
                   12002:             $cleanpath = $doubledots;
                   12003:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12004:                 $cleanpath .= $parts[$i].'/';
                   12005:             }
                   12006:         }
                   12007:     }
                   12008:     $cleanpath =~ s{(/)$}{};
                   12009:     return $cleanpath;
                   12010: }
1.31      albertel 12011: 
1.1053    raeburn  12012: sub is_archive_file {
                   12013:     my ($mimetype) = @_;
                   12014:     if (($mimetype eq 'application/octet-stream') ||
                   12015:         ($mimetype eq 'application/x-stuffit') ||
                   12016:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12017:         return 1;
                   12018:     }
                   12019:     return;
                   12020: }
                   12021: 
                   12022: sub decompress_form {
1.1065    raeburn  12023:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12024:     my %lt = &Apache::lonlocal::texthash (
                   12025:         this => 'This file is an archive file.',
1.1067    raeburn  12026:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12027:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12028:         youm => 'You may wish to extract its contents.',
                   12029:         extr => 'Extract contents',
1.1067    raeburn  12030:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12031:         proa => 'Process automatically?',
1.1053    raeburn  12032:         yes  => 'Yes',
                   12033:         no   => 'No',
1.1067    raeburn  12034:         fold => 'Title for folder containing movie',
                   12035:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12036:     );
1.1065    raeburn  12037:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12038:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12039:     my $info = &list_archive_contents($fileloc,\@paths);
                   12040:     if (@paths) {
                   12041:         foreach my $path (@paths) {
                   12042:             $path =~ s{^/}{};
1.1067    raeburn  12043:             if ($path =~ m{^([^/]+)/$}) {
                   12044:                 $topdir = $1;
                   12045:             }
1.1065    raeburn  12046:             if ($path =~ m{^([^/]+)/}) {
                   12047:                 $toplevel{$1} = $path;
                   12048:             } else {
                   12049:                 $toplevel{$path} = $path;
                   12050:             }
                   12051:         }
                   12052:     }
1.1067    raeburn  12053:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12054:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12055:                         "$topdir/media/",
                   12056:                         "$topdir/media/$topdir.mp4",
                   12057:                         "$topdir/media/FirstFrame.png",
                   12058:                         "$topdir/media/player.swf",
                   12059:                         "$topdir/media/swfobject.js",
                   12060:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12061:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12062:                          "$topdir/$topdir.mp4",
                   12063:                          "$topdir/$topdir\_config.xml",
                   12064:                          "$topdir/$topdir\_controller.swf",
                   12065:                          "$topdir/$topdir\_embed.css",
                   12066:                          "$topdir/$topdir\_First_Frame.png",
                   12067:                          "$topdir/$topdir\_player.html",
                   12068:                          "$topdir/$topdir\_Thumbnails.png",
                   12069:                          "$topdir/playerProductInstall.swf",
                   12070:                          "$topdir/scripts/",
                   12071:                          "$topdir/scripts/config_xml.js",
                   12072:                          "$topdir/scripts/handlebars.js",
                   12073:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12074:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12075:                          "$topdir/scripts/modernizr.js",
                   12076:                          "$topdir/scripts/player-min.js",
                   12077:                          "$topdir/scripts/swfobject.js",
                   12078:                          "$topdir/skins/",
                   12079:                          "$topdir/skins/configuration_express.xml",
                   12080:                          "$topdir/skins/express_show/",
                   12081:                          "$topdir/skins/express_show/player-min.css",
                   12082:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12083:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12084:                          "$topdir/$topdir.mp4",
                   12085:                          "$topdir/$topdir\_config.xml",
                   12086:                          "$topdir/$topdir\_controller.swf",
                   12087:                          "$topdir/$topdir\_embed.css",
                   12088:                          "$topdir/$topdir\_First_Frame.png",
                   12089:                          "$topdir/$topdir\_player.html",
                   12090:                          "$topdir/$topdir\_Thumbnails.png",
                   12091:                          "$topdir/playerProductInstall.swf",
                   12092:                          "$topdir/scripts/",
                   12093:                          "$topdir/scripts/config_xml.js",
                   12094:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12095:                          "$topdir/skins/",
                   12096:                          "$topdir/skins/configuration_express.xml",
                   12097:                          "$topdir/skins/express_show/",
                   12098:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12099:                          "$topdir/skins/express_show/spritesheet.png",
                   12100:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12101:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12102:         if (@diffs == 0) {
1.1075.2.59  raeburn  12103:             $is_camtasia = 6;
                   12104:         } else {
1.1075.2.81  raeburn  12105:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12106:             if (@diffs == 0) {
                   12107:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12108:             } else {
                   12109:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12110:                 if (@diffs == 0) {
                   12111:                     $is_camtasia = 8;
                   12112:                 }
1.1075.2.59  raeburn  12113:             }
1.1067    raeburn  12114:         }
                   12115:     }
                   12116:     my $output;
                   12117:     if ($is_camtasia) {
                   12118:         $output = <<"ENDCAM";
                   12119: <script type="text/javascript" language="Javascript">
                   12120: // <![CDATA[
                   12121: 
                   12122: function camtasiaToggle() {
                   12123:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12124:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12125:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12126:                 document.getElementById('camtasia_titles').style.display='block';
                   12127:             } else {
                   12128:                 document.getElementById('camtasia_titles').style.display='none';
                   12129:             }
                   12130:         }
                   12131:     }
                   12132:     return;
                   12133: }
                   12134: 
                   12135: // ]]>
                   12136: </script>
                   12137: <p>$lt{'camt'}</p>
                   12138: ENDCAM
1.1065    raeburn  12139:     } else {
1.1067    raeburn  12140:         $output = '<p>'.$lt{'this'};
                   12141:         if ($info eq '') {
                   12142:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12143:         } else {
                   12144:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12145:                        '<div><pre>'.$info.'</pre></div>';
                   12146:         }
1.1065    raeburn  12147:     }
1.1067    raeburn  12148:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12149:     my $duplicates;
                   12150:     my $num = 0;
                   12151:     if (ref($dirlist) eq 'ARRAY') {
                   12152:         foreach my $item (@{$dirlist}) {
                   12153:             if (ref($item) eq 'ARRAY') {
                   12154:                 if (exists($toplevel{$item->[0]})) {
                   12155:                     $duplicates .= 
                   12156:                         &start_data_table_row().
                   12157:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12158:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12159:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12160:                         'value="1" />'.&mt('Yes').'</label>'.
                   12161:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12162:                         '<td>'.$item->[0].'</td>';
                   12163:                     if ($item->[2]) {
                   12164:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12165:                     } else {
                   12166:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12167:                     }
                   12168:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12169:                                    '<td>'.
                   12170:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12171:                                    '</td>'.
                   12172:                                    &end_data_table_row();
                   12173:                     $num ++;
                   12174:                 }
                   12175:             }
                   12176:         }
                   12177:     }
                   12178:     my $itemcount;
                   12179:     if (@paths > 0) {
                   12180:         $itemcount = scalar(@paths);
                   12181:     } else {
                   12182:         $itemcount = 1;
                   12183:     }
1.1067    raeburn  12184:     if ($is_camtasia) {
                   12185:         $output .= $lt{'auto'}.'<br />'.
                   12186:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12187:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12188:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12189:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12190:                    $lt{'no'}.'</label></span><br />'.
                   12191:                    '<div id="camtasia_titles" style="display:block">'.
                   12192:                    &Apache::lonhtmlcommon::start_pick_box().
                   12193:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12194:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12195:                    &Apache::lonhtmlcommon::row_closure().
                   12196:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12197:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12198:                    &Apache::lonhtmlcommon::row_closure(1).
                   12199:                    &Apache::lonhtmlcommon::end_pick_box().
                   12200:                    '</div>';
                   12201:     }
1.1065    raeburn  12202:     $output .= 
                   12203:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12204:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12205:         "\n";
1.1065    raeburn  12206:     if ($duplicates ne '') {
                   12207:         $output .= '<p><span class="LC_warning">'.
                   12208:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12209:                    &start_data_table().
                   12210:                    &start_data_table_header_row().
                   12211:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12212:                    '<th>'.&mt('Name').'</th>'.
                   12213:                    '<th>'.&mt('Type').'</th>'.
                   12214:                    '<th>'.&mt('Size').'</th>'.
                   12215:                    '<th>'.&mt('Last modified').'</th>'.
                   12216:                    &end_data_table_header_row().
                   12217:                    $duplicates.
                   12218:                    &end_data_table().
                   12219:                    '</p>';
                   12220:     }
1.1067    raeburn  12221:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12222:     if (ref($hiddenelements) eq 'HASH') {
                   12223:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12224:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12225:         }
                   12226:     }
                   12227:     $output .= <<"END";
1.1067    raeburn  12228: <br />
1.1053    raeburn  12229: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12230: </form>
                   12231: $noextract
                   12232: END
                   12233:     return $output;
                   12234: }
                   12235: 
1.1065    raeburn  12236: sub decompression_utility {
                   12237:     my ($program) = @_;
                   12238:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12239:     my $location;
                   12240:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12241:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12242:                          '/usr/sbin/') {
                   12243:             if (-x $dir.$program) {
                   12244:                 $location = $dir.$program;
                   12245:                 last;
                   12246:             }
                   12247:         }
                   12248:     }
                   12249:     return $location;
                   12250: }
                   12251: 
                   12252: sub list_archive_contents {
                   12253:     my ($file,$pathsref) = @_;
                   12254:     my (@cmd,$output);
                   12255:     my $needsregexp;
                   12256:     if ($file =~ /\.zip$/) {
                   12257:         @cmd = (&decompression_utility('unzip'),"-l");
                   12258:         $needsregexp = 1;
                   12259:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12260:              ($file =~ /\.tgz$/)) {
                   12261:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12262:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12263:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12264:     } elsif ($file =~ m|\.tar$|) {
                   12265:         @cmd = (&decompression_utility('tar'),"-tf");
                   12266:     }
                   12267:     if (@cmd) {
                   12268:         undef($!);
                   12269:         undef($@);
                   12270:         if (open(my $fh,"-|", @cmd, $file)) {
                   12271:             while (my $line = <$fh>) {
                   12272:                 $output .= $line;
                   12273:                 chomp($line);
                   12274:                 my $item;
                   12275:                 if ($needsregexp) {
                   12276:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12277:                 } else {
                   12278:                     $item = $line;
                   12279:                 }
                   12280:                 if ($item ne '') {
                   12281:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12282:                         push(@{$pathsref},$item);
                   12283:                     } 
                   12284:                 }
                   12285:             }
                   12286:             close($fh);
                   12287:         }
                   12288:     }
                   12289:     return $output;
                   12290: }
                   12291: 
1.1053    raeburn  12292: sub decompress_uploaded_file {
                   12293:     my ($file,$dir) = @_;
                   12294:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12295:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12296:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12297:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12298:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12299:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12300:     my $decompressed = $env{'cgi.decompressed'};
                   12301:     &Apache::lonnet::delenv('cgi.file');
                   12302:     &Apache::lonnet::delenv('cgi.dir');
                   12303:     &Apache::lonnet::delenv('cgi.decompressed');
                   12304:     return ($decompressed,$result);
                   12305: }
                   12306: 
1.1055    raeburn  12307: sub process_decompression {
                   12308:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12309:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12310:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12311:                &mt('Unexpected file path.').'</p>'."\n";
                   12312:     }
                   12313:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12314:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12315:                &mt('Unexpected course context.').'</p>'."\n";
                   12316:     }
                   12317:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12318:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12319:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12320:     }
1.1055    raeburn  12321:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12322:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12323:         $error = &mt('Filename not a supported archive file type.').
                   12324:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12325:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12326:     } else {
                   12327:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12328:         if ($docuhome eq 'no_host') {
                   12329:             $error = &mt('Could not determine home server for course.');
                   12330:         } else {
                   12331:             my @ids=&Apache::lonnet::current_machine_ids();
                   12332:             my $currdir = "$dir_root/$destination";
                   12333:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12334:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12335:                        "$dir_root/$destination";
                   12336:             } else {
                   12337:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12338:                        "$dir_root/$docudom/$docuname/$destination";
                   12339:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12340:                     $error = &mt('Archive file not found.');
                   12341:                 }
                   12342:             }
1.1065    raeburn  12343:             my (@to_overwrite,@to_skip);
                   12344:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12345:                 my $total = $env{'form.archive_overwrite_total'};
                   12346:                 for (my $i=0; $i<$total; $i++) {
                   12347:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12348:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12349:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12350:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12351:                     }
                   12352:                 }
                   12353:             }
                   12354:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12355:             my $numoverwrite = scalar(@to_overwrite);
                   12356:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12357:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12358:             } elsif ($dir eq '') {
1.1055    raeburn  12359:                 $error = &mt('Directory containing archive file unavailable.');
                   12360:             } elsif (!$error) {
1.1065    raeburn  12361:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12362:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12363:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12364:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12365:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12366:                         ($decompressed,$display) =
                   12367:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12368:                         foreach my $item (@to_skip) {
                   12369:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12370:                                 if (-f "$dir/$tempdir/$item") {
                   12371:                                     unlink("$dir/$tempdir/$item");
                   12372:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12373:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12374:                                 }
                   12375:                             }
                   12376:                         }
                   12377:                         foreach my $item (@to_overwrite) {
                   12378:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12379:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12380:                                     if (-f "$dir/$item") {
                   12381:                                         unlink("$dir/$item");
                   12382:                                     } elsif (-d "$dir/$item") {
                   12383:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12384:                                     }
                   12385:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12386:                                 }
1.1065    raeburn  12387:                             }
                   12388:                         }
1.1075.2.128  raeburn  12389:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12390:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12391:                         }
1.1065    raeburn  12392:                     }
                   12393:                 } else {
                   12394:                     ($decompressed,$display) = 
                   12395:                         &decompress_uploaded_file($file,$dir);
                   12396:                 }
1.1055    raeburn  12397:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12398:                     $output = '<p class="LC_info">'.
                   12399:                               &mt('Files extracted successfully from archive.').
                   12400:                               '</p>'."\n";
1.1055    raeburn  12401:                     my ($warning,$result,@contents);
                   12402:                     my ($newdirlistref,$newlisterror) =
                   12403:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12404:                                                  $docuname,1);
                   12405:                     my (%is_dir,%changes,@newitems);
                   12406:                     my $dirptr = 16384;
1.1065    raeburn  12407:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12408:                         foreach my $dir_line (@{$newdirlistref}) {
                   12409:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12410:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12411:                                 push(@newitems,$item);
                   12412:                                 if ($dirptr&$testdir) {
                   12413:                                     $is_dir{$item} = 1;
                   12414:                                 }
                   12415:                                 $changes{$item} = 1;
                   12416:                             }
                   12417:                         }
                   12418:                     }
                   12419:                     if (keys(%changes) > 0) {
                   12420:                         foreach my $item (sort(@newitems)) {
                   12421:                             if ($changes{$item}) {
                   12422:                                 push(@contents,$item);
                   12423:                             }
                   12424:                         }
                   12425:                     }
                   12426:                     if (@contents > 0) {
1.1067    raeburn  12427:                         my $wantform;
                   12428:                         unless ($env{'form.autoextract_camtasia'}) {
                   12429:                             $wantform = 1;
                   12430:                         }
1.1056    raeburn  12431:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12432:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12433:                                                                 $currdir,\%is_dir,
                   12434:                                                                 \%children,\%parent,
1.1056    raeburn  12435:                                                                 \@contents,\%dirorder,
                   12436:                                                                 \%titles,$wantform);
1.1055    raeburn  12437:                         if ($datatable ne '') {
                   12438:                             $output .= &archive_options_form('decompressed',$datatable,
                   12439:                                                              $count,$hiddenelem);
1.1065    raeburn  12440:                             my $startcount = 6;
1.1055    raeburn  12441:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12442:                                                            \%titles,\%children);
1.1055    raeburn  12443:                         }
1.1067    raeburn  12444:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12445:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12446:                             my %displayed;
                   12447:                             my $total = 1;
                   12448:                             $env{'form.archive_directory'} = [];
                   12449:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12450:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12451:                                 $path =~ s{/$}{};
                   12452:                                 my $item;
                   12453:                                 if ($path ne '') {
                   12454:                                     $item = "$path/$titles{$i}";
                   12455:                                 } else {
                   12456:                                     $item = $titles{$i};
                   12457:                                 }
                   12458:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12459:                                 if ($item eq $contents[0]) {
                   12460:                                     push(@{$env{'form.archive_directory'}},$i);
                   12461:                                     $env{'form.archive_'.$i} = 'display';
                   12462:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12463:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12464:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12465:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12466:                                     $env{'form.archive_'.$i} = 'display';
                   12467:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12468:                                     $displayed{'web'} = $i;
                   12469:                                 } else {
1.1075.2.59  raeburn  12470:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12471:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12472:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12473:                                         push(@{$env{'form.archive_directory'}},$i);
                   12474:                                     }
                   12475:                                     $env{'form.archive_'.$i} = 'dependency';
                   12476:                                 }
                   12477:                                 $total ++;
                   12478:                             }
                   12479:                             for (my $i=1; $i<$total; $i++) {
                   12480:                                 next if ($i == $displayed{'web'});
                   12481:                                 next if ($i == $displayed{'folder'});
                   12482:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12483:                             }
                   12484:                             $env{'form.phase'} = 'decompress_cleanup';
                   12485:                             $env{'form.archivedelete'} = 1;
                   12486:                             $env{'form.archive_count'} = $total-1;
                   12487:                             $output .=
                   12488:                                 &process_extracted_files('coursedocs',$docudom,
                   12489:                                                          $docuname,$destination,
                   12490:                                                          $dir_root,$hiddenelem);
                   12491:                         }
1.1055    raeburn  12492:                     } else {
                   12493:                         $warning = &mt('No new items extracted from archive file.');
                   12494:                     }
                   12495:                 } else {
                   12496:                     $output = $display;
                   12497:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12498:                 }
                   12499:             }
                   12500:         }
                   12501:     }
                   12502:     if ($error) {
                   12503:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12504:                    $error.'</p>'."\n";
                   12505:     }
                   12506:     if ($warning) {
                   12507:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12508:     }
                   12509:     return $output;
                   12510: }
                   12511: 
                   12512: sub get_extracted {
1.1056    raeburn  12513:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12514:         $titles,$wantform) = @_;
1.1055    raeburn  12515:     my $count = 0;
                   12516:     my $depth = 0;
                   12517:     my $datatable;
1.1056    raeburn  12518:     my @hierarchy;
1.1055    raeburn  12519:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12520:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12521:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12522:     foreach my $item (@{$contents}) {
                   12523:         $count ++;
1.1056    raeburn  12524:         @{$dirorder->{$count}} = @hierarchy;
                   12525:         $titles->{$count} = $item;
1.1055    raeburn  12526:         &archive_hierarchy($depth,$count,$parent,$children);
                   12527:         if ($wantform) {
                   12528:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12529:                                        $currdir,$depth,$count);
                   12530:         }
                   12531:         if ($is_dir->{$item}) {
                   12532:             $depth ++;
1.1056    raeburn  12533:             push(@hierarchy,$count);
                   12534:             $parent->{$depth} = $count;
1.1055    raeburn  12535:             $datatable .=
                   12536:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12537:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12538:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12539:             $depth --;
1.1056    raeburn  12540:             pop(@hierarchy);
1.1055    raeburn  12541:         }
                   12542:     }
                   12543:     return ($count,$datatable);
                   12544: }
                   12545: 
                   12546: sub recurse_extracted_archive {
1.1056    raeburn  12547:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12548:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12549:     my $result='';
1.1056    raeburn  12550:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12551:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12552:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12553:         return $result;
                   12554:     }
                   12555:     my $dirptr = 16384;
                   12556:     my ($newdirlistref,$newlisterror) =
                   12557:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12558:     if (ref($newdirlistref) eq 'ARRAY') {
                   12559:         foreach my $dir_line (@{$newdirlistref}) {
                   12560:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12561:             unless ($item =~ /^\.+$/) {
                   12562:                 $$count ++;
1.1056    raeburn  12563:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12564:                 $titles->{$$count} = $item;
1.1055    raeburn  12565:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12566: 
1.1055    raeburn  12567:                 my $is_dir;
                   12568:                 if ($dirptr&$testdir) {
                   12569:                     $is_dir = 1;
                   12570:                 }
                   12571:                 if ($wantform) {
                   12572:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12573:                 }
                   12574:                 if ($is_dir) {
                   12575:                     $$depth ++;
1.1056    raeburn  12576:                     push(@{$hierarchy},$$count);
                   12577:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12578:                     $result .=
                   12579:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12580:                                                    $docuname,$depth,$count,
1.1056    raeburn  12581:                                                    $hierarchy,$dirorder,$children,
                   12582:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12583:                     $$depth --;
1.1056    raeburn  12584:                     pop(@{$hierarchy});
1.1055    raeburn  12585:                 }
                   12586:             }
                   12587:         }
                   12588:     }
                   12589:     return $result;
                   12590: }
                   12591: 
                   12592: sub archive_hierarchy {
                   12593:     my ($depth,$count,$parent,$children) =@_;
                   12594:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12595:         if (exists($parent->{$depth})) {
                   12596:              $children->{$parent->{$depth}} .= $count.':';
                   12597:         }
                   12598:     }
                   12599:     return;
                   12600: }
                   12601: 
                   12602: sub archive_row {
                   12603:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12604:     my ($name) = ($item =~ m{([^/]+)$});
                   12605:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12606:                                        'display'    => 'Add as file',
1.1055    raeburn  12607:                                        'dependency' => 'Include as dependency',
                   12608:                                        'discard'    => 'Discard',
                   12609:                                       );
                   12610:     if ($is_dir) {
1.1059    raeburn  12611:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12612:     }
1.1056    raeburn  12613:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12614:     my $offset = 0;
1.1055    raeburn  12615:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12616:         $offset ++;
1.1065    raeburn  12617:         if ($action ne 'display') {
                   12618:             $offset ++;
                   12619:         }  
1.1055    raeburn  12620:         $output .= '<td><span class="LC_nobreak">'.
                   12621:                    '<label><input type="radio" name="archive_'.$count.
                   12622:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12623:         my $text = $choices{$action};
                   12624:         if ($is_dir) {
                   12625:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12626:             if ($action eq 'display') {
1.1059    raeburn  12627:                 $text = &mt('Add as folder');
1.1055    raeburn  12628:             }
1.1056    raeburn  12629:         } else {
                   12630:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12631: 
                   12632:         }
                   12633:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12634:         if ($action eq 'dependency') {
                   12635:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12636:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12637:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12638:                        '<option value=""></option>'."\n".
                   12639:                        '</select>'."\n".
                   12640:                        '</div>';
1.1059    raeburn  12641:         } elsif ($action eq 'display') {
                   12642:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12643:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12644:                        '</div>';
1.1055    raeburn  12645:         }
1.1056    raeburn  12646:         $output .= '</td>';
1.1055    raeburn  12647:     }
                   12648:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12649:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12650:     for (my $i=0; $i<$depth; $i++) {
                   12651:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12652:     }
                   12653:     if ($is_dir) {
                   12654:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12655:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12656:     } else {
                   12657:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12658:     }
                   12659:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12660:                &end_data_table_row();
                   12661:     return $output;
                   12662: }
                   12663: 
                   12664: sub archive_options_form {
1.1065    raeburn  12665:     my ($form,$display,$count,$hiddenelem) = @_;
                   12666:     my %lt = &Apache::lonlocal::texthash(
                   12667:                perm => 'Permanently remove archive file?',
                   12668:                hows => 'How should each extracted item be incorporated in the course?',
                   12669:                cont => 'Content actions for all',
                   12670:                addf => 'Add as folder/file',
                   12671:                incd => 'Include as dependency for a displayed file',
                   12672:                disc => 'Discard',
                   12673:                no   => 'No',
                   12674:                yes  => 'Yes',
                   12675:                save => 'Save',
                   12676:     );
                   12677:     my $output = <<"END";
                   12678: <form name="$form" method="post" action="">
                   12679: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12680: <label>
                   12681:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12682: </label>
                   12683: &nbsp;
                   12684: <label>
                   12685:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12686: </span>
                   12687: </p>
                   12688: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12689: <br />$lt{'hows'}
                   12690: <div class="LC_columnSection">
                   12691:   <fieldset>
                   12692:     <legend>$lt{'cont'}</legend>
                   12693:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12694:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12695:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12696:   </fieldset>
                   12697: </div>
                   12698: END
                   12699:     return $output.
1.1055    raeburn  12700:            &start_data_table()."\n".
1.1065    raeburn  12701:            $display."\n".
1.1055    raeburn  12702:            &end_data_table()."\n".
                   12703:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12704:            $hiddenelem.
1.1065    raeburn  12705:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12706:            '</form>';
                   12707: }
                   12708: 
                   12709: sub archive_javascript {
1.1056    raeburn  12710:     my ($startcount,$numitems,$titles,$children) = @_;
                   12711:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12712:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12713:     my $scripttag = <<START;
                   12714: <script type="text/javascript">
                   12715: // <![CDATA[
                   12716: 
                   12717: function checkAll(form,prefix) {
                   12718:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12719:     for (var i=0; i < form.elements.length; i++) {
                   12720:         var id = form.elements[i].id;
                   12721:         if ((id != '') && (id != undefined)) {
                   12722:             if (idstr.test(id)) {
                   12723:                 if (form.elements[i].type == 'radio') {
                   12724:                     form.elements[i].checked = true;
1.1056    raeburn  12725:                     var nostart = i-$startcount;
1.1059    raeburn  12726:                     var offset = nostart%7;
                   12727:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12728:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12729:                 }
                   12730:             }
                   12731:         }
                   12732:     }
                   12733: }
                   12734: 
                   12735: function propagateCheck(form,count) {
                   12736:     if (count > 0) {
1.1059    raeburn  12737:         var startelement = $startcount + ((count-1) * 7);
                   12738:         for (var j=1; j<6; j++) {
                   12739:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12740:                 var item = startelement + j; 
                   12741:                 if (form.elements[item].type == 'radio') {
                   12742:                     if (form.elements[item].checked) {
                   12743:                         containerCheck(form,count,j);
                   12744:                         break;
                   12745:                     }
1.1055    raeburn  12746:                 }
                   12747:             }
                   12748:         }
                   12749:     }
                   12750: }
                   12751: 
                   12752: numitems = $numitems
1.1056    raeburn  12753: var titles = new Array(numitems);
                   12754: var parents = new Array(numitems);
1.1055    raeburn  12755: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12756:     parents[i] = new Array;
1.1055    raeburn  12757: }
1.1059    raeburn  12758: var maintitle = '$maintitle';
1.1055    raeburn  12759: 
                   12760: START
                   12761: 
1.1056    raeburn  12762:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12763:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12764:         for (my $i=0; $i<@contents; $i ++) {
                   12765:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12766:         }
                   12767:     }
                   12768: 
1.1056    raeburn  12769:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12770:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12771:     }
                   12772: 
1.1055    raeburn  12773:     $scripttag .= <<END;
                   12774: 
                   12775: function containerCheck(form,count,offset) {
                   12776:     if (count > 0) {
1.1056    raeburn  12777:         dependencyCheck(form,count,offset);
1.1059    raeburn  12778:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12779:         form.elements[item].checked = true;
                   12780:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12781:             if (parents[count].length > 0) {
                   12782:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12783:                     containerCheck(form,parents[count][j],offset);
                   12784:                 }
                   12785:             }
                   12786:         }
                   12787:     }
                   12788: }
                   12789: 
                   12790: function dependencyCheck(form,count,offset) {
                   12791:     if (count > 0) {
1.1059    raeburn  12792:         var chosen = (offset+$startcount)+7*(count-1);
                   12793:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12794:         var currtype = form.elements[depitem].type;
                   12795:         if (form.elements[chosen].value == 'dependency') {
                   12796:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12797:             form.elements[depitem].options.length = 0;
                   12798:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12799:             for (var i=1; i<=numitems; i++) {
                   12800:                 if (i == count) {
                   12801:                     continue;
                   12802:                 }
1.1059    raeburn  12803:                 var startelement = $startcount + (i-1) * 7;
                   12804:                 for (var j=1; j<6; j++) {
                   12805:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12806:                         var item = startelement + j;
                   12807:                         if (form.elements[item].type == 'radio') {
                   12808:                             if (form.elements[item].checked) {
                   12809:                                 if (form.elements[item].value == 'display') {
                   12810:                                     var n = form.elements[depitem].options.length;
                   12811:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12812:                                 }
                   12813:                             }
                   12814:                         }
                   12815:                     }
                   12816:                 }
                   12817:             }
                   12818:         } else {
                   12819:             document.getElementById('arc_depon_'+count).style.display='none';
                   12820:             form.elements[depitem].options.length = 0;
                   12821:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12822:         }
1.1059    raeburn  12823:         titleCheck(form,count,offset);
1.1056    raeburn  12824:     }
                   12825: }
                   12826: 
                   12827: function propagateSelect(form,count,offset) {
                   12828:     if (count > 0) {
1.1065    raeburn  12829:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12830:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12831:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12832:             if (parents[count].length > 0) {
                   12833:                 for (var j=0; j<parents[count].length; j++) {
                   12834:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12835:                 }
                   12836:             }
                   12837:         }
                   12838:     }
                   12839: }
1.1056    raeburn  12840: 
                   12841: function containerSelect(form,count,offset,picked) {
                   12842:     if (count > 0) {
1.1065    raeburn  12843:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12844:         if (form.elements[item].type == 'radio') {
                   12845:             if (form.elements[item].value == 'dependency') {
                   12846:                 if (form.elements[item+1].type == 'select-one') {
                   12847:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12848:                         if (form.elements[item+1].options[i].value == picked) {
                   12849:                             form.elements[item+1].selectedIndex = i;
                   12850:                             break;
                   12851:                         }
                   12852:                     }
                   12853:                 }
                   12854:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12855:                     if (parents[count].length > 0) {
                   12856:                         for (var j=0; j<parents[count].length; j++) {
                   12857:                             containerSelect(form,parents[count][j],offset,picked);
                   12858:                         }
                   12859:                     }
                   12860:                 }
                   12861:             }
                   12862:         }
                   12863:     }
                   12864: }
                   12865: 
1.1059    raeburn  12866: function titleCheck(form,count,offset) {
                   12867:     if (count > 0) {
                   12868:         var chosen = (offset+$startcount)+7*(count-1);
                   12869:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12870:         var currtype = form.elements[depitem].type;
                   12871:         if (form.elements[chosen].value == 'display') {
                   12872:             document.getElementById('arc_title_'+count).style.display='block';
                   12873:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12874:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12875:             }
                   12876:         } else {
                   12877:             document.getElementById('arc_title_'+count).style.display='none';
                   12878:             if (currtype == 'text') { 
                   12879:                 document.getElementById('archive_title_'+count).value='';
                   12880:             }
                   12881:         }
                   12882:     }
                   12883:     return;
                   12884: }
                   12885: 
1.1055    raeburn  12886: // ]]>
                   12887: </script>
                   12888: END
                   12889:     return $scripttag;
                   12890: }
                   12891: 
                   12892: sub process_extracted_files {
1.1067    raeburn  12893:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12894:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12895:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12896:     my @ids=&Apache::lonnet::current_machine_ids();
                   12897:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12898:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12899:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12900:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12901:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12902:         $pathtocheck = "$dir_root/$destination";
                   12903:         $dir = $dir_root;
                   12904:         $ishome = 1;
                   12905:     } else {
                   12906:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12907:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12908:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12909:     }
                   12910:     my $currdir = "$dir_root/$destination";
                   12911:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12912:     if ($env{'form.folderpath'}) {
                   12913:         my @items = split('&',$env{'form.folderpath'});
                   12914:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12915:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12916:             $containers{'0'}='page';
                   12917:         } else {
                   12918:             $containers{'0'}='sequence';
                   12919:         }
1.1055    raeburn  12920:     }
                   12921:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12922:     if ($numitems) {
                   12923:         for (my $i=1; $i<=$numitems; $i++) {
                   12924:             my $path = $env{'form.archive_content_'.$i};
                   12925:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12926:                 my $item = $1;
                   12927:                 $toplevelitems{$item} = $i;
                   12928:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12929:                     $is_dir{$item} = 1;
                   12930:                 }
                   12931:             }
                   12932:         }
                   12933:     }
1.1067    raeburn  12934:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12935:     if (keys(%toplevelitems) > 0) {
                   12936:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12937:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12938:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12939:     }
1.1066    raeburn  12940:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12941:     if ($numitems) {
                   12942:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12943:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12944:             my $path = $env{'form.archive_content_'.$i};
                   12945:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12946:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12947:                     if ($prefix ne '' && $path ne '') {
                   12948:                         if (-e $prefix.$path) {
1.1066    raeburn  12949:                             if ((@archdirs > 0) && 
                   12950:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12951:                                 $todeletedir{$prefix.$path} = 1;
                   12952:                             } else {
                   12953:                                 $todelete{$prefix.$path} = 1;
                   12954:                             }
1.1055    raeburn  12955:                         }
                   12956:                     }
                   12957:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12958:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12959:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12960:                     $docstitle = $env{'form.archive_title_'.$i};
                   12961:                     if ($docstitle eq '') {
                   12962:                         $docstitle = $title;
                   12963:                     }
1.1055    raeburn  12964:                     $outer = 0;
1.1056    raeburn  12965:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12966:                         if (@{$dirorder{$i}} > 0) {
                   12967:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12968:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12969:                                     $outer = $item;
                   12970:                                     last;
                   12971:                                 }
                   12972:                             }
                   12973:                         }
                   12974:                     }
                   12975:                     my ($errtext,$fatal) = 
                   12976:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12977:                                                '/'.$folders{$outer}.'.'.
                   12978:                                                $containers{$outer});
                   12979:                     next if ($fatal);
                   12980:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12981:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12982:                             $mapinner{$i} = time;
1.1055    raeburn  12983:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12984:                             $containers{$i} = 'sequence';
                   12985:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12986:                                       $folders{$i}.'.'.$containers{$i};
                   12987:                             my $newidx = &LONCAPA::map::getresidx();
                   12988:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12989:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12990:                             push(@LONCAPA::map::order,$newidx);
                   12991:                             my ($outtext,$errtext) =
                   12992:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12993:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12994:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12995:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12996:                             unless ($errtext) {
1.1075.2.128  raeburn  12997:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12998:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12999:                                             '</li>'."\n";
1.1067    raeburn  13000:                             }
1.1055    raeburn  13001:                         }
                   13002:                     } else {
                   13003:                         if ($context eq 'coursedocs') {
                   13004:                             my $newidx=&LONCAPA::map::getresidx();
                   13005:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13006:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13007:                                       $title;
1.1075.2.128  raeburn  13008:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   13009:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13010:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13011:                                 }
1.1075.2.128  raeburn  13012:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13013:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13014:                                 }
                   13015:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13016:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13017:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13018:                                         unless ($ishome) {
                   13019:                                             my $fetch = "$newdest{$i}/$title";
                   13020:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13021:                                             $prompttofetch{$fetch} = 1;
                   13022:                                         }
                   13023:                                    }
                   13024:                                 }
                   13025:                                 $LONCAPA::map::resources[$newidx]=
                   13026:                                     $docstitle.':'.$url.':false:normal:res';
                   13027:                                 push(@LONCAPA::map::order, $newidx);
                   13028:                                 my ($outtext,$errtext)=
                   13029:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13030:                                                             $docuname.'/'.$folders{$outer}.
                   13031:                                                             '.'.$containers{$outer},1,1);
                   13032:                                 unless ($errtext) {
                   13033:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13034:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13035:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13036:                                                    '</li>'."\n";
                   13037:                                     }
1.1067    raeburn  13038:                                 }
1.1075.2.128  raeburn  13039:                             } else {
                   13040:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13041:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13042:                             }
1.1055    raeburn  13043:                         }
                   13044:                     }
1.1075.2.11  raeburn  13045:                 }
                   13046:             } else {
1.1075.2.128  raeburn  13047:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13048:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13049:             }
                   13050:         }
                   13051:         for (my $i=1; $i<=$numitems; $i++) {
                   13052:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13053:             my $path = $env{'form.archive_content_'.$i};
                   13054:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13055:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13056:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13057:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13058:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13059:                         my ($itemidx,$fullpath,$relpath);
                   13060:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13061:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13062:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13063:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13064:                                     $itemidx = $j;
1.1056    raeburn  13065:                                 }
                   13066:                             }
1.1075.2.11  raeburn  13067:                         }
                   13068:                         if ($itemidx eq '') {
                   13069:                             $itemidx =  0;
                   13070:                         }
                   13071:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13072:                             if ($mapinner{$referrer{$i}}) {
                   13073:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13074:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13075:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13076:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13077:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13078:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13079:                                             if (!-e $fullpath) {
                   13080:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13081:                                             }
                   13082:                                         }
1.1075.2.11  raeburn  13083:                                     } else {
                   13084:                                         last;
1.1056    raeburn  13085:                                     }
1.1075.2.11  raeburn  13086:                                 }
                   13087:                             }
                   13088:                         } elsif ($newdest{$referrer{$i}}) {
                   13089:                             $fullpath = $newdest{$referrer{$i}};
                   13090:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13091:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13092:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13093:                                     last;
                   13094:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13095:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13096:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13097:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13098:                                         if (!-e $fullpath) {
                   13099:                                             mkdir($fullpath,0755);
1.1056    raeburn  13100:                                         }
                   13101:                                     }
1.1075.2.11  raeburn  13102:                                 } else {
                   13103:                                     last;
1.1056    raeburn  13104:                                 }
1.1075.2.11  raeburn  13105:                             }
                   13106:                         }
                   13107:                         if ($fullpath ne '') {
                   13108:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13109:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13110:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13111:                                 }
1.1075.2.11  raeburn  13112:                             }
                   13113:                             if (-e "$fullpath/$title") {
                   13114:                                 my $showpath;
                   13115:                                 if ($relpath ne '') {
                   13116:                                     $showpath = "$relpath/$title";
                   13117:                                 } else {
                   13118:                                     $showpath = "/$title";
1.1056    raeburn  13119:                                 }
1.1075.2.128  raeburn  13120:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13121:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13122:                                            '</li>'."\n";
                   13123:                                 unless ($ishome) {
                   13124:                                     my $fetch = "$fullpath/$title";
                   13125:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13126:                                     $prompttofetch{$fetch} = 1;
                   13127:                                 }
1.1055    raeburn  13128:                             }
                   13129:                         }
                   13130:                     }
1.1075.2.11  raeburn  13131:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13132:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13133:                                     &HTML::Entities::encode($path,'<>&"'),
                   13134:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13135:                                 '<br />';
1.1055    raeburn  13136:                 }
                   13137:             } else {
1.1075.2.128  raeburn  13138:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13139:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13140:             }
                   13141:         }
                   13142:         if (keys(%todelete)) {
                   13143:             foreach my $key (keys(%todelete)) {
                   13144:                 unlink($key);
1.1066    raeburn  13145:             }
                   13146:         }
                   13147:         if (keys(%todeletedir)) {
                   13148:             foreach my $key (keys(%todeletedir)) {
                   13149:                 rmdir($key);
                   13150:             }
                   13151:         }
                   13152:         foreach my $dir (sort(keys(%is_dir))) {
                   13153:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13154:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13155:             }
                   13156:         }
1.1067    raeburn  13157:         if ($result ne '') {
                   13158:             $output .= '<ul>'."\n".
                   13159:                        $result."\n".
                   13160:                        '</ul>';
                   13161:         }
                   13162:         unless ($ishome) {
                   13163:             my $replicationfail;
                   13164:             foreach my $item (keys(%prompttofetch)) {
                   13165:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13166:                 unless ($fetchresult eq 'ok') {
                   13167:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13168:                 }
                   13169:             }
                   13170:             if ($replicationfail) {
                   13171:                 $output .= '<p class="LC_error">'.
                   13172:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13173:                            $replicationfail.
                   13174:                            '</ul></p>';
                   13175:             }
                   13176:         }
1.1055    raeburn  13177:     } else {
                   13178:         $warning = &mt('No items found in archive.');
                   13179:     }
                   13180:     if ($error) {
                   13181:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13182:                    $error.'</p>'."\n";
                   13183:     }
                   13184:     if ($warning) {
                   13185:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13186:     }
                   13187:     return $output;
                   13188: }
                   13189: 
1.1066    raeburn  13190: sub cleanup_empty_dirs {
                   13191:     my ($path) = @_;
                   13192:     if (($path ne '') && (-d $path)) {
                   13193:         if (opendir(my $dirh,$path)) {
                   13194:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13195:             my $numitems = 0;
                   13196:             foreach my $item (@dircontents) {
                   13197:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13198:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13199:                     if (-e "$path/$item") {
                   13200:                         $numitems ++;
                   13201:                     }
                   13202:                 } else {
                   13203:                     $numitems ++;
                   13204:                 }
                   13205:             }
                   13206:             if ($numitems == 0) {
                   13207:                 rmdir($path);
                   13208:             }
                   13209:             closedir($dirh);
                   13210:         }
                   13211:     }
                   13212:     return;
                   13213: }
                   13214: 
1.41      ng       13215: =pod
1.45      matthew  13216: 
1.1075.2.56  raeburn  13217: =item * &get_folder_hierarchy()
1.1068    raeburn  13218: 
                   13219: Provides hierarchy of names of folders/sub-folders containing the current
                   13220: item,
                   13221: 
                   13222: Inputs: 3
                   13223:      - $navmap - navmaps object
                   13224: 
                   13225:      - $map - url for map (either the trigger itself, or map containing
                   13226:                            the resource, which is the trigger).
                   13227: 
                   13228:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13229: 
                   13230: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13231: 
                   13232: =cut
                   13233: 
                   13234: sub get_folder_hierarchy {
                   13235:     my ($navmap,$map,$showitem) = @_;
                   13236:     my @pathitems;
                   13237:     if (ref($navmap)) {
                   13238:         my $mapres = $navmap->getResourceByUrl($map);
                   13239:         if (ref($mapres)) {
                   13240:             my $pcslist = $mapres->map_hierarchy();
                   13241:             if ($pcslist ne '') {
                   13242:                 my @pcs = split(/,/,$pcslist);
                   13243:                 foreach my $pc (@pcs) {
                   13244:                     if ($pc == 1) {
1.1075.2.38  raeburn  13245:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13246:                     } else {
                   13247:                         my $res = $navmap->getByMapPc($pc);
                   13248:                         if (ref($res)) {
                   13249:                             my $title = $res->compTitle();
                   13250:                             $title =~ s/\W+/_/g;
                   13251:                             if ($title ne '') {
                   13252:                                 push(@pathitems,$title);
                   13253:                             }
                   13254:                         }
                   13255:                     }
                   13256:                 }
                   13257:             }
1.1071    raeburn  13258:             if ($showitem) {
                   13259:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13260:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13261:                 } else {
                   13262:                     my $maptitle = $mapres->compTitle();
                   13263:                     $maptitle =~ s/\W+/_/g;
                   13264:                     if ($maptitle ne '') {
                   13265:                         push(@pathitems,$maptitle);
                   13266:                     }
1.1068    raeburn  13267:                 }
                   13268:             }
                   13269:         }
                   13270:     }
                   13271:     return @pathitems;
                   13272: }
                   13273: 
                   13274: =pod
                   13275: 
1.1015    raeburn  13276: =item * &get_turnedin_filepath()
                   13277: 
                   13278: Determines path in a user's portfolio file for storage of files uploaded
                   13279: to a specific essayresponse or dropbox item.
                   13280: 
                   13281: Inputs: 3 required + 1 optional.
                   13282: $symb is symb for resource, $uname and $udom are for current user (required).
                   13283: $caller is optional (can be "submission", if routine is called when storing
                   13284: an upoaded file when "Submit Answer" button was pressed).
                   13285: 
                   13286: Returns array containing $path and $multiresp. 
                   13287: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13288: than one file upload item.  Callers of routine should append partid as a 
                   13289: subdirectory to $path in cases where $multiresp is 1.
                   13290: 
                   13291: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13292: 
                   13293: =cut
                   13294: 
                   13295: sub get_turnedin_filepath {
                   13296:     my ($symb,$uname,$udom,$caller) = @_;
                   13297:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13298:     my $turnindir;
                   13299:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13300:     $turnindir = $userhash{'turnindir'};
                   13301:     my ($path,$multiresp);
                   13302:     if ($turnindir eq '') {
                   13303:         if ($caller eq 'submission') {
                   13304:             $turnindir = &mt('turned in');
                   13305:             $turnindir =~ s/\W+/_/g;
                   13306:             my %newhash = (
                   13307:                             'turnindir' => $turnindir,
                   13308:                           );
                   13309:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13310:         }
                   13311:     }
                   13312:     if ($turnindir ne '') {
                   13313:         $path = '/'.$turnindir.'/';
                   13314:         my ($multipart,$turnin,@pathitems);
                   13315:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13316:         if (defined($navmap)) {
                   13317:             my $mapres = $navmap->getResourceByUrl($map);
                   13318:             if (ref($mapres)) {
                   13319:                 my $pcslist = $mapres->map_hierarchy();
                   13320:                 if ($pcslist ne '') {
                   13321:                     foreach my $pc (split(/,/,$pcslist)) {
                   13322:                         my $res = $navmap->getByMapPc($pc);
                   13323:                         if (ref($res)) {
                   13324:                             my $title = $res->compTitle();
                   13325:                             $title =~ s/\W+/_/g;
                   13326:                             if ($title ne '') {
1.1075.2.48  raeburn  13327:                                 if (($pc > 1) && (length($title) > 12)) {
                   13328:                                     $title = substr($title,0,12);
                   13329:                                 }
1.1015    raeburn  13330:                                 push(@pathitems,$title);
                   13331:                             }
                   13332:                         }
                   13333:                     }
                   13334:                 }
                   13335:                 my $maptitle = $mapres->compTitle();
                   13336:                 $maptitle =~ s/\W+/_/g;
                   13337:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13338:                     if (length($maptitle) > 12) {
                   13339:                         $maptitle = substr($maptitle,0,12);
                   13340:                     }
1.1015    raeburn  13341:                     push(@pathitems,$maptitle);
                   13342:                 }
                   13343:                 unless ($env{'request.state'} eq 'construct') {
                   13344:                     my $res = $navmap->getBySymb($symb);
                   13345:                     if (ref($res)) {
                   13346:                         my $partlist = $res->parts();
                   13347:                         my $totaluploads = 0;
                   13348:                         if (ref($partlist) eq 'ARRAY') {
                   13349:                             foreach my $part (@{$partlist}) {
                   13350:                                 my @types = $res->responseType($part);
                   13351:                                 my @ids = $res->responseIds($part);
                   13352:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13353:                                     if ($types[$i] eq 'essay') {
                   13354:                                         my $partid = $part.'_'.$ids[$i];
                   13355:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13356:                                             $totaluploads ++;
                   13357:                                         }
                   13358:                                     }
                   13359:                                 }
                   13360:                             }
                   13361:                             if ($totaluploads > 1) {
                   13362:                                 $multiresp = 1;
                   13363:                             }
                   13364:                         }
                   13365:                     }
                   13366:                 }
                   13367:             } else {
                   13368:                 return;
                   13369:             }
                   13370:         } else {
                   13371:             return;
                   13372:         }
                   13373:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13374:         $restitle =~ s/\W+/_/g;
                   13375:         if ($restitle eq '') {
                   13376:             $restitle = ($resurl =~ m{/[^/]+$});
                   13377:             if ($restitle eq '') {
                   13378:                 $restitle = time;
                   13379:             }
                   13380:         }
1.1075.2.48  raeburn  13381:         if (length($restitle) > 12) {
                   13382:             $restitle = substr($restitle,0,12);
                   13383:         }
1.1015    raeburn  13384:         push(@pathitems,$restitle);
                   13385:         $path .= join('/',@pathitems);
                   13386:     }
                   13387:     return ($path,$multiresp);
                   13388: }
                   13389: 
                   13390: =pod
                   13391: 
1.464     albertel 13392: =back
1.41      ng       13393: 
1.112     bowersj2 13394: =head1 CSV Upload/Handling functions
1.38      albertel 13395: 
1.41      ng       13396: =over 4
                   13397: 
1.648     raeburn  13398: =item * &upfile_store($r)
1.41      ng       13399: 
                   13400: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13401: needs $env{'form.upfile'}
1.41      ng       13402: returns $datatoken to be put into hidden field
                   13403: 
                   13404: =cut
1.31      albertel 13405: 
                   13406: sub upfile_store {
                   13407:     my $r=shift;
1.258     albertel 13408:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13409:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13410:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13411:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13412: 
1.1075.2.128  raeburn  13413:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13414:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13415:                                      time.'_'.$$);
                   13416:     return if ($datatoken eq '');
                   13417: 
1.31      albertel 13418:     {
1.158     raeburn  13419:         my $datafile = $r->dir_config('lonDaemons').
                   13420:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13421:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13422:             print $fh $env{'form.upfile'};
1.158     raeburn  13423:             close($fh);
                   13424:         }
1.31      albertel 13425:     }
                   13426:     return $datatoken;
                   13427: }
                   13428: 
1.56      matthew  13429: =pod
                   13430: 
1.1075.2.128  raeburn  13431: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13432: 
                   13433: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13434: $datatoken is the name to assign to the temporary file.
1.258     albertel 13435: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13436: 
                   13437: =cut
1.31      albertel 13438: 
                   13439: sub load_tmp_file {
1.1075.2.128  raeburn  13440:     my ($r,$datatoken) = @_;
                   13441:     return if ($datatoken eq '');
1.31      albertel 13442:     my @studentdata=();
                   13443:     {
1.158     raeburn  13444:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13445:                               '/tmp/'.$datatoken.'.tmp';
                   13446:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13447:             @studentdata=<$fh>;
                   13448:             close($fh);
                   13449:         }
1.31      albertel 13450:     }
1.258     albertel 13451:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13452: }
                   13453: 
1.1075.2.128  raeburn  13454: sub valid_datatoken {
                   13455:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13456:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13457:         return $datatoken;
                   13458:     }
                   13459:     return;
                   13460: }
                   13461: 
1.56      matthew  13462: =pod
                   13463: 
1.648     raeburn  13464: =item * &upfile_record_sep()
1.41      ng       13465: 
                   13466: Separate uploaded file into records
                   13467: returns array of records,
1.258     albertel 13468: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13469: 
                   13470: =cut
1.31      albertel 13471: 
                   13472: sub upfile_record_sep {
1.258     albertel 13473:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13474:     } else {
1.248     albertel 13475: 	my @records;
1.258     albertel 13476: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13477: 	    if ($line=~/^\s*$/) { next; }
                   13478: 	    push(@records,$line);
                   13479: 	}
                   13480: 	return @records;
1.31      albertel 13481:     }
                   13482: }
                   13483: 
1.56      matthew  13484: =pod
                   13485: 
1.648     raeburn  13486: =item * &record_sep($record)
1.41      ng       13487: 
1.258     albertel 13488: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13489: 
                   13490: =cut
                   13491: 
1.263     www      13492: sub takeleft {
                   13493:     my $index=shift;
                   13494:     return substr('0000'.$index,-4,4);
                   13495: }
                   13496: 
1.31      albertel 13497: sub record_sep {
                   13498:     my $record=shift;
                   13499:     my %components=();
1.258     albertel 13500:     if ($env{'form.upfiletype'} eq 'xml') {
                   13501:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13502:         my $i=0;
1.356     albertel 13503:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13504:             $field=~s/^(\"|\')//;
                   13505:             $field=~s/(\"|\')$//;
1.263     www      13506:             $components{&takeleft($i)}=$field;
1.31      albertel 13507:             $i++;
                   13508:         }
1.258     albertel 13509:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13510:         my $i=0;
1.356     albertel 13511:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13512:             $field=~s/^(\"|\')//;
                   13513:             $field=~s/(\"|\')$//;
1.263     www      13514:             $components{&takeleft($i)}=$field;
1.31      albertel 13515:             $i++;
                   13516:         }
                   13517:     } else {
1.561     www      13518:         my $separator=',';
1.480     banghart 13519:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13520:             $separator=';';
1.480     banghart 13521:         }
1.31      albertel 13522:         my $i=0;
1.561     www      13523: # the character we are looking for to indicate the end of a quote or a record 
                   13524:         my $looking_for=$separator;
                   13525: # do not add the characters to the fields
                   13526:         my $ignore=0;
                   13527: # we just encountered a separator (or the beginning of the record)
                   13528:         my $just_found_separator=1;
                   13529: # store the field we are working on here
                   13530:         my $field='';
                   13531: # work our way through all characters in record
                   13532:         foreach my $character ($record=~/(.)/g) {
                   13533:             if ($character eq $looking_for) {
                   13534:                if ($character ne $separator) {
                   13535: # Found the end of a quote, again looking for separator
                   13536:                   $looking_for=$separator;
                   13537:                   $ignore=1;
                   13538:                } else {
                   13539: # Found a separator, store away what we got
                   13540:                   $components{&takeleft($i)}=$field;
                   13541: 	          $i++;
                   13542:                   $just_found_separator=1;
                   13543:                   $ignore=0;
                   13544:                   $field='';
                   13545:                }
                   13546:                next;
                   13547:             }
                   13548: # single or double quotation marks after a separator indicate beginning of a quote
                   13549: # we are now looking for the end of the quote and need to ignore separators
                   13550:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13551:                $looking_for=$character;
                   13552:                next;
                   13553:             }
                   13554: # ignore would be true after we reached the end of a quote
                   13555:             if ($ignore) { next; }
                   13556:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13557:             $field.=$character;
                   13558:             $just_found_separator=0; 
1.31      albertel 13559:         }
1.561     www      13560: # catch the very last entry, since we never encountered the separator
                   13561:         $components{&takeleft($i)}=$field;
1.31      albertel 13562:     }
                   13563:     return %components;
                   13564: }
                   13565: 
1.144     matthew  13566: ######################################################
                   13567: ######################################################
                   13568: 
1.56      matthew  13569: =pod
                   13570: 
1.648     raeburn  13571: =item * &upfile_select_html()
1.41      ng       13572: 
1.144     matthew  13573: Return HTML code to select a file from the users machine and specify 
                   13574: the file type.
1.41      ng       13575: 
                   13576: =cut
                   13577: 
1.144     matthew  13578: ######################################################
                   13579: ######################################################
1.31      albertel 13580: sub upfile_select_html {
1.144     matthew  13581:     my %Types = (
                   13582:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13583:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13584:                  space => &mt('Space separated'),
                   13585:                  tab   => &mt('Tabulator separated'),
                   13586: #                 xml   => &mt('HTML/XML'),
                   13587:                  );
                   13588:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13589:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13590:     foreach my $type (sort(keys(%Types))) {
                   13591:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13592:     }
                   13593:     $Str .= "</select>\n";
                   13594:     return $Str;
1.31      albertel 13595: }
                   13596: 
1.301     albertel 13597: sub get_samples {
                   13598:     my ($records,$toget) = @_;
                   13599:     my @samples=({});
                   13600:     my $got=0;
                   13601:     foreach my $rec (@$records) {
                   13602: 	my %temp = &record_sep($rec);
                   13603: 	if (! grep(/\S/, values(%temp))) { next; }
                   13604: 	if (%temp) {
                   13605: 	    $samples[$got]=\%temp;
                   13606: 	    $got++;
                   13607: 	    if ($got == $toget) { last; }
                   13608: 	}
                   13609:     }
                   13610:     return \@samples;
                   13611: }
                   13612: 
1.144     matthew  13613: ######################################################
                   13614: ######################################################
                   13615: 
1.56      matthew  13616: =pod
                   13617: 
1.648     raeburn  13618: =item * &csv_print_samples($r,$records)
1.41      ng       13619: 
                   13620: Prints a table of sample values from each column uploaded $r is an
                   13621: Apache Request ref, $records is an arrayref from
                   13622: &Apache::loncommon::upfile_record_sep
                   13623: 
                   13624: =cut
                   13625: 
1.144     matthew  13626: ######################################################
                   13627: ######################################################
1.31      albertel 13628: sub csv_print_samples {
                   13629:     my ($r,$records) = @_;
1.662     bisitz   13630:     my $samples = &get_samples($records,5);
1.301     albertel 13631: 
1.594     raeburn  13632:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13633:               &start_data_table_header_row());
1.356     albertel 13634:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13635:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13636:     $r->print(&end_data_table_header_row());
1.301     albertel 13637:     foreach my $hash (@$samples) {
1.594     raeburn  13638: 	$r->print(&start_data_table_row());
1.356     albertel 13639: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13640: 	    $r->print('<td>');
1.356     albertel 13641: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13642: 	    $r->print('</td>');
                   13643: 	}
1.594     raeburn  13644: 	$r->print(&end_data_table_row());
1.31      albertel 13645:     }
1.594     raeburn  13646:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13647: }
                   13648: 
1.144     matthew  13649: ######################################################
                   13650: ######################################################
                   13651: 
1.56      matthew  13652: =pod
                   13653: 
1.648     raeburn  13654: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13655: 
                   13656: Prints a table to create associations between values and table columns.
1.144     matthew  13657: 
1.41      ng       13658: $r is an Apache Request ref,
                   13659: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13660: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13661: 
                   13662: =cut
                   13663: 
1.144     matthew  13664: ######################################################
                   13665: ######################################################
1.31      albertel 13666: sub csv_print_select_table {
                   13667:     my ($r,$records,$d) = @_;
1.301     albertel 13668:     my $i=0;
                   13669:     my $samples = &get_samples($records,1);
1.144     matthew  13670:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13671: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13672:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13673:               '<th>'.&mt('Column').'</th>'.
                   13674:               &end_data_table_header_row()."\n");
1.356     albertel 13675:     foreach my $array_ref (@$d) {
                   13676: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13677: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13678: 
1.875     bisitz   13679: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13680: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13681: 	$r->print('<option value="none"></option>');
1.356     albertel 13682: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13683: 	    $r->print('<option value="'.$sample.'"'.
                   13684:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13685:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13686: 	}
1.594     raeburn  13687: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13688: 	$i++;
                   13689:     }
1.594     raeburn  13690:     $r->print(&end_data_table());
1.31      albertel 13691:     $i--;
                   13692:     return $i;
                   13693: }
1.56      matthew  13694: 
1.144     matthew  13695: ######################################################
                   13696: ######################################################
                   13697: 
1.56      matthew  13698: =pod
1.31      albertel 13699: 
1.648     raeburn  13700: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13701: 
                   13702: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13703: 
                   13704: $r is an Apache Request ref,
                   13705: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13706: $d is an array of 2 element arrays (internal name, displayed name)
                   13707: 
                   13708: =cut
                   13709: 
1.144     matthew  13710: ######################################################
                   13711: ######################################################
1.31      albertel 13712: sub csv_samples_select_table {
                   13713:     my ($r,$records,$d) = @_;
                   13714:     my $i=0;
1.144     matthew  13715:     #
1.662     bisitz   13716:     my $max_samples = 5;
                   13717:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13718:     $r->print(&start_data_table().
                   13719:               &start_data_table_header_row().'<th>'.
                   13720:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13721:               &end_data_table_header_row());
1.301     albertel 13722: 
                   13723:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13724: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13725: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13726: 	foreach my $option (@$d) {
                   13727: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13728: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13729:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13730:                       $display.'</option>');
1.31      albertel 13731: 	}
                   13732: 	$r->print('</select></td><td>');
1.662     bisitz   13733: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13734: 	    if (defined($samples->[$line]{$key})) { 
                   13735: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13736: 	    }
                   13737: 	}
1.594     raeburn  13738: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13739: 	$i++;
                   13740:     }
1.594     raeburn  13741:     $r->print(&end_data_table());
1.31      albertel 13742:     $i--;
                   13743:     return($i);
1.115     matthew  13744: }
                   13745: 
1.144     matthew  13746: ######################################################
                   13747: ######################################################
                   13748: 
1.115     matthew  13749: =pod
                   13750: 
1.648     raeburn  13751: =item * &clean_excel_name($name)
1.115     matthew  13752: 
                   13753: Returns a replacement for $name which does not contain any illegal characters.
                   13754: 
                   13755: =cut
                   13756: 
1.144     matthew  13757: ######################################################
                   13758: ######################################################
1.115     matthew  13759: sub clean_excel_name {
                   13760:     my ($name) = @_;
                   13761:     $name =~ s/[:\*\?\/\\]//g;
                   13762:     if (length($name) > 31) {
                   13763:         $name = substr($name,0,31);
                   13764:     }
                   13765:     return $name;
1.25      albertel 13766: }
1.84      albertel 13767: 
1.85      albertel 13768: =pod
                   13769: 
1.648     raeburn  13770: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13771: 
                   13772: Returns either 1 or undef
                   13773: 
                   13774: 1 if the part is to be hidden, undef if it is to be shown
                   13775: 
                   13776: Arguments are:
                   13777: 
                   13778: $id the id of the part to be checked
                   13779: $symb, optional the symb of the resource to check
                   13780: $udom, optional the domain of the user to check for
                   13781: $uname, optional the username of the user to check for
                   13782: 
                   13783: =cut
1.84      albertel 13784: 
                   13785: sub check_if_partid_hidden {
                   13786:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13787:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13788: 					 $symb,$udom,$uname);
1.141     albertel 13789:     my $truth=1;
                   13790:     #if the string starts with !, then the list is the list to show not hide
                   13791:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13792:     my @hiddenlist=split(/,/,$hiddenparts);
                   13793:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13794: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13795:     }
1.141     albertel 13796:     return !$truth;
1.84      albertel 13797: }
1.127     matthew  13798: 
1.138     matthew  13799: 
                   13800: ############################################################
                   13801: ############################################################
                   13802: 
                   13803: =pod
                   13804: 
1.157     matthew  13805: =back 
                   13806: 
1.138     matthew  13807: =head1 cgi-bin script and graphing routines
                   13808: 
1.157     matthew  13809: =over 4
                   13810: 
1.648     raeburn  13811: =item * &get_cgi_id()
1.138     matthew  13812: 
                   13813: Inputs: none
                   13814: 
                   13815: Returns an id which can be used to pass environment variables
                   13816: to various cgi-bin scripts.  These environment variables will
                   13817: be removed from the users environment after a given time by
                   13818: the routine &Apache::lonnet::transfer_profile_to_env.
                   13819: 
                   13820: =cut
                   13821: 
                   13822: ############################################################
                   13823: ############################################################
1.152     albertel 13824: my $uniq=0;
1.136     matthew  13825: sub get_cgi_id {
1.154     albertel 13826:     $uniq=($uniq+1)%100000;
1.280     albertel 13827:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13828: }
                   13829: 
1.127     matthew  13830: ############################################################
                   13831: ############################################################
                   13832: 
                   13833: =pod
                   13834: 
1.648     raeburn  13835: =item * &DrawBarGraph()
1.127     matthew  13836: 
1.138     matthew  13837: Facilitates the plotting of data in a (stacked) bar graph.
                   13838: Puts plot definition data into the users environment in order for 
                   13839: graph.png to plot it.  Returns an <img> tag for the plot.
                   13840: The bars on the plot are labeled '1','2',...,'n'.
                   13841: 
                   13842: Inputs:
                   13843: 
                   13844: =over 4
                   13845: 
                   13846: =item $Title: string, the title of the plot
                   13847: 
                   13848: =item $xlabel: string, text describing the X-axis of the plot
                   13849: 
                   13850: =item $ylabel: string, text describing the Y-axis of the plot
                   13851: 
                   13852: =item $Max: scalar, the maximum Y value to use in the plot
                   13853: If $Max is < any data point, the graph will not be rendered.
                   13854: 
1.140     matthew  13855: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13856: they are plotted.  If undefined, default values will be used.
                   13857: 
1.178     matthew  13858: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13859: 
1.138     matthew  13860: =item @Values: An array of array references.  Each array reference holds data
                   13861: to be plotted in a stacked bar chart.
                   13862: 
1.239     matthew  13863: =item If the final element of @Values is a hash reference the key/value
                   13864: pairs will be added to the graph definition.
                   13865: 
1.138     matthew  13866: =back
                   13867: 
                   13868: Returns:
                   13869: 
                   13870: An <img> tag which references graph.png and the appropriate identifying
                   13871: information for the plot.
                   13872: 
1.127     matthew  13873: =cut
                   13874: 
                   13875: ############################################################
                   13876: ############################################################
1.134     matthew  13877: sub DrawBarGraph {
1.178     matthew  13878:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13879:     #
                   13880:     if (! defined($colors)) {
                   13881:         $colors = ['#33ff00', 
                   13882:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13883:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13884:                   ]; 
                   13885:     }
1.228     matthew  13886:     my $extra_settings = {};
                   13887:     if (ref($Values[-1]) eq 'HASH') {
                   13888:         $extra_settings = pop(@Values);
                   13889:     }
1.127     matthew  13890:     #
1.136     matthew  13891:     my $identifier = &get_cgi_id();
                   13892:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13893:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13894:         return '';
                   13895:     }
1.225     matthew  13896:     #
                   13897:     my @Labels;
                   13898:     if (defined($labels)) {
                   13899:         @Labels = @$labels;
                   13900:     } else {
                   13901:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13902:             push(@Labels,$i+1);
1.225     matthew  13903:         }
                   13904:     }
                   13905:     #
1.129     matthew  13906:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13907:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13908:     my %ValuesHash;
                   13909:     my $NumSets=1;
                   13910:     foreach my $array (@Values) {
                   13911:         next if (! ref($array));
1.136     matthew  13912:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13913:             join(',',@$array);
1.129     matthew  13914:     }
1.127     matthew  13915:     #
1.136     matthew  13916:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13917:     if ($NumBars < 3) {
                   13918:         $width = 120+$NumBars*32;
1.220     matthew  13919:         $xskip = 1;
1.225     matthew  13920:         $bar_width = 30;
                   13921:     } elsif ($NumBars < 5) {
                   13922:         $width = 120+$NumBars*20;
                   13923:         $xskip = 1;
                   13924:         $bar_width = 20;
1.220     matthew  13925:     } elsif ($NumBars < 10) {
1.136     matthew  13926:         $width = 120+$NumBars*15;
                   13927:         $xskip = 1;
                   13928:         $bar_width = 15;
                   13929:     } elsif ($NumBars <= 25) {
                   13930:         $width = 120+$NumBars*11;
                   13931:         $xskip = 5;
                   13932:         $bar_width = 8;
                   13933:     } elsif ($NumBars <= 50) {
                   13934:         $width = 120+$NumBars*8;
                   13935:         $xskip = 5;
                   13936:         $bar_width = 4;
                   13937:     } else {
                   13938:         $width = 120+$NumBars*8;
                   13939:         $xskip = 5;
                   13940:         $bar_width = 4;
                   13941:     }
                   13942:     #
1.137     matthew  13943:     $Max = 1 if ($Max < 1);
                   13944:     if ( int($Max) < $Max ) {
                   13945:         $Max++;
                   13946:         $Max = int($Max);
                   13947:     }
1.127     matthew  13948:     $Title  = '' if (! defined($Title));
                   13949:     $xlabel = '' if (! defined($xlabel));
                   13950:     $ylabel = '' if (! defined($ylabel));
1.369     www      13951:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13952:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13953:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13954:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13955:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13956:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13957:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13958:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13959:     $ValuesHash{$id.'.height'}   = $height;
                   13960:     $ValuesHash{$id.'.width'}    = $width;
                   13961:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13962:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13963:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13964:     #
1.228     matthew  13965:     # Deal with other parameters
                   13966:     while (my ($key,$value) = each(%$extra_settings)) {
                   13967:         $ValuesHash{$id.'.'.$key} = $value;
                   13968:     }
                   13969:     #
1.646     raeburn  13970:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13971:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13972: }
                   13973: 
                   13974: ############################################################
                   13975: ############################################################
                   13976: 
                   13977: =pod
                   13978: 
1.648     raeburn  13979: =item * &DrawXYGraph()
1.137     matthew  13980: 
1.138     matthew  13981: Facilitates the plotting of data in an XY graph.
                   13982: Puts plot definition data into the users environment in order for 
                   13983: graph.png to plot it.  Returns an <img> tag for the plot.
                   13984: 
                   13985: Inputs:
                   13986: 
                   13987: =over 4
                   13988: 
                   13989: =item $Title: string, the title of the plot
                   13990: 
                   13991: =item $xlabel: string, text describing the X-axis of the plot
                   13992: 
                   13993: =item $ylabel: string, text describing the Y-axis of the plot
                   13994: 
                   13995: =item $Max: scalar, the maximum Y value to use in the plot
                   13996: If $Max is < any data point, the graph will not be rendered.
                   13997: 
                   13998: =item $colors: Array ref containing the hex color codes for the data to be 
                   13999: plotted in.  If undefined, default values will be used.
                   14000: 
                   14001: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14002: 
                   14003: =item $Ydata: Array ref containing Array refs.  
1.185     www      14004: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14005: 
                   14006: =item %Values: hash indicating or overriding any default values which are 
                   14007: passed to graph.png.  
                   14008: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14009: 
                   14010: =back
                   14011: 
                   14012: Returns:
                   14013: 
                   14014: An <img> tag which references graph.png and the appropriate identifying
                   14015: information for the plot.
                   14016: 
1.137     matthew  14017: =cut
                   14018: 
                   14019: ############################################################
                   14020: ############################################################
                   14021: sub DrawXYGraph {
                   14022:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14023:     #
                   14024:     # Create the identifier for the graph
                   14025:     my $identifier = &get_cgi_id();
                   14026:     my $id = 'cgi.'.$identifier;
                   14027:     #
                   14028:     $Title  = '' if (! defined($Title));
                   14029:     $xlabel = '' if (! defined($xlabel));
                   14030:     $ylabel = '' if (! defined($ylabel));
                   14031:     my %ValuesHash = 
                   14032:         (
1.369     www      14033:          $id.'.title'  => &escape($Title),
                   14034:          $id.'.xlabel' => &escape($xlabel),
                   14035:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14036:          $id.'.y_max_value'=> $Max,
                   14037:          $id.'.labels'     => join(',',@$Xlabels),
                   14038:          $id.'.PlotType'   => 'XY',
                   14039:          );
                   14040:     #
                   14041:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14042:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14043:     }
                   14044:     #
                   14045:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14046:         return '';
                   14047:     }
                   14048:     my $NumSets=1;
1.138     matthew  14049:     foreach my $array (@{$Ydata}){
1.137     matthew  14050:         next if (! ref($array));
                   14051:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14052:     }
1.138     matthew  14053:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14054:     #
                   14055:     # Deal with other parameters
                   14056:     while (my ($key,$value) = each(%Values)) {
                   14057:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14058:     }
                   14059:     #
1.646     raeburn  14060:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14061:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14062: }
                   14063: 
                   14064: ############################################################
                   14065: ############################################################
                   14066: 
                   14067: =pod
                   14068: 
1.648     raeburn  14069: =item * &DrawXYYGraph()
1.138     matthew  14070: 
                   14071: Facilitates the plotting of data in an XY graph with two Y axes.
                   14072: Puts plot definition data into the users environment in order for 
                   14073: graph.png to plot it.  Returns an <img> tag for the plot.
                   14074: 
                   14075: Inputs:
                   14076: 
                   14077: =over 4
                   14078: 
                   14079: =item $Title: string, the title of the plot
                   14080: 
                   14081: =item $xlabel: string, text describing the X-axis of the plot
                   14082: 
                   14083: =item $ylabel: string, text describing the Y-axis of the plot
                   14084: 
                   14085: =item $colors: Array ref containing the hex color codes for the data to be 
                   14086: plotted in.  If undefined, default values will be used.
                   14087: 
                   14088: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14089: 
                   14090: =item $Ydata1: The first data set
                   14091: 
                   14092: =item $Min1: The minimum value of the left Y-axis
                   14093: 
                   14094: =item $Max1: The maximum value of the left Y-axis
                   14095: 
                   14096: =item $Ydata2: The second data set
                   14097: 
                   14098: =item $Min2: The minimum value of the right Y-axis
                   14099: 
                   14100: =item $Max2: The maximum value of the left Y-axis
                   14101: 
                   14102: =item %Values: hash indicating or overriding any default values which are 
                   14103: passed to graph.png.  
                   14104: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14105: 
                   14106: =back
                   14107: 
                   14108: Returns:
                   14109: 
                   14110: An <img> tag which references graph.png and the appropriate identifying
                   14111: information for the plot.
1.136     matthew  14112: 
                   14113: =cut
                   14114: 
                   14115: ############################################################
                   14116: ############################################################
1.137     matthew  14117: sub DrawXYYGraph {
                   14118:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14119:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14120:     #
                   14121:     # Create the identifier for the graph
                   14122:     my $identifier = &get_cgi_id();
                   14123:     my $id = 'cgi.'.$identifier;
                   14124:     #
                   14125:     $Title  = '' if (! defined($Title));
                   14126:     $xlabel = '' if (! defined($xlabel));
                   14127:     $ylabel = '' if (! defined($ylabel));
                   14128:     my %ValuesHash = 
                   14129:         (
1.369     www      14130:          $id.'.title'  => &escape($Title),
                   14131:          $id.'.xlabel' => &escape($xlabel),
                   14132:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14133:          $id.'.labels' => join(',',@$Xlabels),
                   14134:          $id.'.PlotType' => 'XY',
                   14135:          $id.'.NumSets' => 2,
1.137     matthew  14136:          $id.'.two_axes' => 1,
                   14137:          $id.'.y1_max_value' => $Max1,
                   14138:          $id.'.y1_min_value' => $Min1,
                   14139:          $id.'.y2_max_value' => $Max2,
                   14140:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14141:          );
                   14142:     #
1.137     matthew  14143:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14144:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14145:     }
                   14146:     #
                   14147:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14148:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14149:         return '';
                   14150:     }
                   14151:     my $NumSets=1;
1.137     matthew  14152:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14153:         next if (! ref($array));
                   14154:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14155:     }
                   14156:     #
                   14157:     # Deal with other parameters
                   14158:     while (my ($key,$value) = each(%Values)) {
                   14159:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14160:     }
                   14161:     #
1.646     raeburn  14162:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14163:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14164: }
                   14165: 
                   14166: ############################################################
                   14167: ############################################################
                   14168: 
                   14169: =pod
                   14170: 
1.157     matthew  14171: =back 
                   14172: 
1.139     matthew  14173: =head1 Statistics helper routines?  
                   14174: 
                   14175: Bad place for them but what the hell.
                   14176: 
1.157     matthew  14177: =over 4
                   14178: 
1.648     raeburn  14179: =item * &chartlink()
1.139     matthew  14180: 
                   14181: Returns a link to the chart for a specific student.  
                   14182: 
                   14183: Inputs:
                   14184: 
                   14185: =over 4
                   14186: 
                   14187: =item $linktext: The text of the link
                   14188: 
                   14189: =item $sname: The students username
                   14190: 
                   14191: =item $sdomain: The students domain
                   14192: 
                   14193: =back
                   14194: 
1.157     matthew  14195: =back
                   14196: 
1.139     matthew  14197: =cut
                   14198: 
                   14199: ############################################################
                   14200: ############################################################
                   14201: sub chartlink {
                   14202:     my ($linktext, $sname, $sdomain) = @_;
                   14203:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14204:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14205:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14206:        '">'.$linktext.'</a>';
1.153     matthew  14207: }
                   14208: 
                   14209: #######################################################
                   14210: #######################################################
                   14211: 
                   14212: =pod
                   14213: 
                   14214: =head1 Course Environment Routines
1.157     matthew  14215: 
                   14216: =over 4
1.153     matthew  14217: 
1.648     raeburn  14218: =item * &restore_course_settings()
1.153     matthew  14219: 
1.648     raeburn  14220: =item * &store_course_settings()
1.153     matthew  14221: 
                   14222: Restores/Store indicated form parameters from the course environment.
                   14223: Will not overwrite existing values of the form parameters.
                   14224: 
                   14225: Inputs: 
                   14226: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14227: 
                   14228: a hash ref describing the data to be stored.  For example:
                   14229:    
                   14230: %Save_Parameters = ('Status' => 'scalar',
                   14231:     'chartoutputmode' => 'scalar',
                   14232:     'chartoutputdata' => 'scalar',
                   14233:     'Section' => 'array',
1.373     raeburn  14234:     'Group' => 'array',
1.153     matthew  14235:     'StudentData' => 'array',
                   14236:     'Maps' => 'array');
                   14237: 
                   14238: Returns: both routines return nothing
                   14239: 
1.631     raeburn  14240: =back
                   14241: 
1.153     matthew  14242: =cut
                   14243: 
                   14244: #######################################################
                   14245: #######################################################
                   14246: sub store_course_settings {
1.496     albertel 14247:     return &store_settings($env{'request.course.id'},@_);
                   14248: }
                   14249: 
                   14250: sub store_settings {
1.153     matthew  14251:     # save to the environment
                   14252:     # appenv the same items, just to be safe
1.300     albertel 14253:     my $udom  = $env{'user.domain'};
                   14254:     my $uname = $env{'user.name'};
1.496     albertel 14255:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14256:     my %SaveHash;
                   14257:     my %AppHash;
                   14258:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14259:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14260:         my $envname = 'environment.'.$basename;
1.258     albertel 14261:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14262:             # Save this value away
                   14263:             if ($type eq 'scalar' &&
1.258     albertel 14264:                 (! exists($env{$envname}) || 
                   14265:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14266:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14267:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14268:             } elsif ($type eq 'array') {
                   14269:                 my $stored_form;
1.258     albertel 14270:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14271:                     $stored_form = join(',',
                   14272:                                         map {
1.369     www      14273:                                             &escape($_);
1.258     albertel 14274:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14275:                 } else {
                   14276:                     $stored_form = 
1.369     www      14277:                         &escape($env{'form.'.$setting});
1.153     matthew  14278:                 }
                   14279:                 # Determine if the array contents are the same.
1.258     albertel 14280:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14281:                     $SaveHash{$basename} = $stored_form;
                   14282:                     $AppHash{$envname}   = $stored_form;
                   14283:                 }
                   14284:             }
                   14285:         }
                   14286:     }
                   14287:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14288:                                           $udom,$uname);
1.153     matthew  14289:     if ($put_result !~ /^(ok|delayed)/) {
                   14290:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14291:                                  'got error:'.$put_result);
                   14292:     }
                   14293:     # Make sure these settings stick around in this session, too
1.646     raeburn  14294:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14295:     return;
                   14296: }
                   14297: 
                   14298: sub restore_course_settings {
1.499     albertel 14299:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14300: }
                   14301: 
                   14302: sub restore_settings {
                   14303:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14304:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14305:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14306:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14307:             '.'.$setting;
1.258     albertel 14308:         if (exists($env{$envname})) {
1.153     matthew  14309:             if ($type eq 'scalar') {
1.258     albertel 14310:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14311:             } elsif ($type eq 'array') {
1.258     albertel 14312:                 $env{'form.'.$setting} = [ 
1.153     matthew  14313:                                            map { 
1.369     www      14314:                                                &unescape($_); 
1.258     albertel 14315:                                            } split(',',$env{$envname})
1.153     matthew  14316:                                            ];
                   14317:             }
                   14318:         }
                   14319:     }
1.127     matthew  14320: }
                   14321: 
1.618     raeburn  14322: #######################################################
                   14323: #######################################################
                   14324: 
                   14325: =pod
                   14326: 
                   14327: =head1 Domain E-mail Routines  
                   14328: 
                   14329: =over 4
                   14330: 
1.648     raeburn  14331: =item * &build_recipient_list()
1.618     raeburn  14332: 
1.1075.2.44  raeburn  14333: Build recipient lists for following types of e-mail:
1.766     raeburn  14334: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14335: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14336: module change checking, student/employee ID conflict checks, as
                   14337: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14338: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14339: 
                   14340: Inputs:
1.1075.2.44  raeburn  14341: defmail (scalar - email address of default recipient),
                   14342: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14343: requestsmail, updatesmail, or idconflictsmail).
                   14344: 
1.619     raeburn  14345: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14346: 
                   14347: origmail (scalar - email address of recipient from loncapa.conf,
                   14348: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14349: 
1.1075.2.139  raeburn  14350: $requname username of requester (if mailing type is helpdeskmail)
                   14351: 
                   14352: $requdom domain of requester (if mailing type is helpdeskmail)
                   14353: 
                   14354: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14355: 
1.655     raeburn  14356: Returns: comma separated list of addresses to which to send e-mail.
                   14357: 
                   14358: =back
1.618     raeburn  14359: 
                   14360: =cut
                   14361: 
                   14362: ############################################################
                   14363: ############################################################
                   14364: sub build_recipient_list {
1.1075.2.139  raeburn  14365:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14366:     my @recipients;
1.1075.2.122  raeburn  14367:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14368:     my %domconfig =
1.1075.2.122  raeburn  14369:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14370:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14371:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14372:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14373:                 my @contacts = ('adminemail','supportemail');
                   14374:                 foreach my $item (@contacts) {
                   14375:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14376:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14377:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14378:                             push(@recipients,$addr);
                   14379:                         }
1.619     raeburn  14380:                     }
1.1075.2.122  raeburn  14381:                 }
                   14382:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14383:                 if ($mailing eq 'helpdeskmail') {
                   14384:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14385:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14386:                         my @ok_bccs;
                   14387:                         foreach my $bcc (@bccs) {
                   14388:                             $bcc =~ s/^\s+//g;
                   14389:                             $bcc =~ s/\s+$//g;
                   14390:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14391:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14392:                                     push(@ok_bccs,$bcc);
                   14393:                                 }
                   14394:                             }
                   14395:                         }
                   14396:                         if (@ok_bccs > 0) {
                   14397:                             $allbcc = join(', ',@ok_bccs);
                   14398:                         }
                   14399:                     }
                   14400:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14401:                 }
                   14402:             }
1.766     raeburn  14403:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14404:             $lastresort = $origmail;
1.618     raeburn  14405:         }
1.1075.2.139  raeburn  14406:         if ($mailing eq 'helpdeskmail') {
                   14407:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14408:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14409:                 my ($inststatus,$inststatus_checked);
                   14410:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14411:                     ($env{'user.domain'} ne 'public')) {
                   14412:                     $inststatus_checked = 1;
                   14413:                     $inststatus = $env{'environment.inststatus'};
                   14414:                 }
                   14415:                 unless ($inststatus_checked) {
                   14416:                     if (($requname ne '') && ($requdom ne '')) {
                   14417:                         if (($requname =~ /^$match_username$/) &&
                   14418:                             ($requdom =~ /^$match_domain$/) &&
                   14419:                             (&Apache::lonnet::domain($requdom))) {
                   14420:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14421:                                                                       $requdom);
                   14422:                             unless ($requhome eq 'no_host') {
                   14423:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14424:                                 $inststatus = $userenv{'inststatus'};
                   14425:                                 $inststatus_checked = 1;
                   14426:                             }
                   14427:                         }
                   14428:                     }
                   14429:                 }
                   14430:                 unless ($inststatus_checked) {
                   14431:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14432:                         my %srch = (srchby     => 'email',
                   14433:                                     srchdomain => $defdom,
                   14434:                                     srchterm   => $reqemail,
                   14435:                                     srchtype   => 'exact');
                   14436:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14437:                         foreach my $uname (keys(%srch_results)) {
                   14438:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14439:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14440:                                 $inststatus_checked = 1;
                   14441:                                 last;
                   14442:                             }
                   14443:                         }
                   14444:                         unless ($inststatus_checked) {
                   14445:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14446:                             if ($dirsrchres eq 'ok') {
                   14447:                                 foreach my $uname (keys(%srch_results)) {
                   14448:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14449:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14450:                                         $inststatus_checked = 1;
                   14451:                                         last;
                   14452:                                     }
                   14453:                                 }
                   14454:                             }
                   14455:                         }
                   14456:                     }
                   14457:                 }
                   14458:                 if ($inststatus ne '') {
                   14459:                     foreach my $status (split(/\:/,$inststatus)) {
                   14460:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14461:                             my @contacts = ('adminemail','supportemail');
                   14462:                             foreach my $item (@contacts) {
                   14463:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14464:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14465:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14466:                                         push(@recipients,$addr);
                   14467:                                     }
                   14468:                                 }
                   14469:                             }
                   14470:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14471:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14472:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14473:                                 my @ok_bccs;
                   14474:                                 foreach my $bcc (@bccs) {
                   14475:                                     $bcc =~ s/^\s+//g;
                   14476:                                     $bcc =~ s/\s+$//g;
                   14477:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14478:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14479:                                             push(@ok_bccs,$bcc);
                   14480:                                         }
                   14481:                                     }
                   14482:                                 }
                   14483:                                 if (@ok_bccs > 0) {
                   14484:                                     $allbcc = join(', ',@ok_bccs);
                   14485:                                 }
                   14486:                             }
                   14487:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14488:                             last;
                   14489:                         }
                   14490:                     }
                   14491:                 }
                   14492:             }
                   14493:         }
1.619     raeburn  14494:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14495:         $lastresort = $origmail;
                   14496:     }
1.1075.2.128  raeburn  14497:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14498:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14499:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14500:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14501:             my %what = (
                   14502:                           perlvar => 1,
                   14503:                        );
                   14504:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14505:             if ($primary) {
                   14506:                 my $gotaddr;
                   14507:                 my ($result,$returnhash) =
                   14508:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14509:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14510:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14511:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14512:                         $gotaddr = 1;
                   14513:                     }
                   14514:                 }
                   14515:                 unless ($gotaddr) {
                   14516:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14517:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14518:                     unless ($uintdom eq $intdom) {
                   14519:                         my %domconfig =
                   14520:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14521:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14522:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14523:                                 my @contacts = ('adminemail','supportemail');
                   14524:                                 foreach my $item (@contacts) {
                   14525:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14526:                                         my $addr = $domconfig{'contacts'}{$item};
                   14527:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14528:                                             push(@recipients,$addr);
                   14529:                                         }
                   14530:                                     }
                   14531:                                 }
                   14532:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14533:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14534:                                 }
                   14535:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14536:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14537:                                     my @ok_bccs;
                   14538:                                     foreach my $bcc (@bccs) {
                   14539:                                         $bcc =~ s/^\s+//g;
                   14540:                                         $bcc =~ s/\s+$//g;
                   14541:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14542:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14543:                                                 push(@ok_bccs,$bcc);
                   14544:                                             }
                   14545:                                         }
                   14546:                                     }
                   14547:                                     if (@ok_bccs > 0) {
                   14548:                                         $allbcc = join(', ',@ok_bccs);
                   14549:                                     }
                   14550:                                 }
                   14551:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14552:                             }
                   14553:                         }
                   14554:                     }
                   14555:                 }
                   14556:             }
                   14557:         }
1.618     raeburn  14558:     }
1.688     raeburn  14559:     if (defined($defmail)) {
                   14560:         if ($defmail ne '') {
                   14561:             push(@recipients,$defmail);
                   14562:         }
1.618     raeburn  14563:     }
                   14564:     if ($otheremails) {
1.619     raeburn  14565:         my @others;
                   14566:         if ($otheremails =~ /,/) {
                   14567:             @others = split(/,/,$otheremails);
1.618     raeburn  14568:         } else {
1.619     raeburn  14569:             push(@others,$otheremails);
                   14570:         }
                   14571:         foreach my $addr (@others) {
                   14572:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14573:                 push(@recipients,$addr);
                   14574:             }
1.618     raeburn  14575:         }
                   14576:     }
1.1075.2.128  raeburn  14577:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14578:         if ((!@recipients) && ($lastresort ne '')) {
                   14579:             push(@recipients,$lastresort);
                   14580:         }
                   14581:     } elsif ($lastresort ne '') {
                   14582:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14583:             push(@recipients,$lastresort);
                   14584:         }
                   14585:     }
                   14586:     my $recipientlist = join(',',@recipients);
                   14587:     if (wantarray) {
                   14588:         return ($recipientlist,$allbcc,$addtext);
                   14589:     } else {
                   14590:         return $recipientlist;
                   14591:     }
1.618     raeburn  14592: }
                   14593: 
1.127     matthew  14594: ############################################################
                   14595: ############################################################
1.154     albertel 14596: 
1.655     raeburn  14597: =pod
                   14598: 
                   14599: =head1 Course Catalog Routines
                   14600: 
                   14601: =over 4
                   14602: 
                   14603: =item * &gather_categories()
                   14604: 
                   14605: Converts category definitions - keys of categories hash stored in  
                   14606: coursecategories in configuration.db on the primary library server in a 
                   14607: domain - to an array.  Also generates javascript and idx hash used to 
                   14608: generate Domain Coordinator interface for editing Course Categories.
                   14609: 
                   14610: Inputs:
1.663     raeburn  14611: 
1.655     raeburn  14612: categories (reference to hash of category definitions).
1.663     raeburn  14613: 
1.655     raeburn  14614: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14615:       categories and subcategories).
1.663     raeburn  14616: 
1.655     raeburn  14617: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14618:       editing Course Categories).
1.663     raeburn  14619: 
1.655     raeburn  14620: jsarray (reference to array of categories used to create Javascript arrays for
                   14621:          Domain Coordinator interface for editing Course Categories).
                   14622: 
                   14623: Returns: nothing
                   14624: 
                   14625: Side effects: populates cats, idx and jsarray. 
                   14626: 
                   14627: =cut
                   14628: 
                   14629: sub gather_categories {
                   14630:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14631:     my %counters;
                   14632:     my $num = 0;
                   14633:     foreach my $item (keys(%{$categories})) {
                   14634:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14635:         if ($container eq '' && $depth == 0) {
                   14636:             $cats->[$depth][$categories->{$item}] = $cat;
                   14637:         } else {
                   14638:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14639:         }
                   14640:         my ($escitem,$tail) = split(/:/,$item,2);
                   14641:         if ($counters{$tail} eq '') {
                   14642:             $counters{$tail} = $num;
                   14643:             $num ++;
                   14644:         }
                   14645:         if (ref($idx) eq 'HASH') {
                   14646:             $idx->{$item} = $counters{$tail};
                   14647:         }
                   14648:         if (ref($jsarray) eq 'ARRAY') {
                   14649:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14650:         }
                   14651:     }
                   14652:     return;
                   14653: }
                   14654: 
                   14655: =pod
                   14656: 
                   14657: =item * &extract_categories()
                   14658: 
                   14659: Used to generate breadcrumb trails for course categories.
                   14660: 
                   14661: Inputs:
1.663     raeburn  14662: 
1.655     raeburn  14663: categories (reference to hash of category definitions).
1.663     raeburn  14664: 
1.655     raeburn  14665: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14666:       categories and subcategories).
1.663     raeburn  14667: 
1.655     raeburn  14668: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14669: 
1.655     raeburn  14670: allitems (reference to hash - key is category key 
                   14671:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14672: 
1.655     raeburn  14673: idx (reference to hash of counters used in Domain Coordinator interface for
                   14674:       editing Course Categories).
1.663     raeburn  14675: 
1.655     raeburn  14676: jsarray (reference to array of categories used to create Javascript arrays for
                   14677:          Domain Coordinator interface for editing Course Categories).
                   14678: 
1.665     raeburn  14679: subcats (reference to hash of arrays containing all subcategories within each 
                   14680:          category, -recursive)
                   14681: 
1.1075.2.132  raeburn  14682: maxd (reference to hash used to hold max depth for all top-level categories).
                   14683: 
1.655     raeburn  14684: Returns: nothing
                   14685: 
                   14686: Side effects: populates trails and allitems hash references.
                   14687: 
                   14688: =cut
                   14689: 
                   14690: sub extract_categories {
1.1075.2.132  raeburn  14691:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14692:     if (ref($categories) eq 'HASH') {
                   14693:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14694:         if (ref($cats->[0]) eq 'ARRAY') {
                   14695:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14696:                 my $name = $cats->[0][$i];
                   14697:                 my $item = &escape($name).'::0';
                   14698:                 my $trailstr;
                   14699:                 if ($name eq 'instcode') {
                   14700:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14701:                 } elsif ($name eq 'communities') {
                   14702:                     $trailstr = &mt('Communities');
1.655     raeburn  14703:                 } else {
                   14704:                     $trailstr = $name;
                   14705:                 }
                   14706:                 if ($allitems->{$item} eq '') {
                   14707:                     push(@{$trails},$trailstr);
                   14708:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14709:                 }
                   14710:                 my @parents = ($name);
                   14711:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14712:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14713:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14714:                         if (ref($subcats) eq 'HASH') {
                   14715:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14716:                         }
1.1075.2.132  raeburn  14717:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14718:                     }
                   14719:                 } else {
                   14720:                     if (ref($subcats) eq 'HASH') {
                   14721:                         $subcats->{$item} = [];
1.655     raeburn  14722:                     }
1.1075.2.132  raeburn  14723:                     if (ref($maxd) eq 'HASH') {
                   14724:                         $maxd->{$name} = 1;
                   14725:                     }
1.655     raeburn  14726:                 }
                   14727:             }
                   14728:         }
                   14729:     }
                   14730:     return;
                   14731: }
                   14732: 
                   14733: =pod
                   14734: 
1.1075.2.56  raeburn  14735: =item * &recurse_categories()
1.655     raeburn  14736: 
                   14737: Recursively used to generate breadcrumb trails for course categories.
                   14738: 
                   14739: Inputs:
1.663     raeburn  14740: 
1.655     raeburn  14741: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14742:       categories and subcategories).
1.663     raeburn  14743: 
1.655     raeburn  14744: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14745: 
                   14746: category (current course category, for which breadcrumb trail is being generated).
                   14747: 
                   14748: trails (reference to array of breadcrumb trails for each category).
                   14749: 
1.655     raeburn  14750: allitems (reference to hash - key is category key
                   14751:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14752: 
1.655     raeburn  14753: parents (array containing containers directories for current category, 
                   14754:          back to top level). 
                   14755: 
                   14756: Returns: nothing
                   14757: 
                   14758: Side effects: populates trails and allitems hash references
                   14759: 
                   14760: =cut
                   14761: 
                   14762: sub recurse_categories {
1.1075.2.132  raeburn  14763:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14764:     my $shallower = $depth - 1;
                   14765:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14766:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14767:             my $name = $cats->[$depth]{$category}[$k];
                   14768:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14769:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14770:             if ($allitems->{$item} eq '') {
                   14771:                 push(@{$trails},$trailstr);
                   14772:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14773:             }
                   14774:             my $deeper = $depth+1;
                   14775:             push(@{$parents},$category);
1.665     raeburn  14776:             if (ref($subcats) eq 'HASH') {
                   14777:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14778:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14779:                     my $higher;
                   14780:                     if ($j > 0) {
                   14781:                         $higher = &escape($parents->[$j]).':'.
                   14782:                                   &escape($parents->[$j-1]).':'.$j;
                   14783:                     } else {
                   14784:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14785:                     }
                   14786:                     push(@{$subcats->{$higher}},$subcat);
                   14787:                 }
                   14788:             }
                   14789:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14790:                                 $subcats,$maxd);
1.655     raeburn  14791:             pop(@{$parents});
                   14792:         }
                   14793:     } else {
                   14794:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14795:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14796:         if ($allitems->{$item} eq '') {
                   14797:             push(@{$trails},$trailstr);
                   14798:             $allitems->{$item} = scalar(@{$trails})-1;
                   14799:         }
1.1075.2.132  raeburn  14800:         if (ref($maxd) eq 'HASH') {
                   14801:             if ($depth > $maxd->{$parents->[0]}) {
                   14802:                 $maxd->{$parents->[0]} = $depth;
                   14803:             }
                   14804:         }
1.655     raeburn  14805:     }
                   14806:     return;
                   14807: }
                   14808: 
1.663     raeburn  14809: =pod
                   14810: 
1.1075.2.56  raeburn  14811: =item * &assign_categories_table()
1.663     raeburn  14812: 
                   14813: Create a datatable for display of hierarchical categories in a domain,
                   14814: with checkboxes to allow a course to be categorized. 
                   14815: 
                   14816: Inputs:
                   14817: 
                   14818: cathash - reference to hash of categories defined for the domain (from
                   14819:           configuration.db)
                   14820: 
                   14821: currcat - scalar with an & separated list of categories assigned to a course. 
                   14822: 
1.919     raeburn  14823: type    - scalar contains course type (Course or Community).
                   14824: 
1.1075.2.117  raeburn  14825: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14826:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14827: 
1.663     raeburn  14828: Returns: $output (markup to be displayed) 
                   14829: 
                   14830: =cut
                   14831: 
                   14832: sub assign_categories_table {
1.1075.2.117  raeburn  14833:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14834:     my $output;
                   14835:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  14836:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   14837:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  14838:         $maxdepth = scalar(@cats);
                   14839:         if (@cats > 0) {
                   14840:             my $itemcount = 0;
                   14841:             if (ref($cats[0]) eq 'ARRAY') {
                   14842:                 my @currcategories;
                   14843:                 if ($currcat ne '') {
                   14844:                     @currcategories = split('&',$currcat);
                   14845:                 }
1.919     raeburn  14846:                 my $table;
1.663     raeburn  14847:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14848:                     my $parent = $cats[0][$i];
1.919     raeburn  14849:                     next if ($parent eq 'instcode');
                   14850:                     if ($type eq 'Community') {
                   14851:                         next unless ($parent eq 'communities');
                   14852:                     } else {
                   14853:                         next if ($parent eq 'communities');
                   14854:                     }
1.663     raeburn  14855:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14856:                     my $item = &escape($parent).'::0';
                   14857:                     my $checked = '';
                   14858:                     if (@currcategories > 0) {
                   14859:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14860:                             $checked = ' checked="checked"';
1.663     raeburn  14861:                         }
                   14862:                     }
1.919     raeburn  14863:                     my $parent_title = $parent;
                   14864:                     if ($parent eq 'communities') {
                   14865:                         $parent_title = &mt('Communities');
                   14866:                     }
                   14867:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14868:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14869:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14870:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14871:                     my $depth = 1;
                   14872:                     push(@path,$parent);
1.1075.2.117  raeburn  14873:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14874:                     pop(@path);
1.919     raeburn  14875:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14876:                     $itemcount ++;
                   14877:                 }
1.919     raeburn  14878:                 if ($itemcount) {
                   14879:                     $output = &Apache::loncommon::start_data_table().
                   14880:                               $table.
                   14881:                               &Apache::loncommon::end_data_table();
                   14882:                 }
1.663     raeburn  14883:             }
                   14884:         }
                   14885:     }
                   14886:     return $output;
                   14887: }
                   14888: 
                   14889: =pod
                   14890: 
1.1075.2.56  raeburn  14891: =item * &assign_category_rows()
1.663     raeburn  14892: 
                   14893: Create a datatable row for display of nested categories in a domain,
                   14894: with checkboxes to allow a course to be categorized,called recursively.
                   14895: 
                   14896: Inputs:
                   14897: 
                   14898: itemcount - track row number for alternating colors
                   14899: 
                   14900: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14901:       categories and subcategories.
                   14902: 
                   14903: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14904: 
                   14905: parent - parent of current category item
                   14906: 
                   14907: path - Array containing all categories back up through the hierarchy from the
                   14908:        current category to the top level.
                   14909: 
                   14910: currcategories - reference to array of current categories assigned to the course
                   14911: 
1.1075.2.117  raeburn  14912: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14913:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14914: 
1.663     raeburn  14915: Returns: $output (markup to be displayed).
                   14916: 
                   14917: =cut
                   14918: 
                   14919: sub assign_category_rows {
1.1075.2.117  raeburn  14920:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14921:     my ($text,$name,$item,$chgstr);
                   14922:     if (ref($cats) eq 'ARRAY') {
                   14923:         my $maxdepth = scalar(@{$cats});
                   14924:         if (ref($cats->[$depth]) eq 'HASH') {
                   14925:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14926:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14927:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14928:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14929:                 for (my $j=0; $j<$numchildren; $j++) {
                   14930:                     $name = $cats->[$depth]{$parent}[$j];
                   14931:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14932:                     my $deeper = $depth+1;
                   14933:                     my $checked = '';
                   14934:                     if (ref($currcategories) eq 'ARRAY') {
                   14935:                         if (@{$currcategories} > 0) {
                   14936:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14937:                                 $checked = ' checked="checked"';
1.663     raeburn  14938:                             }
                   14939:                         }
                   14940:                     }
1.664     raeburn  14941:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14942:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14943:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14944:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14945:                              '</td><td>';
1.663     raeburn  14946:                     if (ref($path) eq 'ARRAY') {
                   14947:                         push(@{$path},$name);
1.1075.2.117  raeburn  14948:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14949:                         pop(@{$path});
                   14950:                     }
                   14951:                     $text .= '</td></tr>';
                   14952:                 }
                   14953:                 $text .= '</table></td>';
                   14954:             }
                   14955:         }
                   14956:     }
                   14957:     return $text;
                   14958: }
                   14959: 
1.1075.2.69  raeburn  14960: =pod
                   14961: 
                   14962: =back
                   14963: 
                   14964: =cut
                   14965: 
1.655     raeburn  14966: ############################################################
                   14967: ############################################################
                   14968: 
                   14969: 
1.443     albertel 14970: sub commit_customrole {
1.664     raeburn  14971:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14972:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14973:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14974:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14975:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14976:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14977:                  '</b><br />';
                   14978:     return $output;
                   14979: }
                   14980: 
                   14981: sub commit_standardrole {
1.1075.2.31  raeburn  14982:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14983:     my ($output,$logmsg,$linefeed);
                   14984:     if ($context eq 'auto') {
                   14985:         $linefeed = "\n";
                   14986:     } else {
                   14987:         $linefeed = "<br />\n";
                   14988:     }  
1.443     albertel 14989:     if ($three eq 'st') {
1.541     raeburn  14990:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14991:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14992:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14993:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14994:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14995:         } else {
1.541     raeburn  14996:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14997:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14998:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14999:             if ($context eq 'auto') {
                   15000:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15001:             } else {
                   15002:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15003:                &mt('Add to classlist').': <b>ok</b>';
                   15004:             }
                   15005:             $output .= $linefeed;
1.443     albertel 15006:         }
                   15007:     } else {
                   15008:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15009:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15010:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15011:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15012:         if ($context eq 'auto') {
                   15013:             $output .= $result.$linefeed;
                   15014:         } else {
                   15015:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15016:         }
1.443     albertel 15017:     }
                   15018:     return $output;
                   15019: }
                   15020: 
                   15021: sub commit_studentrole {
1.1075.2.31  raeburn  15022:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15023:         $credits) = @_;
1.626     raeburn  15024:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15025:     if ($context eq 'auto') {
                   15026:         $linefeed = "\n";
                   15027:     } else {
                   15028:         $linefeed = '<br />'."\n";
                   15029:     }
1.443     albertel 15030:     if (defined($one) && defined($two)) {
                   15031:         my $cid=$one.'_'.$two;
                   15032:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15033:         my $secchange = 0;
                   15034:         my $expire_role_result;
                   15035:         my $modify_section_result;
1.628     raeburn  15036:         if ($oldsec ne '-1') { 
                   15037:             if ($oldsec ne $sec) {
1.443     albertel 15038:                 $secchange = 1;
1.628     raeburn  15039:                 my $now = time;
1.443     albertel 15040:                 my $uurl='/'.$cid;
                   15041:                 $uurl=~s/\_/\//g;
                   15042:                 if ($oldsec) {
                   15043:                     $uurl.='/'.$oldsec;
                   15044:                 }
1.626     raeburn  15045:                 $oldsecurl = $uurl;
1.628     raeburn  15046:                 $expire_role_result = 
1.652     raeburn  15047:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  15048:                 if ($env{'request.course.sec'} ne '') { 
                   15049:                     if ($expire_role_result eq 'refused') {
                   15050:                         my @roles = ('st');
                   15051:                         my @statuses = ('previous');
                   15052:                         my @roledoms = ($one);
                   15053:                         my $withsec = 1;
                   15054:                         my %roleshash = 
                   15055:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15056:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15057:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15058:                             my ($oldstart,$oldend) = 
                   15059:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15060:                             if ($oldend > 0 && $oldend <= $now) {
                   15061:                                 $expire_role_result = 'ok';
                   15062:                             }
                   15063:                         }
                   15064:                     }
                   15065:                 }
1.443     albertel 15066:                 $result = $expire_role_result;
                   15067:             }
                   15068:         }
                   15069:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15070:             $modify_section_result = 
                   15071:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15072:                                                            undef,undef,undef,$sec,
                   15073:                                                            $end,$start,'','',$cid,
                   15074:                                                            '',$context,$credits);
1.443     albertel 15075:             if ($modify_section_result =~ /^ok/) {
                   15076:                 if ($secchange == 1) {
1.628     raeburn  15077:                     if ($sec eq '') {
                   15078:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15079:                     } else {
                   15080:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15081:                     }
1.443     albertel 15082:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15083:                     if ($sec eq '') {
                   15084:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15085:                     } else {
                   15086:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15087:                     }
1.443     albertel 15088:                 } else {
1.628     raeburn  15089:                     if ($sec eq '') {
                   15090:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15091:                     } else {
                   15092:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15093:                     }
1.443     albertel 15094:                 }
                   15095:             } else {
1.628     raeburn  15096:                 if ($secchange) {       
                   15097:                     $$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;
                   15098:                 } else {
                   15099:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15100:                 }
1.443     albertel 15101:             }
                   15102:             $result = $modify_section_result;
                   15103:         } elsif ($secchange == 1) {
1.628     raeburn  15104:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15105:                 $$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  15106:             } else {
                   15107:                 $$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;
                   15108:             }
1.626     raeburn  15109:             if ($expire_role_result eq 'refused') {
                   15110:                 my $newsecurl = '/'.$cid;
                   15111:                 $newsecurl =~ s/\_/\//g;
                   15112:                 if ($sec ne '') {
                   15113:                     $newsecurl.='/'.$sec;
                   15114:                 }
                   15115:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15116:                     if ($sec eq '') {
                   15117:                         $$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;
                   15118:                     } else {
                   15119:                         $$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;
                   15120:                     }
                   15121:                 }
                   15122:             }
1.443     albertel 15123:         }
                   15124:     } else {
1.626     raeburn  15125:         $$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 15126:         $result = "error: incomplete course id\n";
                   15127:     }
                   15128:     return $result;
                   15129: }
                   15130: 
1.1075.2.25  raeburn  15131: sub show_role_extent {
                   15132:     my ($scope,$context,$role) = @_;
                   15133:     $scope =~ s{^/}{};
                   15134:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15135:     push(@courseroles,'co');
                   15136:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15137:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15138:         $scope =~ s{/}{_};
                   15139:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15140:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15141:         my ($audom,$auname) = split(/\//,$scope);
                   15142:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15143:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15144:     } else {
                   15145:         $scope =~ s{/$}{};
                   15146:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15147:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15148:     }
                   15149: }
                   15150: 
1.443     albertel 15151: ############################################################
                   15152: ############################################################
                   15153: 
1.566     albertel 15154: sub check_clone {
1.578     raeburn  15155:     my ($args,$linefeed) = @_;
1.566     albertel 15156:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15157:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15158:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1075.2.141.  .5(raebu 15159:20):     my $clonetitle;
                   15160:20):     my @clonemsg;
1.566     albertel 15161:     my $can_clone = 0;
1.944     raeburn  15162:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15163:     if ($lctype ne 'community') {
                   15164:         $lctype = 'course';
                   15165:     }
1.566     albertel 15166:     if ($clonehome eq 'no_host') {
1.944     raeburn  15167:         if ($args->{'crstype'} eq 'Community') {
1.1075.2.141.  .5(raebu 15168:20):             push(@clonemsg,({
                   15169:20):                               mt => 'No new community created.',
                   15170:20):                               args => [],
                   15171:20):                             },
                   15172:20):                             {
                   15173:20):                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   15174:20):                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   15175:20):                             }));
1.908     raeburn  15176:         } else {
1.1075.2.141.  .5(raebu 15177:20):             push(@clonemsg,({
                   15178:20):                               mt => 'No new course created.',
                   15179:20):                               args => [],
                   15180:20):                             },
                   15181:20):                             {
                   15182:20):                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   15183:20):                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15184:20):                             }));
                   15185:20):         }
1.566     albertel 15186:     } else {
                   15187: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1075.2.141.  .5(raebu 15188:20):         $clonetitle = $clonedesc{'description'};
1.944     raeburn  15189:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15190:             if ($clonedesc{'type'} ne 'Community') {
1.1075.2.141.  .5(raebu 15191:20):                 push(@clonemsg,({
                   15192:20):                                   mt => 'No new community created.',
                   15193:20):                                   args => [],
                   15194:20):                                 },
                   15195:20):                                 {
                   15196:20):                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   15197:20):                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   15198:20):                                 }));
                   15199:20):                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  15200:             }
                   15201:         }
1.1075.2.119  raeburn  15202: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15203:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15204: 	    $can_clone = 1;
                   15205: 	} else {
1.1075.2.95  raeburn  15206: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15207: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15208:             if ($clonehash{'cloners'} eq '') {
                   15209:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15210:                 if ($domdefs{'canclone'}) {
                   15211:                     unless ($domdefs{'canclone'} eq 'none') {
                   15212:                         if ($domdefs{'canclone'} eq 'domain') {
                   15213:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15214:                                 $can_clone = 1;
                   15215:                             }
                   15216:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15217:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15218:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15219:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15220:                                 $can_clone = 1;
                   15221:                             }
                   15222:                         }
                   15223:                     }
1.908     raeburn  15224:                 }
1.1075.2.95  raeburn  15225:             } else {
                   15226: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15227:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15228:                     $can_clone = 1;
1.1075.2.95  raeburn  15229:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15230:                     $can_clone = 1;
1.1075.2.96  raeburn  15231:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15232:                     $can_clone = 1;
1.1075.2.95  raeburn  15233:                 }
                   15234:                 unless ($can_clone) {
1.1075.2.96  raeburn  15235:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15236:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15237:                         my (%gotdomdefaults,%gotcodedefaults);
                   15238:                         foreach my $cloner (@cloners) {
                   15239:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15240:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15241:                                 my (%codedefaults,@code_order);
                   15242:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15243:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15244:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15245:                                     }
                   15246:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15247:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15248:                                     }
                   15249:                                 } else {
                   15250:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15251:                                                                             \%codedefaults,
                   15252:                                                                             \@code_order);
                   15253:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15254:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15255:                                 }
                   15256:                                 if (@code_order > 0) {
                   15257:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15258:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15259:                                                                                 $args->{'crscode'})) {
                   15260:                                         $can_clone = 1;
                   15261:                                         last;
                   15262:                                     }
                   15263:                                 }
                   15264:                             }
                   15265:                         }
                   15266:                     }
1.1075.2.96  raeburn  15267:                 }
                   15268:             }
                   15269:             unless ($can_clone) {
                   15270:                 my $ccrole = 'cc';
                   15271:                 if ($args->{'crstype'} eq 'Community') {
                   15272:                     $ccrole = 'co';
                   15273:                 }
                   15274:                 my %roleshash =
                   15275:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15276:                                                   $args->{'ccdomain'},
                   15277:                                                   'userroles',['active'],[$ccrole],
                   15278:                                                   [$args->{'clonedomain'}]);
                   15279:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15280:                     $can_clone = 1;
                   15281:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15282:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15283:                     $can_clone = 1;
1.1075.2.95  raeburn  15284:                 }
                   15285:             }
                   15286:             unless ($can_clone) {
                   15287:                 if ($args->{'crstype'} eq 'Community') {
1.1075.2.141.  .5(raebu 15288:20):                     push(@clonemsg,({
                   15289:20):                                       mt => 'No new community created.',
                   15290:20):                                       args => [],
                   15291:20):                                     },
                   15292:20):                                     {
                   15293:20):                                       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]).',
                   15294:20):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15295:20):                                     }));
1.1075.2.95  raeburn  15296:                 } else {
1.1075.2.141.  .5(raebu 15297:20):                     push(@clonemsg,({
                   15298:20):                                       mt => 'No new course created.',
                   15299:20):                                       args => [],
                   15300:20):                                     },
                   15301:20):                                     {
                   15302:20):                                       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]).',
                   15303:20):                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   15304:20):                                     }));
                   15305:20):                 }
1.566     albertel 15306: 	    }
1.578     raeburn  15307:         }
1.566     albertel 15308:     }
1.1075.2.141.  .5(raebu 15309:20):     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15310: }
                   15311: 
1.444     albertel 15312: sub construct_course {
1.1075.2.119  raeburn  15313:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1075.2.141.  .5(raebu 15314:20):         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   15315:20):     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  15316:     my $linefeed =  '<br />'."\n";
                   15317:     if ($context eq 'auto') {
                   15318:         $linefeed = "\n";
                   15319:     }
1.566     albertel 15320: 
                   15321: #
                   15322: # Are we cloning?
                   15323: #
1.1075.2.141.  .5(raebu 15324:20):     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 15325:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1075.2.141.  .5(raebu 15326:20): 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 15327:         if (!$can_clone) {
1.1075.2.141.  .5(raebu 15328:20): 	    return (0,$outcome,$clonemsgref);
1.566     albertel 15329: 	}
                   15330:     }
                   15331: 
1.444     albertel 15332: #
                   15333: # Open course
                   15334: #
                   15335:     my $crstype = lc($args->{'crstype'});
                   15336:     my %cenv=();
                   15337:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15338:                                              $args->{'cdescr'},
                   15339:                                              $args->{'curl'},
                   15340:                                              $args->{'course_home'},
                   15341:                                              $args->{'nonstandard'},
                   15342:                                              $args->{'crscode'},
                   15343:                                              $args->{'ccuname'}.':'.
                   15344:                                              $args->{'ccdomain'},
1.882     raeburn  15345:                                              $args->{'crstype'},
1.1075.2.141.  .5(raebu 15346:20):                                              $cnum,$context,$category,
                   15347:20):                                              $callercontext);
1.444     albertel 15348: 
                   15349:     # Note: The testing routines depend on this being output; see 
                   15350:     # Utils::Course. This needs to at least be output as a comment
                   15351:     # if anyone ever decides to not show this, and Utils::Course::new
                   15352:     # will need to be suitably modified.
1.1075.2.141.  .5(raebu 15353:20):     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15354:20):         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15355:20):     } else {
                   15356:20):         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
                   15357:20):     }
1.943     raeburn  15358:     if ($$courseid =~ /^error:/) {
1.1075.2.141.  .5(raebu 15359:20):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15360:     }
                   15361: 
1.444     albertel 15362: #
                   15363: # Check if created correctly
                   15364: #
1.479     albertel 15365:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15366:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15367:     if ($crsuhome eq 'no_host') {
1.1075.2.141.  .5(raebu 15368:20):         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   15369:20):             $outcome .= &mt_user($user_lh,
                   15370:20):                             'Course creation failed, unrecognized course home server.');
                   15371:20):         } else {
                   15372:20):             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   15373:20):         }
                   15374:20):         $outcome .= $linefeed;
                   15375:20):         return (0,$outcome,$clonemsgref);
1.943     raeburn  15376:     }
1.541     raeburn  15377:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15378: 
1.444     albertel 15379: #
1.566     albertel 15380: # Do the cloning
                   15381: #   
1.1075.2.141.  .5(raebu 15382:20):     my @clonemsg;
1.566     albertel 15383:     if ($can_clone && $cloneid) {
1.1075.2.141.  .5(raebu 15384:20):         push(@clonemsg,
                   15385:20):                       {
                   15386:20):                           mt => 'Created [_1] by cloning from [_2]',
                   15387:20):                           args => [$crstype,$clonetitle],
                   15388:20):                       });
1.566     albertel 15389: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15390: # Copy all files
1.1075.2.141.  .5(raebu 15391:20):         my @info =
                   15392:20): 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   15393:20):                                                      $args->{'dateshift'},$args->{'crscode'},
                   15394:20):                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   15395:20):                                                      $args->{'tinyurls'});
                   15396:20):         if (@info) {
                   15397:20):             push(@clonemsg,@info);
                   15398:20):         }
1.444     albertel 15399: # Restore URL
1.566     albertel 15400: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15401: # Restore title
1.566     albertel 15402: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15403: # Restore creation date, creator and creation context.
                   15404:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15405:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15406:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15407: # Mark as cloned
1.566     albertel 15408: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15409: # Need to clone grading mode
                   15410:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15411:         $cenv{'grading'}=$newenv{'grading'};
                   15412: # Do not clone these environment entries
                   15413:         &Apache::lonnet::del('environment',
                   15414:                   ['default_enrollment_start_date',
                   15415:                    'default_enrollment_end_date',
                   15416:                    'question.email',
                   15417:                    'policy.email',
                   15418:                    'comment.email',
                   15419:                    'pch.users.denied',
1.725     raeburn  15420:                    'plc.users.denied',
                   15421:                    'hidefromcat',
1.1075.2.36  raeburn  15422:                    'checkforpriv',
1.1075.2.59  raeburn  15423:                    'categories',
                   15424:                    'internal.uniquecode'],
1.638     www      15425:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15426:         if ($args->{'textbook'}) {
                   15427:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15428:         }
1.444     albertel 15429:     }
1.566     albertel 15430: 
1.444     albertel 15431: #
                   15432: # Set environment (will override cloned, if existing)
                   15433: #
                   15434:     my @sections = ();
                   15435:     my @xlists = ();
                   15436:     if ($args->{'crstype'}) {
                   15437:         $cenv{'type'}=$args->{'crstype'};
                   15438:     }
                   15439:     if ($args->{'crsid'}) {
                   15440:         $cenv{'courseid'}=$args->{'crsid'};
                   15441:     }
                   15442:     if ($args->{'crscode'}) {
                   15443:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15444:     }
                   15445:     if ($args->{'crsquota'} ne '') {
                   15446:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15447:     } else {
                   15448:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15449:     }
                   15450:     if ($args->{'ccuname'}) {
                   15451:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15452:                                         ':'.$args->{'ccdomain'};
                   15453:     } else {
                   15454:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15455:     }
1.1075.2.31  raeburn  15456:     if ($args->{'defaultcredits'}) {
                   15457:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15458:     }
1.444     albertel 15459:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15460:     if ($args->{'crssections'}) {
                   15461:         $cenv{'internal.sectionnums'} = '';
                   15462:         if ($args->{'crssections'} =~ m/,/) {
                   15463:             @sections = split/,/,$args->{'crssections'};
                   15464:         } else {
                   15465:             $sections[0] = $args->{'crssections'};
                   15466:         }
                   15467:         if (@sections > 0) {
                   15468:             foreach my $item (@sections) {
                   15469:                 my ($sec,$gp) = split/:/,$item;
                   15470:                 my $class = $args->{'crscode'}.$sec;
                   15471:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15472:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15473:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15474:                     push(@badclasses,$class);
1.444     albertel 15475:                 }
                   15476:             }
                   15477:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15478:         }
                   15479:     }
                   15480: # do not hide course coordinator from staff listing, 
                   15481: # even if privileged
                   15482:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15483: # add course coordinator's domain to domains to check for privileged users
                   15484: # if different to course domain
                   15485:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15486:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15487:     }
1.444     albertel 15488: # add crosslistings
                   15489:     if ($args->{'crsxlist'}) {
                   15490:         $cenv{'internal.crosslistings'}='';
                   15491:         if ($args->{'crsxlist'} =~ m/,/) {
                   15492:             @xlists = split/,/,$args->{'crsxlist'};
                   15493:         } else {
                   15494:             $xlists[0] = $args->{'crsxlist'};
                   15495:         }
                   15496:         if (@xlists > 0) {
                   15497:             foreach my $item (@xlists) {
                   15498:                 my ($xl,$gp) = split/:/,$item;
                   15499:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15500:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15501:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15502:                     push(@badclasses,$xl);
1.444     albertel 15503:                 }
                   15504:             }
                   15505:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15506:         }
                   15507:     }
                   15508:     if ($args->{'autoadds'}) {
                   15509:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15510:     }
                   15511:     if ($args->{'autodrops'}) {
                   15512:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15513:     }
                   15514: # check for notification of enrollment changes
                   15515:     my @notified = ();
                   15516:     if ($args->{'notify_owner'}) {
                   15517:         if ($args->{'ccuname'} ne '') {
                   15518:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15519:         }
                   15520:     }
                   15521:     if ($args->{'notify_dc'}) {
                   15522:         if ($uname ne '') { 
1.630     raeburn  15523:             push(@notified,$uname.':'.$udom);
1.444     albertel 15524:         }
                   15525:     }
                   15526:     if (@notified > 0) {
                   15527:         my $notifylist;
                   15528:         if (@notified > 1) {
                   15529:             $notifylist = join(',',@notified);
                   15530:         } else {
                   15531:             $notifylist = $notified[0];
                   15532:         }
                   15533:         $cenv{'internal.notifylist'} = $notifylist;
                   15534:     }
                   15535:     if (@badclasses > 0) {
                   15536:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15537:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15538:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15539:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15540:         );
1.1075.2.119  raeburn  15541:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15542:                            &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  15543:         if ($context eq 'auto') {
                   15544:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15545:         } else {
1.566     albertel 15546:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15547:         }
                   15548:         foreach my $item (@badclasses) {
1.541     raeburn  15549:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15550:                 $outcome .= " - $item\n";
1.541     raeburn  15551:             } else {
1.1075.2.119  raeburn  15552:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15553:             }
1.1075.2.119  raeburn  15554:         }
                   15555:         if ($context eq 'auto') {
                   15556:             $outcome .= $linefeed;
                   15557:         } else {
                   15558:             $outcome .= "</ul><br /><br /></div>\n";
                   15559:         }
1.444     albertel 15560:     }
                   15561:     if ($args->{'no_end_date'}) {
                   15562:         $args->{'endaccess'} = 0;
                   15563:     }
                   15564:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15565:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15566:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15567:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15568:     if ($args->{'showphotos'}) {
                   15569:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15570:     }
                   15571:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15572:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15573:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15574:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15575:             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'); 
                   15576:             if ($context eq 'auto') {
                   15577:                 $outcome .= $krb_msg;
                   15578:             } else {
1.566     albertel 15579:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15580:             }
                   15581:             $outcome .= $linefeed;
1.444     albertel 15582:         }
                   15583:     }
                   15584:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15585:        if ($args->{'setpolicy'}) {
                   15586:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15587:        }
                   15588:        if ($args->{'setcontent'}) {
                   15589:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15590:        }
1.1075.2.110  raeburn  15591:        if ($args->{'setcomment'}) {
                   15592:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15593:        }
1.444     albertel 15594:     }
                   15595:     if ($args->{'reshome'}) {
                   15596: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15597: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15598:     }
                   15599: #
                   15600: # course has keyed access
                   15601: #
                   15602:     if ($args->{'setkeys'}) {
                   15603:        $cenv{'keyaccess'}='yes';
                   15604:     }
                   15605: # if specified, key authority is not course, but user
                   15606: # only active if keyaccess is yes
                   15607:     if ($args->{'keyauth'}) {
1.487     albertel 15608: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15609: 	$user = &LONCAPA::clean_username($user);
                   15610: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15611: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15612: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15613: 	}
                   15614:     }
                   15615: 
1.1075.2.59  raeburn  15616: #
                   15617: #  generate and store uniquecode (available to course requester), if course should have one.
                   15618: #
                   15619:     if ($args->{'uniquecode'}) {
                   15620:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15621:         if ($code) {
                   15622:             $cenv{'internal.uniquecode'} = $code;
                   15623:             my %crsinfo =
                   15624:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15625:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15626:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15627:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15628:             }
                   15629:             if (ref($coderef)) {
                   15630:                 $$coderef = $code;
                   15631:             }
                   15632:         }
                   15633:     }
                   15634: 
1.444     albertel 15635:     if ($args->{'disresdis'}) {
                   15636:         $cenv{'pch.roles.denied'}='st';
                   15637:     }
                   15638:     if ($args->{'disablechat'}) {
                   15639:         $cenv{'plc.roles.denied'}='st';
                   15640:     }
                   15641: 
                   15642:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15643:     # course
                   15644:     $cenv{'course.helper.not.run'} = 1;
                   15645:     #
                   15646:     # Use new Randomseed
                   15647:     #
                   15648:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15649:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15650:     #
                   15651:     # The encryption code and receipt prefix for this course
                   15652:     #
                   15653:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15654:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15655:     #
                   15656:     # By default, use standard grading
                   15657:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15658: 
1.541     raeburn  15659:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15660:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15661: #
                   15662: # Open all assignments
                   15663: #
                   15664:     if ($args->{'openall'}) {
1.1075.2.141.  .4(raebu 15665:20):        my $opendate = time;
                   15666:20):        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15667:20):            $opendate = $args->{'openallfrom'};
                   15668:20):        }
1.444     albertel 15669:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.141.  .4(raebu 15670:20):        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15671:                            $storeunder.'.type' => 'date_start');
1.1075.2.141.  .4(raebu 15672:20):        $outcome .= &mt('All assignments open starting [_1]',
                   15673:20):                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15674:20):                    &Apache::lonnet::cput
                   15675:20):                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15676:    }
                   15677: #
                   15678: # Set first page
                   15679: #
                   15680:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15681: 	    || ($cloneid)) {
1.445     albertel 15682: 	use LONCAPA::map;
1.444     albertel 15683: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15684: 
                   15685: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15686:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15687: 
1.444     albertel 15688:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15689:         my $title; my $url;
                   15690:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15691: 	    $title=&mt('Syllabus');
1.444     albertel 15692:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15693:         } else {
1.963     raeburn  15694:             $title=&mt('Table of Contents');
1.444     albertel 15695:             $url='/adm/navmaps';
                   15696:         }
1.445     albertel 15697: 
                   15698:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15699: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15700: 
                   15701: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15702:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15703:     }
1.566     albertel 15704: 
1.1075.2.141.  .5(raebu 15705:20):     return (1,$outcome,\@clonemsg);
1.444     albertel 15706: }
                   15707: 
1.1075.2.59  raeburn  15708: sub make_unique_code {
                   15709:     my ($cdom,$cnum) = @_;
                   15710:     # get lock on uniquecodes db
                   15711:     my $lockhash = {
                   15712:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15713:                                                   ':'.$env{'user.domain'},
                   15714:                    };
                   15715:     my $tries = 0;
                   15716:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15717:     my ($code,$error);
                   15718: 
                   15719:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15720:         $tries ++;
                   15721:         sleep 1;
                   15722:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15723:     }
                   15724:     if ($gotlock eq 'ok') {
                   15725:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15726:         my $gotcode;
                   15727:         my $attempts = 0;
                   15728:         while ((!$gotcode) && ($attempts < 100)) {
                   15729:             $code = &generate_code();
                   15730:             if (!exists($currcodes{$code})) {
                   15731:                 $gotcode = 1;
                   15732:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15733:                     $error = 'nostore';
                   15734:                 }
                   15735:             }
                   15736:             $attempts ++;
                   15737:         }
                   15738:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15739:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15740:     } else {
                   15741:         $error = 'nolock';
                   15742:     }
                   15743:     return ($code,$error);
                   15744: }
                   15745: 
                   15746: sub generate_code {
                   15747:     my $code;
                   15748:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15749:     for (my $i=0; $i<6; $i++) {
                   15750:         my $lettnum = int (rand 2);
                   15751:         my $item = '';
                   15752:         if ($lettnum) {
                   15753:             $item = $letts[int( rand(18) )];
                   15754:         } else {
                   15755:             $item = 1+int( rand(8) );
                   15756:         }
                   15757:         $code .= $item;
                   15758:     }
                   15759:     return $code;
                   15760: }
                   15761: 
1.444     albertel 15762: ############################################################
                   15763: ############################################################
                   15764: 
1.953     droeschl 15765: #SD
                   15766: # only Community and Course, or anything else?
1.378     raeburn  15767: sub course_type {
                   15768:     my ($cid) = @_;
                   15769:     if (!defined($cid)) {
                   15770:         $cid = $env{'request.course.id'};
                   15771:     }
1.404     albertel 15772:     if (defined($env{'course.'.$cid.'.type'})) {
                   15773:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15774:     } else {
                   15775:         return 'Course';
1.377     raeburn  15776:     }
                   15777: }
1.156     albertel 15778: 
1.406     raeburn  15779: sub group_term {
                   15780:     my $crstype = &course_type();
                   15781:     my %names = (
                   15782:                   'Course' => 'group',
1.865     raeburn  15783:                   'Community' => 'group',
1.406     raeburn  15784:                 );
                   15785:     return $names{$crstype};
                   15786: }
                   15787: 
1.902     raeburn  15788: sub course_types {
1.1075.2.59  raeburn  15789:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15790:     my %typename = (
                   15791:                          official   => 'Official course',
                   15792:                          unofficial => 'Unofficial course',
                   15793:                          community  => 'Community',
1.1075.2.59  raeburn  15794:                          textbook   => 'Textbook course',
1.902     raeburn  15795:                    );
                   15796:     return (\@types,\%typename);
                   15797: }
                   15798: 
1.156     albertel 15799: sub icon {
                   15800:     my ($file)=@_;
1.505     albertel 15801:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15802:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15803:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15804:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15805: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15806: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15807: 	            $curfext.".gif") {
                   15808: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15809: 		$curfext.".gif";
                   15810: 	}
                   15811:     }
1.249     albertel 15812:     return &lonhttpdurl($iconname);
1.154     albertel 15813: } 
1.84      albertel 15814: 
1.575     albertel 15815: sub lonhttpdurl {
1.692     www      15816: #
                   15817: # Had been used for "small fry" static images on separate port 8080.
                   15818: # Modify here if lightweight http functionality desired again.
                   15819: # Currently eliminated due to increasing firewall issues.
                   15820: #
1.575     albertel 15821:     my ($url)=@_;
1.692     www      15822:     return $url;
1.215     albertel 15823: }
                   15824: 
1.213     albertel 15825: sub connection_aborted {
                   15826:     my ($r)=@_;
                   15827:     $r->print(" ");$r->rflush();
                   15828:     my $c = $r->connection;
                   15829:     return $c->aborted();
                   15830: }
                   15831: 
1.221     foxr     15832: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15833: #    strings as 'strings'.
                   15834: sub escape_single {
1.221     foxr     15835:     my ($input) = @_;
1.223     albertel 15836:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15837:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15838:     return $input;
                   15839: }
1.223     albertel 15840: 
1.222     foxr     15841: #  Same as escape_single, but escape's "'s  This 
                   15842: #  can be used for  "strings"
                   15843: sub escape_double {
                   15844:     my ($input) = @_;
                   15845:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15846:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15847:     return $input;
                   15848: }
1.223     albertel 15849:  
1.222     foxr     15850: #   Escapes the last element of a full URL.
                   15851: sub escape_url {
                   15852:     my ($url)   = @_;
1.238     raeburn  15853:     my @urlslices = split(/\//, $url,-1);
1.369     www      15854:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15855:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15856: }
1.462     albertel 15857: 
1.820     raeburn  15858: sub compare_arrays {
                   15859:     my ($arrayref1,$arrayref2) = @_;
                   15860:     my (@difference,%count);
                   15861:     @difference = ();
                   15862:     %count = ();
                   15863:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15864:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15865:         foreach my $element (keys(%count)) {
                   15866:             if ($count{$element} == 1) {
                   15867:                 push(@difference,$element);
                   15868:             }
                   15869:         }
                   15870:     }
                   15871:     return @difference;
                   15872: }
                   15873: 
1.817     bisitz   15874: # -------------------------------------------------------- Initialize user login
1.462     albertel 15875: sub init_user_environment {
1.463     albertel 15876:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15877:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15878: 
                   15879:     my $public=($username eq 'public' && $domain eq 'public');
                   15880: 
                   15881: # See if old ID present, if so, remove
                   15882: 
1.1062    raeburn  15883:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15884:     my $now=time;
                   15885: 
                   15886:     if ($public) {
                   15887: 	my $max_public=100;
                   15888: 	my $oldest;
                   15889: 	my $oldest_time=0;
                   15890: 	for(my $next=1;$next<=$max_public;$next++) {
                   15891: 	    if (-e $lonids."/publicuser_$next.id") {
                   15892: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15893: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15894: 		    $oldest_time=$mtime;
                   15895: 		    $oldest=$next;
                   15896: 		}
                   15897: 	    } else {
                   15898: 		$cookie="publicuser_$next";
                   15899: 		last;
                   15900: 	    }
                   15901: 	}
                   15902: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15903:     } else {
1.463     albertel 15904: 	# if this isn't a robot, kill any existing non-robot sessions
                   15905: 	if (!$args->{'robot'}) {
                   15906: 	    opendir(DIR,$lonids);
                   15907: 	    while ($filename=readdir(DIR)) {
                   15908: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  15909:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   15910:                             &GDBM_READER(),0640)) {
                   15911:                         my $linkedfile;
                   15912:                         if (exists($oldenv{'user.linkedenv'})) {
                   15913:                             $linkedfile = $oldenv{'user.linkedenv'};
                   15914:                         }
                   15915:                         untie(%oldenv);
                   15916:                         if (unlink("$lonids/$filename")) {
                   15917:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   15918:                                 if (-l "$lonids/$linkedfile.id") {
                   15919:                                     unlink("$lonids/$linkedfile.id");
                   15920:                                 }
                   15921:                             }
                   15922:                         }
                   15923:                     } else {
                   15924:                         unlink($lonids.'/'.$filename);
                   15925:                     }
1.463     albertel 15926: 		}
1.462     albertel 15927: 	    }
1.463     albertel 15928: 	    closedir(DIR);
1.1075.2.84  raeburn  15929: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15930:             my $namespace = 'nohist_courseeditor';
                   15931:             my $lockingkey = 'paste'."\0".'locked_num';
                   15932:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15933:                                                 $domain,$username);
                   15934:             if (exists($lockhash{$lockingkey})) {
                   15935:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15936:                 unless ($delresult eq 'ok') {
                   15937:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15938:                 }
                   15939:             }
1.462     albertel 15940: 	}
                   15941: # Give them a new cookie
1.463     albertel 15942: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15943: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15944: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15945:     
                   15946: # Initialize roles
                   15947: 
1.1062    raeburn  15948: 	($userroles,$firstaccenv,$timerintenv) = 
                   15949:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15950:     }
                   15951: # ------------------------------------ Check browser type and MathML capability
                   15952: 
1.1075.2.77  raeburn  15953:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15954:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15955: 
                   15956: # ------------------------------------------------------------- Get environment
                   15957: 
                   15958:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15959:     my ($tmp) = keys(%userenv);
                   15960:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15961:     } else {
                   15962: 	undef(%userenv);
                   15963:     }
                   15964:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15965: 	$form->{'interface'}=$userenv{'interface'};
                   15966:     }
                   15967:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15968: 
                   15969: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15970:     foreach my $option ('interface','localpath','localres') {
                   15971:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15972:     }
                   15973: # --------------------------------------------------------- Write first profile
                   15974: 
                   15975:     {
                   15976: 	my %initial_env = 
                   15977: 	    ("user.name"          => $username,
                   15978: 	     "user.domain"        => $domain,
                   15979: 	     "user.home"          => $authhost,
                   15980: 	     "browser.type"       => $clientbrowser,
                   15981: 	     "browser.version"    => $clientversion,
                   15982: 	     "browser.mathml"     => $clientmathml,
                   15983: 	     "browser.unicode"    => $clientunicode,
                   15984: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15985:              "browser.mobile"     => $clientmobile,
                   15986:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15987:              "browser.osversion"  => $clientosversion,
1.462     albertel 15988: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15989: 	     "request.course.fn"  => '',
                   15990: 	     "request.course.uri" => '',
                   15991: 	     "request.course.sec" => '',
                   15992: 	     "request.role"       => 'cm',
                   15993: 	     "request.role.adv"   => $env{'user.adv'},
                   15994: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   15995: 
                   15996:         if ($form->{'localpath'}) {
                   15997: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15998: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15999:         }
                   16000: 	
                   16001: 	if ($form->{'interface'}) {
                   16002: 	    $form->{'interface'}=~s/\W//gs;
                   16003: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16004: 	    $env{'browser.interface'}=$form->{'interface'};
                   16005: 	}
                   16006: 
1.1075.2.54  raeburn  16007:         if ($form->{'iptoken'}) {
                   16008:             my $lonhost = $r->dir_config('lonHostID');
                   16009:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16010:             $env{'user.noloadbalance'} = $lonhost;
                   16011:         }
                   16012: 
1.1075.2.120  raeburn  16013:         if ($form->{'noloadbalance'}) {
                   16014:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16015:             my $hosthere = $form->{'noloadbalance'};
                   16016:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16017:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16018:                 $env{'user.noloadbalance'} = $hosthere;
                   16019:             }
                   16020:         }
                   16021: 
1.1016    raeburn  16022:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16023:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16024:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16025: 
1.1075.2.125  raeburn  16026:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16027:                 $userenv{'availabletools.'.$tool} = 
                   16028:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16029:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16030:             }
1.724     raeburn  16031: 
1.1075.2.125  raeburn  16032:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16033:                 $userenv{'canrequest.'.$crstype} =
                   16034:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16035:                                                       'reload','requestcourses',
                   16036:                                                       \%userenv,\%domdef,\%is_adv);
                   16037:             }
1.765     raeburn  16038: 
1.1075.2.125  raeburn  16039:             $userenv{'canrequest.author'} =
                   16040:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16041:                                                   'reload','requestauthor',
                   16042:                                                   \%userenv,\%domdef,\%is_adv);
                   16043:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16044:                                                  $domain,$username);
                   16045:             my $reqstatus = $reqauthor{'author_status'};
                   16046:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16047:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16048:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16049:                                                       $reqauthor{'author'}{'timestamp'};
                   16050:                 }
1.1075.2.14  raeburn  16051:             }
                   16052:         }
                   16053: 
1.462     albertel 16054: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16055: 
1.462     albertel 16056: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16057: 		 &GDBM_WRCREAT(),0640)) {
                   16058: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16059: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16060: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16061:             if (ref($firstaccenv) eq 'HASH') {
                   16062:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16063:             }
                   16064:             if (ref($timerintenv) eq 'HASH') {
                   16065:                 &_add_to_env(\%disk_env,$timerintenv);
                   16066:             }
1.463     albertel 16067: 	    if (ref($args->{'extra_env'})) {
                   16068: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16069: 	    }
1.462     albertel 16070: 	    untie(%disk_env);
                   16071: 	} else {
1.705     tempelho 16072: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16073: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16074: 	    return 'error: '.$!;
                   16075: 	}
                   16076:     }
                   16077:     $env{'request.role'}='cm';
                   16078:     $env{'request.role.adv'}=$env{'user.adv'};
                   16079:     $env{'browser.type'}=$clientbrowser;
                   16080: 
                   16081:     return $cookie;
                   16082: 
                   16083: }
                   16084: 
                   16085: sub _add_to_env {
                   16086:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16087:     if (ref($env_data) eq 'HASH') {
                   16088:         while (my ($key,$value) = each(%$env_data)) {
                   16089: 	    $idf->{$prefix.$key} = $value;
                   16090: 	    $env{$prefix.$key}   = $value;
                   16091:         }
1.462     albertel 16092:     }
                   16093: }
                   16094: 
1.685     tempelho 16095: # --- Get the symbolic name of a problem and the url
                   16096: sub get_symb {
                   16097:     my ($request,$silent) = @_;
1.726     raeburn  16098:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16099:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16100:     if ($symb eq '') {
                   16101:         if (!$silent) {
1.1071    raeburn  16102:             if (ref($request)) { 
                   16103:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16104:             }
1.685     tempelho 16105:             return ();
                   16106:         }
                   16107:     }
                   16108:     &Apache::lonenc::check_decrypt(\$symb);
                   16109:     return ($symb);
                   16110: }
                   16111: 
                   16112: # --------------------------------------------------------------Get annotation
                   16113: 
                   16114: sub get_annotation {
                   16115:     my ($symb,$enc) = @_;
                   16116: 
                   16117:     my $key = $symb;
                   16118:     if (!$enc) {
                   16119:         $key =
                   16120:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16121:     }
                   16122:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16123:     return $annotation{$key};
                   16124: }
                   16125: 
                   16126: sub clean_symb {
1.731     raeburn  16127:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16128: 
                   16129:     &Apache::lonenc::check_decrypt(\$symb);
                   16130:     my $enc = $env{'request.enc'};
1.731     raeburn  16131:     if ($delete_enc) {
1.730     raeburn  16132:         delete($env{'request.enc'});
                   16133:     }
1.685     tempelho 16134: 
                   16135:     return ($symb,$enc);
                   16136: }
1.462     albertel 16137: 
1.1075.2.69  raeburn  16138: ############################################################
                   16139: ############################################################
                   16140: 
                   16141: =pod
                   16142: 
                   16143: =head1 Routines for building display used to search for courses
                   16144: 
                   16145: 
                   16146: =over 4
                   16147: 
                   16148: =item * &build_filters()
                   16149: 
                   16150: Create markup for a table used to set filters to use when selecting
                   16151: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16152: and quotacheck.pl
                   16153: 
                   16154: 
                   16155: Inputs:
                   16156: 
                   16157: filterlist - anonymous array of fields to include as potential filters
                   16158: 
                   16159: crstype - course type
                   16160: 
                   16161: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16162:               to pop-open a course selector (will contain "extra element").
                   16163: 
                   16164: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16165: 
                   16166: filter - anonymous hash of criteria and their values
                   16167: 
                   16168: action - form action
                   16169: 
                   16170: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16171: 
                   16172: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16173: 
                   16174: cloneruname - username of owner of new course who wants to clone
                   16175: 
                   16176: clonerudom - domain of owner of new course who wants to clone
                   16177: 
                   16178: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16179: 
                   16180: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16181: 
                   16182: codedom - domain
                   16183: 
                   16184: formname - value of form element named "form".
                   16185: 
                   16186: fixeddom - domain, if fixed.
                   16187: 
                   16188: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16189: 
                   16190: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16191: 
                   16192: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16193: 
                   16194: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16195: 
                   16196: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16197: 
                   16198: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16199: 
                   16200: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16201: 
                   16202: 
                   16203: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16204: 
                   16205: 
                   16206: Side Effects: None
                   16207: 
                   16208: =cut
                   16209: 
                   16210: # ---------------------------------------------- search for courses based on last activity etc.
                   16211: 
                   16212: sub build_filters {
                   16213:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16214:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16215:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16216:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16217:         $clonetext,$clonewarning) = @_;
                   16218:     my ($list,$jscript);
                   16219:     my $onchange = 'javascript:updateFilters(this)';
                   16220:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16221:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16222:         $typeselectform,$instcodetitle);
                   16223:     if ($formname eq '') {
                   16224:         $formname = $caller;
                   16225:     }
                   16226:     foreach my $item (@{$filterlist}) {
                   16227:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16228:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16229:             if ($item eq 'domainfilter') {
                   16230:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16231:             } elsif ($item eq 'coursefilter') {
                   16232:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16233:             } elsif ($item eq 'ownerfilter') {
                   16234:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16235:             } elsif ($item eq 'ownerdomfilter') {
                   16236:                 $filter->{'ownerdomfilter'} =
                   16237:                     &LONCAPA::clean_domain($filter->{$item});
                   16238:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16239:                                                        'ownerdomfilter',1);
                   16240:             } elsif ($item eq 'personfilter') {
                   16241:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16242:             } elsif ($item eq 'persondomfilter') {
                   16243:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16244:                                                         'persondomfilter',1);
                   16245:             } else {
                   16246:                 $filter->{$item} =~ s/\W//g;
                   16247:             }
                   16248:             if (!$filter->{$item}) {
                   16249:                 $filter->{$item} = '';
                   16250:             }
                   16251:         }
                   16252:         if ($item eq 'domainfilter') {
                   16253:             my $allow_blank = 1;
                   16254:             if ($formname eq 'portform') {
                   16255:                 $allow_blank=0;
                   16256:             } elsif ($formname eq 'studentform') {
                   16257:                 $allow_blank=0;
                   16258:             }
                   16259:             if ($fixeddom) {
                   16260:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16261:                                     ' value="'.$codedom.'" />'.
                   16262:                                     &Apache::lonnet::domain($codedom,'description');
                   16263:             } else {
                   16264:                 $domainselectform = &select_dom_form($filter->{$item},
                   16265:                                                      'domainfilter',
                   16266:                                                       $allow_blank,'',$onchange);
                   16267:             }
                   16268:         } else {
                   16269:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16270:         }
                   16271:     }
                   16272: 
                   16273:     # last course activity filter and selection
                   16274:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16275: 
                   16276:     # course created filter and selection
                   16277:     if (exists($filter->{'createdfilter'})) {
                   16278:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16279:     }
                   16280: 
                   16281:     my %lt = &Apache::lonlocal::texthash(
                   16282:                 'cac' => "$crstype Activity",
                   16283:                 'ccr' => "$crstype Created",
                   16284:                 'cde' => "$crstype Title",
                   16285:                 'cdo' => "$crstype Domain",
                   16286:                 'ins' => 'Institutional Code',
                   16287:                 'inc' => 'Institutional Categorization',
                   16288:                 'cow' => "$crstype Owner/Co-owner",
                   16289:                 'cop' => "$crstype Personnel Includes",
                   16290:                 'cog' => 'Type',
                   16291:              );
                   16292: 
                   16293:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16294:         my $typeval = 'Course';
                   16295:         if ($crstype eq 'Community') {
                   16296:             $typeval = 'Community';
                   16297:         }
                   16298:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16299:     } else {
                   16300:         $typeselectform =  '<select name="type" size="1"';
                   16301:         if ($onchange) {
                   16302:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16303:         }
                   16304:         $typeselectform .= '>'."\n";
                   16305:         foreach my $posstype ('Course','Community') {
                   16306:             $typeselectform.='<option value="'.$posstype.'"'.
                   16307:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16308:         }
                   16309:         $typeselectform.="</select>";
                   16310:     }
                   16311: 
                   16312:     my ($cloneableonlyform,$cloneabletitle);
                   16313:     if (exists($filter->{'cloneableonly'})) {
                   16314:         my $cloneableon = '';
                   16315:         my $cloneableoff = ' checked="checked"';
                   16316:         if ($filter->{'cloneableonly'}) {
                   16317:             $cloneableon = $cloneableoff;
                   16318:             $cloneableoff = '';
                   16319:         }
                   16320:         $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>';
                   16321:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16322:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16323:         } else {
                   16324:             $cloneabletitle = &mt('Cloneable by you');
                   16325:         }
                   16326:     }
                   16327:     my $officialjs;
                   16328:     if ($crstype eq 'Course') {
                   16329:         if (exists($filter->{'instcodefilter'})) {
                   16330: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16331: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16332:             if ($codedom) {
                   16333:                 $officialjs = 1;
                   16334:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16335:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16336:                                                                   $officialjs,$codetitlesref);
                   16337:                 if ($jscript) {
                   16338:                     $jscript = '<script type="text/javascript">'."\n".
                   16339:                                '// <![CDATA['."\n".
                   16340:                                $jscript."\n".
                   16341:                                '// ]]>'."\n".
                   16342:                                '</script>'."\n";
                   16343:                 }
                   16344:             }
                   16345:             if ($instcodeform eq '') {
                   16346:                 $instcodeform =
                   16347:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16348:                     $list->{'instcodefilter'}.'" />';
                   16349:                 $instcodetitle = $lt{'ins'};
                   16350:             } else {
                   16351:                 $instcodetitle = $lt{'inc'};
                   16352:             }
                   16353:             if ($fixeddom) {
                   16354:                 $instcodetitle .= '<br />('.$codedom.')';
                   16355:             }
                   16356:         }
                   16357:     }
                   16358:     my $output = qq|
                   16359: <form method="post" name="filterpicker" action="$action">
                   16360: <input type="hidden" name="form" value="$formname" />
                   16361: |;
                   16362:     if ($formname eq 'modifycourse') {
                   16363:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16364:                    '<input type="hidden" name="prevphase" value="'.
                   16365:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16366:     } elsif ($formname eq 'quotacheck') {
                   16367:         $output .= qq|
                   16368: <input type="hidden" name="sortby" value="" />
                   16369: <input type="hidden" name="sortorder" value="" />
                   16370: |;
                   16371:     } else {
1.1075.2.69  raeburn  16372:         my $name_input;
                   16373:         if ($cnameelement ne '') {
                   16374:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16375:                           $cnameelement.'" />';
                   16376:         }
                   16377:         $output .= qq|
                   16378: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16379: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16380: $name_input
                   16381: $roleelement
                   16382: $multelement
                   16383: $typeelement
                   16384: |;
                   16385:         if ($formname eq 'portform') {
                   16386:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16387:         }
                   16388:     }
                   16389:     if ($fixeddom) {
                   16390:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16391:     }
                   16392:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16393:     if ($sincefilterform) {
                   16394:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16395:                   .$sincefilterform
                   16396:                   .&Apache::lonhtmlcommon::row_closure();
                   16397:     }
                   16398:     if ($createdfilterform) {
                   16399:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16400:                   .$createdfilterform
                   16401:                   .&Apache::lonhtmlcommon::row_closure();
                   16402:     }
                   16403:     if ($domainselectform) {
                   16404:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16405:                   .$domainselectform
                   16406:                   .&Apache::lonhtmlcommon::row_closure();
                   16407:     }
                   16408:     if ($typeselectform) {
                   16409:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16410:             $output .= $typeselectform;
                   16411:         } else {
                   16412:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16413:                       .$typeselectform
                   16414:                       .&Apache::lonhtmlcommon::row_closure();
                   16415:         }
                   16416:     }
                   16417:     if ($instcodeform) {
                   16418:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16419:                   .$instcodeform
                   16420:                   .&Apache::lonhtmlcommon::row_closure();
                   16421:     }
                   16422:     if (exists($filter->{'ownerfilter'})) {
                   16423:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16424:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16425:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16426:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16427:                    $ownerdomselectform.'</td></tr></table>'.
                   16428:                    &Apache::lonhtmlcommon::row_closure();
                   16429:     }
                   16430:     if (exists($filter->{'personfilter'})) {
                   16431:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16432:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16433:                    '<input type="text" name="personfilter" size="20" value="'.
                   16434:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16435:                    $persondomselectform.'</td></tr></table>'.
                   16436:                    &Apache::lonhtmlcommon::row_closure();
                   16437:     }
                   16438:     if (exists($filter->{'coursefilter'})) {
                   16439:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16440:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16441:                   .$list->{'coursefilter'}.'" />'
                   16442:                   .&Apache::lonhtmlcommon::row_closure();
                   16443:     }
                   16444:     if ($cloneableonlyform) {
                   16445:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16446:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16447:     }
                   16448:     if (exists($filter->{'descriptfilter'})) {
                   16449:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16450:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16451:                   .$list->{'descriptfilter'}.'" />'
                   16452:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16453:     }
                   16454:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16455:                '<input type="hidden" name="updater" value="" />'."\n".
                   16456:                '<input type="submit" name="gosearch" value="'.
                   16457:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16458:     return $jscript.$clonewarning.$output;
                   16459: }
                   16460: 
                   16461: =pod
                   16462: 
                   16463: =item * &timebased_select_form()
                   16464: 
                   16465: Create markup for a dropdown list used to select a time-based
                   16466: filter e.g., Course Activity, Course Created, when searching for courses
                   16467: or communities
                   16468: 
                   16469: Inputs:
                   16470: 
                   16471: item - name of form element (sincefilter or createdfilter)
                   16472: 
                   16473: filter - anonymous hash of criteria and their values
                   16474: 
                   16475: Returns: HTML for a select box contained a blank, then six time selections,
                   16476:          with value set in incoming form variables currently selected.
                   16477: 
                   16478: Side Effects: None
                   16479: 
                   16480: =cut
                   16481: 
                   16482: sub timebased_select_form {
                   16483:     my ($item,$filter) = @_;
                   16484:     if (ref($filter) eq 'HASH') {
                   16485:         $filter->{$item} =~ s/[^\d-]//g;
                   16486:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16487:         return &select_form(
                   16488:                             $filter->{$item},
                   16489:                             $item,
                   16490:                             {      '-1' => '',
                   16491:                                 '86400' => &mt('today'),
                   16492:                                '604800' => &mt('last week'),
                   16493:                               '2592000' => &mt('last month'),
                   16494:                               '7776000' => &mt('last three months'),
                   16495:                              '15552000' => &mt('last six months'),
                   16496:                              '31104000' => &mt('last year'),
                   16497:                     'select_form_order' =>
                   16498:                            ['-1','86400','604800','2592000','7776000',
                   16499:                             '15552000','31104000']});
                   16500:     }
                   16501: }
                   16502: 
                   16503: =pod
                   16504: 
                   16505: =item * &js_changer()
                   16506: 
                   16507: Create script tag containing Javascript used to submit course search form
                   16508: when course type or domain is changed, and also to hide 'Searching ...' on
                   16509: page load completion for page showing search result.
                   16510: 
                   16511: Inputs: None
                   16512: 
                   16513: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16514: 
                   16515: Side Effects: None
                   16516: 
                   16517: =cut
                   16518: 
                   16519: sub js_changer {
                   16520:     return <<ENDJS;
                   16521: <script type="text/javascript">
                   16522: // <![CDATA[
                   16523: function updateFilters(caller) {
                   16524:     if (typeof(caller) != "undefined") {
                   16525:         document.filterpicker.updater.value = caller.name;
                   16526:     }
                   16527:     document.filterpicker.submit();
                   16528: }
                   16529: 
                   16530: function hideSearching() {
                   16531:     if (document.getElementById('searching')) {
                   16532:         document.getElementById('searching').style.display = 'none';
                   16533:     }
                   16534:     return;
                   16535: }
                   16536: 
                   16537: // ]]>
                   16538: </script>
                   16539: 
                   16540: ENDJS
                   16541: }
                   16542: 
                   16543: =pod
                   16544: 
                   16545: =item * &search_courses()
                   16546: 
                   16547: Process selected filters form course search form and pass to lonnet::courseiddump
                   16548: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16549: 
                   16550: Inputs:
                   16551: 
                   16552: dom - domain being searched
                   16553: 
                   16554: type - course type ('Course' or 'Community' or '.' if any).
                   16555: 
                   16556: filter - anonymous hash of criteria and their values
                   16557: 
                   16558: numtitles - for institutional codes - number of categories
                   16559: 
                   16560: cloneruname - optional username of new course owner
                   16561: 
                   16562: clonerudom - optional domain of new course owner
                   16563: 
1.1075.2.95  raeburn  16564: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16565:             (used when DC is using course creation form)
                   16566: 
                   16567: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16568: 
1.1075.2.95  raeburn  16569: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16570:            (and so can clone automatically)
                   16571: 
                   16572: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16573: 
                   16574: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16575:               courses to clone
1.1075.2.69  raeburn  16576: 
                   16577: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16578: 
                   16579: 
                   16580: Side Effects: None
                   16581: 
                   16582: =cut
                   16583: 
                   16584: 
                   16585: sub search_courses {
1.1075.2.95  raeburn  16586:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16587:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16588:     my (%courses,%showcourses,$cloner);
                   16589:     if (($filter->{'ownerfilter'} ne '') ||
                   16590:         ($filter->{'ownerdomfilter'} ne '')) {
                   16591:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16592:                                        $filter->{'ownerdomfilter'};
                   16593:     }
                   16594:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16595:         if (!$filter->{$item}) {
                   16596:             $filter->{$item}='.';
                   16597:         }
                   16598:     }
                   16599:     my $now = time;
                   16600:     my $timefilter =
                   16601:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16602:     my ($createdbefore,$createdafter);
                   16603:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16604:         $createdbefore = $now;
                   16605:         $createdafter = $now-$filter->{'createdfilter'};
                   16606:     }
                   16607:     my ($instcodefilter,$regexpok);
                   16608:     if ($numtitles) {
                   16609:         if ($env{'form.official'} eq 'on') {
                   16610:             $instcodefilter =
                   16611:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16612:             $regexpok = 1;
                   16613:         } elsif ($env{'form.official'} eq 'off') {
                   16614:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16615:             unless ($instcodefilter eq '') {
                   16616:                 $regexpok = -1;
                   16617:             }
                   16618:         }
                   16619:     } else {
                   16620:         $instcodefilter = $filter->{'instcodefilter'};
                   16621:     }
                   16622:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16623:     if ($type eq '') { $type = '.'; }
                   16624: 
                   16625:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16626:         $cloner = $cloneruname.':'.$clonerudom;
                   16627:     }
                   16628:     %courses = &Apache::lonnet::courseiddump($dom,
                   16629:                                              $filter->{'descriptfilter'},
                   16630:                                              $timefilter,
                   16631:                                              $instcodefilter,
                   16632:                                              $filter->{'combownerfilter'},
                   16633:                                              $filter->{'coursefilter'},
                   16634:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16635:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16636:                                              $filter->{'cloneableonly'},
                   16637:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16638:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16639:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16640:         my $ccrole;
                   16641:         if ($type eq 'Community') {
                   16642:             $ccrole = 'co';
                   16643:         } else {
                   16644:             $ccrole = 'cc';
                   16645:         }
                   16646:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16647:                                                      $filter->{'persondomfilter'},
                   16648:                                                      'userroles',undef,
                   16649:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16650:                                                      $dom);
                   16651:         foreach my $role (keys(%rolehash)) {
                   16652:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16653:             my $cid = $cdom.'_'.$cnum;
                   16654:             if (exists($courses{$cid})) {
                   16655:                 if (ref($courses{$cid}) eq 'HASH') {
                   16656:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16657:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16658:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16659:                         }
                   16660:                     } else {
                   16661:                         $courses{$cid}{roles} = [$courserole];
                   16662:                     }
                   16663:                     $showcourses{$cid} = $courses{$cid};
                   16664:                 }
                   16665:             }
                   16666:         }
                   16667:         %courses = %showcourses;
                   16668:     }
                   16669:     return %courses;
                   16670: }
                   16671: 
                   16672: =pod
                   16673: 
                   16674: =back
                   16675: 
1.1075.2.88  raeburn  16676: =head1 Routines for version requirements for current course.
                   16677: 
                   16678: =over 4
                   16679: 
                   16680: =item * &check_release_required()
                   16681: 
                   16682: Compares required LON-CAPA version with version on server, and
                   16683: if required version is newer looks for a server with the required version.
                   16684: 
                   16685: Looks first at servers in user's owen domain; if none suitable, looks at
                   16686: servers in course's domain are permitted to host sessions for user's domain.
                   16687: 
                   16688: Inputs:
                   16689: 
                   16690: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16691: 
                   16692: $courseid - Course ID of current course
                   16693: 
                   16694: $rolecode - User's current role in course (for switchserver query string).
                   16695: 
                   16696: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16697: 
                   16698: 
                   16699: Returns:
                   16700: 
                   16701: $switchserver - query string tp append to /adm/switchserver call (if
                   16702:                 current server's LON-CAPA version is too old.
                   16703: 
                   16704: $warning - Message is displayed if no suitable server could be found.
                   16705: 
                   16706: =cut
                   16707: 
                   16708: sub check_release_required {
                   16709:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16710:     my ($switchserver,$warning);
                   16711:     if ($required ne '') {
                   16712:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16713:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16714:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16715:             my $otherserver;
                   16716:             if (($major eq '' && $minor eq '') ||
                   16717:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16718:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16719:                 my $switchlcrev =
                   16720:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16721:                                                            $userdomserver);
                   16722:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16723:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16724:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16725:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16726:                     if ($cdom ne $env{'user.domain'}) {
                   16727:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16728:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16729:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16730:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16731:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16732:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16733:                         my $canhost =
                   16734:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16735:                                                               $coursedomserver,
                   16736:                                                               $remoterev,
                   16737:                                                               $udomdefaults{'remotesessions'},
                   16738:                                                               $defdomdefaults{'hostedsessions'});
                   16739: 
                   16740:                         if ($canhost) {
                   16741:                             $otherserver = $coursedomserver;
                   16742:                         } else {
                   16743:                             $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.");
                   16744:                         }
                   16745:                     } else {
                   16746:                         $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).");
                   16747:                     }
                   16748:                 } else {
                   16749:                     $otherserver = $userdomserver;
                   16750:                 }
                   16751:             }
                   16752:             if ($otherserver ne '') {
                   16753:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16754:             }
                   16755:         }
                   16756:     }
                   16757:     return ($switchserver,$warning);
                   16758: }
                   16759: 
                   16760: =pod
                   16761: 
                   16762: =item * &check_release_result()
                   16763: 
                   16764: Inputs:
                   16765: 
                   16766: $switchwarning - Warning message if no suitable server found to host session.
                   16767: 
                   16768: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16769:                 and current role.
                   16770: 
                   16771: Returns: HTML to display with information about requirement to switch server.
                   16772:          Either displaying warning with link to Roles/Courses screen or
                   16773:          display link to switchserver.
                   16774: 
1.1075.2.69  raeburn  16775: =cut
                   16776: 
1.1075.2.88  raeburn  16777: sub check_release_result {
                   16778:     my ($switchwarning,$switchserver) = @_;
                   16779:     my $output = &start_page('Selected course unavailable on this server').
                   16780:                  '<p class="LC_warning">';
                   16781:     if ($switchwarning) {
                   16782:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16783:         if (&show_course()) {
                   16784:             $output .= &mt('Display courses');
                   16785:         } else {
                   16786:             $output .= &mt('Display roles');
                   16787:         }
                   16788:         $output .= '</a>';
                   16789:     } elsif ($switchserver) {
                   16790:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16791:                    '<br />'.
                   16792:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16793:                    &mt('Switch Server').
                   16794:                    '</a>';
                   16795:     }
                   16796:     $output .= '</p>'.&end_page();
                   16797:     return $output;
                   16798: }
                   16799: 
                   16800: =pod
                   16801: 
                   16802: =item * &needs_coursereinit()
                   16803: 
                   16804: Determine if course contents stored for user's session needs to be
                   16805: refreshed, because content has changed since "Big Hash" last tied.
                   16806: 
                   16807: Check for change is made if time last checked is more than 10 minutes ago
                   16808: (by default).
                   16809: 
                   16810: Inputs:
                   16811: 
                   16812: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16813: 
                   16814: $interval (optional) - Time which may elapse (in s) between last check for content
                   16815:                        change in current course. (default: 600 s).
                   16816: 
                   16817: Returns: an array; first element is:
                   16818: 
                   16819: =over 4
                   16820: 
                   16821: 'switch' - if content updates mean user's session
                   16822:            needs to be switched to a server running a newer LON-CAPA version
                   16823: 
                   16824: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16825:            on current server hosting user's session
                   16826: 
                   16827: ''       - if no action required.
                   16828: 
                   16829: =back
                   16830: 
                   16831: If first item element is 'switch':
                   16832: 
                   16833: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16834: 
                   16835: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16836:                               and current role.
                   16837: 
                   16838: otherwise: no other elements returned.
                   16839: 
                   16840: =back
                   16841: 
                   16842: =cut
                   16843: 
                   16844: sub needs_coursereinit {
                   16845:     my ($loncaparev,$interval) = @_;
                   16846:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16847:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16848:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16849:     my $now = time;
                   16850:     if ($interval eq '') {
                   16851:         $interval = 600;
                   16852:     }
                   16853:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16854:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1075.2.141.  .6(raebu 16855:20):         my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
                   16856:20):         if ($blocked) {
                   16857:20):             return ();
                   16858:20):         }
                   16859:20):         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
1.1075.2.88  raeburn  16860:         if ($lastchange > $env{'request.course.tied'}) {
                   16861:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16862:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16863:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16864:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16865:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16866:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16867:                     my ($switchserver,$switchwarning) =
                   16868:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16869:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16870:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16871:                         return ('switch',$switchwarning,$switchserver);
                   16872:                     }
                   16873:                 }
                   16874:             }
                   16875:             return ('update');
                   16876:         }
                   16877:     }
                   16878:     return ();
                   16879: }
1.1075.2.69  raeburn  16880: 
1.1075.2.11  raeburn  16881: sub update_content_constraints {
                   16882:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16883:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16884:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16885:     my %checkresponsetypes;
                   16886:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16887:         my ($item,$name,$value) = split(/:/,$key);
                   16888:         if ($item eq 'resourcetag') {
                   16889:             if ($name eq 'responsetype') {
                   16890:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16891:             }
                   16892:         }
                   16893:     }
                   16894:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16895:     if (defined($navmap)) {
                   16896:         my %allresponses;
                   16897:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16898:             my %responses = $res->responseTypes();
                   16899:             foreach my $key (keys(%responses)) {
                   16900:                 next unless(exists($checkresponsetypes{$key}));
                   16901:                 $allresponses{$key} += $responses{$key};
                   16902:             }
                   16903:         }
                   16904:         foreach my $key (keys(%allresponses)) {
                   16905:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16906:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16907:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16908:             }
                   16909:         }
                   16910:         undef($navmap);
                   16911:     }
                   16912:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16913:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16914:     }
                   16915:     return;
                   16916: }
                   16917: 
1.1075.2.27  raeburn  16918: sub allmaps_incourse {
                   16919:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16920:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16921:         $cid = $env{'request.course.id'};
                   16922:         $cdom = $env{'course.'.$cid.'.domain'};
                   16923:         $cnum = $env{'course.'.$cid.'.num'};
                   16924:         $chome = $env{'course.'.$cid.'.home'};
                   16925:     }
                   16926:     my %allmaps = ();
                   16927:     my $lastchange =
                   16928:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16929:     if ($lastchange > $env{'request.course.tied'}) {
                   16930:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16931:         unless ($ferr) {
                   16932:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16933:         }
                   16934:     }
                   16935:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16936:     if (defined($navmap)) {
                   16937:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16938:             $allmaps{$res->src()} = 1;
                   16939:         }
                   16940:     }
                   16941:     return \%allmaps;
                   16942: }
                   16943: 
1.1075.2.11  raeburn  16944: sub parse_supplemental_title {
                   16945:     my ($title) = @_;
                   16946: 
                   16947:     my ($foldertitle,$renametitle);
                   16948:     if ($title =~ /&amp;&amp;&amp;/) {
                   16949:         $title = &HTML::Entites::decode($title);
                   16950:     }
                   16951:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16952:         $renametitle=$4;
                   16953:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16954:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16955:         my $name =  &plainname($uname,$udom);
                   16956:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16957:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16958:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16959:             $name.': <br />'.$foldertitle;
                   16960:     }
                   16961:     if (wantarray) {
                   16962:         return ($title,$foldertitle,$renametitle);
                   16963:     }
                   16964:     return $title;
                   16965: }
                   16966: 
1.1075.2.43  raeburn  16967: sub recurse_supplemental {
                   16968:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16969:     if ($suppmap) {
                   16970:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16971:         if ($fatal) {
                   16972:             $errors ++;
                   16973:         } else {
                   16974:             if ($#LONCAPA::map::resources > 0) {
                   16975:                 foreach my $res (@LONCAPA::map::resources) {
                   16976:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16977:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16978:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16979:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16980:                         } else {
                   16981:                             $numfiles ++;
                   16982:                         }
                   16983:                     }
                   16984:                 }
                   16985:             }
                   16986:         }
                   16987:     }
                   16988:     return ($numfiles,$errors);
                   16989: }
                   16990: 
1.1075.2.18  raeburn  16991: sub symb_to_docspath {
1.1075.2.119  raeburn  16992:     my ($symb,$navmapref) = @_;
                   16993:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16994:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16995:     if ($resurl=~/\.(sequence|page)$/) {
                   16996:         $mapurl=$resurl;
                   16997:     } elsif ($resurl eq 'adm/navmaps') {
                   16998:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16999:     }
                   17000:     my $mapresobj;
1.1075.2.119  raeburn  17001:     unless (ref($$navmapref)) {
                   17002:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17003:     }
                   17004:     if (ref($$navmapref)) {
                   17005:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17006:     }
                   17007:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17008:     my $type=$2;
                   17009:     my $path;
                   17010:     if (ref($mapresobj)) {
                   17011:         my $pcslist = $mapresobj->map_hierarchy();
                   17012:         if ($pcslist ne '') {
                   17013:             foreach my $pc (split(/,/,$pcslist)) {
                   17014:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17015:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17016:                 if (ref($res)) {
                   17017:                     my $thisurl = $res->src();
                   17018:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17019:                     my $thistitle = $res->title();
                   17020:                     $path .= '&'.
                   17021:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17022:                              &escape($thistitle).
1.1075.2.18  raeburn  17023:                              ':'.$res->randompick().
                   17024:                              ':'.$res->randomout().
                   17025:                              ':'.$res->encrypted().
                   17026:                              ':'.$res->randomorder().
                   17027:                              ':'.$res->is_page();
                   17028:                 }
                   17029:             }
                   17030:         }
                   17031:         $path =~ s/^\&//;
                   17032:         my $maptitle = $mapresobj->title();
                   17033:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17034:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17035:         }
                   17036:         $path .= (($path ne '')? '&' : '').
                   17037:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17038:                  &escape($maptitle).
1.1075.2.18  raeburn  17039:                  ':'.$mapresobj->randompick().
                   17040:                  ':'.$mapresobj->randomout().
                   17041:                  ':'.$mapresobj->encrypted().
                   17042:                  ':'.$mapresobj->randomorder().
                   17043:                  ':'.$mapresobj->is_page();
                   17044:     } else {
                   17045:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17046:         my $ispage = (($type eq 'page')? 1 : '');
                   17047:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17048:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17049:         }
                   17050:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17051:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17052:     }
                   17053:     unless ($mapurl eq 'default') {
                   17054:         $path = 'default&'.
1.1075.2.46  raeburn  17055:                 &escape('Main Content').
1.1075.2.18  raeburn  17056:                 ':::::&'.$path;
                   17057:     }
                   17058:     return $path;
                   17059: }
                   17060: 
1.1075.2.14  raeburn  17061: sub captcha_display {
1.1075.2.137  raeburn  17062:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17063:     my ($output,$error);
1.1075.2.107  raeburn  17064:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17065:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17066:     if ($captcha eq 'original') {
                   17067:         $output = &create_captcha();
                   17068:         unless ($output) {
                   17069:             $error = 'captcha';
                   17070:         }
                   17071:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17072:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17073:         unless ($output) {
                   17074:             $error = 'recaptcha';
                   17075:         }
                   17076:     }
1.1075.2.107  raeburn  17077:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17078: }
                   17079: 
                   17080: sub captcha_response {
1.1075.2.137  raeburn  17081:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17082:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17083:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17084:     if ($captcha eq 'original') {
                   17085:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17086:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17087:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17088:     } else {
                   17089:         $captcha_chk = 1;
                   17090:     }
                   17091:     return ($captcha_chk,$captcha_error);
                   17092: }
                   17093: 
                   17094: sub get_captcha_config {
1.1075.2.137  raeburn  17095:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17096:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17097:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17098:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17099:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17100:     if ($context eq 'usercreation') {
                   17101:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17102:         if (ref($domconfig{$context}) eq 'HASH') {
                   17103:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17104:             if (ref($hashtocheck) eq 'HASH') {
                   17105:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17106:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17107:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17108:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17109:                     }
                   17110:                     if ($privkey && $pubkey) {
                   17111:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17112:                         $version = $hashtocheck->{'recaptchaversion'};
                   17113:                         if ($version ne '2') {
                   17114:                             $version = 1;
                   17115:                         }
1.1075.2.14  raeburn  17116:                     } else {
                   17117:                         $captcha = 'original';
                   17118:                     }
                   17119:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17120:                     $captcha = 'original';
                   17121:                 }
                   17122:             }
                   17123:         } else {
                   17124:             $captcha = 'captcha';
                   17125:         }
                   17126:     } elsif ($context eq 'login') {
                   17127:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17128:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17129:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17130:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17131:             if ($privkey && $pubkey) {
                   17132:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17133:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17134:                 if ($version ne '2') {
                   17135:                     $version = 1;
                   17136:                 }
1.1075.2.14  raeburn  17137:             } else {
                   17138:                 $captcha = 'original';
                   17139:             }
                   17140:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17141:             $captcha = 'original';
                   17142:         }
1.1075.2.137  raeburn  17143:     } elsif ($context eq 'passwords') {
                   17144:         if ($dom_in_effect) {
                   17145:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17146:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17147:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17148:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17149:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17150:                 }
                   17151:                 if ($privkey && $pubkey) {
                   17152:                     $captcha = 'recaptcha';
                   17153:                     $version = $passwdconf{'recaptchaversion'};
                   17154:                     if ($version ne '2') {
                   17155:                         $version = 1;
                   17156:                     }
                   17157:                 } else {
                   17158:                     $captcha = 'original';
                   17159:                 }
                   17160:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17161:                 $captcha = 'original';
                   17162:             }
                   17163:         }
1.1075.2.14  raeburn  17164:     }
1.1075.2.107  raeburn  17165:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17166: }
                   17167: 
                   17168: sub create_captcha {
                   17169:     my %captcha_params = &captcha_settings();
                   17170:     my ($output,$maxtries,$tries) = ('',10,0);
                   17171:     while ($tries < $maxtries) {
                   17172:         $tries ++;
                   17173:         my $captcha = Authen::Captcha->new (
                   17174:                                            output_folder => $captcha_params{'output_dir'},
                   17175:                                            data_folder   => $captcha_params{'db_dir'},
                   17176:                                           );
                   17177:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17178: 
                   17179:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17180:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   17181:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  17182:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   17183:                       '<br />'.
                   17184:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17185:             last;
                   17186:         }
                   17187:     }
                   17188:     return $output;
                   17189: }
                   17190: 
                   17191: sub captcha_settings {
                   17192:     my %captcha_params = (
                   17193:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17194:                            www_output_dir => "/captchaspool",
                   17195:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17196:                            numchars       => '5',
                   17197:                          );
                   17198:     return %captcha_params;
                   17199: }
                   17200: 
                   17201: sub check_captcha {
                   17202:     my ($captcha_chk,$captcha_error);
                   17203:     my $code = $env{'form.code'};
                   17204:     my $md5sum = $env{'form.crypt'};
                   17205:     my %captcha_params = &captcha_settings();
                   17206:     my $captcha = Authen::Captcha->new(
                   17207:                       output_folder => $captcha_params{'output_dir'},
                   17208:                       data_folder   => $captcha_params{'db_dir'},
                   17209:                   );
1.1075.2.26  raeburn  17210:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17211:     my %captcha_hash = (
                   17212:                         0       => 'Code not checked (file error)',
                   17213:                        -1      => 'Failed: code expired',
                   17214:                        -2      => 'Failed: invalid code (not in database)',
                   17215:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17216:     );
                   17217:     if ($captcha_chk != 1) {
                   17218:         $captcha_error = $captcha_hash{$captcha_chk}
                   17219:     }
                   17220:     return ($captcha_chk,$captcha_error);
                   17221: }
                   17222: 
                   17223: sub create_recaptcha {
1.1075.2.107  raeburn  17224:     my ($pubkey,$version) = @_;
                   17225:     if ($version >= 2) {
                   17226:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   17227:     } else {
                   17228:         my $use_ssl;
                   17229:         if ($ENV{'SERVER_PORT'} == 443) {
                   17230:             $use_ssl = 1;
                   17231:         }
                   17232:         my $captcha = Captcha::reCAPTCHA->new;
                   17233:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17234:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17235:                &mt('If the text is hard to read, [_1] will replace them.',
                   17236:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17237:                '<br /><br />';
                   17238:      }
1.1075.2.14  raeburn  17239: }
                   17240: 
                   17241: sub check_recaptcha {
1.1075.2.107  raeburn  17242:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17243:     my $captcha_chk;
1.1075.2.107  raeburn  17244:     if ($version >= 2) {
                   17245:         my $ua = LWP::UserAgent->new;
                   17246:         $ua->timeout(10);
                   17247:         my %info = (
                   17248:                      secret   => $privkey,
                   17249:                      response => $env{'form.g-recaptcha-response'},
                   17250:                      remoteip => $ENV{'REMOTE_ADDR'},
                   17251:                    );
                   17252:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17253:         if ($response->is_success)  {
                   17254:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17255:             if (ref($data) eq 'HASH') {
                   17256:                 if ($data->{'success'}) {
                   17257:                     $captcha_chk = 1;
                   17258:                 }
                   17259:             }
                   17260:         }
                   17261:     } else {
                   17262:         my $captcha = Captcha::reCAPTCHA->new;
                   17263:         my $captcha_result =
                   17264:             $captcha->check_answer(
                   17265:                                     $privkey,
                   17266:                                     $ENV{'REMOTE_ADDR'},
                   17267:                                     $env{'form.recaptcha_challenge_field'},
                   17268:                                     $env{'form.recaptcha_response_field'},
                   17269:                                   );
                   17270:         if ($captcha_result->{is_valid}) {
                   17271:             $captcha_chk = 1;
                   17272:         }
1.1075.2.14  raeburn  17273:     }
                   17274:     return $captcha_chk;
                   17275: }
                   17276: 
1.1075.2.64  raeburn  17277: sub emailusername_info {
1.1075.2.103  raeburn  17278:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17279:     my %titles = &Apache::lonlocal::texthash (
                   17280:                      lastname      => 'Last Name',
                   17281:                      firstname     => 'First Name',
                   17282:                      institution   => 'School/college/university',
                   17283:                      location      => "School's city, state/province, country",
                   17284:                      web           => "School's web address",
                   17285:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17286:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17287:                  );
                   17288:     return (\@fields,\%titles);
                   17289: }
                   17290: 
1.1075.2.56  raeburn  17291: sub cleanup_html {
                   17292:     my ($incoming) = @_;
                   17293:     my $outgoing;
                   17294:     if ($incoming ne '') {
                   17295:         $outgoing = $incoming;
                   17296:         $outgoing =~ s/;/&#059;/g;
                   17297:         $outgoing =~ s/\#/&#035;/g;
                   17298:         $outgoing =~ s/\&/&#038;/g;
                   17299:         $outgoing =~ s/</&#060;/g;
                   17300:         $outgoing =~ s/>/&#062;/g;
                   17301:         $outgoing =~ s/\(/&#040/g;
                   17302:         $outgoing =~ s/\)/&#041;/g;
                   17303:         $outgoing =~ s/"/&#034;/g;
                   17304:         $outgoing =~ s/'/&#039;/g;
                   17305:         $outgoing =~ s/\$/&#036;/g;
                   17306:         $outgoing =~ s{/}{&#047;}g;
                   17307:         $outgoing =~ s/=/&#061;/g;
                   17308:         $outgoing =~ s/\\/&#092;/g
                   17309:     }
                   17310:     return $outgoing;
                   17311: }
                   17312: 
1.1075.2.74  raeburn  17313: # Checks for critical messages and returns a redirect url if one exists.
                   17314: # $interval indicates how often to check for messages.
1.1075.2.141.  .6(raebu 17315:20): # $context is the calling context -- roles, grades, contents, menu or flip.
1.1075.2.74  raeburn  17316: sub critical_redirect {
1.1075.2.141.  .6(raebu 17317:20):     my ($interval,$context) = @_;
1.1075.2.74  raeburn  17318:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1075.2.141.  .6(raebu 17319:20):         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   17320:20):             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17321:20):             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17322:20):             my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
                   17323:20):             if ($blocked) {
                   17324:20):                 my $checkrole = "cm./$cdom/$cnum";
                   17325:20):                 if ($env{'request.course.sec'} ne '') {
                   17326:20):                     $checkrole .= "/$env{'request.course.sec'}";
                   17327:20):                 }
                   17328:20):                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   17329:20):                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   17330:20):                     return;
                   17331:20):                 }
                   17332:20):             }
                   17333:20):         }
1.1075.2.74  raeburn  17334:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17335:                                         $env{'user.name'});
                   17336:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17337:         my $redirecturl;
                   17338:         if ($what[0]) {
                   17339:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   17340:                 $redirecturl='/adm/email?critical=display';
                   17341:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17342:                 return (1, $url);
                   17343:             }
                   17344:         }
                   17345:     }
                   17346:     return ();
                   17347: }
                   17348: 
1.1075.2.64  raeburn  17349: # Use:
                   17350: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17351: #
                   17352: ##################################################
                   17353: #          password associated functions         #
                   17354: ##################################################
                   17355: sub des_keys {
                   17356:     # Make a new key for DES encryption.
                   17357:     # Each key has two parts which are returned separately.
                   17358:     # Please note:  Each key must be passed through the &hex function
                   17359:     # before it is output to the web browser.  The hex versions cannot
                   17360:     # be used to decrypt.
                   17361:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17362:                 '8','9','a','b','c','d','e','f');
                   17363:     my $lkey='';
                   17364:     for (0..7) {
                   17365:         $lkey.=$hexstr[rand(15)];
                   17366:     }
                   17367:     my $ukey='';
                   17368:     for (0..7) {
                   17369:         $ukey.=$hexstr[rand(15)];
                   17370:     }
                   17371:     return ($lkey,$ukey);
                   17372: }
                   17373: 
                   17374: sub des_decrypt {
                   17375:     my ($key,$cyphertext) = @_;
                   17376:     my $keybin=pack("H16",$key);
                   17377:     my $cypher;
                   17378:     if ($Crypt::DES::VERSION>=2.03) {
                   17379:         $cypher=new Crypt::DES $keybin;
                   17380:     } else {
                   17381:         $cypher=new DES $keybin;
                   17382:     }
1.1075.2.106  raeburn  17383:     my $plaintext='';
                   17384:     my $cypherlength = length($cyphertext);
                   17385:     my $numchunks = int($cypherlength/32);
                   17386:     for (my $j=0; $j<$numchunks; $j++) {
                   17387:         my $start = $j*32;
                   17388:         my $cypherblock = substr($cyphertext,$start,32);
                   17389:         my $chunk =
                   17390:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17391:         $chunk .=
                   17392:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17393:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17394:         $plaintext .= $chunk;
                   17395:     }
1.1075.2.64  raeburn  17396:     return $plaintext;
                   17397: }
                   17398: 
1.1075.2.141.  .5(raebu 17399:20): sub get_requested_shorturls {
          .1(raebu 17400:20):     my ($cdom,$cnum,$navmap) = @_;
                   17401:20):     return unless (ref($navmap));
          .5(raebu 17402:20):     my ($numnew,$errors);
          .1(raebu 17403:20):     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   17404:20):     if (@toshorten) {
                   17405:20):         my (%maps,%resources,%titles);
                   17406:20):         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   17407:20):                                                                'shorturls',$cdom,$cnum);
                   17408:20):         if (keys(%resources)) {
          .5(raebu 17409:20):             my %tocreate;
          .1(raebu 17410:20):             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   17411:20):                 my $symb = $resources{$item};
                   17412:20):                 if ($symb) {
                   17413:20):                     $tocreate{$cnum.'&'.$symb} = 1;
                   17414:20):                 }
                   17415:20):             }
          .5(raebu 17416:20):             if (keys(%tocreate)) {
                   17417:20):                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   17418:20):                                                       \%tocreate);
                   17419:20):             }
          .1(raebu 17420:20):         }
          .5(raebu 17421:20):     }
                   17422:20):     return ($numnew,$errors);
                   17423:20): }
                   17424:20): 
                   17425:20): sub make_short_symbs {
                   17426:20):     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   17427:20):     my ($numnew,@errors);
                   17428:20):     if (ref($tocreateref) eq 'HASH') {
                   17429:20):         my %tocreate = %{$tocreateref};
          .1(raebu 17430:20):         if (keys(%tocreate)) {
                   17431:20):             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   17432:20):             my $su = Short::URL->new(no_vowels => 1);
                   17433:20):             my $init = '';
                   17434:20):             my (%newunique,%addcourse,%courseonly,%failed);
                   17435:20):             # get lock on tiny db
                   17436:20):             my $now = time;
          .5(raebu 17437:20):             if ($lockuser eq '') {
                   17438:20):                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   17439:20):             }
          .1(raebu 17440:20):             my $lockhash = {
          .5(raebu 17441:20):                                 "lock\0$now" => $lockuser,
          .1(raebu 17442:20):                             };
                   17443:20):             my $tries = 0;
                   17444:20):             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17445:20):             my ($code,$error);
                   17446:20):             while (($gotlock ne 'ok') && ($tries<3)) {
                   17447:20):                 $tries ++;
                   17448:20):                 sleep 1;
                   17449:20):                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   17450:20):             }
                   17451:20):             if ($gotlock eq 'ok') {
                   17452:20):                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   17453:20):                                        \%addcourse,\%courseonly,\%failed);
                   17454:20):                 if (keys(%failed)) {
                   17455:20):                     my $numfailed = scalar(keys(%failed));
                   17456:20):                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   17457:20):                 }
                   17458:20):                 if (keys(%newunique)) {
                   17459:20):                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   17460:20):                     if ($putres eq 'ok') {
                   17461:20):                         $numnew = scalar(keys(%newunique));
                   17462:20):                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   17463:20):                         unless ($newputres eq 'ok') {
                   17464:20):                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   17465:20):                         }
                   17466:20):                     } else {
                   17467:20):                         push(@errors,&mt('error: could not store unique six character URLs'));
                   17468:20):                     }
                   17469:20):                 }
                   17470:20):             }
                   17471:20):         }
                   17472:20):     }
                   17473:20):     return ($numnew,\@errors);
                   17474:20): }
                   17475:20): 
                   17476:20): sub shorten_symbs {
                   17477:20):     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   17478:20):     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   17479:20):                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   17480:20):                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   17481:20):     my (%possibles,%collisions);
                   17482:20):     foreach my $key (keys(%{$tocreate})) {
                   17483:20):         my $num = String::CRC32::crc32($key);
                   17484:20):         my $tiny = $su->encode($num,$init);
                   17485:20):         if ($tiny) {
                   17486:20):             $possibles{$tiny} = $key;
                   17487:20):         }
                   17488:20):     }
                   17489:20):     if (!$init) {
                   17490:20):         $init = 1;
                   17491:20):     } else {
                   17492:20):         $init ++;
                   17493:20):     }
                   17494:20):     if (keys(%possibles)) {
                   17495:20):         my @posstiny = keys(%possibles);
                   17496:20):         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   17497:20):         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   17498:20):         if (keys(%currtiny)) {
                   17499:20):             foreach my $key (keys(%currtiny)) {
                   17500:20):                 next if ($currtiny{$key} eq '');
                   17501:20):                 if ($currtiny{$key} eq $possibles{$key}) {
                   17502:20):                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   17503:20):                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17504:20):                         $courseonly->{$tsymb} = $key;
                   17505:20):                     }
                   17506:20):                 } else {
                   17507:20):                     $collisions{$possibles{$key}} = 1;
                   17508:20):                 }
                   17509:20):                 delete($possibles{$key});
                   17510:20):             }
                   17511:20):         }
                   17512:20):         foreach my $key (keys(%possibles)) {
                   17513:20):             $newunique->{$key} = $possibles{$key};
                   17514:20):             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   17515:20):             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   17516:20):                 $addcourse->{$tsymb} = $key;
                   17517:20):             }
                   17518:20):         }
                   17519:20):     }
                   17520:20):     if (keys(%collisions)) {
                   17521:20):         if ($init <5) {
                   17522:20):             if (!$init) {
                   17523:20):                 $init = 1;
                   17524:20):             } else {
                   17525:20):                 $init ++;
                   17526:20):             }
                   17527:20):             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   17528:20):                                    $newunique,$addcourse,$courseonly,$failed);
                   17529:20):         } else {
                   17530:20):             foreach my $key (keys(%collisions)) {
                   17531:20):                 $failed->{$key} = 1;
                   17532:20):                 $failed->{$key} = 1;
                   17533:20):             }
                   17534:20):         }
                   17535:20):     }
                   17536:20):     return $init;
                   17537:20): }
                   17538:20): 
1.1075.2.135  raeburn  17539: sub is_nonframeable {
                   17540:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17541:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17542:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17543: 
                   17544:     $remprotocol = lc($remprotocol);
                   17545:     $remhost = lc($remhost);
                   17546:     my $remport = 80;
                   17547:     if ($remprotocol eq 'https') {
                   17548:         $remport = 443;
                   17549:     }
                   17550:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17551:     if ($cached) {
                   17552:         unless ($nocache) {
                   17553:             if ($result) {
                   17554:                 return 1;
                   17555:             } else {
                   17556:                 return 0;
                   17557:             }
                   17558:         }
                   17559:     }
                   17560:     my $uselink;
                   17561:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.141.  .2(raebu 17562:20):     my $ua = LWP::UserAgent->new;
                   17563:20):     $ua->timeout(5);
                   17564:20):     my $response=$ua->request($request);
1.1075.2.135  raeburn  17565:     if ($response->is_success()) {
                   17566:         my $secpolicy = lc($response->header('content-security-policy'));
                   17567:         my $xframeop = lc($response->header('x-frame-options'));
                   17568:         $secpolicy =~ s/^\s+|\s+$//g;
                   17569:         $xframeop =~ s/^\s+|\s+$//g;
                   17570:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17571:             my $remotehost = $remprotocol.'://'.$remhost;
                   17572:             my ($origin,$protocol,$port);
                   17573:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17574:                 $port = $ENV{'SERVER_PORT'};
                   17575:             } else {
                   17576:                 $port = 80;
                   17577:             }
                   17578:             if ($absolute eq '') {
                   17579:                 $protocol = 'http:';
                   17580:                 if ($port == 443) {
                   17581:                     $protocol = 'https:';
                   17582:                 }
                   17583:                 $origin = $protocol.'//'.lc($hostname);
                   17584:             } else {
                   17585:                 $origin = lc($absolute);
                   17586:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17587:             }
                   17588:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17589:                 my $framepolicy = $1;
                   17590:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17591:                 my @policies = split(/\s+/,$framepolicy);
                   17592:                 if (@policies) {
                   17593:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17594:                         $uselink = 1;
                   17595:                     } else {
                   17596:                         $uselink = 1;
                   17597:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17598:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17599:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17600:                             undef($uselink);
                   17601:                         }
                   17602:                         if ($uselink) {
                   17603:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17604:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17605:                                     undef($uselink);
                   17606:                                 }
                   17607:                             }
                   17608:                         }
                   17609:                         if ($uselink) {
                   17610:                             my @possok;
                   17611:                             if ($ip ne '') {
                   17612:                                 push(@possok,$ip);
                   17613:                             }
                   17614:                             my $hoststr = '';
                   17615:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17616:                                 if ($hoststr eq '') {
                   17617:                                     $hoststr = $part;
                   17618:                                 } else {
                   17619:                                     $hoststr = "$part.$hoststr";
                   17620:                                 }
                   17621:                                 if ($hoststr eq $hostname) {
                   17622:                                     push(@possok,$hostname);
                   17623:                                 } else {
                   17624:                                     push(@possok,"*.$hoststr");
                   17625:                                 }
                   17626:                             }
                   17627:                             if (@possok) {
                   17628:                                 foreach my $poss (@possok) {
                   17629:                                     last if (!$uselink);
                   17630:                                     foreach my $policy (@policies) {
                   17631:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17632:                                             undef($uselink);
                   17633:                                             last;
                   17634:                                         }
                   17635:                                     }
                   17636:                                 }
                   17637:                             }
                   17638:                         }
                   17639:                     }
                   17640:                 }
                   17641:             } elsif ($xframeop ne '') {
                   17642:                 $uselink = 1;
                   17643:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17644:                 if (@policies) {
                   17645:                     unless (grep(/^deny$/,@policies)) {
                   17646:                         if ($origin ne '') {
                   17647:                             if (grep(/^sameorigin$/,@policies)) {
                   17648:                                 if ($remotehost eq $origin) {
                   17649:                                     undef($uselink);
                   17650:                                 }
                   17651:                             }
                   17652:                             if ($uselink) {
                   17653:                                 foreach my $policy (@policies) {
                   17654:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17655:                                         my $allowfrom = $1;
                   17656:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17657:                                             undef($uselink);
                   17658:                                             last;
                   17659:                                         }
                   17660:                                     }
                   17661:                                 }
                   17662:                             }
                   17663:                         }
                   17664:                     }
                   17665:                 }
                   17666:             }
                   17667:         }
                   17668:     }
                   17669:     if ($nocache) {
                   17670:         if ($cached) {
                   17671:             my $devalidate;
                   17672:             if ($uselink && !$result) {
                   17673:                 $devalidate = 1;
                   17674:             } elsif (!$uselink && $result) {
                   17675:                 $devalidate = 1;
                   17676:             }
                   17677:             if ($devalidate) {
                   17678:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17679:             }
                   17680:         }
                   17681:     } else {
                   17682:         if ($uselink) {
                   17683:             $result = 1;
                   17684:         } else {
                   17685:             $result = 0;
                   17686:         }
                   17687:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17688:     }
                   17689:     return $uselink;
                   17690: }
                   17691: 
1.112     bowersj2 17692: 1;
                   17693: __END__;
1.41      ng       17694: 

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